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(__APPLE__)
  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     virtual ~wxControlBase();
  39
  40     // Create() function adds the validator parameter
  41     bool Create(wxWindow *parent, wxWindowID id,
  42                 const wxPoint& pos = wxDefaultPosition,
  43                 const wxSize& size = wxDefaultSize,
  44                 long style = 0,
  45                 const wxValidator& validator = wxDefaultValidator,
  46                 const wxString& name = wxControlNameStr);
  47
  48     // simulates the event of given type (i.e. wxButton::Command() is just as
  49     // if the button was clicked)
  50     virtual void Command(wxCommandEvent &event);
  51
  52     // get the control alignment (left/right/centre, top/bottom/centre)
  53     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
  54
  55 protected:
  56     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
  57     // to the list of parents children
  58     bool CreateControl(wxWindowBase *parent,
  59                        wxWindowID id,
  60                        const wxPoint& pos,
  61                        const wxSize& size,
  62                        long style,
  63                        const wxValidator& validator,
  64                        const wxString& name);
  65
  66     // inherit colour and font settings from the parent window
  67     void InheritAttributes();
  68
  69     // initialize the common fields of wxCommandEvent
  70     void InitCommandEvent(wxCommandEvent& event) const;
  71 };
  72
  73 // ----------------------------------------------------------------------------
  74 // include platform-dependent wxControl declarations
  75 // ----------------------------------------------------------------------------
  76
  77 #if defined(__WXUNIVERSAL__)
  78     #include "wx/univ/control.h"
  79 #elif defined(__WXMSW__)
  80     #include "wx/msw/control.h"
  81 #elif defined(__WXMOTIF__)
  82     #include "wx/motif/control.h"
  83 #elif defined(__WXGTK__)
  84     #include "wx/gtk/control.h"
  85 #elif defined(__WXMAC__)
  86     #include "wx/mac/control.h"
  87 #elif defined(__WXCOCOA__)
  88     #include "wx/cocoa/control.h"
  89 #elif defined(__WXPM__)
  90     #include "wx/os2/control.h"
  91 #endif
  92
  93 #endif // wxUSE_CONTROLS
  94
  95 #endif
  96     // _WX_CONTROL_H_BASE_