added wxRadioBox::IsItemEnabled/Shown() (for MSW only for now, other platforms to come); corrected Enable/Show() return values

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36288 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2005-11-29 19:26:38 +00:00
parent 2f1834d9f2
commit 3bfa7be977
6 changed files with 127 additions and 16 deletions

View File

@@ -37,6 +37,7 @@ All (GUI):
- Access to titles through Get/SetTitle is available now only for top level
windows (wxDialog, wxFrame).
- Fixed memory leak of pending events in wxEvtHandler
- Added wxRadioBox::IsItemEnabled/Shown()
wxMSW:

View File

@@ -55,6 +55,7 @@ when a radiobutton is clicked.}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor}
\func{}{wxRadioBox}{\void}
@@ -113,12 +114,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,6 +141,7 @@ 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}}}
@@ -168,6 +172,7 @@ individual button in the radiobox.}
\helpref{wxWindow::Enable}{wxwindowenable}
\membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
\constfunc{int}{FindString}{\param{const wxString\& }{string}}
@@ -179,12 +184,14 @@ 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}
Returns the number of items in the radiobox.
\membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
\constfunc{wxString}{GetLabel}{\void}
@@ -214,12 +221,14 @@ implements the following methods:\par
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}}
@@ -230,6 +239,32 @@ Returns the label for the button at the given position.
\docparam{n}{The zero-based button position.}
\membersection{wxRadioBox::IsItemEnabled}\label{wxradioboxisitemenabled}
\constfunc{bool}{IsItemEnabled}{\void}
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.
\membersection{wxRadioBox::IsItemShown}\label{wxradioboxisitemshown}
\constfunc{bool}{IsItemShown}{\void}
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}
\constfunc{int}{Number}{\void}
@@ -242,6 +277,7 @@ future versions.
Returns the number of buttons in the radiobox.
\membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
\func{void}{SetLabel}{\param{const wxString\&}{ label}}
@@ -263,6 +299,7 @@ implements the following methods:\par
\end{twocollist}}
}
\membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
\func{void}{SetSelection}{\param{int}{ n}}
@@ -274,6 +311,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,6 +323,7 @@ a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
\docparam{string}{The label of the button to select.}
\membersection{wxRadioBox::Show}\label{wxradioboxshow}
\func{virtual bool}{Show}{\param{const bool}{ show = {\tt true}}}