fix wxFindWindowAtPoint for radiobox buttons, it didn't return the radiobox when...

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

diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex
index 97b58b93dae4e29a62ba5035e6e074371289e6a3..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}\\
@@ -55,6 +56,7 @@ when a radiobutton is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor}
 
 \func{}{wxRadioBox}{\void}
@@ -113,12 +115,14 @@ a list of strings.}
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 
+
 \membersection{wxRadioBox::\destruct{wxRadioBox}}\label{wxradioboxdtor}
 
 \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
@@ -138,13 +142,14 @@ Destructor, destroying the radiobox item.
 Creates the radiobox for two-step construction. See \helpref{wxRadioBox::wxRadioBox}{wxradioboxctor}\rtfsp
 for further details.
 
+
 \membersection{wxRadioBox::Enable}\label{wxradioboxenable}
 
 \func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}}
 
 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.
 
@@ -168,6 +173,7 @@ individual button in the radiobox.}
 \helpref{wxWindow::Enable}{wxwindowenable}
 
 
+
 \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
 
 \constfunc{int}{FindString}{\param{const wxString\& }{string}}
@@ -179,11 +185,25 @@ Finds a button matching the given string, returning the position if found, or
 
 \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::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}
 
-Returns the number of items in the radiobox.
 
 \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
 
@@ -208,21 +228,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::GetStringSelection}\label{wxradioboxgetstringselection}
 
 \constfunc{wxString}{GetStringSelection}{\void}
 
 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.
 
@@ -230,17 +259,39 @@ Returns the label for the button at the given position.
 
 \docparam{n}{The zero-based button position.}
 
-\membersection{wxRadioBox::Number}\label{wxradioboxnumber}
 
-\constfunc{int}{Number}{\void}
+\membersection{wxRadioBox::IsItemEnabled}\label{wxradioboxisitemenabled}
 
-{\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.
+\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.}
 
-Returns the number of buttons in the radiobox.
 
 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
 
@@ -263,6 +314,7 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+
 \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
 
 \func{void}{SetSelection}{\param{int}{ n}}
@@ -274,6 +326,7 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 
 \docparam{n}{The zero-based button position.}
 
+
 \membersection{wxRadioBox::SetStringSelection}\label{wxradioboxsetstringselection}
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{string}}
@@ -285,13 +338,35 @@ 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.