interface/control.h

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