%% Purpose: wxRadioBox documentation
%% Author: wxWidgets Team
%% Modified by:
-%% Created:
+%% Created:
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets Team
%% License: wxWindows license
\wxheading{Derived from}
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\
\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
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.
\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::GetItemHelpText}\label{wxradioboxgetitemhelptext}
-\constfunc{int}{GetCount}{\void}
+\constfunc{wxString}{GetItemHelpText}{\param{unsigned int}{ item}}
-Returns the number of items in the radiobox.
+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.}
\membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
\membersection{wxRadioBox::GetRowCount}\label{wxradioboxgetrowcount}
-\constfunc{int}{GetRowCount}{\void}
+\constfunc{unsigned int}{GetRowCount}{\void}
Returns the number of rows in the radiobox.
\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.
\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.
+{\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::Number}\label{wxradioboxnumber}
-\constfunc{int}{Number}{\void}
+\membersection{wxRadioBox::SetItemHelpText}\label{wxradioboxsetitemhelptext}
-{\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.
+\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}
-Returns the number of buttons in the radiobox.
+\docparam{item}{The zero-based item index.}
+
+\docparam{helptext}{The help text to set for the item.}
+
+\wxheading{See also}
+
+\helpref{GetItemHelpText}{wxradioboxgetitemhelptext}
\membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
\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.
projects / wxWidgets.git / blobdiff