X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fe161a2685012cf90bb5bfe95f2260aee71d8ad7..a43ec16b16cf61894294f071011ec984d8a3d673:/docs/latex/wx/control.tex diff --git a/docs/latex/wx/control.tex b/docs/latex/wx/control.tex index 52ecc060f2..eade0d1ddd 100644 --- a/docs/latex/wx/control.tex +++ b/docs/latex/wx/control.tex @@ -29,28 +29,26 @@ displays one or more item of data. Simulates the effect of the user issuing a command to the item. See \helpref{wxCommandEvent}{wxcommandevent}. -\membersection{wxControl::GetAdjustMinSizeFlag}\label{wxcontrolgetadjustminsizeflag} +\membersection{wxControl::GetLabel}\label{wxcontrolgetlabel} -\func{bool}{GetAdjustMinSizeFlag}{} +\constfunc{const wxString\&}{GetLabel}{\void} -Returns whether the minsize should be adjusted for this control when -SetLabel or SetFont are called. +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::GetLabel}\label{wxcontrolgetlabel} -\func{wxString\&}{GetLabel}{\void} +\membersection{wxControl::GetLabelText}\label{wxcontrolgetlabeltext} -Returns the control's text. +\constfunc{const wxString\&}{GetLabelText}{\void} +\func{static const wxString\&}{GetLabelText}{\param{const wxString\& }{label}} -\membersection{wxControl::SetAdjustMinSizeFlag}\label{wxcontrolsetadjustminsizeflag} +Returns the control's label or the given \arg{label} string for the static +version without the mnemonics characters. -\func{void}{SetAdjustMinSizeFlag}{\param{bool }{adjust}} - -By default controls will readjust their size and minsize when -SetLabel or SetFont are called. This flag will allow you to -control this behavior. \membersection{wxControl::SetLabel}\label{wxcontrolsetlabel} @@ -58,3 +56,10 @@ control this behavior. 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{"\&\&"}. + +