1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindowBase class - the interface of wxWindow
4 // Author: Vadim Zeitlin
5 // Modified by: Ron Lee
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_WINDOW_H_BASE_
13 #define _WX_WINDOW_H_BASE_
15 // ----------------------------------------------------------------------------
16 // headers which we must include here
17 // ----------------------------------------------------------------------------
19 #include "wx/event.h" // the base class
21 #include "wx/list.h" // defines wxWindowList
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"
30 #include "wx/validate.h" // for wxDefaultValidator (always include it)
33 #include "wx/palette.h"
34 #endif // wxUSE_PALETTE
40 #if wxUSE_ACCESSIBILITY
41 #include "wx/access.h"
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__
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
62 #define wxHAS_NATIVE_ENABLED_MANAGEMENT
65 // ----------------------------------------------------------------------------
66 // forward declarations
67 // ----------------------------------------------------------------------------
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
;
81 #if wxUSE_ACCESSIBILITY
82 class WXDLLIMPEXP_FWD_CORE wxAccessible
;
85 // ----------------------------------------------------------------------------
86 // helper stuff used by wxWindow
87 // ----------------------------------------------------------------------------
89 // struct containing all the visual attributes of a control
90 struct WXDLLIMPEXP_CORE wxVisualAttributes
92 // the font used for control label/text inside it
95 // the foreground colour
98 // the background colour, may be wxNullColour if the controls background
99 // colour is not solid
103 // different window variants, on platforms like eg mac uses different
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)
114 #if wxUSE_SYSTEM_OPTIONS
115 #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
118 // valid values for Show/HideWithEffect()
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
,
131 wxSHOW_EFFECT_EXPAND
,
135 // flags for SendSizeEvent()
138 wxSEND_EVENT_POST
= 1
141 // ----------------------------------------------------------------------------
142 // (pseudo)template list classes
143 // ----------------------------------------------------------------------------
145 WX_DECLARE_LIST_3(wxWindow
, wxWindowBase
, wxWindowList
, wxWindowListNode
, class WXDLLIMPEXP_CORE
);
147 // ----------------------------------------------------------------------------
149 // ----------------------------------------------------------------------------
151 extern WXDLLIMPEXP_DATA_CORE(wxWindowList
) wxTopLevelWindows
;
153 // declared here for compatibility only, main declaration is in wx/app.h
154 extern WXDLLIMPEXP_DATA_BASE(wxList
) wxPendingDelete
;
156 // ----------------------------------------------------------------------------
157 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
158 // interface of this class.
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 // ----------------------------------------------------------------------------
167 class WXDLLIMPEXP_CORE wxWindowBase
: public wxEvtHandler
170 // creating the window
171 // -------------------
173 // default ctor, initializes everything which can be initialized before
177 virtual ~wxWindowBase();
179 // deleting the window
180 // -------------------
182 // ask the window to close itself, return true if the event handler
183 // honoured our request
184 bool Close( bool force
= false );
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
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();
195 // is the window being deleted?
196 bool IsBeingDeleted() const;
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;
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
; }
212 // sets the window variant, calls internally DoSetVariant if variant
214 void SetWindowVariant(wxWindowVariant variant
);
215 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
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
))
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
,
229 wxCoord widthTotal
) const;
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
; }
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)
243 return wxIdManager::ReserveId(count
);
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)
250 wxIdManager::UnreserveId(id
, count
);
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
); }
262 void SetSize( int width
, int height
)
263 { DoSetSize( wxDefaultCoord
, wxDefaultCoord
, width
, height
, wxSIZE_USE_EXISTING
); }
265 void SetSize( const wxSize
& size
)
266 { SetSize( size
.x
, size
.y
); }
268 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
269 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
271 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
272 { DoSetSize(x
, y
, wxDefaultCoord
, wxDefaultCoord
, flags
); }
274 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
275 { Move(pt
.x
, pt
.y
, flags
); }
277 void SetPosition(const wxPoint
& pt
) { Move(pt
); }
280 virtual void Raise() = 0;
281 virtual void Lower() = 0;
283 // client size is the size of area available for subwindows
284 void SetClientSize( int width
, int height
)
285 { DoSetClientSize(width
, height
); }
287 void SetClientSize( const wxSize
& size
)
288 { DoSetClientSize(size
.x
, size
.y
); }
290 void SetClientSize(const wxRect
& rect
)
291 { SetClientSize( rect
.width
, rect
.height
); }
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
301 DoGetPosition(&x
, &y
);
303 return wxPoint(x
, y
);
306 // get the window position in screen coordinates
307 void GetScreenPosition(int *x
, int *y
) const { DoGetScreenPosition(x
, y
); }
308 wxPoint
GetScreenPosition() const
311 DoGetScreenPosition(&x
, &y
);
313 return wxPoint(x
, y
);
316 // get the window size (pointers may be NULL)
317 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
318 wxSize
GetSize() const
325 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
326 wxSize
GetClientSize() const
329 DoGetClientSize(&w
, &h
);
334 // get the position and size at once
335 wxRect
GetRect() const
341 return wxRect(x
, y
, w
, h
);
344 wxRect
GetScreenRect() const
347 GetScreenPosition(&x
, &y
);
350 return wxRect(x
, y
, w
, h
);
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;
358 // get the client rectangle in window (i.e. client) coordinates
359 wxRect
GetClientRect() const
361 return wxRect(GetClientAreaOrigin(), GetClientSize());
364 // client<->window size conversion
365 virtual wxSize
ClientToWindowSize(const wxSize
& size
) const;
366 virtual wxSize
WindowToClientSize(const wxSize
& size
) const;
368 // get the size best suited for the window (in fact, minimal
369 // acceptable size using which it will still look "nice" in
371 wxSize
GetBestSize() const;
373 void GetBestSize(int *w
, int *h
) const
375 wxSize s
= GetBestSize();
382 // Determine the best size in the other direction if one of them is
383 // fixed. This is used with windows that can wrap their contents and
384 // returns input-independent best size for the others.
385 int GetBestHeight(int width
) const;
386 int GetBestWidth(int height
) const;
389 void SetScrollHelper( wxScrollHelper
*sh
) { m_scrollHelper
= sh
; }
390 wxScrollHelper
*GetScrollHelper() { return m_scrollHelper
; }
392 // reset the cached best size value so it will be recalculated the
393 // next time it is needed.
394 void InvalidateBestSize();
395 void CacheBestSize(const wxSize
& size
) const
396 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
399 // This function will merge the window's best size into the window's
400 // minimum size, giving priority to the min size components, and
401 // returns the results.
402 virtual wxSize
GetEffectiveMinSize() const;
403 wxDEPRECATED( wxSize
GetBestFittingSize() const ); // replaced by GetEffectiveMinSize
404 wxDEPRECATED( wxSize
GetAdjustedMinSize() const ); // replaced by GetEffectiveMinSize
406 // A 'Smart' SetSize that will fill in default size values with 'best'
407 // size. Sets the minsize to what was passed in.
408 void SetInitialSize(const wxSize
& size
=wxDefaultSize
);
409 wxDEPRECATED( void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
) ); // replaced by SetInitialSize
412 // the generic centre function - centers the window on parent by`
413 // default or on screen if it doesn't have parent or
414 // wxCENTER_ON_SCREEN flag is given
415 void Centre(int dir
= wxBOTH
) { DoCentre(dir
); }
416 void Center(int dir
= wxBOTH
) { DoCentre(dir
); }
418 // centre with respect to the parent window
419 void CentreOnParent(int dir
= wxBOTH
) { DoCentre(dir
); }
420 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
422 // set window size to wrap around its children
425 // set virtual size to satisfy children
426 virtual void FitInside();
429 // SetSizeHints is actually for setting the size hints
430 // for the wxTLW for a Window Manager - hence the name -
431 // and it is therefore overridden in wxTLW to do that.
432 // In wxWindow(Base), it has (unfortunately) been abused
433 // to mean the same as SetMinSize() and SetMaxSize().
435 virtual void SetSizeHints( int minW
, int minH
,
436 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
437 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
)
438 { DoSetSizeHints(minW
, minH
, maxW
, maxH
, incW
, incH
); }
440 void SetSizeHints( const wxSize
& minSize
,
441 const wxSize
& maxSize
=wxDefaultSize
,
442 const wxSize
& incSize
=wxDefaultSize
)
443 { DoSetSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
, incSize
.x
, incSize
.y
); }
446 #if WXWIN_COMPATIBILITY_2_8
447 // these are useless and do nothing since wxWidgets 2.9
448 wxDEPRECATED( virtual void SetVirtualSizeHints( int minW
, int minH
,
449 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
) );
450 wxDEPRECATED( void SetVirtualSizeHints( const wxSize
& minSize
,
451 const wxSize
& maxSize
=wxDefaultSize
) );
452 #endif // WXWIN_COMPATIBILITY_2_8
455 // Call these to override what GetBestSize() returns. This
456 // method is only virtual because it is overridden in wxTLW
457 // as a different API for SetSizeHints().
458 virtual void SetMinSize(const wxSize
& minSize
);
459 virtual void SetMaxSize(const wxSize
& maxSize
);
461 // Like Set*Size, but for client, not window, size
462 virtual void SetMinClientSize(const wxSize
& size
)
463 { SetMinSize(ClientToWindowSize(size
)); }
464 virtual void SetMaxClientSize(const wxSize
& size
)
465 { SetMaxSize(ClientToWindowSize(size
)); }
467 // Override these methods to impose restrictions on min/max size.
468 // The easier way is to call SetMinSize() and SetMaxSize() which
469 // will have the same effect. Doing both is non-sense.
470 virtual wxSize
GetMinSize() const { return wxSize(m_minWidth
, m_minHeight
); }
471 virtual wxSize
GetMaxSize() const { return wxSize(m_maxWidth
, m_maxHeight
); }
473 // Like Get*Size, but for client, not window, size
474 virtual wxSize
GetMinClientSize() const
475 { return WindowToClientSize(GetMinSize()); }
476 virtual wxSize
GetMaxClientSize() const
477 { return WindowToClientSize(GetMaxSize()); }
479 // Get the min and max values one by one
480 int GetMinWidth() const { return GetMinSize().x
; }
481 int GetMinHeight() const { return GetMinSize().y
; }
482 int GetMaxWidth() const { return GetMaxSize().x
; }
483 int GetMaxHeight() const { return GetMaxSize().y
; }
486 // Methods for accessing the virtual size of a window. For most
487 // windows this is just the client area of the window, but for
488 // some like scrolled windows it is more or less independent of
489 // the screen window size. You may override the DoXXXVirtual
490 // methods below for classes where that is the case.
492 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
493 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
495 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
496 void GetVirtualSize( int *x
, int *y
) const
498 wxSize
s( DoGetVirtualSize() );
506 // Override these methods for windows that have a virtual size
507 // independent of their client size. eg. the virtual area of a
510 virtual void DoSetVirtualSize( int x
, int y
);
511 virtual wxSize
DoGetVirtualSize() const;
513 // Return the largest of ClientSize and BestSize (as determined
514 // by a sizer, interior children, or other means)
516 virtual wxSize
GetBestVirtualSize() const
518 wxSize
client( GetClientSize() );
519 wxSize
best( GetBestSize() );
521 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
524 // return the size of the left/right and top/bottom borders in x and y
525 // components of the result respectively
526 virtual wxSize
GetWindowBorderSize() const;
528 // wxSizer and friends use this to give a chance to a component to recalc
529 // its min size once one of the final size components is known. Override
530 // this function when that is useful (such as for wxStaticText which can
531 // stretch over several lines). Parameter availableOtherDir
532 // tells the item how much more space there is available in the opposite
533 // direction (-1 if unknown).
535 InformFirstDirection(int direction
, int size
, int availableOtherDir
);
537 // sends a size event to the window using its current size -- this has an
538 // effect of refreshing the window layout
540 // by default the event is sent, i.e. processed immediately, but if flags
541 // value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule
542 // for later processing
543 virtual void SendSizeEvent(int flags
= 0);
545 // this is a safe wrapper for GetParent()->SendSizeEvent(): it checks that
546 // we have a parent window and it's not in process of being deleted
548 // this is used by controls such as tool/status bars changes to which must
549 // also result in parent re-layout
550 void SendSizeEventToParent(int flags
= 0);
552 // this is a more readable synonym for SendSizeEvent(wxSEND_EVENT_POST)
553 void PostSizeEvent() { SendSizeEvent(wxSEND_EVENT_POST
); }
555 // this is the same as SendSizeEventToParent() but using PostSizeEvent()
556 void PostSizeEventToParent() { SendSizeEventToParent(wxSEND_EVENT_POST
); }
562 // returns true if window was shown/hidden, false if the nothing was
563 // done (window was already shown/hidden)
564 virtual bool Show( bool show
= true );
565 bool Hide() { return Show(false); }
567 // show or hide the window with a special effect, not implemented on
568 // most platforms (where it is the same as Show()/Hide() respectively)
570 // timeout specifies how long the animation should take, in ms, the
571 // default value of 0 means to use the default (system-dependent) value
572 virtual bool ShowWithEffect(wxShowEffect
WXUNUSED(effect
),
573 unsigned WXUNUSED(timeout
) = 0)
578 virtual bool HideWithEffect(wxShowEffect
WXUNUSED(effect
),
579 unsigned WXUNUSED(timeout
) = 0)
584 // returns true if window was enabled/disabled, false if nothing done
585 virtual bool Enable( bool enable
= true );
586 bool Disable() { return Enable(false); }
588 virtual bool IsShown() const { return m_isShown
; }
589 // returns true if the window is really enabled and false otherwise,
590 // whether because it had been explicitly disabled itself or because
591 // its parent is currently disabled -- then this method returns false
592 // whatever is the intrinsic state of this window, use IsThisEnabled(0
593 // to retrieve it. In other words, this relation always holds:
595 // IsEnabled() == IsThisEnabled() && parent.IsEnabled()
597 bool IsEnabled() const;
599 // returns the internal window state independently of the parent(s)
600 // state, i.e. the state in which the window would be if all its
601 // parents were enabled (use IsEnabled() above to get the effective
603 bool IsThisEnabled() const { return m_isEnabled
; }
605 // returns true if the window is visible, i.e. IsShown() returns true
606 // if called on it and all its parents up to the first TLW
607 virtual bool IsShownOnScreen() const;
609 // get/set window style (setting style won't update the window and so
610 // is only useful for internal usage)
611 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
612 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
614 // just some (somewhat shorter) synonyms
615 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
616 long GetWindowStyle() const { return GetWindowStyleFlag(); }
618 // check if the flag is set
619 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
620 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
622 // turn the flag on if it had been turned off before and vice versa,
623 // return true if the flag is currently turned on
624 bool ToggleWindowStyle(int flag
);
626 // extra style: the less often used style bits which can't be set with
627 // SetWindowStyleFlag()
628 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
629 long GetExtraStyle() const { return m_exStyle
; }
631 bool HasExtraStyle(int exFlag
) const { return (m_exStyle
& exFlag
) != 0; }
633 #if WXWIN_COMPATIBILITY_2_8
634 // make the window modal (all other windows unresponsive)
635 wxDEPRECATED( virtual void MakeModal(bool modal
= true) );
638 // (primitive) theming support
639 // ---------------------------
641 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
642 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
645 // focus and keyboard handling
646 // ---------------------------
648 // set focus to this window
649 virtual void SetFocus() = 0;
651 // set focus to this window as the result of a keyboard action
652 virtual void SetFocusFromKbd() { SetFocus(); }
654 // return the window which currently has the focus or NULL
655 static wxWindow
*FindFocus();
657 static wxWindow
*DoFindFocus() /* = 0: implement in derived classes */;
659 // return true if the window has focus (handles composite windows
660 // correctly - returns true if GetMainWindowOfCompositeControl()
662 virtual bool HasFocus() const;
664 // can this window have focus in principle?
666 // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus
667 // [FromKeyboard]() is that the former functions are meant to be
668 // overridden in the derived classes to simply return false if the
669 // control can't have focus, while the latter are meant to be used by
670 // this class clients and take into account the current window state
671 virtual bool AcceptsFocus() const { return true; }
673 // can this window or one of its children accept focus?
675 // usually it's the same as AcceptsFocus() but is overridden for
677 virtual bool AcceptsFocusRecursively() const { return AcceptsFocus(); }
679 // can this window be given focus by keyboard navigation? if not, the
680 // only way to give it focus (provided it accepts it at all) is to
682 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
685 // this is mostly a helper for the various functions using it below
686 bool CanBeFocused() const { return IsShown() && IsEnabled(); }
688 // can this window itself have focus?
689 bool IsFocusable() const { return AcceptsFocus() && CanBeFocused(); }
691 // can this window have focus right now?
693 // if this method returns true, it means that calling SetFocus() will
694 // put focus either to this window or one of its children, if you need
695 // to know whether this window accepts focus itself, use IsFocusable()
696 bool CanAcceptFocus() const
697 { return AcceptsFocusRecursively() && CanBeFocused(); }
699 // can this window be assigned focus from keyboard right now?
700 bool CanAcceptFocusFromKeyboard() const
701 { return AcceptsFocusFromKeyboard() && CanBeFocused(); }
703 // call this when the return value of AcceptsFocus() changes
704 virtual void SetCanFocus(bool WXUNUSED(canFocus
)) { }
706 // navigates inside this window
707 bool NavigateIn(int flags
= wxNavigationKeyEvent::IsForward
)
708 { return DoNavigateIn(flags
); }
710 // navigates in the specified direction from this window, this is
711 // equivalent to GetParent()->NavigateIn()
712 bool Navigate(int flags
= wxNavigationKeyEvent::IsForward
)
713 { return m_parent
&& ((wxWindowBase
*)m_parent
)->DoNavigateIn(flags
); }
715 // this function will generate the appropriate call to Navigate() if the
716 // key event is one normally used for keyboard navigation and return true
718 bool HandleAsNavigationKey(const wxKeyEvent
& event
);
720 // move this window just before/after the specified one in tab order
721 // (the other window must be our sibling!)
722 void MoveBeforeInTabOrder(wxWindow
*win
)
723 { DoMoveInTabOrder(win
, OrderBefore
); }
724 void MoveAfterInTabOrder(wxWindow
*win
)
725 { DoMoveInTabOrder(win
, OrderAfter
); }
728 // parent/children relations
729 // -------------------------
731 // get the list of children
732 const wxWindowList
& GetChildren() const { return m_children
; }
733 wxWindowList
& GetChildren() { return m_children
; }
735 // needed just for extended runtime
736 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
738 // get the window before/after this one in the parents children list,
739 // returns NULL if this is the first/last window
740 wxWindow
*GetPrevSibling() const { return DoGetSibling(OrderBefore
); }
741 wxWindow
*GetNextSibling() const { return DoGetSibling(OrderAfter
); }
743 // get the parent or the parent of the parent
744 wxWindow
*GetParent() const { return m_parent
; }
745 inline wxWindow
*GetGrandParent() const;
747 // is this window a top level one?
748 virtual bool IsTopLevel() const;
750 // is this window a child or grand child of this one (inside the same
752 bool IsDescendant(wxWindowBase
* win
) const;
754 // it doesn't really change parent, use Reparent() instead
755 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
756 // change the real parent of this window, return true if the parent
757 // was changed, false otherwise (error or newParent == oldParent)
758 virtual bool Reparent( wxWindowBase
*newParent
);
760 // implementation mostly
761 virtual void AddChild( wxWindowBase
*child
);
762 virtual void RemoveChild( wxWindowBase
*child
);
764 // returns true if the child is in the client area of the window, i.e. is
765 // not scrollbar, toolbar etc.
766 virtual bool IsClientAreaChild(const wxWindow
*WXUNUSED(child
)) const
769 // looking for windows
770 // -------------------
772 // find window among the descendants of this one either by id or by
773 // name (return NULL if not found)
774 wxWindow
*FindWindow(long winid
) const;
775 wxWindow
*FindWindow(const wxString
& name
) const;
777 // Find a window among any window (all return NULL if not found)
778 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
779 static wxWindow
*FindWindowByName( const wxString
& name
,
780 const wxWindow
*parent
= NULL
);
781 static wxWindow
*FindWindowByLabel( const wxString
& label
,
782 const wxWindow
*parent
= NULL
);
784 // event handler stuff
785 // -------------------
787 // get the current event handler
788 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
790 // replace the event handler (allows to completely subclass the
792 void SetEventHandler( wxEvtHandler
*handler
);
794 // push/pop event handler: allows to chain a custom event handler to
795 // alreasy existing ones
796 void PushEventHandler( wxEvtHandler
*handler
);
797 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
799 // find the given handler in the event handler chain and remove (but
800 // not delete) it from the event handler chain, return true if it was
801 // found and false otherwise (this also results in an assert failure so
802 // this function should only be called when the handler is supposed to
804 bool RemoveEventHandler(wxEvtHandler
*handler
);
806 // Process an event by calling GetEventHandler()->ProcessEvent(): this
807 // is a straightforward replacement for ProcessEvent() itself which
808 // shouldn't be used directly with windows as it doesn't take into
809 // account any event handlers associated with the window
810 bool ProcessWindowEvent(wxEvent
& event
)
811 { return GetEventHandler()->ProcessEvent(event
); }
813 // Call GetEventHandler()->ProcessEventLocally(): this should be used
814 // instead of calling ProcessEventLocally() directly on the window
815 // itself as this wouldn't take any pushed event handlers into account
817 bool ProcessWindowEventLocally(wxEvent
& event
)
818 { return GetEventHandler()->ProcessEventLocally(event
); }
820 // Process an event by calling GetEventHandler()->ProcessEvent() and
821 // handling any exceptions thrown by event handlers. It's mostly useful
822 // when processing wx events when called from C code (e.g. in GTK+
823 // callback) when the exception wouldn't correctly propagate to
825 bool HandleWindowEvent(wxEvent
& event
) const;
827 // disable wxEvtHandler double-linked list mechanism:
828 virtual void SetNextHandler(wxEvtHandler
*handler
);
829 virtual void SetPreviousHandler(wxEvtHandler
*handler
);
832 // Watcom doesn't allow reducing access with using access declaration, see
837 // NOTE: we change the access specifier of the following wxEvtHandler functions
838 // so that the user won't be able to call them directly.
839 // Calling wxWindow::ProcessEvent in fact only works when there are NO
840 // event handlers pushed on the window.
841 // To ensure correct operation, instead of wxWindow::ProcessEvent
842 // you must always call wxWindow::GetEventHandler()->ProcessEvent()
843 // or HandleWindowEvent().
844 // The same holds for all other wxEvtHandler functions.
846 using wxEvtHandler::ProcessEvent
;
847 using wxEvtHandler::ProcessEventLocally
;
849 using wxEvtHandler::ProcessThreadEvent
;
851 using wxEvtHandler::SafelyProcessEvent
;
852 using wxEvtHandler::ProcessPendingEvents
;
853 using wxEvtHandler::AddPendingEvent
;
854 using wxEvtHandler::QueueEvent
;
855 #endif // __WATCOMC__
863 // a window may have an associated validator which is used to control
865 virtual void SetValidator( const wxValidator
&validator
);
866 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
867 #endif // wxUSE_VALIDATORS
870 // dialog oriented functions
871 // -------------------------
873 // validate the correctness of input, return true if ok
874 virtual bool Validate();
876 // transfer data between internal and GUI representations
877 virtual bool TransferDataToWindow();
878 virtual bool TransferDataFromWindow();
880 virtual void InitDialog();
885 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
886 { m_acceleratorTable
= accel
; }
887 wxAcceleratorTable
*GetAcceleratorTable()
888 { return &m_acceleratorTable
; }
890 #endif // wxUSE_ACCEL
893 // hot keys (system wide accelerators)
894 // -----------------------------------
896 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
897 virtual bool UnregisterHotKey(int hotkeyId
);
898 #endif // wxUSE_HOTKEY
901 // dialog units translations
902 // -------------------------
904 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
) const;
905 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
) const;
906 wxSize
ConvertPixelsToDialog( const wxSize
& sz
) const
908 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
910 return wxSize(pt
.x
, pt
.y
);
913 wxSize
ConvertDialogToPixels( const wxSize
& sz
) const
915 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
917 return wxSize(pt
.x
, pt
.y
);
923 // move the mouse to the specified position
924 virtual void WarpPointer(int x
, int y
) = 0;
926 // start or end mouse capture, these functions maintain the stack of
927 // windows having captured the mouse and after calling ReleaseMouse()
928 // the mouse is not released but returns to the window which had had
929 // captured it previously (if any)
933 // get the window which currently captures the mouse or NULL
934 static wxWindow
*GetCapture();
936 // does this window have the capture?
937 virtual bool HasCapture() const
938 { return (wxWindow
*)this == GetCapture(); }
940 // painting the window
941 // -------------------
943 // mark the specified rectangle (or the whole window) as "dirty" so it
945 virtual void Refresh( bool eraseBackground
= true,
946 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
948 // a less awkward wrapper for Refresh
949 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true)
951 Refresh(eraseBackground
, &rect
);
954 // repaint all invalid areas of the window immediately
955 virtual void Update() { }
957 // clear the window background
958 virtual void ClearBackground();
960 // freeze the window: don't redraw it until it is thawed
963 // thaw the window: redraw it after it had been frozen
966 // return true if window had been frozen and not unthawed yet
967 bool IsFrozen() const { return m_freezeCount
!= 0; }
969 // adjust DC for drawing on this window
970 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
972 // return true if the window contents is double buffered by the system
973 virtual bool IsDoubleBuffered() const { return false; }
975 // the update region of the window contains the areas which must be
976 // repainted by the program
977 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
978 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
980 // get the update rectangleregion bounding box in client coords
981 wxRect
GetUpdateClientRect() const;
983 // these functions verify whether the given point/rectangle belongs to
984 // (or at least intersects with) the update region
985 virtual bool DoIsExposed( int x
, int y
) const;
986 virtual bool DoIsExposed( int x
, int y
, int w
, int h
) const;
988 bool IsExposed( int x
, int y
) const
989 { return DoIsExposed(x
, y
); }
990 bool IsExposed( int x
, int y
, int w
, int h
) const
991 { return DoIsExposed(x
, y
, w
, h
); }
992 bool IsExposed( const wxPoint
& pt
) const
993 { return DoIsExposed(pt
.x
, pt
.y
); }
994 bool IsExposed( const wxRect
& rect
) const
995 { return DoIsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
997 // colours, fonts and cursors
998 // --------------------------
1000 // get the default attributes for the controls of this class: we
1001 // provide a virtual function which can be used to query the default
1002 // attributes of an existing control and a static function which can
1003 // be used even when no existing object of the given class is
1004 // available, but which won't return any styles specific to this
1005 // particular control, of course (e.g. "Ok" button might have
1006 // different -- bold for example -- font)
1007 virtual wxVisualAttributes
GetDefaultAttributes() const
1009 return GetClassDefaultAttributes(GetWindowVariant());
1012 static wxVisualAttributes
1013 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
1015 // set/retrieve the window colours (system defaults are used by
1016 // default): SetXXX() functions return true if colour was changed,
1017 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
1018 // value to prevent it from being inherited by our children
1019 virtual bool SetBackgroundColour(const wxColour
& colour
);
1020 void SetOwnBackgroundColour(const wxColour
& colour
)
1022 if ( SetBackgroundColour(colour
) )
1023 m_inheritBgCol
= false;
1025 wxColour
GetBackgroundColour() const;
1026 bool InheritsBackgroundColour() const
1028 return m_inheritBgCol
;
1030 bool UseBgCol() const
1035 virtual bool SetForegroundColour(const wxColour
& colour
);
1036 void SetOwnForegroundColour(const wxColour
& colour
)
1038 if ( SetForegroundColour(colour
) )
1039 m_inheritFgCol
= false;
1041 wxColour
GetForegroundColour() const;
1043 // Set/get the background style.
1044 virtual bool SetBackgroundStyle(wxBackgroundStyle style
);
1045 wxBackgroundStyle
GetBackgroundStyle() const
1046 { return m_backgroundStyle
; }
1048 // returns true if the control has "transparent" areas such as a
1049 // wxStaticText and wxCheckBox and the background should be adapted
1050 // from a parent window
1051 virtual bool HasTransparentBackground() { return false; }
1053 // Returns true if background transparency is supported for this
1054 // window, i.e. if calling SetBackgroundStyle(wxBG_STYLE_TRANSPARENT)
1055 // has a chance of succeeding. If reason argument is non-NULL, returns a
1056 // user-readable explanation of why it isn't supported if the return
1058 virtual bool IsTransparentBackgroundSupported(wxString
* reason
= NULL
) const;
1060 // set/retrieve the font for the window (SetFont() returns true if the
1061 // font really changed)
1062 virtual bool SetFont(const wxFont
& font
) = 0;
1063 void SetOwnFont(const wxFont
& font
)
1065 if ( SetFont(font
) )
1066 m_inheritFont
= false;
1068 wxFont
GetFont() const;
1070 // set/retrieve the cursor for this window (SetCursor() returns true
1071 // if the cursor was really changed)
1072 virtual bool SetCursor( const wxCursor
&cursor
);
1073 const wxCursor
& GetCursor() const { return m_cursor
; }
1076 // associate a caret with the window
1077 void SetCaret(wxCaret
*caret
);
1078 // get the current caret (may be NULL)
1079 wxCaret
*GetCaret() const { return m_caret
; }
1080 #endif // wxUSE_CARET
1082 // get the (average) character size for the current font
1083 virtual int GetCharHeight() const = 0;
1084 virtual int GetCharWidth() const = 0;
1086 // get the width/height/... of the text using current or specified
1088 void GetTextExtent(const wxString
& string
,
1090 int *descent
= NULL
,
1091 int *externalLeading
= NULL
,
1092 const wxFont
*font
= NULL
) const
1094 DoGetTextExtent(string
, x
, y
, descent
, externalLeading
, font
);
1097 wxSize
GetTextExtent(const wxString
& string
) const
1100 GetTextExtent(string
, &w
, &h
);
1101 return wxSize(w
, h
);
1104 // client <-> screen coords
1105 // ------------------------
1107 // translate to/from screen/client coordinates (pointers may be NULL)
1108 void ClientToScreen( int *x
, int *y
) const
1109 { DoClientToScreen(x
, y
); }
1110 void ScreenToClient( int *x
, int *y
) const
1111 { DoScreenToClient(x
, y
); }
1113 // wxPoint interface to do the same thing
1114 wxPoint
ClientToScreen(const wxPoint
& pt
) const
1116 int x
= pt
.x
, y
= pt
.y
;
1117 DoClientToScreen(&x
, &y
);
1119 return wxPoint(x
, y
);
1122 wxPoint
ScreenToClient(const wxPoint
& pt
) const
1124 int x
= pt
.x
, y
= pt
.y
;
1125 DoScreenToClient(&x
, &y
);
1127 return wxPoint(x
, y
);
1130 // test where the given (in client coords) point lies
1131 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
1132 { return DoHitTest(x
, y
); }
1134 wxHitTest
HitTest(const wxPoint
& pt
) const
1135 { return DoHitTest(pt
.x
, pt
.y
); }
1140 // get the window border style from the given flags: this is different from
1141 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
1142 // translate wxBORDER_DEFAULT to something reasonable
1143 wxBorder
GetBorder(long flags
) const;
1145 // get border for the flags of this window
1146 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
1148 // send wxUpdateUIEvents to this window, and children if recurse is true
1149 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
1151 // do the window-specific processing after processing the update event
1152 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
1155 // show popup menu at the given position, generate events for the items
1157 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
1158 { return PopupMenu(menu
, pos
.x
, pos
.y
); }
1159 bool PopupMenu(wxMenu
*menu
, int x
, int y
);
1161 // simply return the id of the selected item or wxID_NONE without
1162 // generating any events
1163 int GetPopupMenuSelectionFromUser(wxMenu
& menu
,
1164 const wxPoint
& pos
= wxDefaultPosition
)
1165 { return DoGetPopupMenuSelectionFromUser(menu
, pos
.x
, pos
.y
); }
1166 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
1167 { return DoGetPopupMenuSelectionFromUser(menu
, x
, y
); }
1168 #endif // wxUSE_MENUS
1170 // override this method to return true for controls having multiple pages
1171 virtual bool HasMultiplePages() const { return false; }
1177 // can the window have the scrollbar in this orientation?
1178 bool CanScroll(int orient
) const
1180 return (m_windowStyle
&
1181 (orient
== wxHORIZONTAL
? wxHSCROLL
: wxVSCROLL
)) != 0;
1184 // does the window have the scrollbar in this orientation?
1185 bool HasScrollbar(int orient
) const;
1187 // configure the window scrollbars
1188 virtual void SetScrollbar( int orient
,
1192 bool refresh
= true ) = 0;
1193 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
1194 virtual int GetScrollPos( int orient
) const = 0;
1195 virtual int GetScrollThumb( int orient
) const = 0;
1196 virtual int GetScrollRange( int orient
) const = 0;
1198 // scroll window to the specified position
1199 virtual void ScrollWindow( int dx
, int dy
,
1200 const wxRect
* rect
= NULL
) = 0;
1202 // scrolls window by line/page: note that not all controls support this
1204 // return true if the position changed, false otherwise
1205 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
1206 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
1208 // convenient wrappers for ScrollLines/Pages
1209 bool LineUp() { return ScrollLines(-1); }
1210 bool LineDown() { return ScrollLines(1); }
1211 bool PageUp() { return ScrollPages(-1); }
1212 bool PageDown() { return ScrollPages(1); }
1214 // call this to always show one or both scrollbars, even if the window
1215 // is big enough to not require them
1216 virtual void AlwaysShowScrollbars(bool WXUNUSED(horz
) = true,
1217 bool WXUNUSED(vert
) = true)
1221 // return true if AlwaysShowScrollbars() had been called before for the
1222 // corresponding orientation
1223 virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient
)) const
1228 // context-sensitive help
1229 // ----------------------
1231 // these are the convenience functions wrapping wxHelpProvider methods
1234 // associate this help text with this window
1235 void SetHelpText(const wxString
& text
);
1237 #if WXWIN_COMPATIBILITY_2_8
1238 // Associate this help text with all windows with the same id as this one.
1239 // Don't use this, do wxHelpProvider::Get()->AddHelp(id, text);
1240 wxDEPRECATED( void SetHelpTextForId(const wxString
& text
) );
1241 #endif // WXWIN_COMPATIBILITY_2_8
1243 // get the help string associated with the given position in this window
1245 // notice that pt may be invalid if event origin is keyboard or unknown
1246 // and this method should return the global window help text then
1247 virtual wxString
GetHelpTextAtPoint(const wxPoint
& pt
,
1248 wxHelpEvent::Origin origin
) const;
1249 // returns the position-independent help text
1250 wxString
GetHelpText() const
1252 return GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Unknown
);
1255 #else // !wxUSE_HELP
1256 // silently ignore SetHelpText() calls
1257 void SetHelpText(const wxString
& WXUNUSED(text
)) { }
1258 void SetHelpTextForId(const wxString
& WXUNUSED(text
)) { }
1259 #endif // wxUSE_HELP
1265 // the easiest way to set a tooltip for a window is to use this method
1266 void SetToolTip( const wxString
&tip
);
1267 // attach a tooltip to the window, pointer can be NULL to remove
1269 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
1270 // more readable synonym for SetToolTip(NULL)
1271 void UnsetToolTip() { SetToolTip(NULL
); }
1272 // get the associated tooltip or NULL if none
1273 wxToolTip
* GetToolTip() const { return m_tooltip
; }
1274 wxString
GetToolTipText() const;
1276 // Use the same tool tip as the given one (which can be NULL to indicate
1277 // that no tooltip should be used) for this window. This is currently only
1278 // used by wxCompositeWindow::DoSetToolTip() implementation and is not part
1279 // of the public wx API.
1281 // Returns true if tip was valid and we copied it or false if it was NULL
1282 // and we reset our own tooltip too.
1283 bool CopyToolTip(wxToolTip
*tip
);
1284 #else // !wxUSE_TOOLTIPS
1285 // make it much easier to compile apps in an environment
1286 // that doesn't support tooltips, such as PocketPC
1287 void SetToolTip(const wxString
& WXUNUSED(tip
)) { }
1288 void UnsetToolTip() { }
1289 #endif // wxUSE_TOOLTIPS/!wxUSE_TOOLTIPS
1293 #if wxUSE_DRAG_AND_DROP
1294 // set/retrieve the drop target associated with this window (may be
1295 // NULL; it's owned by the window and will be deleted by it)
1296 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
1297 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
1299 // Accept files for dragging
1300 virtual void DragAcceptFiles(bool accept
)
1302 // it does have common implementation but not for MSW which has its own
1303 // native version of it
1308 #endif // wxUSE_DRAG_AND_DROP
1310 // constraints and sizers
1311 // ----------------------
1312 #if wxUSE_CONSTRAINTS
1313 // set the constraints for this window or retrieve them (may be NULL)
1314 void SetConstraints( wxLayoutConstraints
*constraints
);
1315 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
1317 // implementation only
1318 void UnsetConstraints(wxLayoutConstraints
*c
);
1319 wxWindowList
*GetConstraintsInvolvedIn() const
1320 { return m_constraintsInvolvedIn
; }
1321 void AddConstraintReference(wxWindowBase
*otherWin
);
1322 void RemoveConstraintReference(wxWindowBase
*otherWin
);
1323 void DeleteRelatedConstraints();
1324 void ResetConstraints();
1326 // these methods may be overridden for special layout algorithms
1327 virtual void SetConstraintSizes(bool recurse
= true);
1328 virtual bool LayoutPhase1(int *noChanges
);
1329 virtual bool LayoutPhase2(int *noChanges
);
1330 virtual bool DoPhase(int phase
);
1332 // these methods are virtual but normally won't be overridden
1333 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
1334 virtual void MoveConstraint(int x
, int y
);
1335 virtual void GetSizeConstraint(int *w
, int *h
) const ;
1336 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
1337 virtual void GetPositionConstraint(int *x
, int *y
) const ;
1339 #endif // wxUSE_CONSTRAINTS
1341 // when using constraints or sizers, it makes sense to update
1342 // children positions automatically whenever the window is resized
1343 // - this is done if autoLayout is on
1344 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
1345 bool GetAutoLayout() const { return m_autoLayout
; }
1347 // lay out the window and its children
1348 virtual bool Layout();
1351 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
1352 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
1354 wxSizer
*GetSizer() const { return m_windowSizer
; }
1356 // Track if this window is a member of a sizer
1357 void SetContainingSizer(wxSizer
* sizer
);
1358 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1361 // ----------------------
1362 #if wxUSE_ACCESSIBILITY
1363 // Override to create a specific accessible object.
1364 virtual wxAccessible
* CreateAccessible();
1366 // Sets the accessible object.
1367 void SetAccessible(wxAccessible
* accessible
) ;
1369 // Returns the accessible object.
1370 wxAccessible
* GetAccessible() { return m_accessible
; }
1372 // Returns the accessible object, creating if necessary.
1373 wxAccessible
* GetOrCreateAccessible() ;
1377 // Set window transparency if the platform supports it
1378 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
)) { return false; }
1379 virtual bool CanSetTransparent() { return false; }
1386 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1387 void OnInitDialog( wxInitDialogEvent
&event
);
1388 void OnMiddleClick( wxMouseEvent
& event
);
1390 void OnHelp(wxHelpEvent
& event
);
1391 #endif // wxUSE_HELP
1393 // virtual function for implementing internal idle
1395 virtual void OnInternalIdle();
1397 // Send idle event to window and all subwindows
1398 // Returns true if more idle time is requested.
1399 virtual bool SendIdleEvents(wxIdleEvent
& event
);
1401 // get the handle of the window for the underlying window system: this
1402 // is only used for wxWin itself or for user code which wants to call
1403 // platform-specific APIs
1404 virtual WXWidget
GetHandle() const = 0;
1405 // associate the window with a new native handle
1406 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1407 // dissociate the current native handle from the window
1408 virtual void DissociateHandle() { }
1411 // Store the palette used by DCs in wxWindow so that the dcs can share
1412 // a palette. And we can respond to palette messages.
1413 wxPalette
GetPalette() const { return m_palette
; }
1415 // When palette is changed tell the DC to set the system palette to the
1417 void SetPalette(const wxPalette
& pal
);
1419 // return true if we have a specific palette
1420 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1422 // return the first parent window with a custom palette or NULL
1423 wxWindow
*GetAncestorWithCustomPalette() const;
1424 #endif // wxUSE_PALETTE
1426 // inherit the parents visual attributes if they had been explicitly set
1427 // by the user (i.e. we don't inherit default attributes) and if we don't
1428 // have our own explicitly set
1429 virtual void InheritAttributes();
1431 // returns false from here if this window doesn't want to inherit the
1432 // parents colours even if InheritAttributes() would normally do it
1434 // this just provides a simple way to customize InheritAttributes()
1435 // behaviour in the most common case
1436 virtual bool ShouldInheritColours() const { return false; }
1438 // returns true if the window can be positioned outside of parent's client
1439 // area (normal windows can't, but e.g. menubar or statusbar can):
1440 virtual bool CanBeOutsideClientArea() const { return false; }
1442 // returns true if the platform should explicitly apply a theme border. Currently
1443 // used only by Windows
1444 virtual bool CanApplyThemeBorder() const { return true; }
1446 // returns the main window of composite control; this is the window
1447 // that FindFocus returns if the focus is in one of composite control's
1449 virtual wxWindow
*GetMainWindowOfCompositeControl()
1450 { return (wxWindow
*)this; }
1452 // If this function returns true, keyboard navigation events shouldn't
1453 // escape from it. A typical example of such "navigation domain" is a top
1454 // level window because pressing TAB in one of them must not transfer focus
1455 // to a different top level window. But it's not limited to them, e.g. MDI
1456 // children frames are not top level windows (and their IsTopLevel()
1457 // returns false) but still are self-contained navigation domains as well.
1458 virtual bool IsTopNavigationDomain() const { return false; }
1462 // helper for the derived class Create() methods: the first overload, with
1463 // validator parameter, should be used for child windows while the second
1464 // one is used for top level ones
1465 bool CreateBase(wxWindowBase
*parent
,
1467 const wxPoint
& pos
= wxDefaultPosition
,
1468 const wxSize
& size
= wxDefaultSize
,
1470 const wxValidator
& validator
= wxDefaultValidator
,
1471 const wxString
& name
= wxPanelNameStr
);
1473 bool CreateBase(wxWindowBase
*parent
,
1478 const wxString
& name
);
1480 // event handling specific to wxWindow
1481 virtual bool TryBefore(wxEvent
& event
);
1482 virtual bool TryAfter(wxEvent
& event
);
1486 OrderBefore
, // insert before the given window
1487 OrderAfter
// insert after the given window
1490 // common part of GetPrev/NextSibling()
1491 wxWindow
*DoGetSibling(WindowOrder order
) const;
1493 // common part of MoveBefore/AfterInTabOrder()
1494 virtual void DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
);
1496 // implementation of Navigate() and NavigateIn()
1497 virtual bool DoNavigateIn(int flags
);
1499 #if wxUSE_CONSTRAINTS
1500 // satisfy the constraints for the windows but don't set the window sizes
1501 void SatisfyConstraints();
1502 #endif // wxUSE_CONSTRAINTS
1504 // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
1506 void SendDestroyEvent();
1508 // this method should be implemented to use operating system specific code
1509 // to really enable/disable the widget, it will only be called when we
1510 // really need to enable/disable window and so no additional checks on the
1511 // widgets state are necessary
1512 virtual void DoEnable(bool WXUNUSED(enable
)) { }
1514 // called when the on-screen widget state changes and provides an
1515 // an opportunity for the widget to update its visual state (colours,
1516 // fonts, anything else) as necessary
1517 virtual void OnEnabled(bool WXUNUSED(enabled
)) { }
1520 // the window id - a number which uniquely identifies a window among
1521 // its siblings unless it is wxID_ANY
1522 wxWindowIDRef m_windowId
;
1524 // the parent window of this window (or NULL) and the list of the children
1527 wxWindowList m_children
;
1529 // the minimal allowed size for the window (no minimal size if variable(s)
1530 // contain(s) wxDefaultCoord)
1536 // event handler for this window: usually is just 'this' but may be
1537 // changed with SetEventHandler()
1538 wxEvtHandler
*m_eventHandler
;
1540 #if wxUSE_VALIDATORS
1541 // associated validator or NULL if none
1542 wxValidator
*m_windowValidator
;
1543 #endif // wxUSE_VALIDATORS
1545 #if wxUSE_DRAG_AND_DROP
1546 wxDropTarget
*m_dropTarget
;
1547 #endif // wxUSE_DRAG_AND_DROP
1549 // visual window attributes
1551 wxFont m_font
; // see m_hasFont
1552 wxColour m_backgroundColour
, // m_hasBgCol
1553 m_foregroundColour
; // m_hasFgCol
1557 #endif // wxUSE_CARET
1559 // the region which should be repainted in response to paint event
1560 wxRegion m_updateRegion
;
1563 // the accelerator table for the window which translates key strokes into
1565 wxAcceleratorTable m_acceleratorTable
;
1566 #endif // wxUSE_ACCEL
1568 // the tooltip for this window (may be NULL)
1570 wxToolTip
*m_tooltip
;
1571 #endif // wxUSE_TOOLTIPS
1573 // constraints and sizers
1574 #if wxUSE_CONSTRAINTS
1575 // the constraints for this window or NULL
1576 wxLayoutConstraints
*m_constraints
;
1578 // constraints this window is involved in
1579 wxWindowList
*m_constraintsInvolvedIn
;
1580 #endif // wxUSE_CONSTRAINTS
1582 // this window's sizer
1583 wxSizer
*m_windowSizer
;
1585 // The sizer this window is a member of, if any
1586 wxSizer
*m_containingSizer
;
1588 // Layout() window automatically when its size changes?
1589 bool m_autoLayout
:1;
1594 bool m_isBeingDeleted
:1;
1596 // was the window colours/font explicitly changed by user?
1601 // and should it be inherited by children?
1602 bool m_inheritBgCol
:1;
1603 bool m_inheritFgCol
:1;
1604 bool m_inheritFont
:1;
1606 // window attributes
1609 wxString m_windowName
;
1610 bool m_themeEnabled
;
1611 wxBackgroundStyle m_backgroundStyle
;
1613 wxPalette m_palette
;
1614 bool m_hasCustomPalette
;
1615 #endif // wxUSE_PALETTE
1617 #if wxUSE_ACCESSIBILITY
1618 wxAccessible
* m_accessible
;
1621 // Virtual size (scrolling)
1622 wxSize m_virtualSize
;
1624 wxScrollHelper
*m_scrollHelper
;
1626 wxWindowVariant m_windowVariant
;
1628 // override this to change the default (i.e. used when no style is
1629 // specified) border for the window class
1630 virtual wxBorder
GetDefaultBorder() const;
1632 // this allows you to implement standard control borders without
1633 // repeating the code in different classes that are not derived from
1635 virtual wxBorder
GetDefaultBorderForControl() const { return wxBORDER_THEME
; }
1637 // Get the default size for the new window if no explicit size given. TLWs
1638 // have their own default size so this is just for non top-level windows.
1639 static int WidthDefault(int w
) { return w
== wxDefaultCoord
? 20 : w
; }
1640 static int HeightDefault(int h
) { return h
== wxDefaultCoord
? 20 : h
; }
1643 // Used to save the results of DoGetBestSize so it doesn't need to be
1644 // recalculated each time the value is needed.
1645 wxSize m_bestSizeCache
;
1647 wxDEPRECATED( void SetBestSize(const wxSize
& size
) ); // use SetInitialSize
1648 wxDEPRECATED( virtual void SetInitialBestSize(const wxSize
& size
) ); // use SetInitialSize
1652 // more pure virtual functions
1653 // ---------------------------
1655 // NB: we must have DoSomething() function when Something() is an overloaded
1656 // method: indeed, we can't just have "virtual Something()" in case when
1657 // the function is overloaded because then we'd have to make virtual all
1658 // the variants (otherwise only the virtual function may be called on a
1659 // pointer to derived class according to C++ rules) which is, in
1660 // general, absolutely not needed. So instead we implement all
1661 // overloaded Something()s in terms of DoSomething() which will be the
1662 // only one to be virtual.
1665 virtual void DoGetTextExtent(const wxString
& string
,
1667 int *descent
= NULL
,
1668 int *externalLeading
= NULL
,
1669 const wxFont
*font
= NULL
) const = 0;
1671 // coordinates translation
1672 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1673 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1675 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1677 // capture/release the mouse, used by Capture/ReleaseMouse()
1678 virtual void DoCaptureMouse() = 0;
1679 virtual void DoReleaseMouse() = 0;
1681 // retrieve the position/size of the window
1682 virtual void DoGetPosition(int *x
, int *y
) const = 0;
1683 virtual void DoGetScreenPosition(int *x
, int *y
) const;
1684 virtual void DoGetSize(int *width
, int *height
) const = 0;
1685 virtual void DoGetClientSize(int *width
, int *height
) const = 0;
1687 // get the size which best suits the window: for a control, it would be
1688 // the minimal size which doesn't truncate the control, for a panel - the
1689 // same size as it would have after a call to Fit()
1690 virtual wxSize
DoGetBestSize() const;
1692 // this method can be overridden instead of DoGetBestSize() if it computes
1693 // the best size of the client area of the window only, excluding borders
1694 // (GetBorderSize() will be used to add them)
1695 virtual wxSize
DoGetBestClientSize() const { return wxDefaultSize
; }
1697 // These two methods can be overridden to implement intelligent
1698 // width-for-height and/or height-for-width best size determination for the
1699 // window. By default the fixed best size is used.
1700 virtual int DoGetBestClientHeight(int WXUNUSED(width
)) const
1701 { return wxDefaultCoord
; }
1702 virtual int DoGetBestClientWidth(int WXUNUSED(height
)) const
1703 { return wxDefaultCoord
; }
1705 // this is the virtual function to be overridden in any derived class which
1706 // wants to change how SetSize() or Move() works - it is called by all
1707 // versions of these functions in the base class
1708 virtual void DoSetSize(int x
, int y
,
1709 int width
, int height
,
1710 int sizeFlags
= wxSIZE_AUTO
) = 0;
1712 // same as DoSetSize() for the client size
1713 virtual void DoSetClientSize(int width
, int height
) = 0;
1715 virtual void DoSetSizeHints( int minW
, int minH
,
1717 int incW
, int incH
);
1719 // return the total size of the window borders, i.e. the sum of the widths
1720 // of the left and the right border in the x component of the returned size
1721 // and the sum of the heights of the top and bottom borders in the y one
1723 // NB: this is currently only implemented properly for wxMSW, wxGTK and
1724 // wxUniv and doesn't behave correctly in the presence of scrollbars in
1726 virtual wxSize
DoGetBorderSize() const;
1728 // move the window to the specified location and resize it: this is called
1729 // from both DoSetSize() and DoSetClientSize() and would usually just
1730 // reposition this window except for composite controls which will want to
1731 // arrange themselves inside the given rectangle
1733 // Important note: the coordinates passed to this method are in parent's
1734 // *window* coordinates and not parent's client coordinates (as the values
1735 // passed to DoSetSize and returned by DoGetPosition are)!
1736 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1738 // centre the window in the specified direction on parent, note that
1739 // wxCENTRE_ON_SCREEN shouldn't be specified here, it only makes sense for
1741 virtual void DoCentre(int dir
);
1744 virtual void DoSetToolTip( wxToolTip
*tip
);
1745 #endif // wxUSE_TOOLTIPS
1748 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1749 #endif // wxUSE_MENUS
1751 // Makes an adjustment to the window position to make it relative to the
1752 // parents client area, e.g. if the parent is a frame with a toolbar, its
1753 // (0, 0) is just below the toolbar
1754 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1755 int sizeFlags
= 0) const;
1757 // implements the window variants
1758 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1761 // really freeze/thaw the window (should have port-specific implementation)
1762 virtual void DoFreeze() { }
1763 virtual void DoThaw() { }
1766 // Must be called when mouse capture is lost to send
1767 // wxMouseCaptureLostEvent to windows on capture stack.
1768 static void NotifyCaptureLost();
1771 // recursively call our own and our children OnEnabled() when the
1772 // enabled/disabled status changed because a parent window had been
1774 void NotifyWindowOnEnableChange(bool enabled
);
1777 // temporary event handlers used by GetPopupMenuSelectionFromUser()
1778 void InternalOnPopupMenu(wxCommandEvent
& event
);
1779 void InternalOnPopupMenuUpdate(wxUpdateUIEvent
& event
);
1781 // implementation of the public GetPopupMenuSelectionFromUser() method
1782 int DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
);
1783 #endif // wxUSE_MENUS
1785 // layout the window children when its size changes unless this was
1786 // explicitly disabled with SetAutoLayout(false)
1787 void InternalOnSize(wxSizeEvent
& event
);
1789 // base for dialog unit conversion, i.e. average character size
1790 wxSize
GetDlgUnitBase() const;
1792 // the stack of windows which have captured the mouse
1793 static struct WXDLLIMPEXP_FWD_CORE wxWindowNext
*ms_winCaptureNext
;
1795 // the window that currently has mouse capture
1796 static wxWindow
*ms_winCaptureCurrent
;
1798 // indicates if execution is inside CaptureMouse/ReleaseMouse
1799 static bool ms_winCaptureChanging
;
1802 // number of Freeze() calls minus the number of Thaw() calls: we're frozen
1803 // (i.e. not being updated) if it is positive
1804 unsigned int m_freezeCount
;
1807 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1808 wxDECLARE_NO_COPY_CLASS(wxWindowBase
);
1809 DECLARE_EVENT_TABLE()
1814 // Inlines for some deprecated methods
1815 inline wxSize
wxWindowBase::GetBestFittingSize() const
1817 return GetEffectiveMinSize();
1820 inline void wxWindowBase::SetBestFittingSize(const wxSize
& size
)
1822 SetInitialSize(size
);
1825 inline void wxWindowBase::SetBestSize(const wxSize
& size
)
1827 SetInitialSize(size
);
1830 inline void wxWindowBase::SetInitialBestSize(const wxSize
& size
)
1832 SetInitialSize(size
);
1836 // ----------------------------------------------------------------------------
1837 // now include the declaration of wxWindow class
1838 // ----------------------------------------------------------------------------
1840 // include the declaration of the platform-specific class
1841 #if defined(__WXMSW__)
1842 #ifdef __WXUNIVERSAL__
1843 #define wxWindowNative wxWindowMSW
1845 #define wxWindowMSW wxWindow
1846 #endif // wxUniv/!wxUniv
1847 #include "wx/msw/window.h"
1848 #elif defined(__WXMOTIF__)
1849 #include "wx/motif/window.h"
1850 #elif defined(__WXGTK20__)
1851 #ifdef __WXUNIVERSAL__
1852 #define wxWindowNative wxWindowGTK
1854 #define wxWindowGTK wxWindow
1856 #include "wx/gtk/window.h"
1857 #elif defined(__WXGTK__)
1858 #ifdef __WXUNIVERSAL__
1859 #define wxWindowNative wxWindowGTK
1861 #define wxWindowGTK wxWindow
1863 #include "wx/gtk1/window.h"
1864 #elif defined(__WXX11__)
1865 #ifdef __WXUNIVERSAL__
1866 #define wxWindowNative wxWindowX11
1868 #define wxWindowX11 wxWindow
1870 #include "wx/x11/window.h"
1871 #elif defined(__WXDFB__)
1872 #define wxWindowNative wxWindowDFB
1873 #include "wx/dfb/window.h"
1874 #elif defined(__WXMAC__)
1875 #ifdef __WXUNIVERSAL__
1876 #define wxWindowNative wxWindowMac
1878 #define wxWindowMac wxWindow
1880 #include "wx/osx/window.h"
1881 #elif defined(__WXCOCOA__)
1882 #ifdef __WXUNIVERSAL__
1883 #define wxWindowNative wxWindowCocoa
1885 #define wxWindowCocoa wxWindow
1887 #include "wx/cocoa/window.h"
1888 #elif defined(__WXPM__)
1889 #ifdef __WXUNIVERSAL__
1890 #define wxWindowNative wxWindowOS2
1892 #define wxWindowOS2 wxWindow
1893 #endif // wxUniv/!wxUniv
1894 #include "wx/os2/window.h"
1897 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1898 // for the native ports we already have defined it above
1899 #if defined(__WXUNIVERSAL__)
1900 #ifndef wxWindowNative
1901 #error "wxWindowNative must be defined above!"
1904 #include "wx/univ/window.h"
1907 // ----------------------------------------------------------------------------
1908 // inline functions which couldn't be declared in the class body because of
1909 // forward dependencies
1910 // ----------------------------------------------------------------------------
1912 inline wxWindow
*wxWindowBase::GetGrandParent() const
1914 return m_parent
? m_parent
->GetParent() : NULL
;
1917 // ----------------------------------------------------------------------------
1919 // ----------------------------------------------------------------------------
1921 // Find the wxWindow at the current mouse position, also returning the mouse
1923 extern WXDLLIMPEXP_CORE wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1925 // Get the current mouse position.
1926 extern WXDLLIMPEXP_CORE wxPoint
wxGetMousePosition();
1928 // get the currently active window of this application or NULL
1929 extern WXDLLIMPEXP_CORE wxWindow
*wxGetActiveWindow();
1931 // get the (first) top level parent window
1932 WXDLLIMPEXP_CORE wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1934 #if WXWIN_COMPATIBILITY_2_6
1935 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1936 wxDEPRECATED( wxWindowID
NewControlId() );
1937 inline wxWindowID
NewControlId() { return wxWindowBase::NewControlId(); }
1938 #endif // WXWIN_COMPATIBILITY_2_6
1940 #if wxUSE_ACCESSIBILITY
1941 // ----------------------------------------------------------------------------
1942 // accessible object for windows
1943 // ----------------------------------------------------------------------------
1945 class WXDLLIMPEXP_CORE wxWindowAccessible
: public wxAccessible
1948 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1949 virtual ~wxWindowAccessible() {}
1953 // Can return either a child object, or an integer
1954 // representing the child element, starting from 1.
1955 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1957 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1958 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1960 // Navigates from fromId to toId/toObject.
1961 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1962 int* toId
, wxAccessible
** toObject
);
1964 // Gets the name of the specified object.
1965 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1967 // Gets the number of children.
1968 virtual wxAccStatus
GetChildCount(int* childCount
);
1970 // Gets the specified child (starting from 1).
1971 // If *child is NULL and return value is wxACC_OK,
1972 // this means that the child is a simple element and
1973 // not an accessible object.
1974 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1976 // Gets the parent, or NULL.
1977 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1979 // Performs the default action. childId is 0 (the action for this object)
1980 // or > 0 (the action for a child).
1981 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1982 // window (e.g. an edit control).
1983 virtual wxAccStatus
DoDefaultAction(int childId
);
1985 // Gets the default action for this object (0) or > 0 (the action for a child).
1986 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1987 // string if there is no action.
1988 // The retrieved string describes the action that is performed on an object,
1989 // not what the object does as a result. For example, a toolbar button that prints
1990 // a document has a default action of "Press" rather than "Prints the current document."
1991 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1993 // Returns the description for this object or a child.
1994 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1996 // Returns help text for this object or a child, similar to tooltip text.
1997 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1999 // Returns the keyboard shortcut for this object or child.
2000 // Return e.g. ALT+K
2001 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
2003 // Returns a role constant.
2004 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
2006 // Returns a state constant.
2007 virtual wxAccStatus
GetState(int childId
, long* state
);
2009 // Returns a localized string representing the value for the object
2011 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
2013 // Selects the object or child.
2014 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
2016 // Gets the window with the keyboard focus.
2017 // If childId is 0 and child is NULL, no object in
2018 // this subhierarchy has the focus.
2019 // If this object has the focus, child should be 'this'.
2020 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
2023 // Gets a variant representing the selected children
2025 // Acceptable values:
2026 // - a null variant (IsNull() returns true)
2027 // - a list variant (GetType() == wxT("list")
2028 // - an integer representing the selected child element,
2029 // or 0 if this object is selected (GetType() == wxT("long")
2030 // - a "void*" pointer to a wxAccessible child object
2031 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
2032 #endif // wxUSE_VARIANT
2035 #endif // wxUSE_ACCESSIBILITY
2038 #endif // _WX_WINDOW_H_BASE_