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