X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..11ef729d54ee338a1d569b5a238c2feb84d488ff:/docs/latex/wx/radiobox.tex?ds=inline diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 7aaf5c0bd7..97b58b93da 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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 @@ -23,6 +34,8 @@ labelled buttons. 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}. @@ -42,7 +55,7 @@ when a radiobutton is clicked.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxconstr} +\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor} \func{}{wxRadioBox}{\void} @@ -55,6 +68,13 @@ Default constructor. \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} @@ -93,7 +113,7 @@ 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} @@ -108,16 +128,23 @@ Destructor, destroying the radiobox item. \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{bool}{ enable = {\tt true}}} +\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}} Enables or disables the entire radiobox. -\func{void}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}} +\func{virtual bool}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}} Enables or disables an individual button in the radiobox. @@ -136,6 +163,10 @@ individual button in the radiobox.} \end{twocollist}} } +\wxheading{See also} + +\helpref{wxWindow::Enable}{wxwindowenable} + \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring} @@ -160,10 +191,6 @@ Returns the number of items in the radiobox. 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.} @@ -193,13 +220,23 @@ Returns the zero-based position of the selected button. 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 +{\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 wxWindows was compiled with +code. This method is only available if wxWidgets was compiled with {\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in future versions. @@ -211,9 +248,6 @@ Returns the number of buttons in the radiobox. Sets the radiobox label. -\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}} - -Sets a label for a radio button. \wxheading{Parameters} @@ -253,11 +287,11 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted. \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. @@ -267,6 +301,15 @@ Shows or hides individual buttons. \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} @@ -274,15 +317,3 @@ implements the following methods:\par \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.} - -