added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

[wxWidgets.git] / docs / latex / wx / radiobox.tex

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index c6796673541972c258229d9a638905ab3fecab83..7aaf5c0bd7363b34771a3827c454b52e0a2debaf 100644 (file)
--- a/docs/latex/wx/radiobox.tex
+++ b/docs/latex/wx/radiobox.tex
@@ -11,12 +11,18 @@ labelled buttons.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/radiobox.h>
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxRA\_HORIZONTAL}}{Lays the radiobox out in rows.}
-\twocolitem{\windowstyle{wxRA\_VERTICAL}}{Lays the radiobox out in columns.}
+\twocolitem{\windowstyle{wxRA\_SPECIFY\_ROWS}}{The major dimension parameter refers to the
+maximum number of rows.}
+\twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the
+maximum number of columns.}
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
@@ -45,7 +51,7 @@ Default constructor.
 \func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
-\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_HORIZONTAL},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
@@ -67,7 +73,7 @@ Constructor, creating and showing a radiobox.
 
 \docparam{choices}{An array of choices with which to initialize the radiobox.}
 
-\docparam{majorDimension}{Specifies the number of rows (if style is wxRA\_VERTICAL) or columns (if style is wxRA\_HORIZONTAL) for a two-dimensional
+\docparam{majorDimension}{Specifies the maximum number of rows (if style contains wxRA\_SPECIFY\_ROWS) or columns (if style contains wxRA\_SPECIFY\_COLS) for a two-dimensional
 radiobox.}
 
 \docparam{style}{Window style. See \helpref{wxRadioBox}{wxradiobox}.}
@@ -80,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}
@@ -91,7 +104,7 @@ Destructor, destroying the radiobox item.
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
-\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_HORIZONTAL},\rtfsp
+\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
@@ -100,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}}
@@ -125,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}
@@ -143,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}
@@ -159,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}
@@ -177,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}
 
@@ -191,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}
 
@@ -209,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}}