X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c0e6c0513862fc9a33e5800526058193b7492d8b..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/control.tex diff --git a/docs/latex/wx/control.tex b/docs/latex/wx/control.tex index 75c4e5f975..eade0d1ddd 100644 --- a/docs/latex/wx/control.tex +++ b/docs/latex/wx/control.tex @@ -31,10 +31,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 +56,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{"\&\&"}. + +