]> git.saurik.com Git - wxWidgets.git/blob - include/wx/control.h
Correct wxImage::Size() again; add unit tests for it.
[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 #include "wx/defs.h"
20
21 #if wxUSE_CONTROLS
22
23 #include "wx/window.h" // base class
24
25 extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
26
27
28 // ----------------------------------------------------------------------------
29 // Ellipsize() constants
30 // ----------------------------------------------------------------------------
31
32 enum wxEllipsizeFlags
33 {
34 wxELLIPSIZE_PROCESS_MNEMONICS = 1,
35 wxELLIPSIZE_EXPAND_TAB = 2,
36
37 wxELLIPSIZE_DEFAULT_FLAGS = wxELLIPSIZE_PROCESS_MNEMONICS|wxELLIPSIZE_EXPAND_TAB
38 };
39
40 enum wxEllipsizeMode
41 {
42 wxELLIPSIZE_START,
43 wxELLIPSIZE_MIDDLE,
44 wxELLIPSIZE_END
45 };
46
47 // ----------------------------------------------------------------------------
48 // wxControl is the base class for all controls
49 // ----------------------------------------------------------------------------
50
51 class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
52 {
53 public:
54 wxControlBase() { }
55
56 virtual ~wxControlBase();
57
58 // Create() function adds the validator parameter
59 bool Create(wxWindow *parent, wxWindowID id,
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = 0,
63 const wxValidator& validator = wxDefaultValidator,
64 const wxString& name = wxControlNameStr);
65
66 // get the control alignment (left/right/centre, top/bottom/centre)
67 int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
68
69 virtual void SetLabel(const wxString& label)
70 {
71 m_labelOrig = label;
72
73 InvalidateBestSize();
74
75 wxWindow::SetLabel(label);
76 }
77
78 virtual wxString GetLabel() const
79 {
80 // return the original string, as it was passed to SetLabel()
81 // (i.e. with wx-style mnemonics)
82 return m_labelOrig;
83 }
84
85 // get just the text of the label, without mnemonic characters ('&')
86 wxString GetLabelText() const { return GetLabelText(GetLabel()); }
87
88 void SetLabelText(const wxString& text)
89 {
90 SetLabel(EscapeMnemonics(text));
91 }
92
93 // controls by default inherit the colours of their parents, if a
94 // particular control class doesn't want to do it, it can override
95 // ShouldInheritColours() to return false
96 virtual bool ShouldInheritColours() const { return true; }
97
98
99 // WARNING: this doesn't work for all controls nor all platforms!
100 //
101 // simulates the event of given type (i.e. wxButton::Command() is just as
102 // if the button was clicked)
103 virtual void Command(wxCommandEvent &event);
104
105 virtual bool SetFont(const wxFont& font);
106
107 // wxControl-specific processing after processing the update event
108 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
109
110
111
112 // static utilities
113 // ----------------
114
115 // replaces parts of the (multiline) string with ellipsis if needed
116 static wxString Ellipsize(const wxString& label, const wxDC& dc,
117 wxEllipsizeMode mode, int maxWidth,
118 int flags = wxELLIPSIZE_DEFAULT_FLAGS);
119
120 // get the string without mnemonic characters ('&')
121 static wxString GetLabelText(const wxString& label);
122
123 // removes the mnemonics characters
124 static wxString RemoveMnemonics(const wxString& str);
125
126 // escapes (by doubling them) the mnemonics
127 static wxString EscapeMnemonics(const wxString& str);
128
129 // return the accel index in the string or -1 if none and puts the modified
130 // string into second parameter if non NULL
131 static int FindAccelIndex(const wxString& label,
132 wxString *labelOnly = NULL);
133
134 protected:
135 // choose the default border for this window
136 virtual wxBorder GetDefaultBorder() const;
137
138 // creates the control (calls wxWindowBase::CreateBase inside) and adds it
139 // to the list of parents children
140 bool CreateControl(wxWindowBase *parent,
141 wxWindowID id,
142 const wxPoint& pos,
143 const wxSize& size,
144 long style,
145 const wxValidator& validator,
146 const wxString& name);
147
148 // initialize the common fields of wxCommandEvent
149 void InitCommandEvent(wxCommandEvent& event) const;
150
151 // Ellipsize() helper:
152 static wxString DoEllipsizeSingleLine(const wxString& label, const wxDC& dc,
153 wxEllipsizeMode mode, int maxWidth,
154 int replacementWidth, int marginWidth);
155
156 // this field contains the label in wx format, i.e. with '&' mnemonics
157 wxString m_labelOrig;
158
159 wxDECLARE_NO_COPY_CLASS(wxControlBase);
160 };
161
162 // ----------------------------------------------------------------------------
163 // include platform-dependent wxControl declarations
164 // ----------------------------------------------------------------------------
165
166 #if defined(__WXUNIVERSAL__)
167 #include "wx/univ/control.h"
168 #elif defined(__WXPALMOS__)
169 #include "wx/palmos/control.h"
170 #elif defined(__WXMSW__)
171 #include "wx/msw/control.h"
172 #elif defined(__WXMOTIF__)
173 #include "wx/motif/control.h"
174 #elif defined(__WXGTK20__)
175 #include "wx/gtk/control.h"
176 #elif defined(__WXGTK__)
177 #include "wx/gtk1/control.h"
178 #elif defined(__WXMAC__)
179 #include "wx/osx/control.h"
180 #elif defined(__WXCOCOA__)
181 #include "wx/cocoa/control.h"
182 #elif defined(__WXPM__)
183 #include "wx/os2/control.h"
184 #endif
185
186 #endif // wxUSE_CONTROLS
187
188 #endif
189 // _WX_CONTROL_H_BASE_