docs/latex/wx/control.tex

   1 \section{\class{wxControl}}\label{wxcontrol}
   2
   3 This is the base class for a control or ``widget''.
   4
   5 A control is generally a small window which processes user input and/or
   6 displays 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{Library}
  19
  20 \helpref{wxCore}{librarieslist}
  21
  22 \wxheading{See also}
  23
  24 \helpref{wxValidator}{wxvalidator}
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28
  29 \membersection{wxControl::Command}\label{wxcontrolcommand}
  30
  31 \func{void}{Command}{\param{wxCommandEvent\& }{event}}
  32
  33 Simulates the effect of the user issuing a command to the item. See \helpref{wxCommandEvent}{wxcommandevent}.
  34
  35
  36 \membersection{wxControl::GetLabel}\label{wxcontrolgetlabel}
  37
  38 \constfunc{wxString}{GetLabel}{\void}
  39
  40 Returns the control's text.
  41
  42 Note that the returned string contains the mnemonics (\texttt{\&} characters) if
  43 any, use \helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} if they are
  44 undesired.
  45
  46
  47 \membersection{wxControl::GetLabelText}\label{wxcontrolgetlabeltext}
  48
  49 \constfunc{const wxString\&}{GetLabelText}{\void}
  50
  51 \func{static wxString}{GetLabelText}{\param{const wxString\& }{label}}
  52
  53 Returns the control's label, or the given \arg{label} string for the static
  54 version, without the mnemonics characters.
  55
  56
  57 \membersection{wxControl::SetLabel}\label{wxcontrolsetlabel}
  58
  59 \func{void}{SetLabel}{\param{const wxString\& }{label}}
  60
  61 Sets the item's text.
  62
  63 The \texttt{\&} characters in the \arg{label} are special and indicate that the
  64 following character is a mnemonic for this control and can be used to activate
  65 it from the keyboard (typically by using \textit{Alt} key in combination with
  66 it). To insert a literal ampersand character, you need to double it, i.e. use
  67 \texttt{"\&\&"}.
  68
  69