X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/aa61d3525370a9b9fa8c797d9b7f89d96994db5f..134198f1b773199b5506c302bf9510831d0319f5:/docs/latex/wx/radiobox.tex diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 6dd954b8a3..9472c47cf6 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -27,6 +27,10 @@ labelled buttons. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -193,6 +197,42 @@ Finds a button matching the given string, returning the position if found, or 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.} + + \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel} \constfunc{wxString}{GetLabel}{\void} @@ -281,6 +321,23 @@ and always returns \true in the other ports. \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} + +\helpref{GetItemHelpText}{wxradioboxgetitemhelptext} + + \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel} \func{void}{SetLabel}{\param{const wxString\&}{ label}} @@ -327,6 +384,27 @@ 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}}}