define wxNO_(THREADS|RTTI|EXCEPTIONS) if the corresponding feature is disabled

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

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index 3bcddf3f7c5ab39c93ff8ca2c2b6b111dd010bcc..5cd773a3313397a0fd49df5ac24e98ef7f461d9b 100644 (file)
--- a/docs/latex/wx/radiobox.tex
+++ b/docs/latex/wx/radiobox.tex
@@ -23,6 +23,8 @@ labelled buttons.
 maximum number of rows.}
 \twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the
 maximum number of columns.}
 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}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.


@@ -42,7 +44,7 @@ when a radiobutton is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxconstr}
+\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor}

 
 \func{}{wxRadioBox}{\void}
 
 
 \func{}{wxRadioBox}{\void}
 


@@ -55,6 +57,13 @@ Default constructor.
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
 \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}
 Constructor, creating and showing a radiobox.
 
 \wxheading{Parameters}


@@ -93,7 +102,7 @@ a list of strings.}
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 
 \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}
 
 
 \func{}{\destruct{wxRadioBox}}{\void}
 


@@ -108,22 +117,29 @@ Destructor, destroying the radiobox item.
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioBox"}}
 
 \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}
 
 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.
 
 
 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}
 
 
 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.}
 
 
 \docparam{n}{The zero-based button to enable or disable.}
 


@@ -148,16 +164,18 @@ Finds a button matching the given string, returning the position if found, or
 
 \docparam{string}{The string to find.}
 
 
 \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}
 
 Returns the radiobox label.
 
 \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.}
 \wxheading{Parameters}
 
 \docparam{n}{The zero-based button index.}


@@ -187,10 +205,26 @@ Returns the zero-based position of the selected button.
 
 Returns the selected string.
 
 
 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}
 
 \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}
 Returns the number of buttons in the radiobox.
 
 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}


@@ -199,9 +233,6 @@ Returns the number of buttons in the radiobox.
 
 Sets the radiobox label.
 
 
 Sets the radiobox label.
 

-\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
-
-Sets a label for a radio button.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -251,7 +282,7 @@ Shows or hides individual buttons.
 
 \wxheading{Parameters}
 
 
 \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.}
 
 
 \docparam{item}{The zero-based position of the button to show or hide.}
 


@@ -263,14 +294,3 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \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.}
-
-