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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  20     #pragma interface "controlbase.h"
  21 #endif
  22
  23 #include "wx/defs.h"
  24
  25 #if wxUSE_CONTROLS
  26
  27 #include "wx/window.h"      // base class
  28
  29 extern WXDLLEXPORT_DATA(const wxChar*) wxControlNameStr;
  30
  31 // ----------------------------------------------------------------------------
  32 // wxControl is the base class for all controls
  33 // ----------------------------------------------------------------------------
  34
  35 class WXDLLEXPORT wxControlBase : public wxWindow
  36 {
  37 public:
  38     wxControlBase() { }
  39
  40     virtual ~wxControlBase();
  41
  42     // Create() function adds the validator parameter
  43     bool Create(wxWindow *parent, wxWindowID id,
  44                 const wxPoint& pos = wxDefaultPosition,
  45                 const wxSize& size = wxDefaultSize,
  46                 long style = 0,
  47                 const wxValidator& validator = wxDefaultValidator,
  48                 const wxString& name = wxControlNameStr);
  49
  50     // get the control alignment (left/right/centre, top/bottom/centre)
  51     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
  52
  53
  54     // controls by default inherit the colours of their parents, if a
  55     // particular control class doesn't want to do it, it can override
  56     // ShouldInheritColours() to return false
  57     virtual bool ShouldInheritColours() const { return true; }
  58
  59
  60     // WARNING: this doesn't work for all controls nor all platforms!
  61     //
  62     // simulates the event of given type (i.e. wxButton::Command() is just as
  63     // if the button was clicked)
  64     virtual void Command(wxCommandEvent &event);
  65
  66     virtual void SetLabel( const wxString &label );
  67     virtual bool SetFont(const wxFont& font);
  68
  69     // Reserved for future use
  70     virtual void ReservedControlFunc1() {}
  71     virtual void ReservedControlFunc2() {}
  72     virtual void ReservedControlFunc3() {}
  73     virtual void ReservedControlFunc4() {}
  74     virtual void ReservedControlFunc5() {}
  75     virtual void ReservedControlFunc6() {}
  76     virtual void ReservedControlFunc7() {}
  77     virtual void ReservedControlFunc8() {}
  78     virtual void ReservedControlFunc9() {}
  79
  80 protected:
  81     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
  82     // to the list of parents children
  83     bool CreateControl(wxWindowBase *parent,
  84                        wxWindowID id,
  85                        const wxPoint& pos,
  86                        const wxSize& size,
  87                        long style,
  88                        const wxValidator& validator,
  89                        const wxString& name);
  90
  91     // initialize the common fields of wxCommandEvent
  92     void InitCommandEvent(wxCommandEvent& event) const;
  93
  94     // set the initial window size if none is given (i.e. at least one of the
  95     // components of the size passed to ctor/Create() is -1)
  96     //
  97     // normally just calls SetBestSize() but can be overridden not to do it for
  98     // the controls which have to do some additional initialization (e.g. add
  99     // strings to list box) before their best size can be accurately calculated
 100     virtual void SetInitialBestSize(const wxSize& size)
 101     {
 102         SetBestSize(size);
 103     }
 104
 105     DECLARE_NO_COPY_CLASS(wxControlBase)
 106 };
 107
 108 // ----------------------------------------------------------------------------
 109 // include platform-dependent wxControl declarations
 110 // ----------------------------------------------------------------------------
 111
 112 #if defined(__WXUNIVERSAL__)
 113     #include "wx/univ/control.h"
 114 #elif defined(__WXPALMOS__)
 115     #include "wx/palmos/control.h"
 116 #elif defined(__WXMSW__)
 117     #include "wx/msw/control.h"
 118 #elif defined(__WXMOTIF__)
 119     #include "wx/motif/control.h"
 120 #elif defined(__WXGTK__)
 121     #include "wx/gtk/control.h"
 122 #elif defined(__WXMAC__)
 123     #include "wx/mac/control.h"
 124 #elif defined(__WXCOCOA__)
 125     #include "wx/cocoa/control.h"
 126 #elif defined(__WXPM__)
 127     #include "wx/os2/control.h"
 128 #endif
 129
 130 #endif // wxUSE_CONTROLS
 131
 132 #endif
 133     // _WX_CONTROL_H_BASE_