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
  21     @see wxValidator
  22 */
  23 class wxControl : public wxWindow
  24 {
  25 public:
  26     /**
  27         Simulates the effect of the user issuing a command to the item.
  28
  29         @see wxCommandEvent
  30     */
  31     void Command(wxCommandEvent& event);
  32
  33     /**
  34         Returns the control's text.
  35
  36         @note The returned string contains mnemonics ("&" characters) if it has
  37               any, use GetLabelText() if they are undesired.
  38     */
  39     wxString GetLabel() const;
  40
  41     /**
  42         Returns the control's label without mnemonics.
  43     */
  44     const wxString GetLabelText();
  45
  46     /**
  47         Returns the given @a label string without mnemonics.
  48     */
  49     static wxString GetLabelText(const wxString& label);
  50
  51     /**
  52         Sets the item's text.
  53
  54         Any "&" characters in the @a label are special and indicate that the
  55         following character is a mnemonic for this control and can be used to
  56         activate it from the keyboard (typically by using @e Alt key in
  57         combination with it). To insert a literal ampersand character, you need
  58         to double it, i.e. use "&&".
  59     */
  60     void SetLabel(const wxString& label);
  61 };
  62