fall back on text value if no long/double value could be retrieved from the cell

[wxWidgets.git] / docs / latex / wx / radiobox.tex

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index 36918afb48937c4c8271e74b66c53c6241fd5060..67b539b0cc638dd9d0d20ca3752ad8aae6f76b7e 100644 (file)
--- a/docs/latex/wx/radiobox.tex
+++ b/docs/latex/wx/radiobox.tex
@@ -11,16 +11,30 @@ labelled buttons.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/radiobox.h>
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxRA\_HORIZONTAL}}{Lays the radiobox out in rows.}
-\twocolitem{\windowstyle{wxRA\_VERTICAL}}{Lays the radiobox out in columns.}
+\twocolitem{\windowstyle{wxRA\_SPECIFY\_ROWS}}{The major dimension parameter refers to the
+maximum number of rows.}
+\twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the
+maximum number of columns.}
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Event handling}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event,
+when a radiobutton is clicked.}
+\end{twocollist}
+
 \wxheading{See also}
 
 \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioButton}{wxradiobutton},\rtfsp
@@ -34,10 +48,10 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default constructor.
 
-\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
+\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
-\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp
+\param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
@@ -59,7 +73,7 @@ Constructor, creating and showing a radiobox.
 
 \docparam{choices}{An array of choices with which to initialize the radiobox.}
 
-\docparam{majorDimension}{Specifies the number of rows (if style is wxRA\_VERTICAL) or columns (if style is wxRA\_HORIZONTAL) for a two-dimensional
+\docparam{majorDimension}{Specifies the maximum number of rows (if style contains wxRA\_SPECIFY\_ROWS) or columns (if style contains wxRA\_SPECIFY\_COLS) for a two-dimensional
 radiobox.}
 
 \docparam{style}{Window style. See \helpref{wxRadioBox}{wxradiobox}.}
@@ -72,6 +86,11 @@ radiobox.}
 
 \helpref{wxRadioBox::Create}{wxradioboxcreate}, \helpref{wxValidator}{wxvalidator}
 
+\pythonnote{The wxRadioBox constructor in wxPython reduces the {\tt n}
+and {\tt choices} arguments are to a single argument, which is
+a list of strings.}
+
+
 \membersection{wxRadioBox::\destruct{wxRadioBox}}
 
 \func{}{\destruct{wxRadioBox}}{\void}
@@ -80,10 +99,10 @@ Destructor, destroying the radiobox item.
 
 \membersection{wxRadioBox::Create}\label{wxradioboxcreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
-\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp
+\param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
@@ -96,7 +115,7 @@ for further details.
 
 Enables or disables the entire radiobox.
 
-\func{void}{Enable}{\param{const int}{ n}, \param{const bool}{ enable}}
+\func{void}{Enable}{\param{int}{ n}, \param{const bool}{ enable}}
 
 Enables or disables an individual button in the radiobox.
 
@@ -106,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}}
@@ -123,7 +152,7 @@ Finds a button matching the given string, returning the position if found, or
 
 Returns the radiobox label.
 
-\constfunc{wxString}{GetLabel}{\param{const int }{n}}
+\constfunc{wxString}{GetLabel}{\param{int }{n}}
 
 Returns the label for the given button.
 
@@ -135,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}
@@ -159,7 +197,7 @@ Returns the number of buttons in the radiobox.
 
 Sets the radiobox label.
 
-\func{void}{SetLabel}{\param{const int }{n}, \param{const wxString\&}{ label}}
+\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
 
 Sets a label for a radio button.
 
@@ -169,11 +207,20 @@ 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{const int}{ n}}
+\func{void}{SetSelection}{\param{int}{ n}}
 
-Sets a button by passing the desired string position.
+Sets a button by passing the desired string position. This does not cause
+a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 
 \wxheading{Parameters}
 
@@ -183,7 +230,8 @@ Sets a button by passing the desired string position.
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{string}}
 
-Sets a button by passing the desired string.
+Sets the selection to a button by passing the desired string. This does not cause
+a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 
 \wxheading{Parameters}
 
@@ -195,7 +243,7 @@ Sets a button by passing the desired string.
 
 Shows or hides the entire radiobox.
 
-\func{void}{Show}{\param{const int }{item}, \param{const bool}{ show}}
+\func{void}{Show}{\param{int }{item}, \param{const bool}{ show}}
 
 Shows or hides individual buttons.
 
@@ -205,9 +253,17 @@ 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{const int}{ n}}
+\constfunc{wxString}{GetString}{\param{int}{ n}}
 
 Returns the label for the button at the given position.