X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..78f541fa5b328e5be73b1afaa7cb25849d6211a6:/interface/control.h diff --git a/interface/control.h b/interface/control.h index 862d4795fc..2a9f824059 100644 --- a/interface/control.h +++ b/interface/control.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: control.h -// Purpose: documentation for wxControl class +// Purpose: interface of wxControl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -10,51 +10,53 @@ @class wxControl @wxheader{control.h} - 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. @library{wxcore} @category{ctrl} - @appearance{control.png} - @seealso - wxValidator + @see wxValidator */ class wxControl : public wxWindow { public: /** - Simulates the effect of the user issuing a command to the item. See - wxCommandEvent. + Simulates the effect of the user issuing a command to the item. + + @see wxCommandEvent */ void Command(wxCommandEvent& event); /** Returns the control's text. - Note that the returned string contains the mnemonics (@c characters) if - any, use GetLabelText() if they are - undesired. + + @note The returned string contains mnemonics ("&" characters) if it has + any, use GetLabelText() if they are undesired. */ wxString GetLabel() const; - //@{ /** - Returns the control's label, or the given @a label string for the static - version, without the mnemonics characters. + Returns the control's label without mnemonics. */ const wxString GetLabelText(); - const static wxString GetLabelText(const wxString& label); - //@} + + /** + Returns the given @a label string without mnemonics. + */ + static wxString GetLabelText(const wxString& label); /** Sets the item's text. - The @c characters in the @a 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 @e Alt key in combination with - it). To insert a literal ampersand character, you need to double it, i.e. use - @c "". + + Any "&" characters in the @a 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 @e Alt key in + combination with it). To insert a literal ampersand character, you need + to double it, i.e. use "&&". */ void SetLabel(const wxString& label); }; +