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) wxWindows 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 WXDLLEXPORT_DATA(extern 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 protected:
  67     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
  68     // to the list of parents children
  69     bool CreateControl(wxWindowBase *parent,
  70                        wxWindowID id,
  71                        const wxPoint& pos,
  72                        const wxSize& size,
  73                        long style,
  74                        const wxValidator& validator,
  75                        const wxString& name);
  76
  77     // initialize the common fields of wxCommandEvent
  78     void InitCommandEvent(wxCommandEvent& event) const;
  79
  80     // set the initial window size if none is given (i.e. at least one of the
  81     // components of the size passed to ctor/Create() is -1)
  82     //
  83     // normally just calls SetBestSize() but can be overridden not to do it for
  84     // the controls which have to do some additional initialization (e.g. add
  85     // strings to list box) before their best size can be accurately calculated
  86     virtual void SetInitialBestSize(const wxSize& size)
  87     {
  88         SetBestSize(size);
  89     }
  90
  91     DECLARE_NO_COPY_CLASS(wxControlBase)
  92 };
  93
  94 // ----------------------------------------------------------------------------
  95 // include platform-dependent wxControl declarations
  96 // ----------------------------------------------------------------------------
  97
  98 #if defined(__WXUNIVERSAL__)
  99     #include "wx/univ/control.h"
 100 #elif defined(__WXMSW__)
 101     #include "wx/msw/control.h"
 102 #elif defined(__WXMOTIF__)
 103     #include "wx/motif/control.h"
 104 #elif defined(__WXGTK__)
 105     #include "wx/gtk/control.h"
 106 #elif defined(__WXMAC__)
 107     #include "wx/mac/control.h"
 108 #elif defined(__WXCOCOA__)
 109     #include "wx/cocoa/control.h"
 110 #elif defined(__WXPM__)
 111     #include "wx/os2/control.h"
 112 #endif
 113
 114 #endif // wxUSE_CONTROLS
 115
 116 #endif
 117     // _WX_CONTROL_H_BASE_