// create an entry in subgroup
conf->Write("SubgroupEntry", 3);
-
+
// '..' is understood
conf->Write("../GroupEntry", 2);
conf->SetPath("..");
void bar(wxConfigBase *config)
{
config->Write("Test", 17);
-
+
foo(config);
// we're reading "/Foo/Data/Test" here! -1 will probably be returned...
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\&}{
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\&}{
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\&}{
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}}
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}}
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}}
+}
+
+
+
+
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}
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}}
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}
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}}
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}}
\func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
Virtual function called when the left button is depressed within a
-label.
+label.
{\it row} will be {\it -1} if the click is in the top labels.
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}}
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}}
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}}
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}}
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}}
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}}
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}}
{\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}}
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}}
\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}}
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}}
\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}}
\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}
\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}}
\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}}
\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}
\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}
projects / wxWidgets.git / commitdiff
