wxWidgets/interface/wx/control.h
Francesco Montorsi 4707b84cd0 ifacecheck fixes to c*.h headers
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55842 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-09-24 23:29:43 +00:00

62 lines
1.6 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: control.h
// Purpose: interface of wxControl
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxControl
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}
@see wxValidator
*/
class wxControl : public wxWindow
{
public:
/**
Simulates the effect of the user issuing a command to the item.
@see wxCommandEvent
*/
virtual void Command(wxCommandEvent& event);
/**
Returns the control's text.
@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 without mnemonics.
*/
wxString GetLabelText() const;
/**
Returns the given @a label string without mnemonics.
*/
static wxString GetLabelText(const wxString& label);
/**
Sets the item's text.
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);
};