]> git.saurik.com Git - wxWidgets.git/blob - include/wx/control.h
support SDK < 10.6, fixes #14902
[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_FLAGS_NONE = 0,
35 wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS = 1,
36 wxELLIPSIZE_FLAGS_EXPAND_TABS = 2,
37
38 wxELLIPSIZE_FLAGS_DEFAULT = wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS |
39 wxELLIPSIZE_FLAGS_EXPAND_TABS
40 };
41
42 // NB: Don't change the order of these values, they're the same as in
43 // PangoEllipsizeMode enum.
44 enum wxEllipsizeMode
45 {
46 wxELLIPSIZE_NONE,
47 wxELLIPSIZE_START,
48 wxELLIPSIZE_MIDDLE,
49 wxELLIPSIZE_END
50 };
51
52 // ----------------------------------------------------------------------------
53 // wxControl is the base class for all controls
54 // ----------------------------------------------------------------------------
55
56 class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
57 {
58 public:
59 wxControlBase() { }
60
61 virtual ~wxControlBase();
62
63 // Create() function adds the validator parameter
64 bool Create(wxWindow *parent, wxWindowID id,
65 const wxPoint& pos = wxDefaultPosition,
66 const wxSize& size = wxDefaultSize,
67 long style = 0,
68 const wxValidator& validator = wxDefaultValidator,
69 const wxString& name = wxControlNameStr);
70
71 // get the control alignment (left/right/centre, top/bottom/centre)
72 int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
73
74 // set label with mnemonics
75 virtual void SetLabel(const wxString& label)
76 {
77 m_labelOrig = label;
78
79 InvalidateBestSize();
80
81 wxWindow::SetLabel(label);
82 }
83
84 // return the original string, as it was passed to SetLabel()
85 // (i.e. with wx-style mnemonics)
86 virtual wxString GetLabel() const { return m_labelOrig; }
87
88 // set label text (mnemonics will be escaped)
89 virtual void SetLabelText(const wxString& text)
90 {
91 SetLabel(EscapeMnemonics(text));
92 }
93
94 // get just the text of the label, without mnemonic characters ('&')
95 virtual wxString GetLabelText() const { return GetLabelText(GetLabel()); }
96
97
98 #if wxUSE_MARKUP
99 // Set the label with markup (and mnemonics). Markup is a simple subset of
100 // HTML with tags such as <b>, <i> and <span>. By default it is not
101 // supported i.e. all the markup is simply stripped and SetLabel() is
102 // called but some controls in some ports do support this already and in
103 // the future most of them should.
104 //
105 // Notice that, being HTML-like, markup also supports XML entities so '<'
106 // should be encoded as "&lt;" and so on, a bare '<' in the input will
107 // likely result in an error. As an exception, a bare '&' is allowed and
108 // indicates that the next character is a mnemonic. To insert a literal '&'
109 // in the control you need to use "&amp;" in the input string.
110 //
111 // Returns true if the label was set, even if the markup in it was ignored.
112 // False is only returned if we failed to parse the label.
113 bool SetLabelMarkup(const wxString& markup)
114 {
115 return DoSetLabelMarkup(markup);
116 }
117 #endif // wxUSE_MARKUP
118
119
120 // controls by default inherit the colours of their parents, if a
121 // particular control class doesn't want to do it, it can override
122 // ShouldInheritColours() to return false
123 virtual bool ShouldInheritColours() const { return true; }
124
125
126 // WARNING: this doesn't work for all controls nor all platforms!
127 //
128 // simulates the event of given type (i.e. wxButton::Command() is just as
129 // if the button was clicked)
130 virtual void Command(wxCommandEvent &event);
131
132 virtual bool SetFont(const wxFont& font);
133
134 // wxControl-specific processing after processing the update event
135 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
136
137 wxSize GetSizeFromTextSize(int xlen, int ylen = -1) const
138 { return DoGetSizeFromTextSize(xlen, ylen); }
139 wxSize GetSizeFromTextSize(const wxSize& tsize) const
140 { return DoGetSizeFromTextSize(tsize.x, tsize.y); }
141
142
143 // static utilities for mnemonics char (&) handling
144 // ------------------------------------------------
145
146 // returns the given string without mnemonic characters ('&')
147 static wxString GetLabelText(const wxString& label);
148
149 // returns the given string without mnemonic characters ('&')
150 // this function is identic to GetLabelText() and is provided for clarity
151 // and for symmetry with the wxStaticText::RemoveMarkup() function.
152 static wxString RemoveMnemonics(const wxString& str);
153
154 // escapes (by doubling them) the mnemonics
155 static wxString EscapeMnemonics(const wxString& str);
156
157
158 // miscellaneous static utilities
159 // ------------------------------
160
161 // replaces parts of the given (multiline) string with an ellipsis if needed
162 static wxString Ellipsize(const wxString& label, const wxDC& dc,
163 wxEllipsizeMode mode, int maxWidth,
164 int flags = wxELLIPSIZE_FLAGS_DEFAULT);
165
166 // return the accel index in the string or -1 if none and puts the modified
167 // string into second parameter if non NULL
168 static int FindAccelIndex(const wxString& label,
169 wxString *labelOnly = NULL);
170
171 // this is a helper for the derived class GetClassDefaultAttributes()
172 // implementation: it returns the right colours for the classes which
173 // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
174 // being simple controls (such as wxButton, wxCheckBox, ...)
175 static wxVisualAttributes
176 GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
177
178 protected:
179 // choose the default border for this window
180 virtual wxBorder GetDefaultBorder() const;
181
182 // creates the control (calls wxWindowBase::CreateBase inside) and adds it
183 // to the list of parents children
184 bool CreateControl(wxWindowBase *parent,
185 wxWindowID id,
186 const wxPoint& pos,
187 const wxSize& size,
188 long style,
189 const wxValidator& validator,
190 const wxString& name);
191
192 #if wxUSE_MARKUP
193 // This function may be overridden in the derived classes to implement
194 // support for labels with markup. The base class version simply strips the
195 // markup and calls SetLabel() with the remaining text.
196 virtual bool DoSetLabelMarkup(const wxString& markup);
197 #endif // wxUSE_MARKUP
198
199 // override this to return the total control's size from a string size
200 virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
201
202 // initialize the common fields of wxCommandEvent
203 void InitCommandEvent(wxCommandEvent& event) const;
204
205 // Ellipsize() helper:
206 static wxString DoEllipsizeSingleLine(const wxString& label, const wxDC& dc,
207 wxEllipsizeMode mode, int maxWidth,
208 int replacementWidth);
209
210 #if wxUSE_MARKUP
211 // Remove markup from the given string, returns empty string on error i.e.
212 // if markup was syntactically invalid.
213 static wxString RemoveMarkup(const wxString& markup);
214 #endif // wxUSE_MARKUP
215
216
217 // this field contains the label in wx format, i.e. with '&' mnemonics,
218 // as it was passed to the last SetLabel() call
219 wxString m_labelOrig;
220
221 wxDECLARE_NO_COPY_CLASS(wxControlBase);
222 };
223
224 // ----------------------------------------------------------------------------
225 // include platform-dependent wxControl declarations
226 // ----------------------------------------------------------------------------
227
228 #if defined(__WXUNIVERSAL__)
229 #include "wx/univ/control.h"
230 #elif defined(__WXMSW__)
231 #include "wx/msw/control.h"
232 #elif defined(__WXMOTIF__)
233 #include "wx/motif/control.h"
234 #elif defined(__WXGTK20__)
235 #include "wx/gtk/control.h"
236 #elif defined(__WXGTK__)
237 #include "wx/gtk1/control.h"
238 #elif defined(__WXMAC__)
239 #include "wx/osx/control.h"
240 #elif defined(__WXCOCOA__)
241 #include "wx/cocoa/control.h"
242 #elif defined(__WXPM__)
243 #include "wx/os2/control.h"
244 #endif
245
246 #endif // wxUSE_CONTROLS
247
248 #endif
249 // _WX_CONTROL_H_BASE_