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