/////////////////////////////////////////////////////////////////////////////
// Name: control.h
-// Purpose: documentation for wxControl class
+// Purpose: interface of wxControl
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@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.
@category{ctrl}
@appearance{control.png}
- @seealso
- wxValidator
+ @see wxValidator
*/
class wxControl : public wxWindow
{
/**
Returns the control's text.
-
Note that the returned string contains the mnemonics (@c characters) if
any, use GetLabelText() if they are
undesired.
*/
- wxString GetLabel();
+ wxString GetLabel() const;
//@{
/**
- Returns the control's label, or the given @e label string for the static
+ Returns the control's label, or the given @a label string for the static
version, without the mnemonics characters.
*/
const wxString GetLabelText();
- static wxString GetLabelText(const wxString& label);
+ const static wxString GetLabelText(const wxString& label);
//@}
/**
Sets the item's text.
-
- The @c characters in the @e label are special and indicate that the
+ 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
*/
void SetLabel(const wxString& label);
};
+