wxRichTextAttr does not exist anymore - document instead wxTextAttr

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

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index dd7536ae5269177f28f5d7501c47d641f324ea7d..9472c47cf616f794a1c454c6eac233ccec9c2734 100644 (file)
--- 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
 \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}
 
 
 \wxheading{Derived from}
 

+\helpref{wxControlWithItems}{wxcontrolwithitems}\\

 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\


@@ -15,6 +27,10 @@ labelled buttons.
 
 <wx/radiobox.h>
 
 
 <wx/radiobox.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}


@@ -23,6 +39,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 +60,8 @@ 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}
 


@@ -100,12 +119,14 @@ 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}
 
 Destructor, destroying the radiobox item.
 
 
 \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
 \membersection{wxRadioBox::Create}\label{wxradioboxcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp


@@ -122,16 +143,17 @@ 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
+Creates the radiobox for two-step construction. See \helpref{wxRadioBox::wxRadioBox}{wxradioboxctor}\rtfsp

 for further details.
 
 for further details.
 

+

 \membersection{wxRadioBox::Enable}\label{wxradioboxenable}
 
 \membersection{wxRadioBox::Enable}\label{wxradioboxenable}
 

-\func{void}{Enable}{\param{bool}{ enable = {\tt true}}}
+\func{virtual bool}{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{bool}{ enable = {\tt true}}}
+\func{virtual bool}{Enable}{\param{unsigned int}{ n}, \param{bool}{ enable = {\tt true}}}

 
 Enables or disables an individual button in the radiobox.
 
 
 Enables or disables an individual button in the radiobox.
 


@@ -150,6 +172,11 @@ individual button in the radiobox.}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\wxheading{See also}
+
+\helpref{wxWindow::Enable}{wxwindowenable}
+
+

 
 \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
 
 
 \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
 


@@ -162,11 +189,49 @@ 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}
+\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.}

 
 

-Returns the number of items in the radiobox.

 
 \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
 
 
 \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
 


@@ -174,10 +239,6 @@ Returns the number of items in the radiobox.
 
 Returns the radiobox label.
 
 
 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.}


@@ -195,21 +256,30 @@ implements the following methods:\par
 }
 
 
 }
 
 

+\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::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::GetStringSelection}\label{wxradioboxgetstringselection}
 
 \constfunc{wxString}{GetStringSelection}{\void}
 
 Returns the selected string.
 

+

 \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
 
 \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
 

-\constfunc{wxString}{GetString}{\param{int}{ n}}
+\constfunc{wxString}{GetString}{\param{unsigned int}{ n}}

 
 Returns the label for the button at the given position.
 
 
 Returns the label for the button at the given position.
 


@@ -217,17 +287,56 @@ Returns the label for the button at the given position.
 
 \docparam{n}{The zero-based button position.}
 
 
 \docparam{n}{The zero-based button position.}
 

-\membersection{wxRadioBox::Number}\label{wxradioboxnumber}

 
 

-\constfunc{int}{Number}{\void}
+\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}

 
 

-{\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.
+\helpref{GetItemHelpText}{wxradioboxgetitemhelptext}

 
 

-Returns the number of buttons in the radiobox.

 
 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
 
 
 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
 


@@ -235,9 +344,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}
 


@@ -253,6 +359,7 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+

 \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
 
 \func{void}{SetSelection}{\param{int}{ n}}
 \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
 
 \func{void}{SetSelection}{\param{int}{ n}}


@@ -264,6 +371,7 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 
 \docparam{n}{The zero-based button position.}
 
 
 \docparam{n}{The zero-based button position.}
 

+

 \membersection{wxRadioBox::SetStringSelection}\label{wxradioboxsetstringselection}
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{string}}
 \membersection{wxRadioBox::SetStringSelection}\label{wxradioboxsetstringselection}
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{string}}


@@ -275,13 +383,35 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 
 \docparam{string}{The label of the button to select.}
 
 
 \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}
 
 \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.
 
 
 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.
 
 
 Shows or hides individual buttons.
 


@@ -291,6 +421,15 @@ Shows or hides individual buttons.
 
 \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.}
 

+\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}
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}


@@ -298,4 +437,3 @@ implements the following methods:\par
 \twocolitem{{\bf ShowItem(n, flag)}}{Shows or hides individual buttons.}
 \end{twocollist}}
 }
 \twocolitem{{\bf ShowItem(n, flag)}}{Shows or hides individual buttons.}
 \end{twocollist}}
 }

-