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