X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/953704c1c76cfb9cfb7b91f0e81f98c30d27eb56..f1e7793361bb0106611e5d1373b4e1e6ed30f14f:/docs/latex/wx/radiobox.tex?ds=sidebyside diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 9b1d9be5a2..dd7536ae52 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -55,6 +55,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,10 +93,12 @@ 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}} @@ -106,30 +115,37 @@ Destructor, destroying the radiobox item. \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxString\& }{name = ``radioBox"}} +\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}{wxradioboxconstr}\rtfsp for further details. \membersection{wxRadioBox::Enable}\label{wxradioboxenable} -\func{void}{Enable}{\param{const bool}{ enable}} +\func{void}{Enable}{\param{bool}{ enable = {\tt true}}} Enables or disables the entire radiobox. -\func{void}{Enable}{\param{int}{ n}, \param{const bool}{ enable}} +\func{void}{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}} } @@ -146,6 +162,12 @@ Finds a button matching the given string, returning the position if found, or \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} @@ -167,8 +189,8 @@ 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}} } @@ -185,10 +207,26 @@ 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 +\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} @@ -210,8 +248,8 @@ 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}} } @@ -249,26 +287,15 @@ 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.} \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.} - -