better Wait/Delete() docs (patch 1434085)

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

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index 8e8e80ced85b2894278dbaed63703d65977c484c..31db278c1d20d366edaab2ebcdbefbbe707a26cd 100644 (file)
--- a/docs/latex/wx/radiobox.tex
+++ b/docs/latex/wx/radiobox.tex
@@ -3,7 +3,7 @@
 %% Purpose:     wxRadioBox documentation
 %% Author:      wxWidgets Team
 %% Modified by:
-%% Created:     
+%% Created:
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets Team
 %% License:     wxWindows license
@@ -17,6 +17,7 @@ labelled buttons.
 
 \wxheading{Derived from}
 
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
@@ -148,7 +149,7 @@ for further details.
 
 Enables or disables the entire radiobox.
 
-\func{virtual bool}{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.
 
@@ -187,16 +188,21 @@ Finds a button matching the given string, returning the position if found, or
 
 \membersection{wxRadioBox::GetColumnCount}\label{wxradioboxgetcolumncount}
 
-\constfunc{int}{GetColumnCount}{\void}
+\constfunc{unsigned int}{GetColumnCount}{\void}
 
 Returns the number of columns in the radiobox.
 
 
-\membersection{wxRadioBox::GetCount}\label{wxradioboxgetcount}
+\membersection{wxRadioBox::GetItemToolTip}\label{wxradioboxgetitemtooltip}
 
-\constfunc{int}{GetCount}{\void}
+\constfunc{wxToolTip *}{GetItemToolTip}{\param{unsigned int}{ item}}
 
-Returns the number of items in the radiobox.
+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::GetLabel}\label{wxradioboxgetlabel}
@@ -224,7 +230,7 @@ implements the following methods:\par
 
 \membersection{wxRadioBox::GetRowCount}\label{wxradioboxgetrowcount}
 
-\constfunc{int}{GetRowCount}{\void}
+\constfunc{unsigned int}{GetRowCount}{\void}
 
 Returns the number of rows in the radiobox.
 
@@ -245,7 +251,7 @@ Returns the selected string.
 
 \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.
 
@@ -256,40 +262,35 @@ Returns the label for the button at the given position.
 
 \membersection{wxRadioBox::IsItemEnabled}\label{wxradioboxisitemenabled}
 
-\constfunc{bool}{IsItemEnabled}{\void}
+\constfunc{bool}{IsItemEnabled}{\param{unsigned int}{ n}}
 
-Returns \true if the item is enabled or \false if it was disabled using 
+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 and always returns
-\true in the other ports.
+{\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}{\void}
+\constfunc{bool}{IsItemShown}{\param{unsigned int}{ n}}
 
-Returns \true if the item is currently shown or \false if it was hidden using 
+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 and always returns
-\true in the other ports.
-
-
-\membersection{wxRadioBox::Number}\label{wxradioboxnumber}
+{\bf Platform note:} Currently only implemented in wxMSW, wxGTK and wxUniversal
+and always returns \true in the other ports.
 
-\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.
+\wxheading{Parameters}
 
-Returns the number of buttons in the radiobox.
+\docparam{n}{The zero-based button position.}
 
 
 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
@@ -338,13 +339,34 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 \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}
 
 \func{virtual bool}{Show}{\param{const bool}{ show = {\tt true}}}
 
 Shows or hides the entire radiobox.
 
-\func{virtual bool}{Show}{\param{int}{ item}, \param{const bool}{ show = {\tt true}}}
+\func{virtual bool}{Show}{\param{unsigned int}{ item}, \param{const bool}{ show = {\tt true}}}
 
 Shows or hides individual buttons.