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 WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
  26
  27 // ----------------------------------------------------------------------------
  28 // wxControl is the base class for all controls
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLIMPEXP_CORE 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     // return the accel index in the string or -1 if none and puts the modified
  77     // string into second parameter if non NULL
  78     static int FindAccelIndex(const wxString& label,
  79                               wxString *labelOnly = NULL);
  80
  81
  82     // controls by default inherit the colours of their parents, if a
  83     // particular control class doesn't want to do it, it can override
  84     // ShouldInheritColours() to return false
  85     virtual bool ShouldInheritColours() const { return true; }
  86
  87
  88     // WARNING: this doesn't work for all controls nor all platforms!
  89     //
  90     // simulates the event of given type (i.e. wxButton::Command() is just as
  91     // if the button was clicked)
  92     virtual void Command(wxCommandEvent &event);
  93
  94     virtual bool SetFont(const wxFont& font);
  95
  96     // wxControl-specific processing after processing the update event
  97     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
  98
  99 protected:
 100     // choose the default border for this window
 101     virtual wxBorder GetDefaultBorder() const;
 102
 103     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
 104     // to the list of parents children
 105     bool CreateControl(wxWindowBase *parent,
 106                        wxWindowID id,
 107                        const wxPoint& pos,
 108                        const wxSize& size,
 109                        long style,
 110                        const wxValidator& validator,
 111                        const wxString& name);
 112
 113     // initialize the common fields of wxCommandEvent
 114     void InitCommandEvent(wxCommandEvent& event) const;
 115
 116     // this field contains the label in wx format, i.e. with '&' mnemonics
 117     wxString m_labelOrig;
 118
 119     DECLARE_NO_COPY_CLASS(wxControlBase)
 120 };
 121
 122 // ----------------------------------------------------------------------------
 123 // include platform-dependent wxControl declarations
 124 // ----------------------------------------------------------------------------
 125
 126 #if defined(__WXUNIVERSAL__)
 127     #include "wx/univ/control.h"
 128 #elif defined(__WXPALMOS__)
 129     #include "wx/palmos/control.h"
 130 #elif defined(__WXMSW__)
 131     #include "wx/msw/control.h"
 132 #elif defined(__WXMOTIF__)
 133     #include "wx/motif/control.h"
 134 #elif defined(__WXGTK20__)
 135     #include "wx/gtk/control.h"
 136 #elif defined(__WXGTK__)
 137     #include "wx/gtk1/control.h"
 138 #elif defined(__WXMAC__)
 139     #include "wx/osx/control.h"
 140 #elif defined(__WXCOCOA__)
 141     #include "wx/cocoa/control.h"
 142 #elif defined(__WXPM__)
 143     #include "wx/os2/control.h"
 144 #endif
 145
 146 #endif // wxUSE_CONTROLS
 147
 148 #endif
 149     // _WX_CONTROL_H_BASE_