sorting support for generic version (patch 1765087 from Bo)

[wxWidgets.git] / docs / latex / wx / control.tex

diff --git a/docs/latex/wx/control.tex b/docs/latex/wx/control.tex
index 75c4e5f975a89c46d702a879641381f429b89a4b..4b01800192d4c3d4b51670571a8bb7b764af62cb 100644 (file)
--- a/docs/latex/wx/control.tex
+++ b/docs/latex/wx/control.tex
@@ -15,6 +15,10 @@ displays one or more item of data.
 
 <wx/control.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxValidator}{wxvalidator}
@@ -31,10 +35,24 @@ Simulates the effect of the user issuing a command to the item. See \helpref{wxC
 
 \membersection{wxControl::GetLabel}\label{wxcontrolgetlabel}
 
-\func{wxString\&}{GetLabel}{\void}
+\constfunc{const wxString\&}{GetLabel}{\void}
 
 Returns the control's text.
 
+Note that the returned string contains the mnemonics (\texttt{\&} characters) if
+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.
+
 
 \membersection{wxControl::SetLabel}\label{wxcontrolsetlabel}
 
@@ -42,3 +60,10 @@ Returns the control's text.
 
 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{"\&\&"}.
+
+