]>
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$ | |
8 | // Copyright: (c) wxWindows team | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
34138703 JS |
12 | #ifndef _WX_WINDOW_H_BASE_ |
13 | #define _WX_WINDOW_H_BASE_ | |
c801d85f | 14 | |
12028905 | 15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
58654ed0 VZ |
16 | #pragma interface "windowbase.h" |
17 | #endif | |
18 | ||
f03fc89f VZ |
19 | // ---------------------------------------------------------------------------- |
20 | // headers which we must include here | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
23 | #include "wx/event.h" // the base class | |
24 | ||
25 | #include "wx/list.h" // defines wxWindowList | |
26 | ||
27 | #include "wx/cursor.h" // we have member variables of these classes | |
28 | #include "wx/font.h" // so we can't do without them | |
29 | #include "wx/colour.h" | |
30 | #include "wx/region.h" | |
5e4ff78a | 31 | #include "wx/utils.h" |
88ac883a | 32 | |
674ac8b9 | 33 | #include "wx/validate.h" // for wxDefaultValidator (always include it) |
8d99be5f | 34 | |
574c939e | 35 | #if wxUSE_PALETTE |
d577d610 | 36 | #include "wx/palette.h" |
574c939e KB |
37 | #endif // wxUSE_PALETTE |
38 | ||
88ac883a VZ |
39 | #if wxUSE_ACCEL |
40 | #include "wx/accel.h" | |
41 | #endif // wxUSE_ACCEL | |
f03fc89f | 42 | |
45a959a3 JS |
43 | #if wxUSE_ACCESSIBILITY |
44 | #include "wx/access.h" | |
45 | #endif | |
46 | ||
6522713c VZ |
47 | // when building wxUniv/Foo we don't want the code for native menu use to be |
48 | // compiled in - it should only be used when building real wxFoo | |
49 | #ifdef __WXUNIVERSAL__ | |
50 | #define wxUSE_MENUS_NATIVE 0 | |
51 | #else // __WXMSW__ | |
52 | #define wxUSE_MENUS_NATIVE wxUSE_MENUS | |
53 | #endif // __WXUNIVERSAL__/__WXMSW__ | |
54 | ||
f03fc89f VZ |
55 | // ---------------------------------------------------------------------------- |
56 | // forward declarations | |
57 | // ---------------------------------------------------------------------------- | |
58 | ||
789295bf | 59 | class WXDLLEXPORT wxCaret; |
f03fc89f VZ |
60 | class WXDLLEXPORT wxControl; |
61 | class WXDLLEXPORT wxCursor; | |
eb082a08 | 62 | class WXDLLEXPORT wxDC; |
f03fc89f VZ |
63 | class WXDLLEXPORT wxDropTarget; |
64 | class WXDLLEXPORT wxItemResource; | |
65 | class WXDLLEXPORT wxLayoutConstraints; | |
66 | class WXDLLEXPORT wxResourceTable; | |
67 | class WXDLLEXPORT wxSizer; | |
68 | class WXDLLEXPORT wxToolTip; | |
f03fc89f VZ |
69 | class WXDLLEXPORT wxWindowBase; |
70 | class WXDLLEXPORT wxWindow; | |
71 | ||
45a959a3 JS |
72 | #if wxUSE_ACCESSIBILITY |
73 | class WXDLLEXPORT wxAccessible; | |
74 | #endif | |
75 | ||
1b69c815 VZ |
76 | // ---------------------------------------------------------------------------- |
77 | // helper stuff used by wxWindow | |
78 | // ---------------------------------------------------------------------------- | |
79 | ||
80 | // struct containing all the visual attributes of a control | |
81 | struct WXDLLEXPORT wxVisualAttributes | |
82 | { | |
83 | // the font used for control label/text inside it | |
84 | wxFont font; | |
85 | ||
86 | // the foreground colour | |
87 | wxColour colFg; | |
88 | ||
89 | // the background colour, may be wxNullColour if the controls background | |
90 | // colour is not solid | |
91 | wxColour colBg; | |
92 | }; | |
93 | ||
94 | // different window variants, on platforms like eg mac uses different | |
95 | // rendering sizes | |
96 | enum wxWindowVariant | |
97 | { | |
98 | wxWINDOW_VARIANT_NORMAL, // Normal size | |
99 | wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal) | |
100 | wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal) | |
101 | wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal) | |
102 | wxWINDOW_VARIANT_MAX | |
103 | }; | |
104 | ||
f03fc89f VZ |
105 | // ---------------------------------------------------------------------------- |
106 | // (pseudo)template list classes | |
107 | // ---------------------------------------------------------------------------- | |
108 | ||
f6bcfd97 | 109 | WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT); |
f03fc89f VZ |
110 | |
111 | // ---------------------------------------------------------------------------- | |
112 | // global variables | |
113 | // ---------------------------------------------------------------------------- | |
114 | ||
115 | WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows; | |
116 | ||
f03fc89f VZ |
117 | // ---------------------------------------------------------------------------- |
118 | // wxWindowBase is the base class for all GUI controls/widgets, this is the public | |
119 | // interface of this class. | |
120 | // | |
121 | // Event handler: windows have themselves as their event handlers by default, | |
122 | // but their event handlers could be set to another object entirely. This | |
123 | // separation can reduce the amount of derivation required, and allow | |
124 | // alteration of a window's functionality (e.g. by a resource editor that | |
125 | // temporarily switches event handlers). | |
126 | // ---------------------------------------------------------------------------- | |
127 | ||
128 | class WXDLLEXPORT wxWindowBase : public wxEvtHandler | |
129 | { | |
f03fc89f VZ |
130 | public: |
131 | // creating the window | |
132 | // ------------------- | |
133 | ||
06f6df7d VZ |
134 | // default ctor, initializes everything which can be initialized before |
135 | // Create() | |
6463b9f5 | 136 | wxWindowBase() ; |
f03fc89f VZ |
137 | |
138 | // pseudo ctor (can't be virtual, called from ctor) | |
139 | bool CreateBase(wxWindowBase *parent, | |
d9e2e4c2 | 140 | wxWindowID winid, |
f03fc89f VZ |
141 | const wxPoint& pos = wxDefaultPosition, |
142 | const wxSize& size = wxDefaultSize, | |
143 | long style = 0, | |
8d99be5f | 144 | const wxValidator& validator = wxDefaultValidator, |
f03fc89f VZ |
145 | const wxString& name = wxPanelNameStr); |
146 | ||
147 | virtual ~wxWindowBase(); | |
148 | ||
f03fc89f VZ |
149 | // deleting the window |
150 | // ------------------- | |
151 | ||
d4864e97 | 152 | // ask the window to close itself, return true if the event handler |
f03fc89f | 153 | // honoured our request |
d4864e97 | 154 | bool Close( bool force = false ); |
f03fc89f VZ |
155 | |
156 | // the following functions delete the C++ objects (the window itself | |
157 | // or its children) as well as the GUI windows and normally should | |
158 | // never be used directly | |
159 | ||
d4864e97 | 160 | // delete window unconditionally (dangerous!), returns true if ok |
f03fc89f | 161 | virtual bool Destroy(); |
d4864e97 | 162 | // delete all children of this window, returns true if ok |
f03fc89f VZ |
163 | bool DestroyChildren(); |
164 | ||
165 | // is the window being deleted? | |
166 | bool IsBeingDeleted() const { return m_isBeingDeleted; } | |
167 | ||
168 | // window attributes | |
169 | // ----------------- | |
170 | ||
456bc6d9 VZ |
171 | // NB: in future versions of wxWindows Set/GetTitle() will only work |
172 | // with the top level windows (such as dialogs and frames) and | |
173 | // Set/GetLabel() only with the other ones (i.e. all controls). | |
174 | ||
f03fc89f VZ |
175 | // the title (or label, see below) of the window: the text which the |
176 | // window shows | |
fe6b43a3 VS |
177 | virtual void SetTitle( const wxString& WXUNUSED(title) ) {} |
178 | virtual wxString GetTitle() const { return wxEmptyString; } | |
f03fc89f VZ |
179 | |
180 | // label is just the same as the title (but for, e.g., buttons it | |
181 | // makes more sense to speak about labels) | |
eba0e4d4 RR |
182 | virtual void SetLabel(const wxString& label) { SetTitle(label); } |
183 | virtual wxString GetLabel() const { return GetTitle(); } | |
f03fc89f VZ |
184 | |
185 | // the window name is used for ressource setting in X, it is not the | |
186 | // same as the window title/label | |
187 | virtual void SetName( const wxString &name ) { m_windowName = name; } | |
188 | virtual wxString GetName() const { return m_windowName; } | |
189 | ||
69d90995 SC |
190 | // sets the window variant, calls internally DoSetVariant if variant has changed |
191 | void SetWindowVariant( wxWindowVariant variant ) ; | |
192 | wxWindowVariant GetWindowVariant() const { return m_windowVariant ; } | |
193 | ||
194 | ||
f03fc89f VZ |
195 | // window id uniquely identifies the window among its siblings unless |
196 | // it is -1 which means "don't care" | |
d9e2e4c2 | 197 | void SetId( wxWindowID winid ) { m_windowId = winid; } |
f03fc89f VZ |
198 | wxWindowID GetId() const { return m_windowId; } |
199 | ||
200 | // generate a control id for the controls which were not given one by | |
201 | // user | |
69418a8e | 202 | static int NewControlId() { return --ms_lastControlId; } |
c539ab55 VZ |
203 | // get the id of the control following the one with the given |
204 | // (autogenerated) id | |
d9e2e4c2 | 205 | static int NextControlId(int winid) { return winid - 1; } |
c539ab55 VZ |
206 | // get the id of the control preceding the one with the given |
207 | // (autogenerated) id | |
d9e2e4c2 | 208 | static int PrevControlId(int winid) { return winid + 1; } |
f03fc89f VZ |
209 | |
210 | // moving/resizing | |
211 | // --------------- | |
212 | ||
213 | // set the window size and/or position | |
214 | void SetSize( int x, int y, int width, int height, | |
215 | int sizeFlags = wxSIZE_AUTO ) | |
216 | { DoSetSize(x, y, width, height, sizeFlags); } | |
217 | ||
218 | void SetSize( int width, int height ) | |
219 | { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); } | |
220 | ||
221 | void SetSize( const wxSize& size ) | |
222 | { SetSize( size.x, size.y); } | |
223 | ||
224 | void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO) | |
225 | { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); } | |
226 | ||
1e6feb95 VZ |
227 | void Move(int x, int y, int flags = wxSIZE_USE_EXISTING) |
228 | { DoSetSize(x, y, -1, -1, flags); } | |
f03fc89f | 229 | |
1e6feb95 VZ |
230 | void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING) |
231 | { Move(pt.x, pt.y, flags); } | |
f03fc89f VZ |
232 | |
233 | // Z-order | |
234 | virtual void Raise() = 0; | |
235 | virtual void Lower() = 0; | |
236 | ||
237 | // client size is the size of area available for subwindows | |
238 | void SetClientSize( int width, int height ) | |
239 | { DoSetClientSize(width, height); } | |
240 | ||
241 | void SetClientSize( const wxSize& size ) | |
242 | { DoSetClientSize(size.x, size.y); } | |
243 | ||
244 | void SetClientSize(const wxRect& rect) | |
245 | { SetClientSize( rect.width, rect.height ); } | |
246 | ||
247 | // get the window position and/or size (pointers may be NULL) | |
248 | void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); } | |
249 | wxPoint GetPosition() const | |
250 | { | |
251 | int w, h; | |
252 | DoGetPosition(&w, &h); | |
253 | ||
254 | return wxPoint(w, h); | |
255 | } | |
256 | ||
311a173b | 257 | void SetPosition( const wxPoint& pt ) { Move( pt ) ; } |
38759b67 | 258 | |
f03fc89f VZ |
259 | void GetSize( int *w, int *h ) const { DoGetSize(w, h); } |
260 | wxSize GetSize() const | |
261 | { | |
262 | int w, h; | |
263 | DoGetSize(& w, & h); | |
264 | return wxSize(w, h); | |
265 | } | |
266 | ||
267 | wxRect GetRect() const | |
268 | { | |
269 | int x, y, w, h; | |
270 | GetPosition(& x, & y); | |
271 | GetSize(& w, & h); | |
272 | ||
273 | return wxRect(x, y, w, h); | |
274 | } | |
275 | ||
276 | void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); } | |
277 | wxSize GetClientSize() const | |
278 | { | |
279 | int w, h; | |
280 | DoGetClientSize(& w, & h); | |
281 | ||
282 | return wxSize(w, h); | |
283 | } | |
284 | ||
1e6feb95 VZ |
285 | // get the origin of the client area of the window relative to the |
286 | // window top left corner (the client area may be shifted because of | |
287 | // the borders, scrollbars, other decorations...) | |
288 | virtual wxPoint GetClientAreaOrigin() const; | |
289 | ||
290 | // get the client rectangle in window (i.e. client) coordinates | |
291 | wxRect GetClientRect() const | |
292 | { | |
293 | return wxRect(GetClientAreaOrigin(), GetClientSize()); | |
294 | } | |
295 | ||
f68586e5 VZ |
296 | // get the size best suited for the window (in fact, minimal |
297 | // acceptable size using which it will still look "nice") | |
298 | wxSize GetBestSize() const { return DoGetBestSize(); } | |
299 | void GetBestSize(int *w, int *h) const | |
300 | { | |
301 | wxSize s = DoGetBestSize(); | |
302 | if ( w ) | |
303 | *w = s.x; | |
304 | if ( h ) | |
305 | *h = s.y; | |
306 | } | |
307 | ||
2b5f62a0 VZ |
308 | // There are times (and windows) where 'Best' size and 'Min' size |
309 | // are vastly out of sync. This should be remedied somehow, but in | |
310 | // the meantime, this method will return the larger of BestSize | |
311 | // (the window's smallest legible size), and any user specified | |
312 | // MinSize hint. | |
313 | wxSize GetAdjustedBestSize() const | |
314 | { | |
315 | wxSize s( DoGetBestSize() ); | |
316 | return wxSize( wxMax( s.x, GetMinWidth() ), wxMax( s.y, GetMinHeight() ) ); | |
317 | } | |
318 | ||
319 | // the generic centre function - centers the window on parent by` | |
7eb4e9cc VZ |
320 | // default or on screen if it doesn't have parent or |
321 | // wxCENTER_ON_SCREEN flag is given | |
c39eda94 VZ |
322 | void Centre( int direction = wxBOTH ); |
323 | void Center( int direction = wxBOTH ) { Centre(direction); } | |
7eb4e9cc VZ |
324 | |
325 | // centre on screen (only works for top level windows) | |
326 | void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); } | |
327 | void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); } | |
328 | ||
329 | // centre with respect to the the parent window | |
330 | void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); } | |
331 | void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); } | |
f03fc89f VZ |
332 | |
333 | // set window size to wrap around its children | |
334 | virtual void Fit(); | |
335 | ||
2b5f62a0 VZ |
336 | // set virtual size to satisfy children |
337 | virtual void FitInside(); | |
338 | ||
f03fc89f VZ |
339 | // set min/max size of the window |
340 | virtual void SetSizeHints( int minW, int minH, | |
341 | int maxW = -1, int maxH = -1, | |
342 | int incW = -1, int incH = -1 ); | |
1ec25e8f RD |
343 | void SetSizeHints( const wxSize& minSize, |
344 | const wxSize& maxSize=wxDefaultSize, | |
345 | const wxSize& incSize=wxDefaultSize) | |
346 | { | |
347 | SetSizeHints(minSize.x, minSize.y, | |
348 | maxSize.x, maxSize.y, | |
349 | incSize.x, incSize.y); | |
350 | } | |
f03fc89f | 351 | |
566d84a7 RL |
352 | virtual void SetVirtualSizeHints( int minW, int minH, |
353 | int maxW = -1, int maxH = -1 ); | |
1ec25e8f RD |
354 | void SetVirtualSizeHints( const wxSize& minSize, |
355 | const wxSize& maxSize=wxDefaultSize) | |
356 | { | |
357 | SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y); | |
358 | } | |
566d84a7 | 359 | |
e7dda1ff VS |
360 | virtual int GetMinWidth() const { return m_minWidth; } |
361 | virtual int GetMinHeight() const { return m_minHeight; } | |
738f9e5a RR |
362 | int GetMaxWidth() const { return m_maxWidth; } |
363 | int GetMaxHeight() const { return m_maxHeight; } | |
57c4d796 | 364 | |
34c3ffca RL |
365 | // Override this method to control the values given to Sizers etc. |
366 | virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); } | |
1ec25e8f RD |
367 | virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); } |
368 | ||
566d84a7 RL |
369 | // Methods for accessing the virtual size of a window. For most |
370 | // windows this is just the client area of the window, but for | |
371 | // some like scrolled windows it is more or less independent of | |
372 | // the screen window size. You may override the DoXXXVirtual | |
373 | // methods below for classes where that is is the case. | |
374 | ||
375 | void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); } | |
376 | void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); } | |
377 | ||
378 | wxSize GetVirtualSize() const { return DoGetVirtualSize(); } | |
379 | void GetVirtualSize( int *x, int *y ) const | |
380 | { | |
381 | wxSize s( DoGetVirtualSize() ); | |
382 | ||
383 | if( x ) | |
384 | *x = s.GetWidth(); | |
385 | if( y ) | |
386 | *y = s.GetHeight(); | |
387 | } | |
388 | ||
389 | // Override these methods for windows that have a virtual size | |
390 | // independent of their client size. eg. the virtual area of a | |
391 | // wxScrolledWindow. Default is to alias VirtualSize to ClientSize. | |
392 | ||
393 | virtual void DoSetVirtualSize( int x, int y ); | |
394 | virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; } | |
395 | ||
2b5f62a0 VZ |
396 | // Return the largest of ClientSize and BestSize (as determined |
397 | // by a sizer, interior children, or other means) | |
398 | ||
399 | virtual wxSize GetBestVirtualSize() const | |
400 | { | |
401 | wxSize client( GetClientSize() ); | |
402 | wxSize best( GetBestSize() ); | |
403 | ||
404 | return wxSize( wxMax( client.x, best.x ), wxMax( client.y, best.y ) ); | |
405 | } | |
406 | ||
f03fc89f VZ |
407 | // window state |
408 | // ------------ | |
409 | ||
d4864e97 | 410 | // returns true if window was shown/hidden, false if the nothing was |
f03fc89f | 411 | // done (window was already shown/hidden) |
d4864e97 VZ |
412 | virtual bool Show( bool show = true ); |
413 | bool Hide() { return Show(false); } | |
f03fc89f | 414 | |
d4864e97 VZ |
415 | // returns true if window was enabled/disabled, false if nothing done |
416 | virtual bool Enable( bool enable = true ); | |
417 | bool Disable() { return Enable(false); } | |
f03fc89f VZ |
418 | |
419 | bool IsShown() const { return m_isShown; } | |
420 | bool IsEnabled() const { return m_isEnabled; } | |
421 | ||
422 | // get/set window style (setting style won't update the window and so | |
423 | // is only useful for internal usage) | |
424 | virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; } | |
425 | virtual long GetWindowStyleFlag() const { return m_windowStyle; } | |
426 | ||
427 | // just some (somewhat shorter) synonims | |
428 | void SetWindowStyle( long style ) { SetWindowStyleFlag(style); } | |
429 | long GetWindowStyle() const { return GetWindowStyleFlag(); } | |
430 | ||
431 | bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; } | |
d80cd92a | 432 | virtual bool IsRetained() const { return HasFlag(wxRETAINED); } |
f03fc89f | 433 | |
d80cd92a VZ |
434 | // extra style: the less often used style bits which can't be set with |
435 | // SetWindowStyleFlag() | |
b2d5a7ee | 436 | virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; } |
d80cd92a | 437 | long GetExtraStyle() const { return m_exStyle; } |
f03fc89f VZ |
438 | |
439 | // make the window modal (all other windows unresponsive) | |
d4864e97 | 440 | virtual void MakeModal(bool modal = true); |
f03fc89f | 441 | |
b8e7b673 VZ |
442 | |
443 | // (primitive) theming support | |
444 | // --------------------------- | |
445 | ||
a2d93e73 JS |
446 | virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } |
447 | virtual bool GetThemeEnabled() const { return m_themeEnabled; } | |
448 | ||
bd507486 RD |
449 | // Returns true if this class should have the background colour |
450 | // changed to match the parent window's theme. For example when a | |
451 | // page is added to a notebook it and it's children may need to have | |
452 | // the colours adjusted depending on the current theme settings, but | |
453 | // not all windows/controls can do this without looking wrong. | |
cc0bffac RD |
454 | virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg)) |
455 | { /* do nothing */ } | |
bd507486 | 456 | |
d4864e97 | 457 | |
456bc6d9 VZ |
458 | // focus and keyboard handling |
459 | // --------------------------- | |
f03fc89f VZ |
460 | |
461 | // set focus to this window | |
462 | virtual void SetFocus() = 0; | |
463 | ||
d577d610 VZ |
464 | // set focus to this window as the result of a keyboard action |
465 | virtual void SetFocusFromKbd() { SetFocus(); } | |
466 | ||
f03fc89f VZ |
467 | // return the window which currently has the focus or NULL |
468 | static wxWindow *FindFocus() /* = 0: implement in derived classes */; | |
469 | ||
470 | // can this window have focus? | |
471 | virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); } | |
472 | ||
1e6feb95 VZ |
473 | // can this window be given focus by keyboard navigation? if not, the |
474 | // only way to give it focus (provided it accepts it at all) is to | |
475 | // click it | |
476 | virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); } | |
477 | ||
456bc6d9 VZ |
478 | // NB: these methods really don't belong here but with the current |
479 | // class hierarchy there is no other place for them :-( | |
480 | ||
481 | // get the default child of this parent, i.e. the one which is | |
482 | // activated by pressing <Enter> | |
483 | virtual wxWindow *GetDefaultItem() const { return NULL; } | |
484 | ||
485 | // set this child as default, return the old default | |
486 | virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child)) | |
487 | { return NULL; } | |
488 | ||
036da5e3 VZ |
489 | // set this child as temporary default |
490 | virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { } | |
491 | ||
f03fc89f VZ |
492 | // parent/children relations |
493 | // ------------------------- | |
494 | ||
495 | // get the list of children | |
496 | const wxWindowList& GetChildren() const { return m_children; } | |
497 | wxWindowList& GetChildren() { return m_children; } | |
498 | ||
1978421a SC |
499 | // needed just for extended runtime |
500 | const wxWindowList& GetWindowChildren() const { return GetChildren() ; } | |
501 | ||
f03fc89f VZ |
502 | // get the parent or the parent of the parent |
503 | wxWindow *GetParent() const { return m_parent; } | |
504 | inline wxWindow *GetGrandParent() const; | |
505 | ||
506 | // is this window a top level one? | |
8487f887 | 507 | virtual bool IsTopLevel() const; |
f03fc89f VZ |
508 | |
509 | // it doesn't really change parent, use ReParent() instead | |
510 | void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; } | |
d4864e97 VZ |
511 | // change the real parent of this window, return true if the parent |
512 | // was changed, false otherwise (error or newParent == oldParent) | |
f03fc89f VZ |
513 | virtual bool Reparent( wxWindowBase *newParent ); |
514 | ||
146ba0fe VZ |
515 | // implementation mostly |
516 | virtual void AddChild( wxWindowBase *child ); | |
517 | virtual void RemoveChild( wxWindowBase *child ); | |
518 | ||
519 | // looking for windows | |
520 | // ------------------- | |
521 | ||
f03fc89f VZ |
522 | // find window among the descendants of this one either by id or by |
523 | // name (return NULL if not found) | |
d9e2e4c2 | 524 | wxWindow *FindWindow( long winid ); |
f03fc89f VZ |
525 | wxWindow *FindWindow( const wxString& name ); |
526 | ||
146ba0fe | 527 | // Find a window among any window (all return NULL if not found) |
d9e2e4c2 | 528 | static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL ); |
146ba0fe VZ |
529 | static wxWindow *FindWindowByName( const wxString& name, |
530 | const wxWindow *parent = NULL ); | |
531 | static wxWindow *FindWindowByLabel( const wxString& label, | |
532 | const wxWindow *parent = NULL ); | |
f03fc89f VZ |
533 | |
534 | // event handler stuff | |
535 | // ------------------- | |
536 | ||
537 | // get the current event handler | |
538 | wxEvtHandler *GetEventHandler() const { return m_eventHandler; } | |
539 | ||
540 | // replace the event handler (allows to completely subclass the | |
541 | // window) | |
542 | void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; } | |
543 | ||
544 | // push/pop event handler: allows to chain a custom event handler to | |
545 | // alreasy existing ones | |
546 | void PushEventHandler( wxEvtHandler *handler ); | |
d4864e97 | 547 | wxEvtHandler *PopEventHandler( bool deleteHandler = false ); |
f03fc89f | 548 | |
2e36d5cf | 549 | // find the given handler in the event handler chain and remove (but |
d4864e97 VZ |
550 | // not delete) it from the event handler chain, return true if it was |
551 | // found and false otherwise (this also results in an assert failure so | |
2e36d5cf VZ |
552 | // this function should only be called when the handler is supposed to |
553 | // be there) | |
554 | bool RemoveEventHandler(wxEvtHandler *handler); | |
555 | ||
1e6feb95 VZ |
556 | // validators |
557 | // ---------- | |
f03fc89f | 558 | |
88ac883a | 559 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
560 | // a window may have an associated validator which is used to control |
561 | // user input | |
562 | virtual void SetValidator( const wxValidator &validator ); | |
563 | virtual wxValidator *GetValidator() { return m_windowValidator; } | |
88ac883a | 564 | #endif // wxUSE_VALIDATORS |
f03fc89f | 565 | |
f03fc89f VZ |
566 | |
567 | // dialog oriented functions | |
568 | // ------------------------- | |
569 | ||
d4864e97 | 570 | // validate the correctness of input, return true if ok |
f03fc89f VZ |
571 | virtual bool Validate(); |
572 | ||
573 | // transfer data between internal and GUI representations | |
574 | virtual bool TransferDataToWindow(); | |
575 | virtual bool TransferDataFromWindow(); | |
576 | ||
577 | virtual void InitDialog(); | |
578 | ||
88ac883a | 579 | #if wxUSE_ACCEL |
f03fc89f VZ |
580 | // accelerators |
581 | // ------------ | |
582 | virtual void SetAcceleratorTable( const wxAcceleratorTable& accel ) | |
583 | { m_acceleratorTable = accel; } | |
584 | wxAcceleratorTable *GetAcceleratorTable() | |
585 | { return &m_acceleratorTable; } | |
5048c832 | 586 | |
540b6b09 VZ |
587 | #endif // wxUSE_ACCEL |
588 | ||
589 | #if wxUSE_HOTKEY | |
590 | // hot keys (system wide accelerators) | |
591 | // ----------------------------------- | |
592 | ||
593 | virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode); | |
5048c832 | 594 | virtual bool UnregisterHotKey(int hotkeyId); |
540b6b09 | 595 | #endif // wxUSE_HOTKEY |
5048c832 | 596 | |
f03fc89f VZ |
597 | |
598 | // dialog units translations | |
599 | // ------------------------- | |
600 | ||
601 | wxPoint ConvertPixelsToDialog( const wxPoint& pt ); | |
602 | wxPoint ConvertDialogToPixels( const wxPoint& pt ); | |
603 | wxSize ConvertPixelsToDialog( const wxSize& sz ) | |
604 | { | |
605 | wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); | |
606 | ||
607 | return wxSize(pt.x, pt.y); | |
608 | } | |
609 | ||
610 | wxSize ConvertDialogToPixels( const wxSize& sz ) | |
611 | { | |
612 | wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); | |
613 | ||
614 | return wxSize(pt.x, pt.y); | |
615 | } | |
616 | ||
617 | // mouse functions | |
618 | // --------------- | |
619 | ||
620 | // move the mouse to the specified position | |
621 | virtual void WarpPointer(int x, int y) = 0; | |
622 | ||
94633ad9 VZ |
623 | // start or end mouse capture, these functions maintain the stack of |
624 | // windows having captured the mouse and after calling ReleaseMouse() | |
625 | // the mouse is not released but returns to the window which had had | |
626 | // captured it previously (if any) | |
627 | void CaptureMouse(); | |
628 | void ReleaseMouse(); | |
f03fc89f | 629 | |
1e6feb95 VZ |
630 | // get the window which currently captures the mouse or NULL |
631 | static wxWindow *GetCapture(); | |
632 | ||
633 | // does this window have the capture? | |
634 | virtual bool HasCapture() const | |
635 | { return (wxWindow *)this == GetCapture(); } | |
636 | ||
f03fc89f VZ |
637 | // painting the window |
638 | // ------------------- | |
639 | ||
640 | // mark the specified rectangle (or the whole window) as "dirty" so it | |
641 | // will be repainted | |
d4864e97 | 642 | virtual void Refresh( bool eraseBackground = true, |
f03fc89f | 643 | const wxRect *rect = (const wxRect *) NULL ) = 0; |
1e6feb95 VZ |
644 | |
645 | // a less awkward wrapper for Refresh | |
d4864e97 | 646 | void RefreshRect(const wxRect& rect) { Refresh(true, &rect); } |
1e6feb95 VZ |
647 | |
648 | // repaint all invalid areas of the window immediately | |
649 | virtual void Update() { } | |
650 | ||
5da0803c VZ |
651 | // clear the window background |
652 | virtual void ClearBackground(); | |
f03fc89f | 653 | |
0cc7251e VZ |
654 | // freeze the window: don't redraw it until it is thawed |
655 | virtual void Freeze() { } | |
656 | ||
657 | // thaw the window: redraw it after it had been frozen | |
658 | virtual void Thaw() { } | |
659 | ||
f03fc89f | 660 | // adjust DC for drawing on this window |
f6147cfc | 661 | virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { } |
f03fc89f VZ |
662 | |
663 | // the update region of the window contains the areas which must be | |
664 | // repainted by the program | |
665 | const wxRegion& GetUpdateRegion() const { return m_updateRegion; } | |
666 | wxRegion& GetUpdateRegion() { return m_updateRegion; } | |
667 | ||
1e6feb95 VZ |
668 | // get the update rectangleregion bounding box in client coords |
669 | wxRect GetUpdateClientRect() const; | |
670 | ||
f03fc89f VZ |
671 | // these functions verify whether the given point/rectangle belongs to |
672 | // (or at least intersects with) the update region | |
673 | bool IsExposed( int x, int y ) const; | |
674 | bool IsExposed( int x, int y, int w, int h ) const; | |
675 | ||
676 | bool IsExposed( const wxPoint& pt ) const | |
677 | { return IsExposed(pt.x, pt.y); } | |
678 | bool IsExposed( const wxRect& rect ) const | |
679 | { return IsExposed(rect.x, rect.y, rect.width, rect.height); } | |
680 | ||
681 | // colours, fonts and cursors | |
682 | // -------------------------- | |
683 | ||
1b69c815 VZ |
684 | // get the default attributes for the controls of this class: we |
685 | // provide a virtual function which can be used to query the default | |
686 | // attributes of an existing control and a static function which can | |
687 | // be used even when no existing object of the given class is | |
688 | // available, but which won't return any styles specific to this | |
689 | // particular control, of course (e.g. "Ok" button might have | |
690 | // different -- bold for example -- font) | |
691 | virtual wxVisualAttributes GetDefaultAttributes() const | |
692 | { | |
693 | return GetClassDefaultAttributes(GetWindowVariant()); | |
694 | } | |
695 | ||
696 | static wxVisualAttributes | |
697 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); | |
698 | ||
f03fc89f | 699 | // set/retrieve the window colours (system defaults are used by |
b8e7b673 VZ |
700 | // default): SetXXX() functions return true if colour was changed, |
701 | // SetDefaultXXX() reset the "m_hasXXX" flag after setting the value | |
702 | // to prevent it from being inherited by our children | |
703 | virtual bool SetBackgroundColour(const wxColour& colour); | |
704 | void SetDefaultBackgroundColour(const wxColour& colour) | |
705 | { | |
706 | if ( SetBackgroundColour(colour) ) | |
707 | m_hasBgCol = false; | |
708 | } | |
1b69c815 | 709 | wxColour GetBackgroundColour() const; |
b8e7b673 VZ |
710 | |
711 | virtual bool SetForegroundColour(const wxColour& colour); | |
712 | void SetDefaultForegroundColour(const wxColour& colour) | |
713 | { | |
714 | if ( SetForegroundColour(colour) ) | |
715 | m_hasFgCol = false; | |
716 | } | |
1b69c815 | 717 | wxColour GetForegroundColour() const; |
f03fc89f | 718 | |
b8e7b673 VZ |
719 | // set/retrieve the font for the window (SetFont() returns true if the |
720 | // font really changed) | |
721 | virtual bool SetFont(const wxFont& font) = 0; | |
722 | void SetDefaultFont(const wxFont& font) | |
723 | { | |
724 | if ( SetFont(font) ) | |
725 | m_hasFont = false; | |
726 | } | |
727 | const wxFont& GetFont() const { return DoGetFont(); } | |
728 | wxFont& GetFont() { return DoGetFont(); } | |
729 | ||
d4864e97 | 730 | // set/retrieve the cursor for this window (SetCursor() returns true |
f03fc89f VZ |
731 | // if the cursor was really changed) |
732 | virtual bool SetCursor( const wxCursor &cursor ); | |
733 | const wxCursor& GetCursor() const { return m_cursor; } | |
734 | wxCursor& GetCursor() { return m_cursor; } | |
735 | ||
789295bf VZ |
736 | #if wxUSE_CARET |
737 | // associate a caret with the window | |
738 | void SetCaret(wxCaret *caret); | |
739 | // get the current caret (may be NULL) | |
740 | wxCaret *GetCaret() const { return m_caret; } | |
741 | #endif // wxUSE_CARET | |
742 | ||
f03fc89f VZ |
743 | // get the (average) character size for the current font |
744 | virtual int GetCharHeight() const = 0; | |
745 | virtual int GetCharWidth() const = 0; | |
746 | ||
747 | // get the width/height/... of the text using current or specified | |
748 | // font | |
749 | virtual void GetTextExtent(const wxString& string, | |
750 | int *x, int *y, | |
751 | int *descent = (int *) NULL, | |
752 | int *externalLeading = (int *) NULL, | |
753 | const wxFont *theFont = (const wxFont *) NULL) | |
754 | const = 0; | |
755 | ||
1e6feb95 VZ |
756 | // client <-> screen coords |
757 | // ------------------------ | |
758 | ||
f03fc89f | 759 | // translate to/from screen/client coordinates (pointers may be NULL) |
dabc0cd5 VZ |
760 | void ClientToScreen( int *x, int *y ) const |
761 | { DoClientToScreen(x, y); } | |
762 | void ScreenToClient( int *x, int *y ) const | |
763 | { DoScreenToClient(x, y); } | |
1e6feb95 VZ |
764 | |
765 | // wxPoint interface to do the same thing | |
dabc0cd5 VZ |
766 | wxPoint ClientToScreen(const wxPoint& pt) const |
767 | { | |
768 | int x = pt.x, y = pt.y; | |
769 | DoClientToScreen(&x, &y); | |
770 | ||
771 | return wxPoint(x, y); | |
772 | } | |
773 | ||
774 | wxPoint ScreenToClient(const wxPoint& pt) const | |
775 | { | |
776 | int x = pt.x, y = pt.y; | |
777 | DoScreenToClient(&x, &y); | |
778 | ||
779 | return wxPoint(x, y); | |
780 | } | |
f03fc89f | 781 | |
1e6feb95 VZ |
782 | // test where the given (in client coords) point lies |
783 | wxHitTest HitTest(wxCoord x, wxCoord y) const | |
784 | { return DoHitTest(x, y); } | |
785 | ||
786 | wxHitTest HitTest(const wxPoint& pt) const | |
787 | { return DoHitTest(pt.x, pt.y); } | |
788 | ||
f03fc89f VZ |
789 | // misc |
790 | // ---- | |
791 | ||
aede4ebb VZ |
792 | // get the window border style from the given flags: this is different from |
793 | // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to | |
794 | // translate wxBORDER_DEFAULT to something reasonable | |
795 | wxBorder GetBorder(long flags) const; | |
796 | ||
797 | // get border for the flags of this window | |
798 | wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } | |
1e6feb95 | 799 | |
d4864e97 | 800 | // send wxUpdateUIEvents to this window, and children if recurse is true |
e39af974 JS |
801 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); |
802 | ||
803 | // do the window-specific processing after processing the update event | |
804 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
f03fc89f | 805 | |
1e6feb95 | 806 | #if wxUSE_MENUS |
a1665b22 VZ |
807 | bool PopupMenu( wxMenu *menu, const wxPoint& pos ) |
808 | { return DoPopupMenu(menu, pos.x, pos.y); } | |
809 | bool PopupMenu( wxMenu *menu, int x, int y ) | |
810 | { return DoPopupMenu(menu, x, y); } | |
1e6feb95 | 811 | #endif // wxUSE_MENUS |
f03fc89f VZ |
812 | |
813 | // scrollbars | |
814 | // ---------- | |
815 | ||
1e6feb95 VZ |
816 | // does the window have the scrollbar for this orientation? |
817 | bool HasScrollbar(int orient) const | |
818 | { | |
819 | return (m_windowStyle & | |
820 | (orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0; | |
821 | } | |
822 | ||
f03fc89f VZ |
823 | // configure the window scrollbars |
824 | virtual void SetScrollbar( int orient, | |
825 | int pos, | |
1e6feb95 | 826 | int thumbvisible, |
f03fc89f | 827 | int range, |
d4864e97 VZ |
828 | bool refresh = true ) = 0; |
829 | virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0; | |
f03fc89f VZ |
830 | virtual int GetScrollPos( int orient ) const = 0; |
831 | virtual int GetScrollThumb( int orient ) const = 0; | |
832 | virtual int GetScrollRange( int orient ) const = 0; | |
833 | ||
834 | // scroll window to the specified position | |
835 | virtual void ScrollWindow( int dx, int dy, | |
836 | const wxRect* rect = (wxRect *) NULL ) = 0; | |
837 | ||
b9b3393e | 838 | // scrolls window by line/page: note that not all controls support this |
9cd6d737 | 839 | // |
d4864e97 VZ |
840 | // return true if the position changed, false otherwise |
841 | virtual bool ScrollLines(int WXUNUSED(lines)) { return false; } | |
842 | virtual bool ScrollPages(int WXUNUSED(pages)) { return false; } | |
9cd6d737 VZ |
843 | |
844 | // convenient wrappers for ScrollLines/Pages | |
845 | bool LineUp() { return ScrollLines(-1); } | |
846 | bool LineDown() { return ScrollLines(1); } | |
847 | bool PageUp() { return ScrollPages(-1); } | |
848 | bool PageDown() { return ScrollPages(1); } | |
b9b3393e | 849 | |
bd83cb56 VZ |
850 | // context-sensitive help |
851 | // ---------------------- | |
852 | ||
853 | // these are the convenience functions wrapping wxHelpProvider methods | |
854 | ||
855 | #if wxUSE_HELP | |
856 | // associate this help text with this window | |
857 | void SetHelpText(const wxString& text); | |
858 | // associate this help text with all windows with the same id as this | |
859 | // one | |
860 | void SetHelpTextForId(const wxString& text); | |
861 | // get the help string associated with this window (may be empty) | |
862 | wxString GetHelpText() const; | |
863 | #endif // wxUSE_HELP | |
864 | ||
f03fc89f VZ |
865 | // tooltips |
866 | // -------- | |
bd83cb56 | 867 | |
f03fc89f VZ |
868 | #if wxUSE_TOOLTIPS |
869 | // the easiest way to set a tooltip for a window is to use this method | |
870 | void SetToolTip( const wxString &tip ); | |
871 | // attach a tooltip to the window | |
872 | void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); } | |
873 | // get the associated tooltip or NULL if none | |
874 | wxToolTip* GetToolTip() const { return m_tooltip; } | |
311a173b | 875 | wxString GetToolTipText() const ; |
f03fc89f VZ |
876 | #endif // wxUSE_TOOLTIPS |
877 | ||
878 | // drag and drop | |
879 | // ------------- | |
880 | #if wxUSE_DRAG_AND_DROP | |
881 | // set/retrieve the drop target associated with this window (may be | |
882 | // NULL; it's owned by the window and will be deleted by it) | |
883 | virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0; | |
884 | virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; } | |
885 | #endif // wxUSE_DRAG_AND_DROP | |
886 | ||
887 | // constraints and sizers | |
888 | // ---------------------- | |
889 | #if wxUSE_CONSTRAINTS | |
890 | // set the constraints for this window or retrieve them (may be NULL) | |
891 | void SetConstraints( wxLayoutConstraints *constraints ); | |
892 | wxLayoutConstraints *GetConstraints() const { return m_constraints; } | |
893 | ||
f03fc89f VZ |
894 | // implementation only |
895 | void UnsetConstraints(wxLayoutConstraints *c); | |
896 | wxWindowList *GetConstraintsInvolvedIn() const | |
897 | { return m_constraintsInvolvedIn; } | |
898 | void AddConstraintReference(wxWindowBase *otherWin); | |
899 | void RemoveConstraintReference(wxWindowBase *otherWin); | |
900 | void DeleteRelatedConstraints(); | |
901 | void ResetConstraints(); | |
902 | ||
903 | // these methods may be overriden for special layout algorithms | |
d4864e97 | 904 | virtual void SetConstraintSizes(bool recurse = true); |
f03fc89f VZ |
905 | virtual bool LayoutPhase1(int *noChanges); |
906 | virtual bool LayoutPhase2(int *noChanges); | |
4b7f2165 | 907 | virtual bool DoPhase(int phase); |
f03fc89f VZ |
908 | |
909 | // these methods are virtual but normally won't be overridden | |
f03fc89f VZ |
910 | virtual void SetSizeConstraint(int x, int y, int w, int h); |
911 | virtual void MoveConstraint(int x, int y); | |
912 | virtual void GetSizeConstraint(int *w, int *h) const ; | |
913 | virtual void GetClientSizeConstraint(int *w, int *h) const ; | |
914 | virtual void GetPositionConstraint(int *x, int *y) const ; | |
915 | ||
461e93f9 JS |
916 | #endif // wxUSE_CONSTRAINTS |
917 | ||
918 | // when using constraints or sizers, it makes sense to update | |
919 | // children positions automatically whenever the window is resized | |
920 | // - this is done if autoLayout is on | |
921 | void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; } | |
922 | bool GetAutoLayout() const { return m_autoLayout; } | |
923 | ||
924 | // lay out the window and its children | |
925 | virtual bool Layout(); | |
926 | ||
f03fc89f | 927 | // sizers |
d4864e97 VZ |
928 | void SetSizer(wxSizer *sizer, bool deleteOld = true ); |
929 | void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ); | |
566d84a7 | 930 | |
f03fc89f | 931 | wxSizer *GetSizer() const { return m_windowSizer; } |
be90c029 RD |
932 | |
933 | // Track if this window is a member of a sizer | |
f0244295 VZ |
934 | void SetContainingSizer(wxSizer* sizer) |
935 | { | |
936 | // adding a window to a sizer twice is going to result in fatal and | |
937 | // hard to debug problems later because when deleting the second | |
938 | // associated wxSizerItem we're going to dereference a dangling | |
939 | // pointer; so try to detect this as early as possible | |
940 | wxASSERT_MSG( !sizer || m_containingSizer != sizer, | |
941 | _T("Adding a window to the same sizer twice?") ); | |
942 | ||
943 | m_containingSizer = sizer; | |
944 | } | |
be90c029 RD |
945 | wxSizer *GetContainingSizer() const { return m_containingSizer; } |
946 | ||
45a959a3 JS |
947 | // accessibility |
948 | // ---------------------- | |
949 | #if wxUSE_ACCESSIBILITY | |
950 | // Override to create a specific accessible object. | |
951 | virtual wxAccessible* CreateAccessible(); | |
952 | ||
953 | // Sets the accessible object. | |
954 | void SetAccessible(wxAccessible* accessible) ; | |
955 | ||
956 | // Returns the accessible object. | |
957 | wxAccessible* GetAccessible() { return m_accessible; }; | |
958 | ||
959 | // Returns the accessible object, creating if necessary. | |
960 | wxAccessible* GetOrCreateAccessible() ; | |
961 | #endif | |
962 | ||
f03fc89f VZ |
963 | // implementation |
964 | // -------------- | |
965 | ||
966 | // event handlers | |
967 | void OnSysColourChanged( wxSysColourChangedEvent& event ); | |
968 | void OnInitDialog( wxInitDialogEvent &event ); | |
72fc5caf | 969 | void OnMiddleClick( wxMouseEvent& event ); |
bd83cb56 VZ |
970 | #if wxUSE_HELP |
971 | void OnHelp(wxHelpEvent& event); | |
972 | #endif // wxUSE_HELP | |
f03fc89f | 973 | |
e39af974 JS |
974 | // virtual function for implementing internal idle |
975 | // behaviour | |
976 | virtual void OnInternalIdle() {} | |
977 | ||
978 | // call internal idle recursively | |
5109ae5d | 979 | // void ProcessInternalIdle() ; |
e39af974 JS |
980 | |
981 | // get the handle of the window for the underlying window system: this | |
d7c24517 VZ |
982 | // is only used for wxWin itself or for user code which wants to call |
983 | // platform-specific APIs | |
d22699b5 | 984 | virtual WXWidget GetHandle() const = 0; |
cc2b7472 | 985 | |
574c939e KB |
986 | #if wxUSE_PALETTE |
987 | // Store the palette used by DCs in wxWindow so that the dcs can share | |
988 | // a palette. And we can respond to palette messages. | |
989 | wxPalette GetPalette() const { return m_palette; } | |
b95edd47 | 990 | |
574c939e KB |
991 | // When palette is changed tell the DC to set the system palette to the |
992 | // new one. | |
b95edd47 VZ |
993 | void SetPalette(const wxPalette& pal); |
994 | ||
995 | // return true if we have a specific palette | |
996 | bool HasCustomPalette() const { return m_hasCustomPalette; } | |
997 | ||
998 | // return the first parent window with a custom palette or NULL | |
999 | wxWindow *GetAncestorWithCustomPalette() const; | |
574c939e KB |
1000 | #endif // wxUSE_PALETTE |
1001 | ||
739730ca | 1002 | protected: |
4caf847c | 1003 | // event handling specific to wxWindow |
4caf847c | 1004 | virtual bool TryValidator(wxEvent& event); |
4caf847c VZ |
1005 | virtual bool TryParent(wxEvent& event); |
1006 | ||
b8e7b673 VZ |
1007 | // inherit the parents visual attributes if they had been explicitly set |
1008 | // by the user (i.e. we don't inherit default attributes) and if we don't | |
1009 | // have our own explicitly set | |
1010 | virtual void InheritAttributes(); | |
1011 | ||
1012 | // returns false from here if this window doesn't want to inherit the | |
1013 | // parents colours even if InheritAttributes() would normally do it | |
1014 | // | |
1015 | // this just provides a simple way to customize InheritAttributes() | |
1016 | // behaviour in the most common case | |
1017 | virtual bool ShouldInheritColours() const { return false; } | |
1018 | ||
4caf847c | 1019 | |
ec5bb70d VZ |
1020 | #if wxUSE_CONSTRAINTS |
1021 | // satisfy the constraints for the windows but don't set the window sizes | |
1022 | void SatisfyConstraints(); | |
1023 | #endif // wxUSE_CONSTRAINTS | |
566d84a7 | 1024 | |
7de59551 RD |
1025 | // Send the wxWindowDestroyEvent |
1026 | void SendDestroyEvent(); | |
1027 | ||
7af6f327 | 1028 | // the window id - a number which uniquely identifies a window among |
d7c24517 | 1029 | // its siblings unless it is -1 |
f03fc89f | 1030 | wxWindowID m_windowId; |
456bc6d9 | 1031 | |
f03fc89f VZ |
1032 | // the parent window of this window (or NULL) and the list of the children |
1033 | // of this window | |
1034 | wxWindow *m_parent; | |
1035 | wxWindowList m_children; | |
1036 | ||
1037 | // the minimal allowed size for the window (no minimal size if variable(s) | |
1038 | // contain(s) -1) | |
ec5bb70d VZ |
1039 | int m_minWidth, |
1040 | m_minHeight, | |
1041 | m_maxWidth, | |
1042 | m_maxHeight; | |
f03fc89f VZ |
1043 | |
1044 | // event handler for this window: usually is just 'this' but may be | |
1045 | // changed with SetEventHandler() | |
1046 | wxEvtHandler *m_eventHandler; | |
1047 | ||
88ac883a | 1048 | #if wxUSE_VALIDATORS |
f03fc89f VZ |
1049 | // associated validator or NULL if none |
1050 | wxValidator *m_windowValidator; | |
88ac883a | 1051 | #endif // wxUSE_VALIDATORS |
f03fc89f VZ |
1052 | |
1053 | #if wxUSE_DRAG_AND_DROP | |
1054 | wxDropTarget *m_dropTarget; | |
1055 | #endif // wxUSE_DRAG_AND_DROP | |
1056 | ||
1057 | // visual window attributes | |
1058 | wxCursor m_cursor; | |
1b69c815 VZ |
1059 | wxFont m_font; // see m_hasFont |
1060 | wxColour m_backgroundColour, // m_hasBgCol | |
1061 | m_foregroundColour; // m_hasFgCol | |
f03fc89f | 1062 | |
789295bf VZ |
1063 | #if wxUSE_CARET |
1064 | wxCaret *m_caret; | |
1065 | #endif // wxUSE_CARET | |
1066 | ||
f03fc89f VZ |
1067 | // the region which should be repainted in response to paint event |
1068 | wxRegion m_updateRegion; | |
1069 | ||
88ac883a | 1070 | #if wxUSE_ACCEL |
f03fc89f VZ |
1071 | // the accelerator table for the window which translates key strokes into |
1072 | // command events | |
1073 | wxAcceleratorTable m_acceleratorTable; | |
88ac883a | 1074 | #endif // wxUSE_ACCEL |
f03fc89f | 1075 | |
f03fc89f VZ |
1076 | // the tooltip for this window (may be NULL) |
1077 | #if wxUSE_TOOLTIPS | |
1078 | wxToolTip *m_tooltip; | |
1079 | #endif // wxUSE_TOOLTIPS | |
1080 | ||
1081 | // constraints and sizers | |
1082 | #if wxUSE_CONSTRAINTS | |
1083 | // the constraints for this window or NULL | |
1084 | wxLayoutConstraints *m_constraints; | |
1085 | ||
1086 | // constraints this window is involved in | |
1087 | wxWindowList *m_constraintsInvolvedIn; | |
461e93f9 | 1088 | #endif // wxUSE_CONSTRAINTS |
f03fc89f | 1089 | |
be90c029 | 1090 | // this window's sizer |
f03fc89f | 1091 | wxSizer *m_windowSizer; |
be90c029 RD |
1092 | |
1093 | // The sizer this window is a member of, if any | |
1094 | wxSizer *m_containingSizer; | |
f03fc89f VZ |
1095 | |
1096 | // Layout() window automatically when its size changes? | |
1097 | bool m_autoLayout:1; | |
f03fc89f VZ |
1098 | |
1099 | // window state | |
1100 | bool m_isShown:1; | |
1101 | bool m_isEnabled:1; | |
1102 | bool m_isBeingDeleted:1; | |
1103 | ||
23895080 VZ |
1104 | // was the window colours/font explicitly changed by user? |
1105 | bool m_hasBgCol:1; | |
1106 | bool m_hasFgCol:1; | |
1107 | bool m_hasFont:1; | |
1108 | ||
f03fc89f | 1109 | // window attributes |
d80cd92a VZ |
1110 | long m_windowStyle, |
1111 | m_exStyle; | |
f03fc89f | 1112 | wxString m_windowName; |
a2d93e73 | 1113 | bool m_themeEnabled; |
f03fc89f | 1114 | |
071e5fd9 | 1115 | #if wxUSE_PALETTE |
574c939e | 1116 | wxPalette m_palette; |
b95edd47 VZ |
1117 | bool m_hasCustomPalette; |
1118 | #endif // wxUSE_PALETTE | |
574c939e | 1119 | |
45a959a3 JS |
1120 | #if wxUSE_ACCESSIBILITY |
1121 | wxAccessible* m_accessible; | |
1122 | #endif | |
2654f7e4 DE |
1123 | // Best size for controls which fail to implement DoGetBestSize() |
1124 | wxSize m_bestSize; | |
1125 | ||
566d84a7 RL |
1126 | // Virtual size (scrolling) |
1127 | wxSize m_virtualSize; | |
1128 | ||
1129 | int m_minVirtualWidth; // VirtualSizeHints | |
1130 | int m_minVirtualHeight; | |
1131 | int m_maxVirtualWidth; | |
1132 | int m_maxVirtualHeight; | |
69d90995 SC |
1133 | |
1134 | wxWindowVariant m_windowVariant ; | |
45e0dc94 | 1135 | |
1e6feb95 VZ |
1136 | // override this to change the default (i.e. used when no style is |
1137 | // specified) border for the window class | |
1138 | virtual wxBorder GetDefaultBorder() const; | |
1139 | ||
5c2be659 RD |
1140 | // Get the default size for the new window if no explicit size given. TLWs |
1141 | // have their own default size so this is just for non top-level windows. | |
66202a7e RD |
1142 | static int WidthDefault(int w) { return w == -1 ? 20 : w; } |
1143 | static int HeightDefault(int h) { return h == -1 ? 20 : h; } | |
f03fc89f | 1144 | |
1e6feb95 VZ |
1145 | // set the best size for the control if the default size was given: |
1146 | // replaces the fields of size == -1 with the best values for them and | |
1147 | // calls SetSize() if needed | |
2b5f62a0 VZ |
1148 | // |
1149 | // This function is rather unfortunately named.. it's really just a | |
1150 | // smarter SetSize / convenience function for expanding wxDefaultSize. | |
1151 | // Note that it does not influence the value returned by GetBestSize | |
1152 | // at all. | |
1e6feb95 | 1153 | void SetBestSize(const wxSize& size) |
f68586e5 | 1154 | { |
2b5f62a0 VZ |
1155 | // the size only needs to be changed if the current size is incomplete, |
1156 | // i.e. one of the components was specified as default -- so if both | |
1157 | // were given, simply don't do anything | |
f68586e5 VZ |
1158 | if ( size.x == -1 || size.y == -1 ) |
1159 | { | |
1e6feb95 VZ |
1160 | wxSize sizeBest = DoGetBestSize(); |
1161 | if ( size.x != -1 ) | |
1162 | sizeBest.x = size.x; | |
1163 | if ( size.y != -1 ) | |
1164 | sizeBest.y = size.y; | |
1165 | ||
1166 | SetSize(sizeBest); | |
f68586e5 VZ |
1167 | } |
1168 | } | |
1169 | ||
f03fc89f VZ |
1170 | // more pure virtual functions |
1171 | // --------------------------- | |
1172 | ||
1173 | // NB: we must have DoSomething() function when Something() is an overloaded | |
1174 | // method: indeed, we can't just have "virtual Something()" in case when | |
1175 | // the function is overloaded because then we'd have to make virtual all | |
1176 | // the variants (otherwise only the virtual function may be called on a | |
1177 | // pointer to derived class according to C++ rules) which is, in | |
1178 | // general, absolutely not needed. So instead we implement all | |
1179 | // overloaded Something()s in terms of DoSomething() which will be the | |
1180 | // only one to be virtual. | |
1181 | ||
dabc0cd5 VZ |
1182 | // coordinates translation |
1183 | virtual void DoClientToScreen( int *x, int *y ) const = 0; | |
1184 | virtual void DoScreenToClient( int *x, int *y ) const = 0; | |
1185 | ||
1e6feb95 VZ |
1186 | virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const; |
1187 | ||
94633ad9 | 1188 | // capture/release the mouse, used by Capture/ReleaseMouse() |
a83e1475 VZ |
1189 | virtual void DoCaptureMouse() = 0; |
1190 | virtual void DoReleaseMouse() = 0; | |
be90c029 | 1191 | |
f03fc89f VZ |
1192 | // retrieve the position/size of the window |
1193 | virtual void DoGetPosition( int *x, int *y ) const = 0; | |
1194 | virtual void DoGetSize( int *width, int *height ) const = 0; | |
1195 | virtual void DoGetClientSize( int *width, int *height ) const = 0; | |
1196 | ||
f68586e5 VZ |
1197 | // get the size which best suits the window: for a control, it would be |
1198 | // the minimal size which doesn't truncate the control, for a panel - the | |
1199 | // same size as it would have after a call to Fit() | |
1200 | virtual wxSize DoGetBestSize() const; | |
1201 | ||
f03fc89f VZ |
1202 | // this is the virtual function to be overriden in any derived class which |
1203 | // wants to change how SetSize() or Move() works - it is called by all | |
1204 | // versions of these functions in the base class | |
1205 | virtual void DoSetSize(int x, int y, | |
1206 | int width, int height, | |
1207 | int sizeFlags = wxSIZE_AUTO) = 0; | |
1208 | ||
1209 | // same as DoSetSize() for the client size | |
1210 | virtual void DoSetClientSize(int width, int height) = 0; | |
1211 | ||
9d9b7755 VZ |
1212 | // move the window to the specified location and resize it: this is called |
1213 | // from both DoSetSize() and DoSetClientSize() and would usually just | |
1214 | // reposition this window except for composite controls which will want to | |
1215 | // arrange themselves inside the given rectangle | |
1216 | virtual void DoMoveWindow(int x, int y, int width, int height) = 0; | |
1217 | ||
f03fc89f VZ |
1218 | #if wxUSE_TOOLTIPS |
1219 | virtual void DoSetToolTip( wxToolTip *tip ); | |
1220 | #endif // wxUSE_TOOLTIPS | |
1221 | ||
1e6feb95 | 1222 | #if wxUSE_MENUS |
a1665b22 | 1223 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0; |
1e6feb95 | 1224 | #endif // wxUSE_MENUS |
a1665b22 | 1225 | |
716e96df VZ |
1226 | // Makes an adjustment to the window position to make it relative to the |
1227 | // parents client area, e.g. if the parent is a frame with a toolbar, its | |
1228 | // (0, 0) is just below the toolbar | |
1229 | virtual void AdjustForParentClientOrigin(int& x, int& y, | |
1230 | int sizeFlags = 0) const; | |
8d99be5f | 1231 | |
69d90995 SC |
1232 | // implements the window variants |
1233 | virtual void DoSetWindowVariant( wxWindowVariant variant ) ; | |
45e0dc94 | 1234 | |
f03fc89f VZ |
1235 | private: |
1236 | // contains the last id generated by NewControlId | |
1237 | static int ms_lastControlId; | |
1238 | ||
a83e1475 VZ |
1239 | // the stack of windows which have captured the mouse |
1240 | static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext; | |
1241 | ||
1b69c815 VZ |
1242 | // implementation of both const and non-const versions of GetFont() |
1243 | wxFont& DoGetFont() const; | |
1244 | ||
1245 | ||
1e6feb95 VZ |
1246 | DECLARE_ABSTRACT_CLASS(wxWindowBase) |
1247 | DECLARE_NO_COPY_CLASS(wxWindowBase) | |
f03fc89f VZ |
1248 | DECLARE_EVENT_TABLE() |
1249 | }; | |
1250 | ||
1251 | // ---------------------------------------------------------------------------- | |
1252 | // now include the declaration of wxWindow class | |
1253 | // ---------------------------------------------------------------------------- | |
1254 | ||
1e6feb95 | 1255 | // include the declaration of the platform-specific class |
2049ba38 | 1256 | #if defined(__WXMSW__) |
a5b3669d VZ |
1257 | #ifdef __WXUNIVERSAL__ |
1258 | #define wxWindowNative wxWindowMSW | |
1259 | #else // !wxUniv | |
1e6feb95 | 1260 | #define wxWindowMSW wxWindow |
a5b3669d | 1261 | #endif // wxUniv/!wxUniv |
f03fc89f | 1262 | #include "wx/msw/window.h" |
2049ba38 | 1263 | #elif defined(__WXMOTIF__) |
f03fc89f | 1264 | #include "wx/motif/window.h" |
2049ba38 | 1265 | #elif defined(__WXGTK__) |
a5b3669d VZ |
1266 | #ifdef __WXUNIVERSAL__ |
1267 | #define wxWindowNative wxWindowGTK | |
1268 | #else // !wxUniv | |
1e6feb95 | 1269 | #define wxWindowGTK wxWindow |
1e6feb95 | 1270 | #endif // wxUniv |
f03fc89f | 1271 | #include "wx/gtk/window.h" |
83df96d6 JS |
1272 | #elif defined(__WXX11__) |
1273 | #ifdef __WXUNIVERSAL__ | |
1274 | #define wxWindowNative wxWindowX11 | |
1275 | #else // !wxUniv | |
1276 | #define wxWindowX11 wxWindow | |
83df96d6 JS |
1277 | #endif // wxUniv |
1278 | #include "wx/x11/window.h" | |
711c76db | 1279 | #elif defined(__WXMGL__) |
386c7058 VS |
1280 | #ifdef __WXUNIVERSAL__ |
1281 | #define wxWindowNative wxWindowMGL | |
1282 | #else // !wxUniv | |
1283 | #define wxWindowMGL wxWindow | |
386c7058 VS |
1284 | #endif // wxUniv |
1285 | #include "wx/mgl/window.h" | |
34138703 | 1286 | #elif defined(__WXMAC__) |
e766c8a9 SC |
1287 | #ifdef __WXUNIVERSAL__ |
1288 | #define wxWindowNative wxWindowMac | |
1289 | #else // !wxUniv | |
1290 | #define wxWindowMac wxWindow | |
e766c8a9 | 1291 | #endif // wxUniv |
f03fc89f | 1292 | #include "wx/mac/window.h" |
e64df9bc DE |
1293 | #elif defined(__WXCOCOA__) |
1294 | #ifdef __WXUNIVERSAL__ | |
1295 | #define wxWindowNative wxWindowCocoa | |
1296 | #else // !wxUniv | |
1297 | #define wxWindowCocoa wxWindow | |
e64df9bc DE |
1298 | #endif // wxUniv |
1299 | #include "wx/cocoa/window.h" | |
1777b9bb | 1300 | #elif defined(__WXPM__) |
210a651b DW |
1301 | #ifdef __WXUNIVERSAL__ |
1302 | #define wxWindowNative wxWindowOS2 | |
1303 | #else // !wxUniv | |
1304 | #define wxWindowOS2 wxWindow | |
210a651b | 1305 | #endif // wxUniv/!wxUniv |
1777b9bb | 1306 | #include "wx/os2/window.h" |
c801d85f KB |
1307 | #endif |
1308 | ||
1e6feb95 VZ |
1309 | // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>, |
1310 | // for the native ports we already have defined it above | |
1311 | #if defined(__WXUNIVERSAL__) | |
a5b3669d VZ |
1312 | #ifndef wxWindowNative |
1313 | #error "wxWindowNative must be defined above!" | |
1314 | #endif | |
1315 | ||
1e6feb95 VZ |
1316 | #include "wx/univ/window.h" |
1317 | #endif // wxUniv | |
1318 | ||
f03fc89f VZ |
1319 | // ---------------------------------------------------------------------------- |
1320 | // inline functions which couldn't be declared in the class body because of | |
1321 | // forward dependencies | |
1322 | // ---------------------------------------------------------------------------- | |
1323 | ||
bacd69f9 | 1324 | inline wxWindow *wxWindowBase::GetGrandParent() const |
f03fc89f VZ |
1325 | { |
1326 | return m_parent ? m_parent->GetParent() : (wxWindow *)NULL; | |
1327 | } | |
1328 | ||
1329 | // ---------------------------------------------------------------------------- | |
3723b7b1 | 1330 | // global functions |
f03fc89f VZ |
1331 | // ---------------------------------------------------------------------------- |
1332 | ||
3723b7b1 JS |
1333 | // Find the wxWindow at the current mouse position, also returning the mouse |
1334 | // position. | |
1335 | WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt); | |
1336 | ||
1337 | // Get the current mouse position. | |
1338 | WXDLLEXPORT extern wxPoint wxGetMousePosition(); | |
1339 | ||
1e6feb95 VZ |
1340 | // get the currently active window of this application or NULL |
1341 | WXDLLEXPORT extern wxWindow *wxGetActiveWindow(); | |
1342 | ||
33b494d6 VZ |
1343 | // get the (first) top level parent window |
1344 | WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win); | |
1345 | ||
f68586e5 | 1346 | // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId() |
6d56eb5c | 1347 | inline int NewControlId() { return wxWindowBase::NewControlId(); } |
f03fc89f | 1348 | |
45a959a3 JS |
1349 | #if wxUSE_ACCESSIBILITY |
1350 | // ---------------------------------------------------------------------------- | |
1351 | // accessible object for windows | |
1352 | // ---------------------------------------------------------------------------- | |
1353 | ||
1354 | class WXDLLEXPORT wxWindowAccessible: public wxAccessible | |
1355 | { | |
1356 | public: | |
f81387bd | 1357 | wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); } |
45a959a3 JS |
1358 | virtual ~wxWindowAccessible() {}; |
1359 | ||
1360 | // Overridables | |
1361 | ||
1362 | // Can return either a child object, or an integer | |
1363 | // representing the child element, starting from 1. | |
1364 | virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject); | |
1365 | ||
1366 | // Returns the rectangle for this object (id = 0) or a child element (id > 0). | |
1367 | virtual wxAccStatus GetLocation(wxRect& rect, int elementId); | |
1368 | ||
1369 | // Navigates from fromId to toId/toObject. | |
1370 | virtual wxAccStatus Navigate(wxNavDir navDir, int fromId, | |
1371 | int* toId, wxAccessible** toObject); | |
1372 | ||
1373 | // Gets the name of the specified object. | |
1374 | virtual wxAccStatus GetName(int childId, wxString* name); | |
1375 | ||
1376 | // Gets the number of children. | |
a37e4a07 | 1377 | virtual wxAccStatus GetChildCount(int* childCount); |
45a959a3 JS |
1378 | |
1379 | // Gets the specified child (starting from 1). | |
1380 | // If *child is NULL and return value is wxACC_OK, | |
1381 | // this means that the child is a simple element and | |
1382 | // not an accessible object. | |
1383 | virtual wxAccStatus GetChild(int childId, wxAccessible** child); | |
1384 | ||
1385 | // Gets the parent, or NULL. | |
1386 | virtual wxAccStatus GetParent(wxAccessible** parent); | |
1387 | ||
1388 | // Performs the default action. childId is 0 (the action for this object) | |
1389 | // or > 0 (the action for a child). | |
1390 | // Return wxACC_NOT_SUPPORTED if there is no default action for this | |
1391 | // window (e.g. an edit control). | |
1392 | virtual wxAccStatus DoDefaultAction(int childId); | |
1393 | ||
1394 | // Gets the default action for this object (0) or > 0 (the action for a child). | |
1395 | // Return wxACC_OK even if there is no action. actionName is the action, or the empty | |
1396 | // string if there is no action. | |
1397 | // The retrieved string describes the action that is performed on an object, | |
1398 | // not what the object does as a result. For example, a toolbar button that prints | |
1399 | // a document has a default action of "Press" rather than "Prints the current document." | |
1400 | virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName); | |
1401 | ||
1402 | // Returns the description for this object or a child. | |
1403 | virtual wxAccStatus GetDescription(int childId, wxString* description); | |
1404 | ||
1405 | // Returns help text for this object or a child, similar to tooltip text. | |
1406 | virtual wxAccStatus GetHelpText(int childId, wxString* helpText); | |
1407 | ||
1408 | // Returns the keyboard shortcut for this object or child. | |
1409 | // Return e.g. ALT+K | |
1410 | virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut); | |
1411 | ||
1412 | // Returns a role constant. | |
1413 | virtual wxAccStatus GetRole(int childId, wxAccRole* role); | |
1414 | ||
1415 | // Returns a state constant. | |
1416 | virtual wxAccStatus GetState(int childId, long* state); | |
1417 | ||
1418 | // Returns a localized string representing the value for the object | |
1419 | // or child. | |
1420 | virtual wxAccStatus GetValue(int childId, wxString* strValue); | |
1421 | ||
1422 | // Selects the object or child. | |
1423 | virtual wxAccStatus Select(int childId, wxAccSelectionFlags selectFlags); | |
1424 | ||
1425 | // Gets the window with the keyboard focus. | |
1426 | // If childId is 0 and child is NULL, no object in | |
1427 | // this subhierarchy has the focus. | |
1428 | // If this object has the focus, child should be 'this'. | |
1429 | virtual wxAccStatus GetFocus(int* childId, wxAccessible** child); | |
1430 | ||
1431 | // Gets a variant representing the selected children | |
1432 | // of this object. | |
1433 | // Acceptable values: | |
d4864e97 | 1434 | // - a null variant (IsNull() returns true) |
45a959a3 JS |
1435 | // - a list variant (GetType() == wxT("list") |
1436 | // - an integer representing the selected child element, | |
1437 | // or 0 if this object is selected (GetType() == wxT("long") | |
1438 | // - a "void*" pointer to a wxAccessible child object | |
1439 | virtual wxAccStatus GetSelections(wxVariant* selections); | |
1440 | }; | |
1441 | ||
1442 | #endif // wxUSE_ACCESSIBILITY | |
1443 | ||
1444 | ||
c801d85f | 1445 | #endif |
34138703 | 1446 | // _WX_WINDOW_H_BASE_ |
34c3ffca | 1447 |