]>
Commit | Line | Data |
---|---|---|
f03fc89f | 1 | /////////////////////////////////////////////////////////////////////////////// |
23895080 | 2 | // Name: wx/window.h |
789295bf | 3 | // Purpose: wxWindowBase class - the interface of wxWindow |
f03fc89f | 4 | // Author: Vadim Zeitlin |
566d84a7 | 5 | // Modified by: Ron Lee |
f03fc89f VZ |
6 | // Created: 01/02/97 |
7 | // RCS-ID: $Id$ | |
99d80019 | 8 | // Copyright: (c) Vadim Zeitlin |
65571936 | 9 | // Licence: wxWindows licence |
f03fc89f VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_WINDOW_H_BASE_ |
13 | #define _WX_WINDOW_H_BASE_ | |
c801d85f | 14 | |
f03fc89f VZ |
15 | // ---------------------------------------------------------------------------- |
16 | // headers which we must include here | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
19 | #include "wx/event.h" // the base class | |
20 | ||
21 | #include "wx/list.h" // defines wxWindowList | |
22 | ||
23 | #include "wx/cursor.h" // we have member variables of these classes | |
24 | #include "wx/font.h" // so we can't do without them | |
25 | #include "wx/colour.h" | |
26 | #include "wx/region.h" | |
5e4ff78a | 27 | #include "wx/utils.h" |
978af864 | 28 | #include "wx/intl.h" |
88ac883a | 29 | |
674ac8b9 | 30 | #include "wx/validate.h" // for wxDefaultValidator (always include it) |
8d99be5f | 31 | |
574c939e | 32 | #if wxUSE_PALETTE |
d577d610 | 33 | #include "wx/palette.h" |
574c939e KB |
34 | #endif // wxUSE_PALETTE |
35 | ||
88ac883a VZ |
36 | #if wxUSE_ACCEL |
37 | #include "wx/accel.h" | |
38 | #endif // wxUSE_ACCEL | |
f03fc89f | 39 | |
45a959a3 JS |
40 | #if wxUSE_ACCESSIBILITY |
41 | #include "wx/access.h" | |
42 | #endif | |
43 | ||
6522713c VZ |
44 | // when building wxUniv/Foo we don't want the code for native menu use to be |
45 | // compiled in - it should only be used when building real wxFoo | |
46 | #ifdef __WXUNIVERSAL__ | |
47 | #define wxUSE_MENUS_NATIVE 0 | |
22dd3847 | 48 | #else // !__WXUNIVERSAL__ |
6522713c | 49 | #define wxUSE_MENUS_NATIVE wxUSE_MENUS |
22dd3847 | 50 | #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ |
6522713c | 51 | |
47a8a4d5 VZ |
52 | |
53 | // Define this macro if the corresponding operating system handles the state | |
54 | // of children windows automatically when the parent is enabled/disabled. | |
55 | // Otherwise wx itself must ensure that when the parent is disabled its | |
56 | // children are disabled too, and their initial state is restored when the | |
57 | // parent is enabled back. | |
58 | #if defined(__WXMSW__) || defined(__WXPM__) | |
59 | // must do everything ourselves | |
60 | #undef wxHAS_NATIVE_ENABLED_MANAGEMENT | |
61 | #else | |
62 | #define wxHAS_NATIVE_ENABLED_MANAGEMENT | |
63 | #endif | |
64 | ||
f03fc89f VZ |
65 | // ---------------------------------------------------------------------------- |
66 | // forward declarations | |
67 | // ---------------------------------------------------------------------------- | |
68 | ||
b5dbe15d VS |
69 | class WXDLLIMPEXP_FWD_CORE wxCaret; |
70 | class WXDLLIMPEXP_FWD_CORE wxControl; | |
71 | class WXDLLIMPEXP_FWD_CORE wxCursor; | |
72 | class WXDLLIMPEXP_FWD_CORE wxDC; | |
73 | class WXDLLIMPEXP_FWD_CORE wxDropTarget; | |
b5dbe15d | 74 | class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints; |
b5dbe15d VS |
75 | class WXDLLIMPEXP_FWD_CORE wxSizer; |
76 | class WXDLLIMPEXP_FWD_CORE wxToolTip; | |
77 | class WXDLLIMPEXP_FWD_CORE wxWindowBase; | |
78 | class WXDLLIMPEXP_FWD_CORE wxWindow; | |
79 | class WXDLLIMPEXP_FWD_CORE wxScrollHelper; | |
f03fc89f | 80 | |
45a959a3 | 81 | #if wxUSE_ACCESSIBILITY |
b5dbe15d | 82 | class WXDLLIMPEXP_FWD_CORE wxAccessible; |
45a959a3 JS |
83 | #endif |
84 | ||
1b69c815 VZ |
85 | // ---------------------------------------------------------------------------- |
86 | // helper stuff used by wxWindow | |
87 | // ---------------------------------------------------------------------------- | |
88 | ||
89 | // struct containing all the visual attributes of a control | |
90 | struct WXDLLEXPORT wxVisualAttributes | |
91 | { | |
92 | // the font used for control label/text inside it | |
93 | wxFont font; | |
94 | ||
95 | // the foreground colour | |
96 | wxColour colFg; | |
97 | ||
98 | // the background colour, may be wxNullColour if the controls background | |
99 | // colour is not solid | |
100 | wxColour colBg; | |
101 | }; | |
102 | ||
103 | // different window variants, on platforms like eg mac uses different | |
104 | // rendering sizes | |
400a9e41 | 105 | enum wxWindowVariant |
1b69c815 VZ |
106 | { |
107 | wxWINDOW_VARIANT_NORMAL, // Normal size | |
108 | wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal) | |
109 | wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal) | |
110 | wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal) | |
111 | wxWINDOW_VARIANT_MAX | |
112 | }; | |
113 | ||
ff9f7a12 SC |
114 | #if wxUSE_SYSTEM_OPTIONS |
115 | #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant") | |
116 | #endif | |
117 | ||
376d7d97 VZ |
118 | // valid values for Show/HideWithEffect() |
119 | enum wxShowEffect | |
120 | { | |
121 | wxSHOW_EFFECT_ROLL, | |
122 | wxSHOW_EFFECT_SLIDE, | |
123 | wxSHOW_EFFECT_BLEND, | |
124 | wxSHOW_EFFECT_EXPAND, | |
125 | wxSHOW_EFFECT_MAX | |
126 | }; | |
127 | ||
f03fc89f VZ |
128 | // ---------------------------------------------------------------------------- |
129 | // (pseudo)template list classes | |
130 | // ---------------------------------------------------------------------------- | |
131 | ||
f6bcfd97 | 132 | WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT); |
f03fc89f VZ |
133 | |
134 | // ---------------------------------------------------------------------------- | |
135 | // global variables | |
136 | // ---------------------------------------------------------------------------- | |
137 | ||
16cba29d | 138 | extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows; |
e7445ff8 | 139 | extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete; |
f03fc89f | 140 | |
f03fc89f VZ |
141 | // ---------------------------------------------------------------------------- |
142 | // wxWindowBase is the base class for all GUI controls/widgets, this is the public | |
143 | // interface of this class. | |
144 | // | |
145 | // Event handler: windows have themselves as their event handlers by default, | |
146 | // but their event handlers could be set to another object entirely. This | |
147 | // separation can reduce the amount of derivation required, and allow | |
148 | // alteration of a window's functionality (e.g. by a resource editor that | |
149 | // temporarily switches event handlers). | |
150 | // ---------------------------------------------------------------------------- | |
151 | ||
152 | class WXDLLEXPORT wxWindowBase : public wxEvtHandler | |
153 | { | |
f03fc89f VZ |
154 | public: |
155 | // creating the window | |
156 | // ------------------- | |
157 | ||
06f6df7d VZ |
158 | // default ctor, initializes everything which can be initialized before |
159 | // Create() | |
6463b9f5 | 160 | wxWindowBase() ; |
f03fc89f VZ |
161 | |
162 | // pseudo ctor (can't be virtual, called from ctor) | |
163 | bool CreateBase(wxWindowBase *parent, | |
d9e2e4c2 | 164 | wxWindowID winid, |
f03fc89f VZ |
165 | const wxPoint& pos = wxDefaultPosition, |
166 | const wxSize& size = wxDefaultSize, | |
167 | long style = 0, | |
8d99be5f | 168 | const wxValidator& validator = wxDefaultValidator, |
f03fc89f VZ |
169 | const wxString& name = wxPanelNameStr); |
170 | ||
171 | virtual ~wxWindowBase(); | |
172 | ||
f03fc89f VZ |
173 | // deleting the window |
174 | // ------------------- | |
175 | ||
d4864e97 | 176 | // ask the window to close itself, return true if the event handler |
f03fc89f | 177 | // honoured our request |
d4864e97 | 178 | bool Close( bool force = false ); |
f03fc89f VZ |
179 | |
180 | // the following functions delete the C++ objects (the window itself | |
181 | // or its children) as well as the GUI windows and normally should | |
182 | // never be used directly | |
183 | ||
d4864e97 | 184 | // delete window unconditionally (dangerous!), returns true if ok |
f03fc89f | 185 | virtual bool Destroy(); |
d4864e97 | 186 | // delete all children of this window, returns true if ok |
f03fc89f VZ |
187 | bool DestroyChildren(); |
188 | ||
189 | // is the window being deleted? | |
190 | bool IsBeingDeleted() const { return m_isBeingDeleted; } | |
191 | ||
192 | // window attributes | |
193 | // ----------------- | |
194 | ||
ffd84c94 WS |
195 | // label is just the same as the title (but for, e.g., buttons it |
196 | // makes more sense to speak about labels), title access | |
197 | // is available from wxTLW classes only (frames, dialogs) | |
faa49bfd WS |
198 | virtual void SetLabel(const wxString& label) = 0; |
199 | virtual wxString GetLabel() const = 0; | |
f03fc89f VZ |
200 | |
201 | // the window name is used for ressource setting in X, it is not the | |
202 | // same as the window title/label | |
203 | virtual void SetName( const wxString &name ) { m_windowName = name; } | |
204 | virtual wxString GetName() const { return m_windowName; } | |
205 | ||
978af864 VZ |
206 | // sets the window variant, calls internally DoSetVariant if variant |
207 | // has changed | |
208 | void SetWindowVariant(wxWindowVariant variant); | |
209 | wxWindowVariant GetWindowVariant() const { return m_windowVariant; } | |
400a9e41 | 210 | |
69d90995 | 211 | |
978af864 VZ |
212 | // get or change the layout direction (LTR or RTL) for this window, |
213 | // wxLayout_Default is returned if layout direction is not supported | |
214 | virtual wxLayoutDirection GetLayoutDirection() const | |
215 | { return wxLayout_Default; } | |
216 | virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir)) | |
217 | { } | |
218 | ||
219 | // mirror coordinates for RTL layout if this window uses it and if the | |
220 | // mirroring is not done automatically like Win32 | |
221 | virtual wxCoord AdjustForLayoutDirection(wxCoord x, | |
222 | wxCoord width, | |
223 | wxCoord widthTotal) const; | |
f03fc89f | 224 | |
f35fdf7e VZ |
225 | |
226 | // window id uniquely identifies the window among its siblings unless | |
227 | // it is wxID_ANY which means "don't care" | |
228 | void SetId( wxWindowID winid ) { m_windowId = winid; } | |
229 | wxWindowID GetId() const { return m_windowId; } | |
230 | ||
231 | // returns true if this id value belong to the range reserved for the | |
232 | // auto-generated (by NewControlId()) ids (they're always negative) | |
233 | static bool IsAutoGeneratedId(wxWindowID id); | |
234 | ||
235 | // generate a unique id (or count of them consecutively), returns a | |
236 | // valid id in IsAutoGeneratedId() range or wxID_NONE if failed | |
237 | static wxWindowID NewControlId(int count = 1); | |
238 | ||
239 | // mark an id previously returned by NewControlId() as being unused any | |
240 | // more so that it can be reused again for another control later | |
241 | static void ReleaseControlId(wxWindowID id); | |
242 | ||
f03fc89f VZ |
243 | |
244 | // moving/resizing | |
245 | // --------------- | |
246 | ||
247 | // set the window size and/or position | |
248 | void SetSize( int x, int y, int width, int height, | |
249 | int sizeFlags = wxSIZE_AUTO ) | |
250 | { DoSetSize(x, y, width, height, sizeFlags); } | |
251 | ||
252 | void SetSize( int width, int height ) | |
a0d9c6cb | 253 | { DoSetSize( wxDefaultCoord, wxDefaultCoord, width, height, wxSIZE_USE_EXISTING ); } |
f03fc89f VZ |
254 | |
255 | void SetSize( const wxSize& size ) | |
256 | { SetSize( size.x, size.y); } | |
257 | ||
258 | void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO) | |
259 | { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); } | |
260 | ||
1e6feb95 | 261 | void Move(int x, int y, int flags = wxSIZE_USE_EXISTING) |
a0d9c6cb | 262 | { DoSetSize(x, y, wxDefaultCoord, wxDefaultCoord, flags); } |
f03fc89f | 263 | |
1e6feb95 VZ |
264 | void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING) |
265 | { Move(pt.x, pt.y, flags); } | |
f03fc89f | 266 | |
3c81c9aa VZ |
267 | void SetPosition(const wxPoint& pt) { Move(pt); } |
268 | ||
f03fc89f VZ |
269 | // Z-order |
270 | virtual void Raise() = 0; | |
271 | virtual void Lower() = 0; | |
272 | ||
273 | // client size is the size of area available for subwindows | |
274 | void SetClientSize( int width, int height ) | |
275 | { DoSetClientSize(width, height); } | |
276 | ||
277 | void SetClientSize( const wxSize& size ) | |
278 | { DoSetClientSize(size.x, size.y); } | |
279 | ||
280 | void SetClientSize(const wxRect& rect) | |
281 | { SetClientSize( rect.width, rect.height ); } | |
282 | ||
3c81c9aa VZ |
283 | // get the window position (pointers may be NULL): notice that it is in |
284 | // client coordinates for child windows and screen coordinates for the | |
285 | // top level ones, use GetScreenPosition() if you need screen | |
286 | // coordinates for all kinds of windows | |
f03fc89f VZ |
287 | void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); } |
288 | wxPoint GetPosition() const | |
289 | { | |
3c81c9aa VZ |
290 | int x, y; |
291 | DoGetPosition(&x, &y); | |
f03fc89f | 292 | |
3c81c9aa | 293 | return wxPoint(x, y); |
f03fc89f VZ |
294 | } |
295 | ||
3c81c9aa VZ |
296 | // get the window position in screen coordinates |
297 | void GetScreenPosition(int *x, int *y) const { DoGetScreenPosition(x, y); } | |
298 | wxPoint GetScreenPosition() const | |
299 | { | |
300 | int x, y; | |
301 | DoGetScreenPosition(&x, &y); | |
38759b67 | 302 | |
3c81c9aa VZ |
303 | return wxPoint(x, y); |
304 | } | |
305 | ||
306 | // get the window size (pointers may be NULL) | |
f03fc89f VZ |
307 | void GetSize( int *w, int *h ) const { DoGetSize(w, h); } |
308 | wxSize GetSize() const | |
309 | { | |
310 | int w, h; | |
311 | DoGetSize(& w, & h); | |
312 | return wxSize(w, h); | |
313 | } | |
314 | ||
3c81c9aa VZ |
315 | void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); } |
316 | wxSize GetClientSize() const | |
317 | { | |
318 | int w, h; | |
319 | DoGetClientSize(&w, &h); | |
320 | ||
321 | return wxSize(w, h); | |
322 | } | |
323 | ||
324 | // get the position and size at once | |
f03fc89f VZ |
325 | wxRect GetRect() const |
326 | { | |
327 | int x, y, w, h; | |
3c81c9aa VZ |
328 | GetPosition(&x, &y); |
329 | GetSize(&w, &h); | |
f03fc89f VZ |
330 | |
331 | return wxRect(x, y, w, h); | |
332 | } | |
333 | ||
3c81c9aa | 334 | wxRect GetScreenRect() const |
f03fc89f | 335 | { |
3c81c9aa VZ |
336 | int x, y, w, h; |
337 | GetScreenPosition(&x, &y); | |
338 | GetSize(&w, &h); | |
f03fc89f | 339 | |
3c81c9aa | 340 | return wxRect(x, y, w, h); |
f03fc89f VZ |
341 | } |
342 | ||
1e6feb95 VZ |
343 | // get the origin of the client area of the window relative to the |
344 | // window top left corner (the client area may be shifted because of | |
345 | // the borders, scrollbars, other decorations...) | |
346 | virtual wxPoint GetClientAreaOrigin() const; | |
347 | ||
348 | // get the client rectangle in window (i.e. client) coordinates | |
349 | wxRect GetClientRect() const | |
350 | { | |
351 | return wxRect(GetClientAreaOrigin(), GetClientSize()); | |
352 | } | |
353 | ||
f68586e5 | 354 | // get the size best suited for the window (in fact, minimal |
9f884528 RD |
355 | // acceptable size using which it will still look "nice" in |
356 | // most situations) | |
357 | wxSize GetBestSize() const | |
358 | { | |
359 | if (m_bestSizeCache.IsFullySpecified()) | |
360 | return m_bestSizeCache; | |
361 | return DoGetBestSize(); | |
362 | } | |
f68586e5 VZ |
363 | void GetBestSize(int *w, int *h) const |
364 | { | |
9f884528 | 365 | wxSize s = GetBestSize(); |
f68586e5 VZ |
366 | if ( w ) |
367 | *w = s.x; | |
368 | if ( h ) | |
369 | *h = s.y; | |
370 | } | |
371 | ||
f4fe2f20 RR |
372 | void SetScrollHelper( wxScrollHelper *sh ) { m_scrollHelper = sh; } |
373 | wxScrollHelper *GetScrollHelper() { return m_scrollHelper; } | |
374 | ||
9f884528 RD |
375 | // reset the cached best size value so it will be recalculated the |
376 | // next time it is needed. | |
992b2ec4 | 377 | void InvalidateBestSize(); |
9f884528 RD |
378 | void CacheBestSize(const wxSize& size) const |
379 | { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; } | |
a0d9c6cb | 380 | |
2b5f62a0 | 381 | |
9f884528 RD |
382 | // This function will merge the window's best size into the window's |
383 | // minimum size, giving priority to the min size components, and | |
384 | // returns the results. | |
170acdc9 RD |
385 | wxSize GetEffectiveMinSize() const; |
386 | wxDEPRECATED( wxSize GetBestFittingSize() const ); // replaced by GetEffectiveMinSize | |
d6f582e7 | 387 | wxDEPRECATED( wxSize GetAdjustedMinSize() const ); // replaced by GetEffectiveMinSize |
a0d9c6cb | 388 | |
9f884528 RD |
389 | // A 'Smart' SetSize that will fill in default size values with 'best' |
390 | // size. Sets the minsize to what was passed in. | |
170acdc9 RD |
391 | void SetInitialSize(const wxSize& size=wxDefaultSize); |
392 | wxDEPRECATED( void SetBestFittingSize(const wxSize& size=wxDefaultSize) ); // replaced by SetInitialSize | |
9f884528 | 393 | |
47a8a4d5 | 394 | |
2b5f62a0 | 395 | // the generic centre function - centers the window on parent by` |
7eb4e9cc VZ |
396 | // default or on screen if it doesn't have parent or |
397 | // wxCENTER_ON_SCREEN flag is given | |
1f464296 VZ |
398 | void Centre(int dir = wxBOTH) { DoCentre(dir); } |
399 | void Center(int dir = wxBOTH) { DoCentre(dir); } | |
7eb4e9cc VZ |
400 | |
401 | // centre with respect to the the parent window | |
1f464296 | 402 | void CentreOnParent(int dir = wxBOTH) { DoCentre(dir); } |
7eb4e9cc | 403 | void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); } |
f03fc89f VZ |
404 | |
405 | // set window size to wrap around its children | |
406 | virtual void Fit(); | |
407 | ||
2b5f62a0 VZ |
408 | // set virtual size to satisfy children |
409 | virtual void FitInside(); | |
410 | ||
9379c0d7 | 411 | |
b21f4960 RR |
412 | // SetSizeHints is actually for setting the size hints |
413 | // for the wxTLW for a Window Manager - hence the name - | |
414 | // and it is therefore overridden in wxTLW to do that. | |
415 | // In wxWindow(Base), it has (unfortunately) been abused | |
416 | // to mean the same as SetMinSize() and SetMaxSize(). | |
47a8a4d5 | 417 | |
f03fc89f | 418 | virtual void SetSizeHints( int minW, int minH, |
a0d9c6cb | 419 | int maxW = wxDefaultCoord, int maxH = wxDefaultCoord, |
571f6981 | 420 | int incW = wxDefaultCoord, int incH = wxDefaultCoord ) |
9379c0d7 | 421 | { DoSetSizeHints(minW, minH, maxW, maxH, incW, incH); } |
6fb99eb3 | 422 | |
1ec25e8f RD |
423 | void SetSizeHints( const wxSize& minSize, |
424 | const wxSize& maxSize=wxDefaultSize, | |
425 | const wxSize& incSize=wxDefaultSize) | |
9379c0d7 RR |
426 | { DoSetSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y, incSize.x, incSize.y); } |
427 | ||
f03fc89f | 428 | |
f944aec0 VS |
429 | #if WXWIN_COMPATIBILITY_2_8 |
430 | // these are useless and do nothing since wxWidgets 2.9 | |
431 | wxDEPRECATED( virtual void SetVirtualSizeHints( int minW, int minH, | |
432 | int maxW = wxDefaultCoord, int maxH = wxDefaultCoord ) ); | |
433 | wxDEPRECATED( void SetVirtualSizeHints( const wxSize& minSize, | |
434 | const wxSize& maxSize=wxDefaultSize) ); | |
435 | #endif // WXWIN_COMPATIBILITY_2_8 | |
566d84a7 | 436 | |
57c4d796 | 437 | |
47a8a4d5 | 438 | // Call these to override what GetBestSize() returns. This |
a1b05a60 RR |
439 | // method is only virtual because it is overriden in wxTLW |
440 | // as a different API for SetSizeHints(). | |
441 | virtual void SetMinSize(const wxSize& minSize) { m_minWidth = minSize.x; m_minHeight = minSize.y; } | |
442 | virtual void SetMaxSize(const wxSize& maxSize) { m_maxWidth = maxSize.x; m_maxHeight = maxSize.y; } | |
443 | ||
444 | // Override these methods to impose restrictions on min/max size. | |
47a8a4d5 | 445 | // The easier way is to call SetMinSize() and SetMaxSize() which |
a1b05a60 | 446 | // will have the same effect. Doing both is non-sense. |
b4350341 VZ |
447 | virtual wxSize GetMinSize() const { return wxSize(m_minWidth, m_minHeight); } |
448 | virtual wxSize GetMaxSize() const { return wxSize(m_maxWidth, m_maxHeight); } | |
400a9e41 | 449 | |
a1b05a60 RR |
450 | // Get the min and max values one by one |
451 | int GetMinWidth() const { return GetMinSize().x; } | |
452 | int GetMinHeight() const { return GetMinSize().y; } | |
453 | int GetMaxWidth() const { return GetMaxSize().x; } | |
454 | int GetMaxHeight() const { return GetMaxSize().y; } | |
9379c0d7 | 455 | |
a0d9c6cb | 456 | |
566d84a7 RL |
457 | // Methods for accessing the virtual size of a window. For most |
458 | // windows this is just the client area of the window, but for | |
459 | // some like scrolled windows it is more or less independent of | |
460 | // the screen window size. You may override the DoXXXVirtual | |
461 | // methods below for classes where that is is the case. | |
462 | ||
463 | void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); } | |
464 | void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); } | |
465 | ||
466 | wxSize GetVirtualSize() const { return DoGetVirtualSize(); } | |
467 | void GetVirtualSize( int *x, int *y ) const | |
468 | { | |
469 | wxSize s( DoGetVirtualSize() ); | |
470 | ||
471 | if( x ) | |
472 | *x = s.GetWidth(); | |
473 | if( y ) | |
474 | *y = s.GetHeight(); | |
475 | } | |
476 | ||
477 | // Override these methods for windows that have a virtual size | |
478 | // independent of their client size. eg. the virtual area of a | |
e5ecf1fc | 479 | // wxScrolledWindow. |
566d84a7 RL |
480 | |
481 | virtual void DoSetVirtualSize( int x, int y ); | |
85b38e0b | 482 | virtual wxSize DoGetVirtualSize() const; |
e5ecf1fc | 483 | |
2b5f62a0 VZ |
484 | // Return the largest of ClientSize and BestSize (as determined |
485 | // by a sizer, interior children, or other means) | |
486 | ||
487 | virtual wxSize GetBestVirtualSize() const | |
488 | { | |
489 | wxSize client( GetClientSize() ); | |
490 | wxSize best( GetBestSize() ); | |
491 | ||
492 | return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) ); | |
493 | } | |
494 | ||
333d7052 VZ |
495 | // return the size of the left/right and top/bottom borders in x and y |
496 | // components of the result respectively | |
497 | virtual wxSize GetWindowBorderSize() const; | |
498 | ||
15f7c305 RR |
499 | // wxSizer and friends use this to give a chance to a component to recalc |
500 | // its min size once one of the final size components is known. Override | |
501 | // this function when that is useful (such as for wxStaticText which can | |
502 | // stretch over several lines). Parameter availableOtherDir | |
503 | // tells the item how much more space there is available in the opposite | |
504 | // direction (-1 if unknown). | |
505 | virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) ) | |
506 | { return false; } | |
333d7052 | 507 | |
f03fc89f VZ |
508 | // window state |
509 | // ------------ | |
510 | ||
d4864e97 | 511 | // returns true if window was shown/hidden, false if the nothing was |
f03fc89f | 512 | // done (window was already shown/hidden) |
d4864e97 VZ |
513 | virtual bool Show( bool show = true ); |
514 | bool Hide() { return Show(false); } | |
f03fc89f | 515 | |
376d7d97 VZ |
516 | // show or hide the window with a special effect, not implemented on |
517 | // most platforms (where it is the same as Show()/Hide() respectively) | |
518 | // | |
519 | // timeout specifies how long the animation should take, in ms, the | |
520 | // default value of 0 means to use the default (system-dependent) value | |
521 | // | |
522 | // direction is only used with wxSHOW_EFFECT_ROLL and SLIDE values | |
523 | virtual bool ShowWithEffect(wxShowEffect effect, | |
524 | unsigned timeout = 0, | |
525 | wxDirection dir = wxBOTTOM) | |
526 | { | |
527 | wxUnusedVar(effect); | |
528 | wxUnusedVar(timeout); | |
529 | wxUnusedVar(dir); | |
530 | ||
531 | return Show(); | |
532 | } | |
533 | ||
534 | virtual bool HideWithEffect(wxShowEffect effect, | |
535 | unsigned timeout = 0, | |
536 | wxDirection dir = wxBOTTOM) | |
537 | { | |
538 | wxUnusedVar(effect); | |
539 | wxUnusedVar(timeout); | |
540 | wxUnusedVar(dir); | |
541 | ||
542 | return Hide(); | |
543 | } | |
544 | ||
d4864e97 VZ |
545 | // returns true if window was enabled/disabled, false if nothing done |
546 | virtual bool Enable( bool enable = true ); | |
547 | bool Disable() { return Enable(false); } | |
f03fc89f | 548 | |
b08cd3bf | 549 | virtual bool IsShown() const { return m_isShown; } |
47a8a4d5 VZ |
550 | // returns true if the window is really enabled and false otherwise, |
551 | // whether because it had been explicitly disabled itself or because | |
552 | // its parent is currently disabled -- then this method returns false | |
553 | // whatever is the intrinsic state of this window, use IsThisEnabled(0 | |
554 | // to retrieve it. In other words, this relation always holds: | |
555 | // | |
556 | // IsEnabled() == IsThisEnabled() && parent.IsEnabled() | |
557 | // | |
558 | bool IsEnabled() const; | |
559 | ||
560 | // returns the internal window state independently of the parent(s) | |
561 | // state, i.e. the state in which the window would be if all its | |
562 | // parents were enabled (use IsEnabled() above to get the effective | |
563 | // window state) | |
564 | bool IsThisEnabled() const { return m_isEnabled; } | |
f03fc89f | 565 | |
9c72cf76 VS |
566 | // returns true if the window is visible, i.e. IsShown() returns true |
567 | // if called on it and all its parents up to the first TLW | |
865a74c7 | 568 | virtual bool IsShownOnScreen() const; |
9c72cf76 | 569 | |
f03fc89f VZ |
570 | // get/set window style (setting style won't update the window and so |
571 | // is only useful for internal usage) | |
572 | virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; } | |
573 | virtual long GetWindowStyleFlag() const { return m_windowStyle; } | |
574 | ||
575 | // just some (somewhat shorter) synonims | |
576 | void SetWindowStyle( long style ) { SetWindowStyleFlag(style); } | |
577 | long GetWindowStyle() const { return GetWindowStyleFlag(); } | |
578 | ||
d63312a9 | 579 | // check if the flag is set |
f03fc89f | 580 | bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; } |
d80cd92a | 581 | virtual bool IsRetained() const { return HasFlag(wxRETAINED); } |
f03fc89f | 582 | |
d63312a9 VZ |
583 | // turn the flag on if it had been turned off before and vice versa, |
584 | // return true if the flag is currently turned on | |
585 | bool ToggleWindowStyle(int flag); | |
586 | ||
d80cd92a VZ |
587 | // extra style: the less often used style bits which can't be set with |
588 | // SetWindowStyleFlag() | |
b2d5a7ee | 589 | virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; } |
d80cd92a | 590 | long GetExtraStyle() const { return m_exStyle; } |
f03fc89f | 591 | |
a2979ead VZ |
592 | bool HasExtraStyle(int exFlag) const { return (m_exStyle & exFlag) != 0; } |
593 | ||
f03fc89f | 594 | // make the window modal (all other windows unresponsive) |
d4864e97 | 595 | virtual void MakeModal(bool modal = true); |
f03fc89f | 596 | |
b8e7b673 VZ |
597 | |
598 | // (primitive) theming support | |
599 | // --------------------------- | |
600 | ||
a2d93e73 JS |
601 | virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } |
602 | virtual bool GetThemeEnabled() const { return m_themeEnabled; } | |
603 | ||
d4864e97 | 604 | |
456bc6d9 VZ |
605 | // focus and keyboard handling |
606 | // --------------------------- | |
f03fc89f VZ |
607 | |
608 | // set focus to this window | |
609 | virtual void SetFocus() = 0; | |
610 | ||
d577d610 VZ |
611 | // set focus to this window as the result of a keyboard action |
612 | virtual void SetFocusFromKbd() { SetFocus(); } | |
613 | ||
f03fc89f | 614 | // return the window which currently has the focus or NULL |
0fe02759 | 615 | static wxWindow *FindFocus(); |
6fb99eb3 | 616 | |
0fe02759 | 617 | static wxWindow *DoFindFocus() /* = 0: implement in derived classes */; |
f03fc89f | 618 | |
ad02525d VZ |
619 | // can this window have focus in principle? |
620 | // | |
621 | // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus | |
622 | // [FromKeyboard]() is that the former functions are meant to be | |
623 | // overridden in the derived classes to simply return false if the | |
624 | // control can't have focus, while the latter are meant to be used by | |
625 | // this class clients and take into account the current window state | |
626 | virtual bool AcceptsFocus() const { return true; } | |
627 | ||
edc09871 VZ |
628 | // can this window or one of its children accept focus? |
629 | // | |
630 | // usually it's the same as AcceptsFocus() but is overridden for | |
631 | // container windows | |
632 | virtual bool AcceptsFocusRecursively() const { return AcceptsFocus(); } | |
f03fc89f | 633 | |
1e6feb95 VZ |
634 | // can this window be given focus by keyboard navigation? if not, the |
635 | // only way to give it focus (provided it accepts it at all) is to | |
636 | // click it | |
637 | virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); } | |
638 | ||
edc09871 VZ |
639 | |
640 | // this is mostly a helper for the various functions using it below | |
641 | bool CanBeFocused() const { return IsShown() && IsEnabled(); } | |
642 | ||
643 | // can this window itself have focus? | |
644 | bool IsFocusable() const { return AcceptsFocus() && CanBeFocused(); } | |
645 | ||
646 | // can this window have focus right now? | |
647 | // | |
648 | // if this method returns true, it means that calling SetFocus() will | |
649 | // put focus either to this window or one of its children, if you need | |
650 | // to know whether this window accepts focus itself, use IsFocusable() | |
651 | bool CanAcceptFocus() const | |
652 | { return AcceptsFocusRecursively() && CanBeFocused(); } | |
653 | ||
ad02525d VZ |
654 | // can this window be assigned focus from keyboard right now? |
655 | bool CanAcceptFocusFromKeyboard() const | |
edc09871 | 656 | { return AcceptsFocusFromKeyboard() && CanBeFocused(); } |
ad02525d | 657 | |
80332672 VZ |
658 | // call this when the return value of AcceptsFocus() changes |
659 | virtual void SetCanFocus(bool WXUNUSED(canFocus)) { } | |
660 | ||
5644933f VZ |
661 | // navigates inside this window |
662 | bool NavigateIn(int flags = wxNavigationKeyEvent::IsForward) | |
663 | { return DoNavigateIn(flags); } | |
664 | ||
665 | // navigates in the specified direction from this window, this is | |
666 | // equivalent to GetParent()->NavigateIn() | |
667 | bool Navigate(int flags = wxNavigationKeyEvent::IsForward) | |
668 | { return m_parent && ((wxWindowBase *)m_parent)->DoNavigateIn(flags); } | |
5f6cfda7 | 669 | |
a24de76b VZ |
670 | // move this window just before/after the specified one in tab order |
671 | // (the other window must be our sibling!) | |
672 | void MoveBeforeInTabOrder(wxWindow *win) | |
c944775f | 673 | { DoMoveInTabOrder(win, OrderBefore); } |
a24de76b | 674 | void MoveAfterInTabOrder(wxWindow *win) |
c944775f | 675 | { DoMoveInTabOrder(win, OrderAfter); } |
a24de76b VZ |
676 | |
677 | ||
f03fc89f VZ |
678 | // parent/children relations |
679 | // ------------------------- | |
680 | ||
681 | // get the list of children | |
682 | const wxWindowList& GetChildren() const { return m_children; } | |
683 | wxWindowList& GetChildren() { return m_children; } | |
684 | ||
1978421a SC |
685 | // needed just for extended runtime |
686 | const wxWindowList& GetWindowChildren() const { return GetChildren() ; } | |
687 | ||
c944775f VZ |
688 | // get the window before/after this one in the parents children list, |
689 | // returns NULL if this is the first/last window | |
690 | wxWindow *GetPrevSibling() const { return DoGetSibling(OrderBefore); } | |
691 | wxWindow *GetNextSibling() const { return DoGetSibling(OrderAfter); } | |
692 | ||
f03fc89f VZ |
693 | // get the parent or the parent of the parent |
694 | wxWindow *GetParent() const { return m_parent; } | |
695 | inline wxWindow *GetGrandParent() const; | |
696 | ||
697 | // is this window a top level one? | |
8487f887 | 698 | virtual bool IsTopLevel() const; |
f03fc89f | 699 | |
87b6002d | 700 | // it doesn't really change parent, use Reparent() instead |
f03fc89f | 701 | void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; } |
d4864e97 VZ |
702 | // change the real parent of this window, return true if the parent |
703 | // was changed, false otherwise (error or newParent == oldParent) | |
f03fc89f VZ |
704 | virtual bool Reparent( wxWindowBase *newParent ); |
705 | ||
146ba0fe VZ |
706 | // implementation mostly |
707 | virtual void AddChild( wxWindowBase *child ); | |
708 | virtual void RemoveChild( wxWindowBase *child ); | |
709 | ||
049908c5 VS |
710 | // returns true if the child is in the client area of the window, i.e. is |
711 | // not scrollbar, toolbar etc. | |
712 | virtual bool IsClientAreaChild(const wxWindow *WXUNUSED(child)) const | |
713 | { return true; } | |
714 | ||
146ba0fe VZ |
715 | // looking for windows |
716 | // ------------------- | |
717 | ||
f03fc89f VZ |
718 | // find window among the descendants of this one either by id or by |
719 | // name (return NULL if not found) | |
6b73af79 VZ |
720 | wxWindow *FindWindow(long winid) const; |
721 | wxWindow *FindWindow(const wxString& name) const; | |
f03fc89f | 722 | |
146ba0fe | 723 | // Find a window among any window (all return NULL if not found) |
d9e2e4c2 | 724 | static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL ); |
146ba0fe VZ |
725 | static wxWindow *FindWindowByName( const wxString& name, |
726 | const wxWindow *parent = NULL ); | |
727 | static wxWindow *FindWindowByLabel( const wxString& label, | |
728 | const wxWindow *parent = NULL ); | |
f03fc89f VZ |
729 | |
730 | // event handler stuff | |
731 | // ------------------- | |
732 | ||
733 | // get the current event handler | |
734 | wxEvtHandler *GetEventHandler() const { return m_eventHandler; } | |
735 | ||
736 | // replace the event handler (allows to completely subclass the | |
737 | // window) | |
738 | void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; } | |
739 | ||
740 | // push/pop event handler: allows to chain a custom event handler to | |
741 | // alreasy existing ones | |
742 | void PushEventHandler( wxEvtHandler *handler ); | |
d4864e97 | 743 | wxEvtHandler *PopEventHandler( bool deleteHandler = false ); |
f03fc89f | 744 | |
2e36d5cf | 745 | // find the given handler in the event handler chain and remove (but |
d4864e97 VZ |
746 | // not delete) it from the event handler chain, return true if it was |
747 | // found and false otherwise (this also results in an assert failure so | |
2e36d5cf VZ |
748 | // this function should only be called when the handler is supposed to |
749 | // be there) | |
750 | bool RemoveEventHandler(wxEvtHandler *handler); | |
751 | ||
937013e0 VS |
752 | // Process an event by calling GetEventHandler()->ProcessEvent() and |
753 | // handling any exceptions thrown by event handlers. It's mostly useful | |
754 | // when processing wx events when called from C code (e.g. in GTK+ | |
755 | // callback) when the exception wouldn't correctly propagate to | |
756 | // wxEventLoop. | |
757 | bool HandleWindowEvent(wxEvent& event) const; | |
758 | ||
1e6feb95 VZ |
759 | // validators |
760 | // ---------- | |
f03fc89f | 761 | |
88ac883a | 762 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
763 | // a window may have an associated validator which is used to control |
764 | // user input | |
765 | virtual void SetValidator( const wxValidator &validator ); | |
766 | virtual wxValidator *GetValidator() { return m_windowValidator; } | |
88ac883a | 767 | #endif // wxUSE_VALIDATORS |
f03fc89f | 768 | |
f03fc89f VZ |
769 | |
770 | // dialog oriented functions | |
771 | // ------------------------- | |
772 | ||
d4864e97 | 773 | // validate the correctness of input, return true if ok |
f03fc89f VZ |
774 | virtual bool Validate(); |
775 | ||
776 | // transfer data between internal and GUI representations | |
777 | virtual bool TransferDataToWindow(); | |
778 | virtual bool TransferDataFromWindow(); | |
779 | ||
780 | virtual void InitDialog(); | |
781 | ||
88ac883a | 782 | #if wxUSE_ACCEL |
f03fc89f VZ |
783 | // accelerators |
784 | // ------------ | |
785 | virtual void SetAcceleratorTable( const wxAcceleratorTable& accel ) | |
786 | { m_acceleratorTable = accel; } | |
787 | wxAcceleratorTable *GetAcceleratorTable() | |
788 | { return &m_acceleratorTable; } | |
5048c832 | 789 | |
540b6b09 VZ |
790 | #endif // wxUSE_ACCEL |
791 | ||
792 | #if wxUSE_HOTKEY | |
793 | // hot keys (system wide accelerators) | |
794 | // ----------------------------------- | |
795 | ||
796 | virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode); | |
5048c832 | 797 | virtual bool UnregisterHotKey(int hotkeyId); |
540b6b09 | 798 | #endif // wxUSE_HOTKEY |
5048c832 | 799 | |
f03fc89f VZ |
800 | |
801 | // dialog units translations | |
802 | // ------------------------- | |
803 | ||
804 | wxPoint ConvertPixelsToDialog( const wxPoint& pt ); | |
805 | wxPoint ConvertDialogToPixels( const wxPoint& pt ); | |
806 | wxSize ConvertPixelsToDialog( const wxSize& sz ) | |
807 | { | |
808 | wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); | |
809 | ||
810 | return wxSize(pt.x, pt.y); | |
811 | } | |
812 | ||
813 | wxSize ConvertDialogToPixels( const wxSize& sz ) | |
814 | { | |
815 | wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); | |
816 | ||
817 | return wxSize(pt.x, pt.y); | |
818 | } | |
819 | ||
820 | // mouse functions | |
821 | // --------------- | |
822 | ||
823 | // move the mouse to the specified position | |
824 | virtual void WarpPointer(int x, int y) = 0; | |
825 | ||
94633ad9 VZ |
826 | // start or end mouse capture, these functions maintain the stack of |
827 | // windows having captured the mouse and after calling ReleaseMouse() | |
828 | // the mouse is not released but returns to the window which had had | |
829 | // captured it previously (if any) | |
830 | void CaptureMouse(); | |
831 | void ReleaseMouse(); | |
f03fc89f | 832 | |
1e6feb95 VZ |
833 | // get the window which currently captures the mouse or NULL |
834 | static wxWindow *GetCapture(); | |
835 | ||
836 | // does this window have the capture? | |
837 | virtual bool HasCapture() const | |
838 | { return (wxWindow *)this == GetCapture(); } | |
839 | ||
f03fc89f VZ |
840 | // painting the window |
841 | // ------------------- | |
842 | ||
843 | // mark the specified rectangle (or the whole window) as "dirty" so it | |
844 | // will be repainted | |
d4864e97 | 845 | virtual void Refresh( bool eraseBackground = true, |
f03fc89f | 846 | const wxRect *rect = (const wxRect *) NULL ) = 0; |
1e6feb95 VZ |
847 | |
848 | // a less awkward wrapper for Refresh | |
8cfa09bd VZ |
849 | void RefreshRect(const wxRect& rect, bool eraseBackground = true) |
850 | { | |
851 | Refresh(eraseBackground, &rect); | |
852 | } | |
1e6feb95 VZ |
853 | |
854 | // repaint all invalid areas of the window immediately | |
855 | virtual void Update() { } | |
856 | ||
5da0803c VZ |
857 | // clear the window background |
858 | virtual void ClearBackground(); | |
f03fc89f | 859 | |
0cc7251e VZ |
860 | // freeze the window: don't redraw it until it is thawed |
861 | virtual void Freeze() { } | |
862 | ||
863 | // thaw the window: redraw it after it had been frozen | |
864 | virtual void Thaw() { } | |
865 | ||
d4a1433f VZ |
866 | // return true if window had been frozen and not unthawed yet |
867 | virtual bool IsFrozen() const { return false; } | |
868 | ||
f03fc89f | 869 | // adjust DC for drawing on this window |
f6147cfc | 870 | virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { } |
f03fc89f | 871 | |
2e992e06 VZ |
872 | // return true if the window contents is double buffered by the system |
873 | virtual bool IsDoubleBuffered() const { return false; } | |
874 | ||
f03fc89f VZ |
875 | // the update region of the window contains the areas which must be |
876 | // repainted by the program | |
877 | const wxRegion& GetUpdateRegion() const { return m_updateRegion; } | |
878 | wxRegion& GetUpdateRegion() { return m_updateRegion; } | |
879 | ||
1e6feb95 VZ |
880 | // get the update rectangleregion bounding box in client coords |
881 | wxRect GetUpdateClientRect() const; | |
882 | ||
f03fc89f VZ |
883 | // these functions verify whether the given point/rectangle belongs to |
884 | // (or at least intersects with) the update region | |
657b4fd4 RD |
885 | virtual bool DoIsExposed( int x, int y ) const; |
886 | virtual bool DoIsExposed( int x, int y, int w, int h ) const; | |
f03fc89f | 887 | |
657b4fd4 RD |
888 | bool IsExposed( int x, int y ) const |
889 | { return DoIsExposed(x, y); } | |
890 | bool IsExposed( int x, int y, int w, int h ) const | |
891 | { return DoIsExposed(x, y, w, h); } | |
f03fc89f | 892 | bool IsExposed( const wxPoint& pt ) const |
657b4fd4 | 893 | { return DoIsExposed(pt.x, pt.y); } |
f03fc89f | 894 | bool IsExposed( const wxRect& rect ) const |
657b4fd4 | 895 | { return DoIsExposed(rect.x, rect.y, rect.width, rect.height); } |
f03fc89f VZ |
896 | |
897 | // colours, fonts and cursors | |
898 | // -------------------------- | |
899 | ||
1b69c815 VZ |
900 | // get the default attributes for the controls of this class: we |
901 | // provide a virtual function which can be used to query the default | |
902 | // attributes of an existing control and a static function which can | |
903 | // be used even when no existing object of the given class is | |
904 | // available, but which won't return any styles specific to this | |
905 | // particular control, of course (e.g. "Ok" button might have | |
906 | // different -- bold for example -- font) | |
907 | virtual wxVisualAttributes GetDefaultAttributes() const | |
908 | { | |
909 | return GetClassDefaultAttributes(GetWindowVariant()); | |
910 | } | |
911 | ||
912 | static wxVisualAttributes | |
913 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); | |
914 | ||
f03fc89f | 915 | // set/retrieve the window colours (system defaults are used by |
b8e7b673 | 916 | // default): SetXXX() functions return true if colour was changed, |
f8ff87ed VS |
917 | // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the |
918 | // value to prevent it from being inherited by our children | |
b8e7b673 | 919 | virtual bool SetBackgroundColour(const wxColour& colour); |
fa47d7a7 | 920 | void SetOwnBackgroundColour(const wxColour& colour) |
b8e7b673 VZ |
921 | { |
922 | if ( SetBackgroundColour(colour) ) | |
f8ff87ed | 923 | m_inheritBgCol = false; |
b8e7b673 | 924 | } |
1b69c815 | 925 | wxColour GetBackgroundColour() const; |
e5ecf1fc WS |
926 | bool InheritsBackgroundColour() const |
927 | { | |
928 | return m_inheritBgCol; | |
929 | } | |
930 | bool UseBgCol() const | |
931 | { | |
932 | return m_hasBgCol; | |
933 | } | |
b8e7b673 VZ |
934 | |
935 | virtual bool SetForegroundColour(const wxColour& colour); | |
fa47d7a7 | 936 | void SetOwnForegroundColour(const wxColour& colour) |
b8e7b673 VZ |
937 | { |
938 | if ( SetForegroundColour(colour) ) | |
f8ff87ed | 939 | m_inheritFgCol = false; |
b8e7b673 | 940 | } |
1b69c815 | 941 | wxColour GetForegroundColour() const; |
f03fc89f | 942 | |
50c53860 JS |
943 | // Set/get the background style. |
944 | // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM | |
945 | virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; } | |
946 | virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; } | |
947 | ||
7c7a653b VZ |
948 | // returns true if the control has "transparent" areas such as a |
949 | // wxStaticText and wxCheckBox and the background should be adapted | |
950 | // from a parent window | |
951 | virtual bool HasTransparentBackground() { return false; } | |
952 | ||
b8e7b673 VZ |
953 | // set/retrieve the font for the window (SetFont() returns true if the |
954 | // font really changed) | |
955 | virtual bool SetFont(const wxFont& font) = 0; | |
fa47d7a7 | 956 | void SetOwnFont(const wxFont& font) |
b8e7b673 VZ |
957 | { |
958 | if ( SetFont(font) ) | |
f8ff87ed | 959 | m_inheritFont = false; |
b8e7b673 | 960 | } |
29094af0 | 961 | wxFont GetFont() const; |
b8e7b673 | 962 | |
d4864e97 | 963 | // set/retrieve the cursor for this window (SetCursor() returns true |
f03fc89f VZ |
964 | // if the cursor was really changed) |
965 | virtual bool SetCursor( const wxCursor &cursor ); | |
966 | const wxCursor& GetCursor() const { return m_cursor; } | |
f03fc89f | 967 | |
789295bf VZ |
968 | #if wxUSE_CARET |
969 | // associate a caret with the window | |
970 | void SetCaret(wxCaret *caret); | |
971 | // get the current caret (may be NULL) | |
972 | wxCaret *GetCaret() const { return m_caret; } | |
973 | #endif // wxUSE_CARET | |
974 | ||
f03fc89f VZ |
975 | // get the (average) character size for the current font |
976 | virtual int GetCharHeight() const = 0; | |
977 | virtual int GetCharWidth() const = 0; | |
978 | ||
979 | // get the width/height/... of the text using current or specified | |
980 | // font | |
981 | virtual void GetTextExtent(const wxString& string, | |
982 | int *x, int *y, | |
983 | int *descent = (int *) NULL, | |
984 | int *externalLeading = (int *) NULL, | |
985 | const wxFont *theFont = (const wxFont *) NULL) | |
986 | const = 0; | |
987 | ||
6b062263 VZ |
988 | wxSize GetTextExtent(const wxString& string) const |
989 | { | |
990 | wxCoord w, h; | |
991 | GetTextExtent(string, &w, &h); | |
992 | return wxSize(w, h); | |
993 | } | |
994 | ||
1e6feb95 VZ |
995 | // client <-> screen coords |
996 | // ------------------------ | |
997 | ||
f03fc89f | 998 | // translate to/from screen/client coordinates (pointers may be NULL) |
dabc0cd5 VZ |
999 | void ClientToScreen( int *x, int *y ) const |
1000 | { DoClientToScreen(x, y); } | |
1001 | void ScreenToClient( int *x, int *y ) const | |
1002 | { DoScreenToClient(x, y); } | |
1e6feb95 VZ |
1003 | |
1004 | // wxPoint interface to do the same thing | |
dabc0cd5 VZ |
1005 | wxPoint ClientToScreen(const wxPoint& pt) const |
1006 | { | |
1007 | int x = pt.x, y = pt.y; | |
1008 | DoClientToScreen(&x, &y); | |
1009 | ||
1010 | return wxPoint(x, y); | |
1011 | } | |
1012 | ||
1013 | wxPoint ScreenToClient(const wxPoint& pt) const | |
1014 | { | |
1015 | int x = pt.x, y = pt.y; | |
1016 | DoScreenToClient(&x, &y); | |
1017 | ||
1018 | return wxPoint(x, y); | |
1019 | } | |
f03fc89f | 1020 | |
1e6feb95 VZ |
1021 | // test where the given (in client coords) point lies |
1022 | wxHitTest HitTest(wxCoord x, wxCoord y) const | |
1023 | { return DoHitTest(x, y); } | |
1024 | ||
1025 | wxHitTest HitTest(const wxPoint& pt) const | |
1026 | { return DoHitTest(pt.x, pt.y); } | |
1027 | ||
f03fc89f VZ |
1028 | // misc |
1029 | // ---- | |
1030 | ||
aede4ebb VZ |
1031 | // get the window border style from the given flags: this is different from |
1032 | // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to | |
1033 | // translate wxBORDER_DEFAULT to something reasonable | |
1034 | wxBorder GetBorder(long flags) const; | |
1035 | ||
1036 | // get border for the flags of this window | |
1037 | wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } | |
1e6feb95 | 1038 | |
d4864e97 | 1039 | // send wxUpdateUIEvents to this window, and children if recurse is true |
e39af974 JS |
1040 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); |
1041 | ||
1042 | // do the window-specific processing after processing the update event | |
1043 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
f03fc89f | 1044 | |
1e6feb95 | 1045 | #if wxUSE_MENUS |
00a77b7c VZ |
1046 | // show popup menu at the given position, generate events for the items |
1047 | // selected in it | |
45b8a256 | 1048 | bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition) |
a1665b22 | 1049 | { return DoPopupMenu(menu, pos.x, pos.y); } |
971562cb | 1050 | bool PopupMenu(wxMenu *menu, int x, int y) |
a1665b22 | 1051 | { return DoPopupMenu(menu, x, y); } |
00a77b7c VZ |
1052 | |
1053 | // simply return the id of the selected item or wxID_NONE without | |
1054 | // generating any events | |
1055 | int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos) | |
1056 | { return DoGetPopupMenuSelectionFromUser(menu, pos.x, pos.y); } | |
1057 | int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y) | |
1058 | { return DoGetPopupMenuSelectionFromUser(menu, x, y); } | |
1e6feb95 | 1059 | #endif // wxUSE_MENUS |
f03fc89f | 1060 | |
e71c530e VZ |
1061 | // override this method to return true for controls having multiple pages |
1062 | virtual bool HasMultiplePages() const { return false; } | |
1063 | ||
1064 | ||
f03fc89f VZ |
1065 | // scrollbars |
1066 | // ---------- | |
1067 | ||
1e6feb95 VZ |
1068 | // does the window have the scrollbar for this orientation? |
1069 | bool HasScrollbar(int orient) const | |
1070 | { | |
1071 | return (m_windowStyle & | |
1072 | (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0; | |
1073 | } | |
1074 | ||
f03fc89f VZ |
1075 | // configure the window scrollbars |
1076 | virtual void SetScrollbar( int orient, | |
1077 | int pos, | |
1e6feb95 | 1078 | int thumbvisible, |
f03fc89f | 1079 | int range, |
d4864e97 VZ |
1080 | bool refresh = true ) = 0; |
1081 | virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0; | |
f03fc89f VZ |
1082 | virtual int GetScrollPos( int orient ) const = 0; |
1083 | virtual int GetScrollThumb( int orient ) const = 0; | |
1084 | virtual int GetScrollRange( int orient ) const = 0; | |
1085 | ||
1086 | // scroll window to the specified position | |
1087 | virtual void ScrollWindow( int dx, int dy, | |
1088 | const wxRect* rect = (wxRect *) NULL ) = 0; | |
1089 | ||
b9b3393e | 1090 | // scrolls window by line/page: note that not all controls support this |
9cd6d737 | 1091 | // |
d4864e97 VZ |
1092 | // return true if the position changed, false otherwise |
1093 | virtual bool ScrollLines(int WXUNUSED(lines)) { return false; } | |
1094 | virtual bool ScrollPages(int WXUNUSED(pages)) { return false; } | |
9cd6d737 VZ |
1095 | |
1096 | // convenient wrappers for ScrollLines/Pages | |
1097 | bool LineUp() { return ScrollLines(-1); } | |
1098 | bool LineDown() { return ScrollLines(1); } | |
1099 | bool PageUp() { return ScrollPages(-1); } | |
1100 | bool PageDown() { return ScrollPages(1); } | |
b9b3393e | 1101 | |
c1142003 VZ |
1102 | // call this to always show one or both scrollbars, even if the window |
1103 | // is big enough to not require them | |
1104 | virtual void AlwaysShowScrollbars(bool WXUNUSED(horz) = true, | |
1105 | bool WXUNUSED(vert) = true) | |
1106 | { | |
1107 | } | |
1108 | ||
1109 | // return true if AlwaysShowScrollbars() had been called before for the | |
1110 | // corresponding orientation | |
1111 | virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient)) const | |
1112 | { | |
1113 | return false; | |
1114 | } | |
1115 | ||
bd83cb56 VZ |
1116 | // context-sensitive help |
1117 | // ---------------------- | |
1118 | ||
1119 | // these are the convenience functions wrapping wxHelpProvider methods | |
1120 | ||
1121 | #if wxUSE_HELP | |
1122 | // associate this help text with this window | |
1123 | void SetHelpText(const wxString& text); | |
1124 | // associate this help text with all windows with the same id as this | |
1125 | // one | |
1126 | void SetHelpTextForId(const wxString& text); | |
dc6588e7 VZ |
1127 | // get the help string associated with the given position in this window |
1128 | // | |
1129 | // notice that pt may be invalid if event origin is keyboard or unknown | |
1130 | // and this method should return the global window help text then | |
1131 | virtual wxString GetHelpTextAtPoint(const wxPoint& pt, | |
1132 | wxHelpEvent::Origin origin) const; | |
1133 | // returns the position-independent help text | |
1134 | wxString GetHelpText() const | |
1135 | { | |
1136 | return GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Unknown); | |
1137 | } | |
1138 | ||
1139 | #else // !wxUSE_HELP | |
6c3c55cf VZ |
1140 | // silently ignore SetHelpText() calls |
1141 | void SetHelpText(const wxString& WXUNUSED(text)) { } | |
1142 | void SetHelpTextForId(const wxString& WXUNUSED(text)) { } | |
bd83cb56 VZ |
1143 | #endif // wxUSE_HELP |
1144 | ||
f03fc89f VZ |
1145 | // tooltips |
1146 | // -------- | |
bd83cb56 | 1147 | |
f03fc89f VZ |
1148 | #if wxUSE_TOOLTIPS |
1149 | // the easiest way to set a tooltip for a window is to use this method | |
1150 | void SetToolTip( const wxString &tip ); | |
1151 | // attach a tooltip to the window | |
1152 | void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); } | |
1153 | // get the associated tooltip or NULL if none | |
1154 | wxToolTip* GetToolTip() const { return m_tooltip; } | |
311a173b | 1155 | wxString GetToolTipText() const ; |
7649d8fc JS |
1156 | #else |
1157 | // make it much easier to compile apps in an environment | |
1158 | // that doesn't support tooltips, such as PocketPC | |
1159 | inline void SetToolTip( const wxString & WXUNUSED(tip) ) {} | |
f03fc89f VZ |
1160 | #endif // wxUSE_TOOLTIPS |
1161 | ||
1162 | // drag and drop | |
1163 | // ------------- | |
1164 | #if wxUSE_DRAG_AND_DROP | |
1165 | // set/retrieve the drop target associated with this window (may be | |
1166 | // NULL; it's owned by the window and will be deleted by it) | |
1167 | virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0; | |
1168 | virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; } | |
1169 | #endif // wxUSE_DRAG_AND_DROP | |
1170 | ||
1171 | // constraints and sizers | |
1172 | // ---------------------- | |
1173 | #if wxUSE_CONSTRAINTS | |
1174 | // set the constraints for this window or retrieve them (may be NULL) | |
1175 | void SetConstraints( wxLayoutConstraints *constraints ); | |
1176 | wxLayoutConstraints *GetConstraints() const { return m_constraints; } | |
1177 | ||
f03fc89f VZ |
1178 | // implementation only |
1179 | void UnsetConstraints(wxLayoutConstraints *c); | |
1180 | wxWindowList *GetConstraintsInvolvedIn() const | |
1181 | { return m_constraintsInvolvedIn; } | |
1182 | void AddConstraintReference(wxWindowBase *otherWin); | |
1183 | void RemoveConstraintReference(wxWindowBase *otherWin); | |
1184 | void DeleteRelatedConstraints(); | |
1185 | void ResetConstraints(); | |
1186 | ||
90e572f1 | 1187 | // these methods may be overridden for special layout algorithms |
d4864e97 | 1188 | virtual void SetConstraintSizes(bool recurse = true); |
f03fc89f VZ |
1189 | virtual bool LayoutPhase1(int *noChanges); |
1190 | virtual bool LayoutPhase2(int *noChanges); | |
4b7f2165 | 1191 | virtual bool DoPhase(int phase); |
f03fc89f VZ |
1192 | |
1193 | // these methods are virtual but normally won't be overridden | |
f03fc89f VZ |
1194 | virtual void SetSizeConstraint(int x, int y, int w, int h); |
1195 | virtual void MoveConstraint(int x, int y); | |
1196 | virtual void GetSizeConstraint(int *w, int *h) const ; | |
1197 | virtual void GetClientSizeConstraint(int *w, int *h) const ; | |
1198 | virtual void GetPositionConstraint(int *x, int *y) const ; | |
1199 | ||
461e93f9 JS |
1200 | #endif // wxUSE_CONSTRAINTS |
1201 | ||
1202 | // when using constraints or sizers, it makes sense to update | |
1203 | // children positions automatically whenever the window is resized | |
1204 | // - this is done if autoLayout is on | |
1205 | void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; } | |
1206 | bool GetAutoLayout() const { return m_autoLayout; } | |
1207 | ||
1208 | // lay out the window and its children | |
1209 | virtual bool Layout(); | |
1210 | ||
f03fc89f | 1211 | // sizers |
d4864e97 VZ |
1212 | void SetSizer(wxSizer *sizer, bool deleteOld = true ); |
1213 | void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ); | |
566d84a7 | 1214 | |
f03fc89f | 1215 | wxSizer *GetSizer() const { return m_windowSizer; } |
be90c029 RD |
1216 | |
1217 | // Track if this window is a member of a sizer | |
1ebfafde | 1218 | void SetContainingSizer(wxSizer* sizer); |
be90c029 RD |
1219 | wxSizer *GetContainingSizer() const { return m_containingSizer; } |
1220 | ||
45a959a3 JS |
1221 | // accessibility |
1222 | // ---------------------- | |
1223 | #if wxUSE_ACCESSIBILITY | |
1224 | // Override to create a specific accessible object. | |
1225 | virtual wxAccessible* CreateAccessible(); | |
1226 | ||
1227 | // Sets the accessible object. | |
1228 | void SetAccessible(wxAccessible* accessible) ; | |
1229 | ||
1230 | // Returns the accessible object. | |
47b378bd | 1231 | wxAccessible* GetAccessible() { return m_accessible; } |
45a959a3 JS |
1232 | |
1233 | // Returns the accessible object, creating if necessary. | |
1234 | wxAccessible* GetOrCreateAccessible() ; | |
1235 | #endif | |
1236 | ||
b137e493 | 1237 | |
b58d5e2d RD |
1238 | // Set window transparency if the platform supports it |
1239 | virtual bool SetTransparent(wxByte WXUNUSED(alpha)) { return false; } | |
1240 | virtual bool CanSetTransparent() { return false; } | |
1241 | ||
1242 | ||
f03fc89f VZ |
1243 | // implementation |
1244 | // -------------- | |
1245 | ||
1246 | // event handlers | |
1247 | void OnSysColourChanged( wxSysColourChangedEvent& event ); | |
1248 | void OnInitDialog( wxInitDialogEvent &event ); | |
72fc5caf | 1249 | void OnMiddleClick( wxMouseEvent& event ); |
bd83cb56 VZ |
1250 | #if wxUSE_HELP |
1251 | void OnHelp(wxHelpEvent& event); | |
1252 | #endif // wxUSE_HELP | |
f03fc89f | 1253 | |
e39af974 JS |
1254 | // virtual function for implementing internal idle |
1255 | // behaviour | |
1256 | virtual void OnInternalIdle() {} | |
1257 | ||
1258 | // call internal idle recursively | |
5109ae5d | 1259 | // void ProcessInternalIdle() ; |
e39af974 JS |
1260 | |
1261 | // get the handle of the window for the underlying window system: this | |
d7c24517 VZ |
1262 | // is only used for wxWin itself or for user code which wants to call |
1263 | // platform-specific APIs | |
d22699b5 | 1264 | virtual WXWidget GetHandle() const = 0; |
ed4780ea VZ |
1265 | // associate the window with a new native handle |
1266 | virtual void AssociateHandle(WXWidget WXUNUSED(handle)) { } | |
1267 | // dissociate the current native handle from the window | |
1268 | virtual void DissociateHandle() { } | |
cc2b7472 | 1269 | |
574c939e KB |
1270 | #if wxUSE_PALETTE |
1271 | // Store the palette used by DCs in wxWindow so that the dcs can share | |
1272 | // a palette. And we can respond to palette messages. | |
1273 | wxPalette GetPalette() const { return m_palette; } | |
b95edd47 | 1274 | |
574c939e KB |
1275 | // When palette is changed tell the DC to set the system palette to the |
1276 | // new one. | |
b95edd47 VZ |
1277 | void SetPalette(const wxPalette& pal); |
1278 | ||
1279 | // return true if we have a specific palette | |
1280 | bool HasCustomPalette() const { return m_hasCustomPalette; } | |
1281 | ||
1282 | // return the first parent window with a custom palette or NULL | |
1283 | wxWindow *GetAncestorWithCustomPalette() const; | |
574c939e KB |
1284 | #endif // wxUSE_PALETTE |
1285 | ||
b8e7b673 VZ |
1286 | // inherit the parents visual attributes if they had been explicitly set |
1287 | // by the user (i.e. we don't inherit default attributes) and if we don't | |
1288 | // have our own explicitly set | |
1289 | virtual void InheritAttributes(); | |
1290 | ||
1291 | // returns false from here if this window doesn't want to inherit the | |
1292 | // parents colours even if InheritAttributes() would normally do it | |
1293 | // | |
1294 | // this just provides a simple way to customize InheritAttributes() | |
1295 | // behaviour in the most common case | |
1296 | virtual bool ShouldInheritColours() const { return false; } | |
1297 | ||
c04c7a3d VS |
1298 | // returns true if the window can be positioned outside of parent's client |
1299 | // area (normal windows can't, but e.g. menubar or statusbar can): | |
1300 | virtual bool CanBeOutsideClientArea() const { return false; } | |
1301 | ||
dc797d8e JS |
1302 | // returns true if the platform should explicitly apply a theme border. Currently |
1303 | // used only by Windows | |
a047aff2 JS |
1304 | virtual bool CanApplyThemeBorder() const { return true; } |
1305 | ||
245c5d2e RD |
1306 | protected: |
1307 | // event handling specific to wxWindow | |
1308 | virtual bool TryValidator(wxEvent& event); | |
1309 | virtual bool TryParent(wxEvent& event); | |
1310 | ||
c944775f | 1311 | enum WindowOrder |
a24de76b | 1312 | { |
c944775f VZ |
1313 | OrderBefore, // insert before the given window |
1314 | OrderAfter // insert after the given window | |
a24de76b | 1315 | }; |
c944775f VZ |
1316 | |
1317 | // common part of GetPrev/NextSibling() | |
1318 | wxWindow *DoGetSibling(WindowOrder order) const; | |
1319 | ||
1320 | // common part of MoveBefore/AfterInTabOrder() | |
1321 | virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move); | |
4caf847c | 1322 | |
5644933f VZ |
1323 | // implementation of Navigate() and NavigateIn() |
1324 | virtual bool DoNavigateIn(int flags); | |
1325 | ||
ec5bb70d VZ |
1326 | #if wxUSE_CONSTRAINTS |
1327 | // satisfy the constraints for the windows but don't set the window sizes | |
1328 | void SatisfyConstraints(); | |
1329 | #endif // wxUSE_CONSTRAINTS | |
566d84a7 | 1330 | |
7de59551 RD |
1331 | // Send the wxWindowDestroyEvent |
1332 | void SendDestroyEvent(); | |
1333 | ||
0fe02759 VS |
1334 | // returns the main window of composite control; this is the window |
1335 | // that FindFocus returns if the focus is in one of composite control's | |
1336 | // windows | |
6fb99eb3 | 1337 | virtual wxWindow *GetMainWindowOfCompositeControl() |
0fe02759 VS |
1338 | { return (wxWindow*)this; } |
1339 | ||
47a8a4d5 VZ |
1340 | // this method should be implemented to use operating system specific code |
1341 | // to really enable/disable the widget, it will only be called when we | |
1342 | // really need to enable/disable window and so no additional checks on the | |
1343 | // widgets state are necessary | |
1344 | virtual void DoEnable(bool WXUNUSED(enable)) { } | |
1345 | ||
1346 | // called when the on-screen widget state changes and provides an | |
1347 | // an opportunity for the widget to update its visual state (colours, | |
1348 | // fonts, anything else) as necessary | |
1349 | virtual void OnEnabled(bool WXUNUSED(enabled)) { } | |
1350 | ||
1351 | ||
7af6f327 | 1352 | // the window id - a number which uniquely identifies a window among |
a0d9c6cb | 1353 | // its siblings unless it is wxID_ANY |
f03fc89f | 1354 | wxWindowID m_windowId; |
456bc6d9 | 1355 | |
f03fc89f VZ |
1356 | // the parent window of this window (or NULL) and the list of the children |
1357 | // of this window | |
1358 | wxWindow *m_parent; | |
1359 | wxWindowList m_children; | |
1360 | ||
1361 | // the minimal allowed size for the window (no minimal size if variable(s) | |
a0d9c6cb | 1362 | // contain(s) wxDefaultCoord) |
ec5bb70d VZ |
1363 | int m_minWidth, |
1364 | m_minHeight, | |
1365 | m_maxWidth, | |
1366 | m_maxHeight; | |
f03fc89f VZ |
1367 | |
1368 | // event handler for this window: usually is just 'this' but may be | |
1369 | // changed with SetEventHandler() | |
1370 | wxEvtHandler *m_eventHandler; | |
1371 | ||
88ac883a | 1372 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
1373 | // associated validator or NULL if none |
1374 | wxValidator *m_windowValidator; | |
88ac883a | 1375 | #endif // wxUSE_VALIDATORS |
f03fc89f VZ |
1376 | |
1377 | #if wxUSE_DRAG_AND_DROP | |
1378 | wxDropTarget *m_dropTarget; | |
1379 | #endif // wxUSE_DRAG_AND_DROP | |
1380 | ||
1381 | // visual window attributes | |
1382 | wxCursor m_cursor; | |
1b69c815 VZ |
1383 | wxFont m_font; // see m_hasFont |
1384 | wxColour m_backgroundColour, // m_hasBgCol | |
1385 | m_foregroundColour; // m_hasFgCol | |
f03fc89f | 1386 | |
789295bf VZ |
1387 | #if wxUSE_CARET |
1388 | wxCaret *m_caret; | |
1389 | #endif // wxUSE_CARET | |
1390 | ||
f03fc89f VZ |
1391 | // the region which should be repainted in response to paint event |
1392 | wxRegion m_updateRegion; | |
1393 | ||
88ac883a | 1394 | #if wxUSE_ACCEL |
f03fc89f VZ |
1395 | // the accelerator table for the window which translates key strokes into |
1396 | // command events | |
1397 | wxAcceleratorTable m_acceleratorTable; | |
88ac883a | 1398 | #endif // wxUSE_ACCEL |
f03fc89f | 1399 | |
f03fc89f VZ |
1400 | // the tooltip for this window (may be NULL) |
1401 | #if wxUSE_TOOLTIPS | |
1402 | wxToolTip *m_tooltip; | |
1403 | #endif // wxUSE_TOOLTIPS | |
1404 | ||
1405 | // constraints and sizers | |
1406 | #if wxUSE_CONSTRAINTS | |
1407 | // the constraints for this window or NULL | |
1408 | wxLayoutConstraints *m_constraints; | |
1409 | ||
1410 | // constraints this window is involved in | |
1411 | wxWindowList *m_constraintsInvolvedIn; | |
461e93f9 | 1412 | #endif // wxUSE_CONSTRAINTS |
f03fc89f | 1413 | |
be90c029 | 1414 | // this window's sizer |
f03fc89f | 1415 | wxSizer *m_windowSizer; |
be90c029 RD |
1416 | |
1417 | // The sizer this window is a member of, if any | |
1418 | wxSizer *m_containingSizer; | |
f03fc89f VZ |
1419 | |
1420 | // Layout() window automatically when its size changes? | |
1421 | bool m_autoLayout:1; | |
f03fc89f | 1422 | |
f35fdf7e VZ |
1423 | // true if we had automatically allocated the id value for this window |
1424 | // (i.e. wxID_ANY had been passed to the ctor) | |
1425 | bool m_freeId:1; | |
1426 | ||
f03fc89f VZ |
1427 | // window state |
1428 | bool m_isShown:1; | |
1429 | bool m_isEnabled:1; | |
1430 | bool m_isBeingDeleted:1; | |
1431 | ||
23895080 VZ |
1432 | // was the window colours/font explicitly changed by user? |
1433 | bool m_hasBgCol:1; | |
1434 | bool m_hasFgCol:1; | |
1435 | bool m_hasFont:1; | |
a0d9c6cb | 1436 | |
f8ff87ed VS |
1437 | // and should it be inherited by children? |
1438 | bool m_inheritBgCol:1; | |
1439 | bool m_inheritFgCol:1; | |
1440 | bool m_inheritFont:1; | |
23895080 | 1441 | |
f03fc89f | 1442 | // window attributes |
d80cd92a VZ |
1443 | long m_windowStyle, |
1444 | m_exStyle; | |
f03fc89f | 1445 | wxString m_windowName; |
a2d93e73 | 1446 | bool m_themeEnabled; |
50c53860 | 1447 | wxBackgroundStyle m_backgroundStyle; |
071e5fd9 | 1448 | #if wxUSE_PALETTE |
574c939e | 1449 | wxPalette m_palette; |
b95edd47 VZ |
1450 | bool m_hasCustomPalette; |
1451 | #endif // wxUSE_PALETTE | |
574c939e | 1452 | |
45a959a3 JS |
1453 | #if wxUSE_ACCESSIBILITY |
1454 | wxAccessible* m_accessible; | |
1455 | #endif | |
2654f7e4 | 1456 | |
566d84a7 RL |
1457 | // Virtual size (scrolling) |
1458 | wxSize m_virtualSize; | |
1459 | ||
f4fe2f20 RR |
1460 | wxScrollHelper *m_scrollHelper; |
1461 | ||
69d90995 | 1462 | wxWindowVariant m_windowVariant ; |
45e0dc94 | 1463 | |
1e6feb95 VZ |
1464 | // override this to change the default (i.e. used when no style is |
1465 | // specified) border for the window class | |
1466 | virtual wxBorder GetDefaultBorder() const; | |
1467 | ||
a047aff2 JS |
1468 | // this allows you to implement standard control borders without |
1469 | // repeating the code in different classes that are not derived from | |
1470 | // wxControl | |
dc797d8e | 1471 | virtual wxBorder GetDefaultBorderForControl() const { return wxBORDER_THEME; } |
a047aff2 | 1472 | |
5c2be659 RD |
1473 | // Get the default size for the new window if no explicit size given. TLWs |
1474 | // have their own default size so this is just for non top-level windows. | |
a0d9c6cb WS |
1475 | static int WidthDefault(int w) { return w == wxDefaultCoord ? 20 : w; } |
1476 | static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; } | |
f03fc89f | 1477 | |
9f884528 RD |
1478 | |
1479 | // Used to save the results of DoGetBestSize so it doesn't need to be | |
1480 | // recalculated each time the value is needed. | |
1481 | wxSize m_bestSizeCache; | |
1482 | ||
170acdc9 RD |
1483 | wxDEPRECATED( void SetBestSize(const wxSize& size) ); // use SetInitialSize |
1484 | wxDEPRECATED( virtual void SetInitialBestSize(const wxSize& size) ); // use SetInitialSize | |
d3b5db4b | 1485 | |
a0d9c6cb | 1486 | |
d3b5db4b | 1487 | |
f03fc89f VZ |
1488 | // more pure virtual functions |
1489 | // --------------------------- | |
1490 | ||
1491 | // NB: we must have DoSomething() function when Something() is an overloaded | |
1492 | // method: indeed, we can't just have "virtual Something()" in case when | |
1493 | // the function is overloaded because then we'd have to make virtual all | |
1494 | // the variants (otherwise only the virtual function may be called on a | |
1495 | // pointer to derived class according to C++ rules) which is, in | |
1496 | // general, absolutely not needed. So instead we implement all | |
1497 | // overloaded Something()s in terms of DoSomething() which will be the | |
1498 | // only one to be virtual. | |
1499 | ||
dabc0cd5 VZ |
1500 | // coordinates translation |
1501 | virtual void DoClientToScreen( int *x, int *y ) const = 0; | |
1502 | virtual void DoScreenToClient( int *x, int *y ) const = 0; | |
1503 | ||
1e6feb95 VZ |
1504 | virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const; |
1505 | ||
94633ad9 | 1506 | // capture/release the mouse, used by Capture/ReleaseMouse() |
a83e1475 VZ |
1507 | virtual void DoCaptureMouse() = 0; |
1508 | virtual void DoReleaseMouse() = 0; | |
be90c029 | 1509 | |
f03fc89f | 1510 | // retrieve the position/size of the window |
3c81c9aa VZ |
1511 | virtual void DoGetPosition(int *x, int *y) const = 0; |
1512 | virtual void DoGetScreenPosition(int *x, int *y) const; | |
1513 | virtual void DoGetSize(int *width, int *height) const = 0; | |
1514 | virtual void DoGetClientSize(int *width, int *height) const = 0; | |
f03fc89f | 1515 | |
f68586e5 VZ |
1516 | // get the size which best suits the window: for a control, it would be |
1517 | // the minimal size which doesn't truncate the control, for a panel - the | |
1518 | // same size as it would have after a call to Fit() | |
1519 | virtual wxSize DoGetBestSize() const; | |
1520 | ||
ee146bca VZ |
1521 | // called from DoGetBestSize() to convert best virtual size (returned by |
1522 | // the window sizer) to the best size for the window itself; this is | |
1523 | // overridden at wxScrolledWindow level to clump down virtual size to real | |
1524 | virtual wxSize GetWindowSizeForVirtualSize(const wxSize& size) const | |
1525 | { | |
1526 | return size; | |
1527 | } | |
1528 | ||
f03fc89f VZ |
1529 | // this is the virtual function to be overriden in any derived class which |
1530 | // wants to change how SetSize() or Move() works - it is called by all | |
1531 | // versions of these functions in the base class | |
1532 | virtual void DoSetSize(int x, int y, | |
1533 | int width, int height, | |
1534 | int sizeFlags = wxSIZE_AUTO) = 0; | |
1535 | ||
1536 | // same as DoSetSize() for the client size | |
1537 | virtual void DoSetClientSize(int width, int height) = 0; | |
1538 | ||
b2e10dac PC |
1539 | virtual void DoSetSizeHints( int minW, int minH, |
1540 | int maxW, int maxH, | |
1541 | int incW, int incH ); | |
1542 | ||
9d9b7755 VZ |
1543 | // move the window to the specified location and resize it: this is called |
1544 | // from both DoSetSize() and DoSetClientSize() and would usually just | |
1545 | // reposition this window except for composite controls which will want to | |
1546 | // arrange themselves inside the given rectangle | |
69deca26 VS |
1547 | // |
1548 | // Important note: the coordinates passed to this method are in parent's | |
1549 | // *window* coordinates and not parent's client coordinates (as the values | |
1550 | // passed to DoSetSize and returned by DoGetPosition are)! | |
9d9b7755 VZ |
1551 | virtual void DoMoveWindow(int x, int y, int width, int height) = 0; |
1552 | ||
1f464296 VZ |
1553 | // centre the window in the specified direction on parent, note that |
1554 | // wxCENTRE_ON_SCREEN shouldn't be specified here, it only makes sense for | |
1555 | // TLWs | |
1556 | virtual void DoCentre(int dir); | |
1557 | ||
f03fc89f VZ |
1558 | #if wxUSE_TOOLTIPS |
1559 | virtual void DoSetToolTip( wxToolTip *tip ); | |
1560 | #endif // wxUSE_TOOLTIPS | |
1561 | ||
1e6feb95 | 1562 | #if wxUSE_MENUS |
971562cb | 1563 | virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0; |
1e6feb95 | 1564 | #endif // wxUSE_MENUS |
a1665b22 | 1565 | |
716e96df VZ |
1566 | // Makes an adjustment to the window position to make it relative to the |
1567 | // parents client area, e.g. if the parent is a frame with a toolbar, its | |
1568 | // (0, 0) is just below the toolbar | |
1569 | virtual void AdjustForParentClientOrigin(int& x, int& y, | |
1570 | int sizeFlags = 0) const; | |
8d99be5f | 1571 | |
69d90995 SC |
1572 | // implements the window variants |
1573 | virtual void DoSetWindowVariant( wxWindowVariant variant ) ; | |
45e0dc94 | 1574 | |
63e819f2 | 1575 | // Must be called when mouse capture is lost to send |
72f8c792 VS |
1576 | // wxMouseCaptureLostEvent to windows on capture stack. |
1577 | static void NotifyCaptureLost(); | |
63e819f2 | 1578 | |
f03fc89f | 1579 | private: |
47a8a4d5 VZ |
1580 | // recursively call our own and our children OnEnabled() when the |
1581 | // enabled/disabled status changed because a parent window had been | |
1582 | // enabled/disabled | |
1583 | void NotifyWindowOnEnableChange(bool enabled); | |
1584 | ||
00a77b7c VZ |
1585 | #if wxUSE_MENUS |
1586 | // temporary event handler used by GetPopupMenuSelectionFromUser() | |
1587 | void InternalOnPopupMenu(wxCommandEvent& event); | |
1588 | ||
1589 | // implementation of the public GetPopupMenuSelectionFromUser() method | |
1590 | int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y); | |
1591 | #endif // wxUSE_MENUS | |
47a8a4d5 | 1592 | |
a83e1475 | 1593 | // the stack of windows which have captured the mouse |
b5dbe15d | 1594 | static struct WXDLLIMPEXP_FWD_CORE wxWindowNext *ms_winCaptureNext; |
63e819f2 VS |
1595 | // the window that currently has mouse capture |
1596 | static wxWindow *ms_winCaptureCurrent; | |
1597 | // indicates if execution is inside CaptureMouse/ReleaseMouse | |
1598 | static bool ms_winCaptureChanging; | |
a83e1475 | 1599 | |
1e6feb95 VZ |
1600 | DECLARE_ABSTRACT_CLASS(wxWindowBase) |
1601 | DECLARE_NO_COPY_CLASS(wxWindowBase) | |
f03fc89f VZ |
1602 | DECLARE_EVENT_TABLE() |
1603 | }; | |
1604 | ||
170acdc9 RD |
1605 | |
1606 | ||
1607 | // Inlines for some deprecated methods | |
1608 | inline wxSize wxWindowBase::GetBestFittingSize() const | |
1609 | { | |
1610 | return GetEffectiveMinSize(); | |
1611 | } | |
1612 | ||
1613 | inline void wxWindowBase::SetBestFittingSize(const wxSize& size) | |
1614 | { | |
1615 | SetInitialSize(size); | |
1616 | } | |
1617 | ||
1618 | inline void wxWindowBase::SetBestSize(const wxSize& size) | |
1619 | { | |
1620 | SetInitialSize(size); | |
1621 | } | |
1622 | ||
1623 | inline void wxWindowBase::SetInitialBestSize(const wxSize& size) | |
1624 | { | |
1625 | SetInitialSize(size); | |
1626 | } | |
1627 | ||
1628 | ||
f03fc89f VZ |
1629 | // ---------------------------------------------------------------------------- |
1630 | // now include the declaration of wxWindow class | |
1631 | // ---------------------------------------------------------------------------- | |
1632 | ||
1e6feb95 | 1633 | // include the declaration of the platform-specific class |
4055ed82 | 1634 | #if defined(__WXPALMOS__) |
ffecfa5a JS |
1635 | #ifdef __WXUNIVERSAL__ |
1636 | #define wxWindowNative wxWindowPalm | |
1637 | #else // !wxUniv | |
1638 | #define wxWindowPalm wxWindow | |
1639 | #endif // wxUniv/!wxUniv | |
1640 | #include "wx/palmos/window.h" | |
1641 | #elif defined(__WXMSW__) | |
a5b3669d VZ |
1642 | #ifdef __WXUNIVERSAL__ |
1643 | #define wxWindowNative wxWindowMSW | |
1644 | #else // !wxUniv | |
1e6feb95 | 1645 | #define wxWindowMSW wxWindow |
a5b3669d | 1646 | #endif // wxUniv/!wxUniv |
f03fc89f | 1647 | #include "wx/msw/window.h" |
2049ba38 | 1648 | #elif defined(__WXMOTIF__) |
f03fc89f | 1649 | #include "wx/motif/window.h" |
1be7a35c | 1650 | #elif defined(__WXGTK20__) |
a5b3669d VZ |
1651 | #ifdef __WXUNIVERSAL__ |
1652 | #define wxWindowNative wxWindowGTK | |
1653 | #else // !wxUniv | |
1e6feb95 | 1654 | #define wxWindowGTK wxWindow |
1e6feb95 | 1655 | #endif // wxUniv |
f03fc89f | 1656 | #include "wx/gtk/window.h" |
1be7a35c MR |
1657 | #elif defined(__WXGTK__) |
1658 | #ifdef __WXUNIVERSAL__ | |
1659 | #define wxWindowNative wxWindowGTK | |
1660 | #else // !wxUniv | |
1661 | #define wxWindowGTK wxWindow | |
1662 | #endif // wxUniv | |
1663 | #include "wx/gtk1/window.h" | |
83df96d6 JS |
1664 | #elif defined(__WXX11__) |
1665 | #ifdef __WXUNIVERSAL__ | |
1666 | #define wxWindowNative wxWindowX11 | |
1667 | #else // !wxUniv | |
1668 | #define wxWindowX11 wxWindow | |
83df96d6 JS |
1669 | #endif // wxUniv |
1670 | #include "wx/x11/window.h" | |
711c76db | 1671 | #elif defined(__WXMGL__) |
b3c86150 | 1672 | #define wxWindowNative wxWindowMGL |
386c7058 | 1673 | #include "wx/mgl/window.h" |
b3c86150 VS |
1674 | #elif defined(__WXDFB__) |
1675 | #define wxWindowNative wxWindowDFB | |
1676 | #include "wx/dfb/window.h" | |
34138703 | 1677 | #elif defined(__WXMAC__) |
e766c8a9 SC |
1678 | #ifdef __WXUNIVERSAL__ |
1679 | #define wxWindowNative wxWindowMac | |
1680 | #else // !wxUniv | |
1681 | #define wxWindowMac wxWindow | |
e766c8a9 | 1682 | #endif // wxUniv |
f03fc89f | 1683 | #include "wx/mac/window.h" |
e64df9bc DE |
1684 | #elif defined(__WXCOCOA__) |
1685 | #ifdef __WXUNIVERSAL__ | |
1686 | #define wxWindowNative wxWindowCocoa | |
1687 | #else // !wxUniv | |
1688 | #define wxWindowCocoa wxWindow | |
e64df9bc DE |
1689 | #endif // wxUniv |
1690 | #include "wx/cocoa/window.h" | |
1777b9bb | 1691 | #elif defined(__WXPM__) |
210a651b DW |
1692 | #ifdef __WXUNIVERSAL__ |
1693 | #define wxWindowNative wxWindowOS2 | |
1694 | #else // !wxUniv | |
1695 | #define wxWindowOS2 wxWindow | |
210a651b | 1696 | #endif // wxUniv/!wxUniv |
1777b9bb | 1697 | #include "wx/os2/window.h" |
c801d85f KB |
1698 | #endif |
1699 | ||
1e6feb95 VZ |
1700 | // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>, |
1701 | // for the native ports we already have defined it above | |
1702 | #if defined(__WXUNIVERSAL__) | |
a5b3669d VZ |
1703 | #ifndef wxWindowNative |
1704 | #error "wxWindowNative must be defined above!" | |
1705 | #endif | |
1706 | ||
1e6feb95 VZ |
1707 | #include "wx/univ/window.h" |
1708 | #endif // wxUniv | |
1709 | ||
f03fc89f VZ |
1710 | // ---------------------------------------------------------------------------- |
1711 | // inline functions which couldn't be declared in the class body because of | |
1712 | // forward dependencies | |
1713 | // ---------------------------------------------------------------------------- | |
1714 | ||
bacd69f9 | 1715 | inline wxWindow *wxWindowBase::GetGrandParent() const |
f03fc89f VZ |
1716 | { |
1717 | return m_parent ? m_parent->GetParent() : (wxWindow *)NULL; | |
1718 | } | |
1719 | ||
1720 | // ---------------------------------------------------------------------------- | |
3723b7b1 | 1721 | // global functions |
f03fc89f VZ |
1722 | // ---------------------------------------------------------------------------- |
1723 | ||
3723b7b1 JS |
1724 | // Find the wxWindow at the current mouse position, also returning the mouse |
1725 | // position. | |
16cba29d | 1726 | extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt); |
3723b7b1 JS |
1727 | |
1728 | // Get the current mouse position. | |
16cba29d | 1729 | extern WXDLLEXPORT wxPoint wxGetMousePosition(); |
3723b7b1 | 1730 | |
1e6feb95 | 1731 | // get the currently active window of this application or NULL |
16cba29d | 1732 | extern WXDLLEXPORT wxWindow *wxGetActiveWindow(); |
1e6feb95 | 1733 | |
33b494d6 VZ |
1734 | // get the (first) top level parent window |
1735 | WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win); | |
1736 | ||
40ff126a WS |
1737 | #if WXWIN_COMPATIBILITY_2_6 |
1738 | // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId() | |
1739 | wxDEPRECATED( int NewControlId() ); | |
1740 | inline int NewControlId() { return wxWindowBase::NewControlId(); } | |
1741 | #endif // WXWIN_COMPATIBILITY_2_6 | |
f03fc89f | 1742 | |
45a959a3 JS |
1743 | #if wxUSE_ACCESSIBILITY |
1744 | // ---------------------------------------------------------------------------- | |
1745 | // accessible object for windows | |
1746 | // ---------------------------------------------------------------------------- | |
1747 | ||
1748 | class WXDLLEXPORT wxWindowAccessible: public wxAccessible | |
1749 | { | |
1750 | public: | |
f81387bd | 1751 | wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); } |
6fb99eb3 | 1752 | virtual ~wxWindowAccessible() {} |
45a959a3 JS |
1753 | |
1754 | // Overridables | |
1755 | ||
1756 | // Can return either a child object, or an integer | |
1757 | // representing the child element, starting from 1. | |
1758 | virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject); | |
1759 | ||
1760 | // Returns the rectangle for this object (id = 0) or a child element (id > 0). | |
1761 | virtual wxAccStatus GetLocation(wxRect& rect, int elementId); | |
1762 | ||
1763 | // Navigates from fromId to toId/toObject. | |
1764 | virtual wxAccStatus Navigate(wxNavDir navDir, int fromId, | |
1765 | int* toId, wxAccessible** toObject); | |
1766 | ||
1767 | // Gets the name of the specified object. | |
1768 | virtual wxAccStatus GetName(int childId, wxString* name); | |
1769 | ||
1770 | // Gets the number of children. | |
a37e4a07 | 1771 | virtual wxAccStatus GetChildCount(int* childCount); |
45a959a3 JS |
1772 | |
1773 | // Gets the specified child (starting from 1). | |
1774 | // If *child is NULL and return value is wxACC_OK, | |
1775 | // this means that the child is a simple element and | |
1776 | // not an accessible object. | |
1777 | virtual wxAccStatus GetChild(int childId, wxAccessible** child); | |
1778 | ||
1779 | // Gets the parent, or NULL. | |
1780 | virtual wxAccStatus GetParent(wxAccessible** parent); | |
1781 | ||
1782 | // Performs the default action. childId is 0 (the action for this object) | |
1783 | // or > 0 (the action for a child). | |
1784 | // Return wxACC_NOT_SUPPORTED if there is no default action for this | |
1785 | // window (e.g. an edit control). | |
1786 | virtual wxAccStatus DoDefaultAction(int childId); | |
1787 | ||
1788 | // Gets the default action for this object (0) or > 0 (the action for a child). | |
1789 | // Return wxACC_OK even if there is no action. actionName is the action, or the empty | |
1790 | // string if there is no action. | |
1791 | // The retrieved string describes the action that is performed on an object, | |
1792 | // not what the object does as a result. For example, a toolbar button that prints | |
1793 | // a document has a default action of "Press" rather than "Prints the current document." | |
1794 | virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName); | |
1795 | ||
1796 | // Returns the description for this object or a child. | |
1797 | virtual wxAccStatus GetDescription(int childId, wxString* description); | |
1798 | ||
1799 | // Returns help text for this object or a child, similar to tooltip text. | |
1800 | virtual wxAccStatus GetHelpText(int childId, wxString* helpText); | |
1801 | ||
1802 | // Returns the keyboard shortcut for this object or child. | |
1803 | // Return e.g. ALT+K | |
1804 | virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut); | |
1805 | ||
1806 | // Returns a role constant. | |
1807 | virtual wxAccStatus GetRole(int childId, wxAccRole* role); | |
1808 | ||
1809 | // Returns a state constant. | |
1810 | virtual wxAccStatus GetState(int childId, long* state); | |
1811 | ||
1812 | // Returns a localized string representing the value for the object | |
1813 | // or child. | |
1814 | virtual wxAccStatus GetValue(int childId, wxString* strValue); | |
1815 | ||
1816 | // Selects the object or child. | |
1817 | virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags); | |
1818 | ||
1819 | // Gets the window with the keyboard focus. | |
1820 | // If childId is 0 and child is NULL, no object in | |
1821 | // this subhierarchy has the focus. | |
1822 | // If this object has the focus, child should be 'this'. | |
1823 | virtual wxAccStatus GetFocus(int* childId, wxAccessible** child); | |
1824 | ||
ca5c6ac3 | 1825 | #if wxUSE_VARIANT |
45a959a3 JS |
1826 | // Gets a variant representing the selected children |
1827 | // of this object. | |
1828 | // Acceptable values: | |
d4864e97 | 1829 | // - a null variant (IsNull() returns true) |
45a959a3 JS |
1830 | // - a list variant (GetType() == wxT("list") |
1831 | // - an integer representing the selected child element, | |
1832 | // or 0 if this object is selected (GetType() == wxT("long") | |
1833 | // - a "void*" pointer to a wxAccessible child object | |
1834 | virtual wxAccStatus GetSelections(wxVariant* selections); | |
ca5c6ac3 | 1835 | #endif // wxUSE_VARIANT |
45a959a3 JS |
1836 | }; |
1837 | ||
1838 | #endif // wxUSE_ACCESSIBILITY | |
1839 | ||
1840 | ||
faa49bfd | 1841 | #endif // _WX_WINDOW_H_BASE_ |