X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/21f280f4ec6815bae2664155b2370c7bf628c524..b72979e918a07a9c4860bac4aea5c216cabbf21e:/docs/latex/wx/radiobox.tex diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index da55b879f2..ddb6cad091 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 @@ -6,6 +17,7 @@ labelled buttons. \wxheading{Derived from} +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -23,6 +35,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 +56,8 @@ when a radiobutton is clicked.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxconstr} + +\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor} \func{}{wxRadioBox}{\void} @@ -55,6 +70,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} @@ -86,17 +108,21 @@ 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 +\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} Destructor, destroying the radiobox item. + \membersection{wxRadioBox::Create}\label{wxradioboxcreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp @@ -106,34 +132,47 @@ 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{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{unsigned 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} @@ -146,16 +185,56 @@ Finds a button matching the given string, returning the position if found, or \docparam{string}{The string to find.} + +\membersection{wxRadioBox::GetColumnCount}\label{wxradioboxgetcolumncount} + +\constfunc{unsigned int}{GetColumnCount}{\void} + +Returns the number of columns in the radiobox. + + +\membersection{wxRadioBox::GetItemHelpText}\label{wxradioboxgetitemhelptext} + +\constfunc{wxString}{GetItemHelpText}{\param{unsigned int}{ item}} + +Returns the helptext associated with the specified \arg{item} if any or {\tt wxEmptyString}. + +\wxheading{Parameters} + +\docparam{item}{The zero-based item index.} + +\wxheading{See also} + +\helpref{SetItemHelpText}{wxradioboxsetitemhelptext} + + +\membersection{wxRadioBox::GetItemToolTip}\label{wxradioboxgetitemtooltip} + +\constfunc{wxToolTip *}{GetItemToolTip}{\param{unsigned int}{ item}} + +Returns the tooltip associated with the specified \arg{item} if any or \NULL. + +\wxheading{See also} + +\helpref{SetItemToolTip}{wxradioboxsetitemtooltip},\\ +\helpref{wxWindow::GetToolTip}{wxwindowgettooltip} + + +\membersection{wxRadioBox::GetItemFromPoint}\label{wxradioboxgetitemfrompoint} + +\constfunc{int}{GetItemFromPoint}{\param{const wxPoint&}{ pt}} + +Returns a radio box item under the point, a zero-based item index, or {\tt wxNOT\_FOUND} if no item is under the point. + +\docparam{pt}{Point in client coordinates.} + + \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.} @@ -167,29 +246,93 @@ Returns the label for the given button. \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}} } +\membersection{wxRadioBox::GetRowCount}\label{wxradioboxgetrowcount} + +\constfunc{unsigned int}{GetRowCount}{\void} + +Returns the number of rows in the radiobox. + + \membersection{wxRadioBox::GetSelection}\label{wxradioboxgetselection} \constfunc{int}{GetSelection}{\void} Returns the zero-based position of the selected button. + \membersection{wxRadioBox::GetStringSelection}\label{wxradioboxgetstringselection} \constfunc{wxString}{GetStringSelection}{\void} Returns the selected string. -\membersection{wxRadioBox::Number}\label{wxradioboxnumber} -\constfunc{int}{Number}{\void} +\membersection{wxRadioBox::GetString}\label{wxradioboxgetstring} + +\constfunc{wxString}{GetString}{\param{unsigned int}{ n}} + +Returns the label for the button at the given position. + +\wxheading{Parameters} + +\docparam{n}{The zero-based button position.} + + +\membersection{wxRadioBox::IsItemEnabled}\label{wxradioboxisitemenabled} + +\constfunc{bool}{IsItemEnabled}{\param{unsigned int}{ n}} + +Returns \true if the item is enabled or \false if it was disabled using +\helpref{Enable(n, false)}{wxradioboxenable}. + +{\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal +and always returns \true in the other ports. + +\wxheading{Parameters} + +\docparam{n}{The zero-based button position.} + + +\membersection{wxRadioBox::IsItemShown}\label{wxradioboxisitemshown} + +\constfunc{bool}{IsItemShown}{\param{unsigned int}{ n}} + +Returns \true if the item is currently shown or \false if it was hidden using +\helpref{Show(n, false)}{wxradioboxshow}. + +Note that this function returns \true for an item which hadn't been hidden even +if the entire radiobox is not currently shown. + +{\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal +and always returns \true in the other ports. + +\wxheading{Parameters} + +\docparam{n}{The zero-based button position.} + + +\membersection{wxRadioBox::SetItemHelpText}\label{wxradioboxsetitemhelptext} + +\func{void}{SetItemHelpText}{\param{unsigned int}{ item}, \param{const wxString\&}{ helptext}} + +Sets the helptext for an item. Empty string erases any existing helptext. + +\wxheading{Parameters} + +\docparam{item}{The zero-based item index.} + +\docparam{helptext}{The help text to set for the item.} + +\wxheading{See also} + +\helpref{GetItemHelpText}{wxradioboxgetitemhelptext} -Returns the number of buttons in the radiobox. \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel} @@ -197,9 +340,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} @@ -210,63 +350,86 @@ Sets a label for a radio button. \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::SetSelection}\label{wxradioboxsetselection} \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} \docparam{n}{The zero-based button position.} + \membersection{wxRadioBox::SetStringSelection}\label{wxradioboxsetstringselection} \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} \docparam{string}{The label of the button to select.} + +\membersection{wxRadioBox::SetItemToolTip}\label{wxradioboxsetitemtooltip} + +\func{void}{SetItemToolTip}{\param{unsigned int}{ item}, \param{const wxString\& }{text}} + +Sets the tooltip text for the specified item in the radio group. + +{\bf Platform note:} Currently only implemented in wxMSW and wxGTK2 and does +nothing in the other ports. + +\wxheading{Parameters} + +\docparam{item}{Index of the item the tooltip will be shown for.} + +\docparam{text}{Tooltip text for the item, the tooltip is removed if empty.} + +\wxheading{See also} + +\helpref{GetItemToolTip}{wxradioboxgetitemtooltip},\\ +\helpref{wxWindow::SetToolTip}{wxwindowsettooltip} + + \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{unsigned 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.} - -