]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/control.tex
fixed typo in HitTest() docs
[wxWidgets.git] / docs / latex / wx / control.tex
... / ...
CommitLineData
1\section{\class{wxControl}}\label{wxcontrol}
2
3This is the base class for a control or ``widget''.
4
5A control is generally a small window which processes user input and/or
6displays one or more item of data.
7
8\wxheading{Derived from}
9
10\helpref{wxWindow}{wxwindow}\\
11\helpref{wxEvtHandler}{wxevthandler}\\
12\helpref{wxObject}{wxobject}
13
14\wxheading{Include files}
15
16<wx/control.h>
17
18\wxheading{See also}
19
20\helpref{wxValidator}{wxvalidator}
21
22\latexignore{\rtfignore{\wxheading{Members}}}
23
24
25\membersection{wxControl::Command}\label{wxcontrolcommand}
26
27\func{void}{Command}{\param{wxCommandEvent\& }{event}}
28
29Simulates the effect of the user issuing a command to the item. See \helpref{wxCommandEvent}{wxcommandevent}.
30
31
32\membersection{wxControl::GetLabel}\label{wxcontrolgetlabel}
33
34\func{wxString\&}{GetLabel}{\void}
35
36Returns the control's text.
37
38Note that the returned string contains the mnemonics (\texttt{\&} characters) if
39any.
40
41
42\membersection{wxControl::SetLabel}\label{wxcontrolsetlabel}
43
44\func{void}{SetLabel}{\param{const wxString\& }{label}}
45
46Sets the item's text.
47
48The \texttt{\&} characters in the \arg{label} are special and indicate that the
49following character is a mnemonic for this control and can be used to activate
50it from the keyboard (typically by using \textit{Alt} key in combination with
51it). To insert a literal ampersand character, you need to double it, i.e. use
52\texttt{"\&\&"}.
53
54