interface/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        control.h
   3 // Purpose:     interface of wxControl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxControl
  11     @wxheader{control.h}
  12
  13     This is the base class for a control or "widget".
  14
  15     A control is generally a small window which processes user input and/or
  16     displays one or more item of data.
  17
  18     @library{wxcore}
  19     @category{ctrl}
  20     @appearance{control.png}
  21
  22     @see wxValidator
  23 */
  24 class wxControl : public wxWindow
  25 {
  26 public:
  27     /**
  28         Simulates the effect of the user issuing a command to the item. See
  29         wxCommandEvent.
  30     */
  31     void Command(wxCommandEvent& event);
  32
  33     /**
  34         Returns the control's text.
  35         Note that the returned string contains the mnemonics (@c  characters) if
  36         any, use GetLabelText() if they are
  37         undesired.
  38     */
  39     wxString GetLabel() const;
  40
  41     //@{
  42     /**
  43         Returns the control's label, or the given @a label string for the static
  44         version, without the mnemonics characters.
  45     */
  46     const wxString GetLabelText();
  47     const static wxString  GetLabelText(const wxString& label);
  48     //@}
  49
  50     /**
  51         Sets the item's text.
  52         The @c  characters in the @a label are special and indicate that the
  53         following character is a mnemonic for this control and can be used to activate
  54         it from the keyboard (typically by using @e Alt key in combination with
  55         it). To insert a literal ampersand character, you need to double it, i.e. use
  56         @c "".
  57     */
  58     void SetLabel(const wxString& label);
  59 };
  60