+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: radiobox.tex
+%% Purpose: wxRadioBox documentation
+%% Author: wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID: $Id$
+%% Copyright: (c) wxWidgets Team
+%% License: wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{\class{wxRadioBox}}\label{wxradiobox}
A radio box item is used to select one of number of mutually exclusive
maximum number of rows.}
\twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the
maximum number of columns.}
+\twocolitem{\windowstyle{wxRA\_USE\_CHECKBOX}}{Use of the checkbox controls instead of radio
+buttons (currently supported only on PalmOS)}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}.
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxconstr}
+\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor}
\func{}{wxRadioBox}{\void}
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioBox"}}
+\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
+\param{const wxPoint\& }{point}, \param{const wxSize\& }{size},\rtfsp
+\param{const wxArrayString\&}{ choices},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
+\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{const wxString\& }{name = ``radioBox"}}
+
Constructor, creating and showing a radiobox.
\wxheading{Parameters}
\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
+\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.}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
-\membersection{wxRadioBox::\destruct{wxRadioBox}}
+\membersection{wxRadioBox::\destruct{wxRadioBox}}\label{wxradioboxdtor}
\func{}{\destruct{wxRadioBox}}{\void}
\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
\param{const wxString\& }{name = ``radioBox"}}
-Creates the radiobox for two-step construction. See \helpref{wxRadioBox::wxRadioBox}{wxradioboxconstr}\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
+\param{const wxPoint\& }{point}, \param{const wxSize\& }{size},\rtfsp
+\param{const wxArrayString\&}{ choices},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
+\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{const wxString\& }{name = ``radioBox"}}
+
+Creates the radiobox for two-step construction. See \helpref{wxRadioBox::wxRadioBox}{wxradioboxctor}\rtfsp
for further details.
\membersection{wxRadioBox::Enable}\label{wxradioboxenable}
-\func{void}{Enable}{\param{const bool}{ enable}}
+\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}}
Enables or disables the entire radiobox.
-\func{void}{Enable}{\param{int}{ n}, \param{const bool}{ enable}}
+\func{virtual bool}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}}
Enables or disables an individual button in the radiobox.
\wxheading{Parameters}
-\docparam{enable}{TRUE to enable, FALSE to disable.}
+\docparam{enable}{true to enable, false to disable.}
\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
+\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}}
}
+\wxheading{See also}
+
+\helpref{wxWindow::Enable}{wxwindowenable}
+
\membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
\docparam{string}{The string to find.}
+\membersection{wxRadioBox::GetCount}\label{wxradioboxgetcount}
+
+\constfunc{int}{GetCount}{\void}
+
+Returns the number of items in the radiobox.
+
\membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
\constfunc{wxString}{GetLabel}{\void}
Returns the radiobox label.
-\constfunc{wxString}{GetLabel}{\param{int }{n}}
-
-Returns the label for the given button.
-
\wxheading{Parameters}
\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{GetLabel()}}{Returns the radiobox label.}
-\twocolitem{\bf{GetItemLabel(n)}}{Returns the label for the given button.}
+\twocolitem{{\bf GetLabel()}}{Returns the radiobox label.}
+\twocolitem{{\bf GetItemLabel(n)}}{Returns the label for the given button.}
\end{twocollist}}
}
Returns the selected string.
+\membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
+
+\constfunc{wxString}{GetString}{\param{int}{ n}}
+
+Returns the label for the button at the given position.
+
+\wxheading{Parameters}
+
+\docparam{n}{The zero-based button position.}
+
\membersection{wxRadioBox::Number}\label{wxradioboxnumber}
\constfunc{int}{Number}{\void}
+{\bf Obsolescence note:} This method is obsolete and was replaced with
+\helpref{GetCount}{wxradioboxgetcount}, please use the new method in the new
+code. This method is only available if wxWidgets was compiled with
+{\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in
+future versions.
+
Returns the number of buttons in the radiobox.
\membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
Sets the radiobox label.
-\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
-
-Sets a label for a radio button.
\wxheading{Parameters}
\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.}
+\twocolitem{{\bf SetLabel(string)}}{Sets the radiobox label.}
+\twocolitem{{\bf SetItemLabel(n, string)}}{Sets a label for a radio button.}
\end{twocollist}}
}
\membersection{wxRadioBox::Show}\label{wxradioboxshow}
-\func{void}{Show}{\param{const bool}{ show}}
+\func{virtual bool}{Show}{\param{const bool}{ show = {\tt true}}}
Shows or hides the entire radiobox.
-\func{void}{Show}{\param{int }{item}, \param{const bool}{ show}}
+\func{virtual bool}{Show}{\param{int}{ item}, \param{const bool}{ show = {\tt true}}}
Shows or hides individual buttons.
\wxheading{Parameters}
-\docparam{show}{TRUE to show, FALSE to hide.}
+\docparam{show}{true to show, false to hide.}
\docparam{item}{The zero-based position of the button to show or hide.}
+\wxheading{Return value}
+
+{\tt true} if the box or item has been shown or hidden or {\tt false} if nothing was
+done because it already was in the requested state.
+
+\wxheading{See also}
+
+\helpref{wxWindow::Show}{wxwindowshow}
+
\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.}
+\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}}
-
-Returns the label for the button at the given position.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based button position.}
-
-
projects / wxWidgets.git / blobdiff