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 the string without mnemonic characters ('&')
  50     static wxString GetLabelText(const wxString& label);
  51
  52     // get just the text of the label, without mnemonic characters ('&')
  53     wxString GetLabelText() const { return GetLabelText(GetLabel()); }
  54
  55     // controls by default inherit the colours of their parents, if a
  56     // particular control class doesn't want to do it, it can override
  57     // ShouldInheritColours() to return false
  58     virtual bool ShouldInheritColours() const { return true; }
  59
  60
  61     // WARNING: this doesn't work for all controls nor all platforms!
  62     //
  63     // simulates the event of given type (i.e. wxButton::Command() is just as
  64     // if the button was clicked)
  65     virtual void Command(wxCommandEvent &event);
  66
  67     virtual void SetLabel( const wxString &label );
  68     virtual bool SetFont(const wxFont& font);
  69
  70     // wxControl-specific processing after processing the update event
  71     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
  72
  73 protected:
  74     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
  75     // to the list of parents children
  76     bool CreateControl(wxWindowBase *parent,
  77                        wxWindowID id,
  78                        const wxPoint& pos,
  79                        const wxSize& size,
  80                        long style,
  81                        const wxValidator& validator,
  82                        const wxString& name);
  83
  84     // initialize the common fields of wxCommandEvent
  85     void InitCommandEvent(wxCommandEvent& event) const;
  86
  87     // set the initial window size if none is given (i.e. at least one of the
  88     // components of the size passed to ctor/Create() is -1)
  89     //
  90     // normally just calls SetBestSize() but can be overridden not to do it for
  91     // the controls which have to do some additional initialization (e.g. add
  92     // strings to list box) before their best size can be accurately calculated
  93     virtual void SetInitialBestSize(const wxSize& size)
  94     {
  95         SetBestSize(size);
  96     }
  97
  98     DECLARE_NO_COPY_CLASS(wxControlBase)
  99 };
 100
 101 // ----------------------------------------------------------------------------
 102 // include platform-dependent wxControl declarations
 103 // ----------------------------------------------------------------------------
 104
 105 #if defined(__WXUNIVERSAL__)
 106     #include "wx/univ/control.h"
 107 #elif defined(__WXPALMOS__)
 108     #include "wx/palmos/control.h"
 109 #elif defined(__WXMSW__)
 110     #include "wx/msw/control.h"
 111 #elif defined(__WXMOTIF__)
 112     #include "wx/motif/control.h"
 113 #elif defined(__WXGTK20__)
 114     #include "wx/gtk/control.h"
 115 #elif defined(__WXGTK__)
 116     #include "wx/gtk1/control.h"
 117 #elif defined(__WXMAC__)
 118     #include "wx/mac/control.h"
 119 #elif defined(__WXCOCOA__)
 120     #include "wx/cocoa/control.h"
 121 #elif defined(__WXPM__)
 122     #include "wx/os2/control.h"
 123 #endif
 124
 125 #endif // wxUSE_CONTROLS
 126
 127 #endif
 128     // _WX_CONTROL_H_BASE_