]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/control.tex
Line-up interfaces to use size_t for GetCount()s (and count related api).
[wxWidgets.git] / docs / latex / wx / control.tex
index 8419d9b81ad1c165fb477f54373096762b244e90..317ab1f7e65593d41591a97c484a5781a43fadbd 100644 (file)
@@ -1,9 +1,9 @@
 \section{\class{wxControl}}\label{wxcontrol}
 
-This is the base class for a control or `widget'.
+This is the base class for a control or ``widget''.
 
-A control is generally a small window which processes user input and/or displays one or more item
-of data.
+A control is generally a small window which processes user input and/or
+displays one or more item of data.
 
 \wxheading{Derived from}
 
@@ -11,27 +11,44 @@ of data.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/control.h>
+
 \wxheading{See also}
 
 \helpref{wxValidator}{wxvalidator}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \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}.
 
+
 \membersection{wxControl::GetLabel}\label{wxcontrolgetlabel}
 
 \func{wxString\&}{GetLabel}{\void}
 
 Returns the control's text.
 
+Note that the returned string contains the mnemonics (\texttt{\&} characters) if
+any.
+
+
 \membersection{wxControl::SetLabel}\label{wxcontrolsetlabel}
 
 \func{void}{SetLabel}{\param{const wxString\& }{label}}
 
 Sets the item's text.
 
+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{"\&\&"}.
+
+