include/wx/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/control.h
   3 // Purpose:     wxControl common interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     26.07.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CONTROL_H_BASE_
  13 #define _WX_CONTROL_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_CONTROLS
  22
  23 #include "wx/window.h"      // base class
  24
  25 extern WXDLLEXPORT_DATA(const wxChar) wxControlNameStr[];
  26
  27 // ----------------------------------------------------------------------------
  28 // wxControl is the base class for all controls
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxControlBase : public wxWindow
  32 {
  33 public:
  34     wxControlBase() { }
  35
  36     virtual ~wxControlBase();
  37
  38     // Create() function adds the validator parameter
  39     bool Create(wxWindow *parent, wxWindowID id,
  40                 const wxPoint& pos = wxDefaultPosition,
  41                 const wxSize& size = wxDefaultSize,
  42                 long style = 0,
  43                 const wxValidator& validator = wxDefaultValidator,
  44                 const wxString& name = wxControlNameStr);
  45
  46     // get the control alignment (left/right/centre, top/bottom/centre)
  47     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
  48
  49     // get just the text of the label, without mnemonic characters ('&')
  50     wxString GetLabelText() const { return GetLabelText(GetLabel()); }
  51
  52     virtual void SetLabel(const wxString& label)
  53     {
  54         m_labelOrig = label;
  55
  56         InvalidateBestSize();
  57
  58         wxWindow::SetLabel(label);
  59     }
  60
  61     virtual wxString GetLabel() const
  62     {
  63         // return the original string, as it was passed to SetLabel()
  64         // (i.e. with wx-style mnemonics)
  65         return m_labelOrig;
  66     }
  67
  68     // static utilities:
  69
  70     // get the string without mnemonic characters ('&')
  71     static wxString GetLabelText(const wxString& label);
  72
  73     // removes the mnemonics characters
  74     static wxString RemoveMnemonics(const wxString& str);
  75
  76     // escapes the mnemonics characters ('&') by doubling them
  77     static wxString EscapeMnemonics(const wxString& str);
  78
  79
  80     // controls by default inherit the colours of their parents, if a
  81     // particular control class doesn't want to do it, it can override
  82     // ShouldInheritColours() to return false
  83     virtual bool ShouldInheritColours() const { return true; }
  84
  85
  86     // WARNING: this doesn't work for all controls nor all platforms!
  87     //
  88     // simulates the event of given type (i.e. wxButton::Command() is just as
  89     // if the button was clicked)
  90     virtual void Command(wxCommandEvent &event);
  91
  92     virtual bool SetFont(const wxFont& font);
  93
  94     // wxControl-specific processing after processing the update event
  95     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
  96
  97 protected:
  98     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
  99     // to the list of parents children
 100     bool CreateControl(wxWindowBase *parent,
 101                        wxWindowID id,
 102                        const wxPoint& pos,
 103                        const wxSize& size,
 104                        long style,
 105                        const wxValidator& validator,
 106                        const wxString& name);
 107
 108     // initialize the common fields of wxCommandEvent
 109     void InitCommandEvent(wxCommandEvent& event) const;
 110
 111     // this field contains the label in wx format, i.e. with '&' mnemonics
 112     wxString m_labelOrig;
 113
 114     DECLARE_NO_COPY_CLASS(wxControlBase)
 115 };
 116
 117 // ----------------------------------------------------------------------------
 118 // include platform-dependent wxControl declarations
 119 // ----------------------------------------------------------------------------
 120
 121 #if defined(__WXUNIVERSAL__)
 122     #include "wx/univ/control.h"
 123 #elif defined(__WXPALMOS__)
 124     #include "wx/palmos/control.h"
 125 #elif defined(__WXMSW__)
 126     #include "wx/msw/control.h"
 127 #elif defined(__WXMOTIF__)
 128     #include "wx/motif/control.h"
 129 #elif defined(__WXGTK20__)
 130     #include "wx/gtk/control.h"
 131 #elif defined(__WXGTK__)
 132     #include "wx/gtk1/control.h"
 133 #elif defined(__WXMAC__)
 134     #include "wx/mac/control.h"
 135 #elif defined(__WXCOCOA__)
 136     #include "wx/cocoa/control.h"
 137 #elif defined(__WXPM__)
 138     #include "wx/os2/control.h"
 139 #endif
 140
 141 #endif // wxUSE_CONTROLS
 142
 143 #endif
 144     // _WX_CONTROL_H_BASE_