X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..d83eeece0ee86a3ad81096d894a560647cef0d3a:/docs/latex/wx/radiobox.tex diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index ec378a7039..7aaf5c0bd7 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -86,6 +86,13 @@ 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.} + +\perlnote{In wxPerl there is just an array reference in place of {\tt n} +and {\tt choices}.} + \membersection{wxRadioBox::\destruct{wxRadioBox}} \func{}{\destruct{wxRadioBox}}{\void} @@ -106,20 +113,30 @@ 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 +individual button in the radiobox.} +\end{twocollist}} +} + + \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring} \constfunc{int}{FindString}{\param{const wxString\& }{string}} @@ -131,6 +148,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} @@ -149,6 +172,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} @@ -165,6 +197,12 @@ Returns the selected string. \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 wxWindows 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} @@ -183,11 +221,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{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} @@ -197,7 +244,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} @@ -215,10 +263,18 @@ 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.} +\end{twocollist}} +} + \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring} \constfunc{wxString}{GetString}{\param{int}{ n}}