More wxPython docs...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1776 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/config.tex

@@ -443,6 +443,10 @@ index}}
 
 Gets the first group.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{
@@ -450,6 +454,10 @@ index}}
 
 Gets the first entry.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{
@@ -457,6 +465,10 @@ index}}
 
 Gets the next group.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{
@@ -464,6 +476,10 @@ index}}
 
 Gets the next entry.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
@@ -580,6 +596,15 @@ not found, {\it b} is not changed.
 Reads a bool value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Read(key, default="")}}{Returns a string.}
+\twocolitem{\bf{ReadInt(key, default=0)}}{Returns an int.}
+\twocolitem{\bf{ReadFloat(key, default=0.0)}}{Returns a floating point number.}
+\end{twocollist}}
+}
+
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
@@ -659,4 +684,16 @@ value}}
 These functions write the specified value to the config file and return TRUE
 on success.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Write(key, value)}}{Writes a string.}
+\twocolitem{\bf{WriteInt(key, value)}}{Writes an int.}
+\twocolitem{\bf{WriteFloat(key, value)}}{Writes a floating point number.}
+\end{twocollist}}
+}
+
+
+
+
 

docs/latex/wx/grid.tex

@@ -83,6 +83,16 @@ and widths, and/or default cell width and height.
 
 Call this function after creating the wxGrid object.
 
+\pythonnote{Currently the \tt{cellValues} and \tt{widths} parameters
+don't exisit in the wxPython version of this method.  So in other
+words, the definition of the  wxPython version of this method looks like this:
+\begin{verbatim}
+    CreateGrid(rows, cols,
+               defaultWidth = wxGRID_DEFAULT_CELL_WIDTH,
+               defaultHeight = wxGRID_DEFAULT_CELL_HEIGHT)
+\end{verbatim}
+}
+
 \membersection{wxGrid::CurrentCellVisible}\label{wxgridcurrentcellvisible}
 
 \func{bool}{CurrentCellVisible}{\void}
@@ -142,6 +152,14 @@ wxGenericGrid implementation only.
 Sets the text alignment for the cell at the given position, or the global alignment value.
 The return value is wxLEFT, wxRIGHT or wxCENTRE.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetCellAlignment(row, col)}}{}
+\twocolitem{\bf{GetDefCellAlignment()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 
 \constfunc{wxColour\&}{GetCellBackgroundColour}{\param{int}{ row}, \param{int}{ col}}
@@ -150,6 +168,14 @@ The return value is wxLEFT, wxRIGHT or wxCENTRE.
 
 Gets the background colour for the cell at the given position, or the global background colour.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetCellBackgroundColour(row, col)}}{}
+\twocolitem{\bf{GetDefCellBackgroundColourt()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCells}\label{wxgridgetcells}
 
 \constfunc{wxGridCell ***}{GetCells}{\void}
@@ -164,6 +190,14 @@ Returns the array of grid cell object associated with this wxGrid.
 
 Gets the text colour for the cell at the given position, or the global text colour.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetCellTextColour(row, col)}}{}
+\twocolitem{\bf{GetDefCellTextColour()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
 
 \constfunc{const wxFont\&}{GetCellTextFont}{\param{int}{ row}, \param{int}{ col}}
@@ -172,6 +206,14 @@ Gets the text colour for the cell at the given position, or the global text colo
 
 Gets the text font for the cell at the given position, or the global text font.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetCellTextFont(row, col)}}{}
+\twocolitem{\bf{GetDefCellTextFont()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}
 
 \constfunc{wxString\&}{GetCellValue}{\param{int}{ row}, \param{int}{ col}}
@@ -403,6 +445,14 @@ call wxGrid::OnSelectCell to apply the default behaviour.
 
 Sets the text alignment for the cell at the given position, or for the whole grid. {\it alignment} may be wxLEFT, wxRIGHT or wxCENTRE.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetCellAlignment(alignment, row, col)}}{}
+\twocolitem{\bf{SetDefCellAlignment(alignment)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
@@ -411,6 +461,14 @@ Sets the text alignment for the cell at the given position, or for the whole gri
 
 Sets the background colour for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetCellBackgroundColour(colour, row, col)}}{}
+\twocolitem{\bf{SetDefCellBackgroundColour(colour)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
 
 \func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
@@ -419,6 +477,14 @@ Sets the background colour for the cell at the given position, or for the whole
 
 Sets the text colour for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetCellTextColour(colour, row, col)}}{}
+\twocolitem{\bf{SetDefCellTextColour(colour)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
 
 \func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}, \param{int}{ row}, \param{int}{ col}}
@@ -427,6 +493,14 @@ Sets the text colour for the cell at the given position, or for the whole grid.
 
 Sets the text font for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetCellTextFont(font, row, col)}}{}
