1998-05-20 10:25:30 -04:00
|
|
|
\section{\class{wxControl}}\label{wxcontrol}
|
|
|
|
|
2004-03-31 19:05:13 -05:00
|
|
|
This is the base class for a control or ``widget''.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-03-31 19:05:13 -05:00
|
|
|
A control is generally a small window which processes user input and/or
|
|
|
|
displays one or more item of data.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\wxheading{Derived from}
|
|
|
|
|
|
|
|
\helpref{wxWindow}{wxwindow}\\
|
|
|
|
\helpref{wxEvtHandler}{wxevthandler}\\
|
|
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
|
1999-02-15 15:41:29 -05:00
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/control.h>
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxValidator}{wxvalidator}
|
|
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2004-03-31 19:05:13 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxControl::Command}\label{wxcontrolcommand}
|
|
|
|
|
|
|
|
\func{void}{Command}{\param{wxCommandEvent\& }{event}}
|
|
|
|
|
|
|
|
Simulates the effect of the user issuing a command to the item. See \helpref{wxCommandEvent}{wxcommandevent}.
|
|
|
|
|
2004-03-31 19:05:13 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxControl::GetLabel}\label{wxcontrolgetlabel}
|
|
|
|
|
2006-07-25 14:40:04 -04:00
|
|
|
\constfunc{const wxString\&}{GetLabel}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Returns the control's text.
|
|
|
|
|
2005-12-18 11:39:18 -05:00
|
|
|
Note that the returned string contains the mnemonics (\texttt{\&} characters) if
|
2006-07-25 14:40:04 -04:00
|
|
|
any, use \helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} if they are
|
|
|
|
undesired.
|
|
|
|
|
|
|
|
|
|
|
|
\membersection{wxControl::GetLabelText}\label{wxcontrolgetlabeltext}
|
|
|
|
|
|
|
|
\constfunc{const wxString\&}{GetLabelText}{\void}
|
|
|
|
|
|
|
|
\func{static const wxString\&}{GetLabelText}{\param{const wxString\& }{label}}
|
|
|
|
|
|
|
|
Returns the control's label or the given \arg{label} string for the static
|
|
|
|
version without the mnemonics characters.
|
2005-12-18 11:39:18 -05:00
|
|
|
|
2004-03-31 19:05:13 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxControl::SetLabel}\label{wxcontrolsetlabel}
|
|
|
|
|
|
|
|
\func{void}{SetLabel}{\param{const wxString\& }{label}}
|
|
|
|
|
|
|
|
Sets the item's text.
|
|
|
|
|
2005-12-18 11:39:18 -05:00
|
|
|
The \texttt{\&} characters in the \arg{label} are special and indicate that the
|
|
|
|
following character is a mnemonic for this control and can be used to activate
|
|
|
|
it from the keyboard (typically by using \textit{Alt} key in combination with
|
|
|
|
it). To insert a literal ampersand character, you need to double it, i.e. use
|
|
|
|
\texttt{"\&\&"}.
|
|
|
|
|
|
|
|
|