+\twocolitem{\bf{SetDefCellTextFont(font)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
 
 \func{void}{SetCellValue}{\param{const wxString\&}{ val}, \param{int}{ row}, \param{int}{ col}}

docs/latex/wx/listctrl.tex

@@ -176,6 +176,15 @@ the beginning if 'start' is -1.
 Find an item nearest this position in the specified direction, starting from
 the item after {\it start} or the beginning if {\it start} is -1.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{FindItem(start, str, partial=FALSE)}}{}
+\twocolitem{\bf{FindItemData(start, data)}}{}
+\twocolitem{\bf{FindItemAtPos(start, point, direction)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
 
 \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
@@ -224,6 +233,10 @@ Returns the specified image list. {\it which} may be one of:
 Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
 information.
 
+\pythonnote{The wxPython version of this method takes a parameter
+representing the item ID, and returns the wxListItem object.
+}
+
 \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
 
 \constfunc{long}{GetItemData}{\param{long }{item}}
@@ -236,6 +249,9 @@ Gets the application-defined data associated with this item.
 
 Returns the position of the item, in icon or small icon view.
 
+\pythonnote{The wxPython version of this method accempts only the item
+ID and returns the wxPoint.}
+
 \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
 
 \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
@@ -244,6 +260,9 @@ Returns the rectangle representing the item's size and position, in client coord
 
 {\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL.
 
+\pythonnote{The wxPython version of this method accempts only the item
+ID and returns the wxRect.}
+
 \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
 
 \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
@@ -355,6 +374,16 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi
 
 For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{InsertColumn(col, heading, format=wxLIST_FORMAT_LEFT,
+width=-1)}}{Creates a column using a header string only.}
+\twocolitem{\bf{InsertColumnInfo(col, item)}}{Creates a column using a
+wxListInfo.}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
 
 \func{long}{InsertItem}{\param{wxListItem\& }{info}}
@@ -384,6 +413,16 @@ Insert an image/string item.
 
 \docparam{imageIndex}{index into the image list associated with this control and view style}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{InsertItem(item)}}{Inserts an item using a wxListItem.}
+\twocolitem{\bf{InsertStringItem(index, label)}}{Inserts a string item.}
+\twocolitem{\bf{InsertImageItem(index, imageIndex)}}{Inserts an image item.}
+\twocolitem{\bf{InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist}
 
 \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}}
@@ -476,6 +515,16 @@ The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following:
 
 Sets a string field at a particular column.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetItem(item)}}{Sets information about the given wxListItem.}
+\twocolitem{\bf{SetStringItem(index, col, label, imageId)}}{Sets a
+string or image at a given location.}
+\end{twocollist}}
+}
+
+
 \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
 
 \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}

docs/latex/wx/radiobox.tex

@@ -125,6 +125,16 @@ Enables or disables an individual button in the radiobox.
 
 \docparam{n}{The zero-based button to enable or disable.}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Enable(flag)}}{Enables or disables the entire radiobox.}
+\twocolitem{\bf{EnableItem(n, flag)}}{Enables or disables an
+individual button in the radiobox.}
+\end{twocollist}}
+}
+
+
 \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
 
 \constfunc{int}{FindString}{\param{const wxString\& }{string}}
@@ -154,6 +164,15 @@ Returns the label for the given button.
 
 \helpref{wxRadioBox::SetLabel}{wxradioboxsetlabel}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetLabel()}}{Returns the radiobox label.}
+\twocolitem{\bf{GetItemLabel(n)}}{Returns the label for the given button.}
+\end{twocollist}}
+}
+
+
 \membersection{wxRadioBox::GetSelection}\label{wxradioboxgetselection}
 
 \constfunc{int}{GetSelection}{\void}
@@ -188,6 +207,14 @@ Sets a label for a radio button.
 
 \docparam{n}{The zero-based button index.}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetLabel(string)}}{Sets the radiobox label.}
+\twocolitem{\bf{SetItemLabel(n, string)}}{Sets a label for a radio button.}
+\end{twocollist}}
+}
+
 \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
 
 \func{void}{SetSelection}{\param{int}{ n}}
@@ -224,6 +251,14 @@ Shows or hides individual buttons.
 
 \docparam{item}{The zero-based position of the button to show or hide.}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Show(flag)}}{Shows or hides the entire radiobox.}
+\twocolitem{\bf{ShowItem(n, flag)}}{Shows or hides individual buttons.}
+\end{twocollist}}
+}
+
 \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
 
 \constfunc{wxString}{GetString}{\param{int}{ n}}

docs/latex/wx/wxPython.tex

@@ -443,7 +443,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxListBox}{wxlistbox}
 \item \helpref{wxListCtrl}{wxlistctrl}
 \item \helpref{wxListEvent}{wxlistevent}
-\item \helpref{wxListItem}{wxlistitem}
+\item \helpref{wxListItem}{wxlistctrlsetitem}
 \item \helpref{wxMDIChildFrame}{wxmdichildframe}
 \item \helpref{wxMDIClientWindow}{wxmdiclientwindow}
 \item \helpref{wxMDIParentFrame}{wxmdiparentframe}
@@ -506,6 +506,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxTimer}{wxtimer}
 \item \helpref{wxToolBarTool}{wxtoolbartool}
 \item \helpref{wxToolBar}{wxtoolbar}
+\item \helpref{wxToolTip}{wxtooltip}
 \item \helpref{wxTreeCtrl}{wxtreectrl}
 \item \helpref{wxTreeEvent}{wxtreeevent}
 \item \helpref{wxTreeItemData}{wxtreeitemdata}