1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindowBase class - the interface of wxWindow
4 // Author: Vadim Zeitlin
5 // Modified by: Ron Lee
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_WINDOW_H_BASE_
13 #define _WX_WINDOW_H_BASE_
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "windowbase.h"
19 // ----------------------------------------------------------------------------
20 // headers which we must include here
21 // ----------------------------------------------------------------------------
23 #include "wx/event.h" // the base class
25 #include "wx/list.h" // defines wxWindowList
27 #include "wx/cursor.h" // we have member variables of these classes
28 #include "wx/font.h" // so we can't do without them
29 #include "wx/colour.h"
30 #include "wx/region.h"
33 #include "wx/validate.h" // for wxDefaultValidator (always include it)
36 #include "wx/palette.h"
37 #endif // wxUSE_PALETTE
43 #if wxUSE_ACCESSIBILITY
44 #include "wx/access.h"
47 // when building wxUniv/Foo we don't want the code for native menu use to be
48 // compiled in - it should only be used when building real wxFoo
49 #ifdef __WXUNIVERSAL__
50 #define wxUSE_MENUS_NATIVE 0
52 #define wxUSE_MENUS_NATIVE wxUSE_MENUS
53 #endif // __WXUNIVERSAL__/__WXMSW__
55 // ----------------------------------------------------------------------------
56 // forward declarations
57 // ----------------------------------------------------------------------------
59 class WXDLLEXPORT wxCaret
;
60 class WXDLLEXPORT wxControl
;
61 class WXDLLEXPORT wxCursor
;
62 class WXDLLEXPORT wxDC
;
63 class WXDLLEXPORT wxDropTarget
;
64 class WXDLLEXPORT wxItemResource
;
65 class WXDLLEXPORT wxLayoutConstraints
;
66 class WXDLLEXPORT wxResourceTable
;
67 class WXDLLEXPORT wxSizer
;
68 class WXDLLEXPORT wxToolTip
;
69 class WXDLLEXPORT wxWindowBase
;
70 class WXDLLEXPORT wxWindow
;
72 #if wxUSE_ACCESSIBILITY
73 class WXDLLEXPORT wxAccessible
;
76 // ----------------------------------------------------------------------------
77 // helper stuff used by wxWindow
78 // ----------------------------------------------------------------------------
80 // struct containing all the visual attributes of a control
81 struct WXDLLEXPORT wxVisualAttributes
83 // the font used for control label/text inside it
86 // the foreground colour
89 // the background colour, may be wxNullColour if the controls background
90 // colour is not solid
94 // different window variants, on platforms like eg mac uses different
98 wxWINDOW_VARIANT_NORMAL
, // Normal size
99 wxWINDOW_VARIANT_SMALL
, // Smaller size (about 25 % smaller than normal)
100 wxWINDOW_VARIANT_MINI
, // Mini size (about 33 % smaller than normal)
101 wxWINDOW_VARIANT_LARGE
, // Large size (about 25 % larger than normal)
105 #if wxUSE_SYSTEM_OPTIONS
106 #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
109 // ----------------------------------------------------------------------------
110 // (pseudo)template list classes
111 // ----------------------------------------------------------------------------
113 WX_DECLARE_LIST_3(wxWindow
, wxWindowBase
, wxWindowList
, wxWindowListNode
, class WXDLLEXPORT
);
115 // ----------------------------------------------------------------------------
117 // ----------------------------------------------------------------------------
119 WXDLLEXPORT_DATA(extern wxWindowList
) wxTopLevelWindows
;
121 // ----------------------------------------------------------------------------
122 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
123 // interface of this class.
125 // Event handler: windows have themselves as their event handlers by default,
126 // but their event handlers could be set to another object entirely. This
127 // separation can reduce the amount of derivation required, and allow
128 // alteration of a window's functionality (e.g. by a resource editor that
129 // temporarily switches event handlers).
130 // ----------------------------------------------------------------------------
132 class WXDLLEXPORT wxWindowBase
: public wxEvtHandler
135 // creating the window
136 // -------------------
138 // default ctor, initializes everything which can be initialized before
142 // pseudo ctor (can't be virtual, called from ctor)
143 bool CreateBase(wxWindowBase
*parent
,
145 const wxPoint
& pos
= wxDefaultPosition
,
146 const wxSize
& size
= wxDefaultSize
,
148 const wxValidator
& validator
= wxDefaultValidator
,
149 const wxString
& name
= wxPanelNameStr
);
151 virtual ~wxWindowBase();
153 // deleting the window
154 // -------------------
156 // ask the window to close itself, return true if the event handler
157 // honoured our request
158 bool Close( bool force
= false );
160 // the following functions delete the C++ objects (the window itself
161 // or its children) as well as the GUI windows and normally should
162 // never be used directly
164 // delete window unconditionally (dangerous!), returns true if ok
165 virtual bool Destroy();
166 // delete all children of this window, returns true if ok
167 bool DestroyChildren();
169 // is the window being deleted?
170 bool IsBeingDeleted() const { return m_isBeingDeleted
; }
175 // NB: in future versions of wxWidgets Set/GetTitle() will only work
176 // with the top level windows (such as dialogs and frames) and
177 // Set/GetLabel() only with the other ones (i.e. all controls).
179 // the title (or label, see below) of the window: the text which the
181 virtual void SetTitle( const wxString
& WXUNUSED(title
) ) {}
182 virtual wxString
GetTitle() const { return wxEmptyString
; }
184 // label is just the same as the title (but for, e.g., buttons it
185 // makes more sense to speak about labels)
186 virtual void SetLabel(const wxString
& label
) { SetTitle(label
); }
187 virtual wxString
GetLabel() const { return GetTitle(); }
189 // the window name is used for ressource setting in X, it is not the
190 // same as the window title/label
191 virtual void SetName( const wxString
&name
) { m_windowName
= name
; }
192 virtual wxString
GetName() const { return m_windowName
; }
194 // sets the window variant, calls internally DoSetVariant if variant has changed
195 void SetWindowVariant( wxWindowVariant variant
) ;
196 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
199 // window id uniquely identifies the window among its siblings unless
200 // it is wxID_ANY which means "don't care"
201 void SetId( wxWindowID winid
) { m_windowId
= winid
; }
202 wxWindowID
GetId() const { return m_windowId
; }
204 // generate a control id for the controls which were not given one by
206 static int NewControlId() { return --ms_lastControlId
; }
207 // get the id of the control following the one with the given
208 // (autogenerated) id
209 static int NextControlId(int winid
) { return winid
- 1; }
210 // get the id of the control preceding the one with the given
211 // (autogenerated) id
212 static int PrevControlId(int winid
) { return winid
+ 1; }
217 // set the window size and/or position
218 void SetSize( int x
, int y
, int width
, int height
,
219 int sizeFlags
= wxSIZE_AUTO
)
220 { DoSetSize(x
, y
, width
, height
, sizeFlags
); }
222 void SetSize( int width
, int height
)
223 { DoSetSize( wxDefaultCoord
, wxDefaultCoord
, width
, height
, wxSIZE_USE_EXISTING
); }
225 void SetSize( const wxSize
& size
)
226 { SetSize( size
.x
, size
.y
); }
228 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
229 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
231 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
232 { DoSetSize(x
, y
, wxDefaultCoord
, wxDefaultCoord
, flags
); }
234 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
235 { Move(pt
.x
, pt
.y
, flags
); }
238 virtual void Raise() = 0;
239 virtual void Lower() = 0;
241 // client size is the size of area available for subwindows
242 void SetClientSize( int width
, int height
)
243 { DoSetClientSize(width
, height
); }
245 void SetClientSize( const wxSize
& size
)
246 { DoSetClientSize(size
.x
, size
.y
); }
248 void SetClientSize(const wxRect
& rect
)
249 { SetClientSize( rect
.width
, rect
.height
); }
251 // get the window position and/or size (pointers may be NULL)
252 void GetPosition( int *x
, int *y
) const { DoGetPosition(x
, y
); }
253 wxPoint
GetPosition() const
256 DoGetPosition(&w
, &h
);
258 return wxPoint(w
, h
);
261 void SetPosition( const wxPoint
& pt
) { Move( pt
) ; }
263 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
264 wxSize
GetSize() const
271 wxRect
GetRect() const
274 GetPosition(& x
, & y
);
277 return wxRect(x
, y
, w
, h
);
280 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
281 wxSize
GetClientSize() const
284 DoGetClientSize(& w
, & h
);
289 // get the origin of the client area of the window relative to the
290 // window top left corner (the client area may be shifted because of
291 // the borders, scrollbars, other decorations...)
292 virtual wxPoint
GetClientAreaOrigin() const;
294 // get the client rectangle in window (i.e. client) coordinates
295 wxRect
GetClientRect() const
297 return wxRect(GetClientAreaOrigin(), GetClientSize());
300 // get the size best suited for the window (in fact, minimal
301 // acceptable size using which it will still look "nice" in
303 wxSize
GetBestSize() const
305 if (m_bestSizeCache
.IsFullySpecified())
306 return m_bestSizeCache
;
307 return DoGetBestSize();
309 void GetBestSize(int *w
, int *h
) const
311 wxSize s
= GetBestSize();
318 // reset the cached best size value so it will be recalculated the
319 // next time it is needed.
320 void InvalidateBestSize();
321 void CacheBestSize(const wxSize
& size
) const
322 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
324 // There are times (and windows) where 'Best' size and 'Min' size
325 // are vastly out of sync. This should be remedied somehow, but in
326 // the meantime, this method will return the larger of BestSize
327 // (the window's smallest legible size), and any user specified
329 wxSize
GetAdjustedBestSize() const
331 wxSize
s( GetBestSize() );
332 return wxSize( wxMax( s
.x
, GetMinWidth() ), wxMax( s
.y
, GetMinHeight() ) );
335 // This function will merge the window's best size into the window's
336 // minimum size, giving priority to the min size components, and
337 // returns the results.
338 wxSize
GetBestFittingSize() const;
340 // A 'Smart' SetSize that will fill in default size values with 'best'
341 // size. Sets the minsize to what was passed in.
342 void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
);
344 // the generic centre function - centers the window on parent by`
345 // default or on screen if it doesn't have parent or
346 // wxCENTER_ON_SCREEN flag is given
347 void Centre( int direction
= wxBOTH
);
348 void Center( int direction
= wxBOTH
) { Centre(direction
); }
350 // centre on screen (only works for top level windows)
351 void CentreOnScreen(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_ON_SCREEN
); }
352 void CenterOnScreen(int dir
= wxBOTH
) { CentreOnScreen(dir
); }
354 // centre with respect to the the parent window
355 void CentreOnParent(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_FRAME
); }
356 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
358 // set window size to wrap around its children
361 // set virtual size to satisfy children
362 virtual void FitInside();
364 // set min/max size of the window
365 virtual void SetSizeHints( int minW
, int minH
,
366 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
367 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
)
369 DoSetSizeHints(minW
, minH
, maxW
, maxH
, incW
, incH
);
372 void SetSizeHints( const wxSize
& minSize
,
373 const wxSize
& maxSize
=wxDefaultSize
,
374 const wxSize
& incSize
=wxDefaultSize
)
376 DoSetSizeHints(minSize
.x
, minSize
.y
,
377 maxSize
.x
, maxSize
.y
,
378 incSize
.x
, incSize
.y
);
381 virtual void DoSetSizeHints(int minW
, int minH
,
382 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
383 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
);
385 virtual void SetVirtualSizeHints( int minW
, int minH
,
386 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
);
387 void SetVirtualSizeHints( const wxSize
& minSize
,
388 const wxSize
& maxSize
=wxDefaultSize
)
390 SetVirtualSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
);
393 virtual int GetMinWidth() const { return m_minWidth
; }
394 virtual int GetMinHeight() const { return m_minHeight
; }
395 int GetMaxWidth() const { return m_maxWidth
; }
396 int GetMaxHeight() const { return m_maxHeight
; }
398 // Override this method to control the values given to Sizers etc.
399 virtual wxSize
GetMaxSize() const { return wxSize( m_maxWidth
, m_maxHeight
); }
400 virtual wxSize
GetMinSize() const { return wxSize( m_minWidth
, m_minHeight
); }
402 void SetMinSize(const wxSize
& minSize
) { SetSizeHints(minSize
); }
403 void SetMaxSize(const wxSize
& maxSize
) { SetSizeHints(GetMinSize(), maxSize
); }
405 // Methods for accessing the virtual size of a window. For most
406 // windows this is just the client area of the window, but for
407 // some like scrolled windows it is more or less independent of
408 // the screen window size. You may override the DoXXXVirtual
409 // methods below for classes where that is is the case.
411 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
412 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
414 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
415 void GetVirtualSize( int *x
, int *y
) const
417 wxSize
s( DoGetVirtualSize() );
425 // Override these methods for windows that have a virtual size
426 // independent of their client size. eg. the virtual area of a
427 // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
429 virtual void DoSetVirtualSize( int x
, int y
);
430 virtual wxSize
DoGetVirtualSize() const; // { return m_virtualSize; }
432 // Return the largest of ClientSize and BestSize (as determined
433 // by a sizer, interior children, or other means)
435 virtual wxSize
GetBestVirtualSize() const
437 wxSize
client( GetClientSize() );
438 wxSize
best( GetBestSize() );
440 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
446 // returns true if window was shown/hidden, false if the nothing was
447 // done (window was already shown/hidden)
448 virtual bool Show( bool show
= true );
449 bool Hide() { return Show(false); }
451 // returns true if window was enabled/disabled, false if nothing done
452 virtual bool Enable( bool enable
= true );
453 bool Disable() { return Enable(false); }
455 virtual bool IsShown() const { return m_isShown
; }
456 bool IsEnabled() const { return m_isEnabled
; }
458 // get/set window style (setting style won't update the window and so
459 // is only useful for internal usage)
460 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
461 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
463 // just some (somewhat shorter) synonims
464 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
465 long GetWindowStyle() const { return GetWindowStyleFlag(); }
467 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
468 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
470 // extra style: the less often used style bits which can't be set with
471 // SetWindowStyleFlag()
472 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
473 long GetExtraStyle() const { return m_exStyle
; }
475 // make the window modal (all other windows unresponsive)
476 virtual void MakeModal(bool modal
= true);
479 // (primitive) theming support
480 // ---------------------------
482 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
483 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
485 // Returns true if this class should have the background colour
486 // changed to match the parent window's theme. For example when a
487 // page is added to a notebook it and its children may need to have
488 // the colours adjusted depending on the current theme settings, but
489 // not all windows/controls can do this without looking wrong.
490 virtual void ApplyParentThemeBackground(const wxColour
& WXUNUSED(bg
))
494 // focus and keyboard handling
495 // ---------------------------
497 // set focus to this window
498 virtual void SetFocus() = 0;
500 // set focus to this window as the result of a keyboard action
501 virtual void SetFocusFromKbd() { SetFocus(); }
503 // return the window which currently has the focus or NULL
504 static wxWindow
*FindFocus();
506 static wxWindow
*DoFindFocus() /* = 0: implement in derived classes */;
508 // can this window have focus?
509 virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
511 // can this window be given focus by keyboard navigation? if not, the
512 // only way to give it focus (provided it accepts it at all) is to
514 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
516 // NB: these methods really don't belong here but with the current
517 // class hierarchy there is no other place for them :-(
519 // get the default child of this parent, i.e. the one which is
520 // activated by pressing <Enter>
521 virtual wxWindow
*GetDefaultItem() const { return NULL
; }
523 // set this child as default, return the old default
524 virtual wxWindow
*SetDefaultItem(wxWindow
* WXUNUSED(child
))
527 // set this child as temporary default
528 virtual void SetTmpDefaultItem(wxWindow
* WXUNUSED(win
)) { }
530 // navigates in the specified direction by sending a wxNavigationKeyEvent
531 virtual bool Navigate(int flags
= wxNavigationKeyEvent::IsForward
);
533 // move this window just before/after the specified one in tab order
534 // (the other window must be our sibling!)
535 void MoveBeforeInTabOrder(wxWindow
*win
)
536 { DoMoveInTabOrder(win
, MoveBefore
); }
537 void MoveAfterInTabOrder(wxWindow
*win
)
538 { DoMoveInTabOrder(win
, MoveAfter
); }
541 // parent/children relations
542 // -------------------------
544 // get the list of children
545 const wxWindowList
& GetChildren() const { return m_children
; }
546 wxWindowList
& GetChildren() { return m_children
; }
548 // needed just for extended runtime
549 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
551 // get the parent or the parent of the parent
552 wxWindow
*GetParent() const { return m_parent
; }
553 inline wxWindow
*GetGrandParent() const;
555 // is this window a top level one?
556 virtual bool IsTopLevel() const;
558 // it doesn't really change parent, use Reparent() instead
559 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
560 // change the real parent of this window, return true if the parent
561 // was changed, false otherwise (error or newParent == oldParent)
562 virtual bool Reparent( wxWindowBase
*newParent
);
564 // implementation mostly
565 virtual void AddChild( wxWindowBase
*child
);
566 virtual void RemoveChild( wxWindowBase
*child
);
568 // looking for windows
569 // -------------------
571 // find window among the descendants of this one either by id or by
572 // name (return NULL if not found)
573 wxWindow
*FindWindow(long winid
) const;
574 wxWindow
*FindWindow(const wxString
& name
) const;
576 // Find a window among any window (all return NULL if not found)
577 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
578 static wxWindow
*FindWindowByName( const wxString
& name
,
579 const wxWindow
*parent
= NULL
);
580 static wxWindow
*FindWindowByLabel( const wxString
& label
,
581 const wxWindow
*parent
= NULL
);
583 // event handler stuff
584 // -------------------
586 // get the current event handler
587 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
589 // replace the event handler (allows to completely subclass the
591 void SetEventHandler( wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
593 // push/pop event handler: allows to chain a custom event handler to
594 // alreasy existing ones
595 void PushEventHandler( wxEvtHandler
*handler
);
596 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
598 // find the given handler in the event handler chain and remove (but
599 // not delete) it from the event handler chain, return true if it was
600 // found and false otherwise (this also results in an assert failure so
601 // this function should only be called when the handler is supposed to
603 bool RemoveEventHandler(wxEvtHandler
*handler
);
609 // a window may have an associated validator which is used to control
611 virtual void SetValidator( const wxValidator
&validator
);
612 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
613 #endif // wxUSE_VALIDATORS
616 // dialog oriented functions
617 // -------------------------
619 // validate the correctness of input, return true if ok
620 virtual bool Validate();
622 // transfer data between internal and GUI representations
623 virtual bool TransferDataToWindow();
624 virtual bool TransferDataFromWindow();
626 virtual void InitDialog();
631 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
632 { m_acceleratorTable
= accel
; }
633 wxAcceleratorTable
*GetAcceleratorTable()
634 { return &m_acceleratorTable
; }
636 #endif // wxUSE_ACCEL
639 // hot keys (system wide accelerators)
640 // -----------------------------------
642 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
643 virtual bool UnregisterHotKey(int hotkeyId
);
644 #endif // wxUSE_HOTKEY
647 // dialog units translations
648 // -------------------------
650 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
651 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
652 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
654 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
656 return wxSize(pt
.x
, pt
.y
);
659 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
661 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
663 return wxSize(pt
.x
, pt
.y
);
669 // move the mouse to the specified position
670 virtual void WarpPointer(int x
, int y
) = 0;
672 // start or end mouse capture, these functions maintain the stack of
673 // windows having captured the mouse and after calling ReleaseMouse()
674 // the mouse is not released but returns to the window which had had
675 // captured it previously (if any)
679 // get the window which currently captures the mouse or NULL
680 static wxWindow
*GetCapture();
682 // does this window have the capture?
683 virtual bool HasCapture() const
684 { return (wxWindow
*)this == GetCapture(); }
686 // painting the window
687 // -------------------
689 // mark the specified rectangle (or the whole window) as "dirty" so it
691 virtual void Refresh( bool eraseBackground
= true,
692 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
694 // a less awkward wrapper for Refresh
695 void RefreshRect(const wxRect
& rect
) { Refresh(true, &rect
); }
697 // repaint all invalid areas of the window immediately
698 virtual void Update() { }
700 // clear the window background
701 virtual void ClearBackground();
703 // freeze the window: don't redraw it until it is thawed
704 virtual void Freeze() { }
706 // thaw the window: redraw it after it had been frozen
707 virtual void Thaw() { }
709 // adjust DC for drawing on this window
710 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
712 // the update region of the window contains the areas which must be
713 // repainted by the program
714 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
715 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
717 // get the update rectangleregion bounding box in client coords
718 wxRect
GetUpdateClientRect() const;
720 // these functions verify whether the given point/rectangle belongs to
721 // (or at least intersects with) the update region
722 bool IsExposed( int x
, int y
) const;
723 bool IsExposed( int x
, int y
, int w
, int h
) const;
725 bool IsExposed( const wxPoint
& pt
) const
726 { return IsExposed(pt
.x
, pt
.y
); }
727 bool IsExposed( const wxRect
& rect
) const
728 { return IsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
730 // colours, fonts and cursors
731 // --------------------------
733 // get the default attributes for the controls of this class: we
734 // provide a virtual function which can be used to query the default
735 // attributes of an existing control and a static function which can
736 // be used even when no existing object of the given class is
737 // available, but which won't return any styles specific to this
738 // particular control, of course (e.g. "Ok" button might have
739 // different -- bold for example -- font)
740 virtual wxVisualAttributes
GetDefaultAttributes() const
742 return GetClassDefaultAttributes(GetWindowVariant());
745 static wxVisualAttributes
746 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
748 // set/retrieve the window colours (system defaults are used by
749 // default): SetXXX() functions return true if colour was changed,
750 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
751 // value to prevent it from being inherited by our children
752 virtual bool SetBackgroundColour(const wxColour
& colour
);
753 void SetOwnBackgroundColour(const wxColour
& colour
)
755 if ( SetBackgroundColour(colour
) )
756 m_inheritBgCol
= false;
758 wxColour
GetBackgroundColour() const;
760 // if the window shouldn't inherit its colour from the parent, override
761 // this function to return true
763 // this is currently only used by wxMSW and wxUniv but should be useful for
764 // the other ports too
765 virtual bool ProvidesBackground() const { return false; }
767 virtual bool SetForegroundColour(const wxColour
& colour
);
768 void SetOwnForegroundColour(const wxColour
& colour
)
770 if ( SetForegroundColour(colour
) )
771 m_inheritFgCol
= false;
773 wxColour
GetForegroundColour() const;
775 // Set/get the background style.
776 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
777 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) { m_backgroundStyle
= style
; return true; }
778 virtual wxBackgroundStyle
GetBackgroundStyle() const { return m_backgroundStyle
; }
780 // returns true if the control has "transparent" areas such as a
781 // wxStaticText and wxCheckBox and the background should be adapted
782 // from a parent window
783 virtual bool HasTransparentBackground() { return false; }
785 // set/retrieve the font for the window (SetFont() returns true if the
786 // font really changed)
787 virtual bool SetFont(const wxFont
& font
) = 0;
788 void SetOwnFont(const wxFont
& font
)
791 m_inheritFont
= false;
793 wxFont
GetFont() const;
795 // set/retrieve the cursor for this window (SetCursor() returns true
796 // if the cursor was really changed)
797 virtual bool SetCursor( const wxCursor
&cursor
);
798 const wxCursor
& GetCursor() const { return m_cursor
; }
801 // associate a caret with the window
802 void SetCaret(wxCaret
*caret
);
803 // get the current caret (may be NULL)
804 wxCaret
*GetCaret() const { return m_caret
; }
805 #endif // wxUSE_CARET
807 // get the (average) character size for the current font
808 virtual int GetCharHeight() const = 0;
809 virtual int GetCharWidth() const = 0;
811 // get the width/height/... of the text using current or specified
813 virtual void GetTextExtent(const wxString
& string
,
815 int *descent
= (int *) NULL
,
816 int *externalLeading
= (int *) NULL
,
817 const wxFont
*theFont
= (const wxFont
*) NULL
)
820 // client <-> screen coords
821 // ------------------------
823 // translate to/from screen/client coordinates (pointers may be NULL)
824 void ClientToScreen( int *x
, int *y
) const
825 { DoClientToScreen(x
, y
); }
826 void ScreenToClient( int *x
, int *y
) const
827 { DoScreenToClient(x
, y
); }
829 // wxPoint interface to do the same thing
830 wxPoint
ClientToScreen(const wxPoint
& pt
) const
832 int x
= pt
.x
, y
= pt
.y
;
833 DoClientToScreen(&x
, &y
);
835 return wxPoint(x
, y
);
838 wxPoint
ScreenToClient(const wxPoint
& pt
) const
840 int x
= pt
.x
, y
= pt
.y
;
841 DoScreenToClient(&x
, &y
);
843 return wxPoint(x
, y
);
846 // test where the given (in client coords) point lies
847 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
848 { return DoHitTest(x
, y
); }
850 wxHitTest
HitTest(const wxPoint
& pt
) const
851 { return DoHitTest(pt
.x
, pt
.y
); }
856 // get the window border style from the given flags: this is different from
857 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
858 // translate wxBORDER_DEFAULT to something reasonable
859 wxBorder
GetBorder(long flags
) const;
861 // get border for the flags of this window
862 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
864 // send wxUpdateUIEvents to this window, and children if recurse is true
865 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
867 // do the window-specific processing after processing the update event
868 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
871 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
872 { return DoPopupMenu(menu
, pos
.x
, pos
.y
); }
873 bool PopupMenu(wxMenu
*menu
, int x
, int y
)
874 { return DoPopupMenu(menu
, x
, y
); }
875 #endif // wxUSE_MENUS
880 // does the window have the scrollbar for this orientation?
881 bool HasScrollbar(int orient
) const
883 return (m_windowStyle
&
884 (orient
== wxHORIZONTAL
? wxHSCROLL
: wxVSCROLL
)) != 0;
887 // configure the window scrollbars
888 virtual void SetScrollbar( int orient
,
892 bool refresh
= true ) = 0;
893 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
894 virtual int GetScrollPos( int orient
) const = 0;
895 virtual int GetScrollThumb( int orient
) const = 0;
896 virtual int GetScrollRange( int orient
) const = 0;
898 // scroll window to the specified position
899 virtual void ScrollWindow( int dx
, int dy
,
900 const wxRect
* rect
= (wxRect
*) NULL
) = 0;
902 // scrolls window by line/page: note that not all controls support this
904 // return true if the position changed, false otherwise
905 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
906 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
908 // convenient wrappers for ScrollLines/Pages
909 bool LineUp() { return ScrollLines(-1); }
910 bool LineDown() { return ScrollLines(1); }
911 bool PageUp() { return ScrollPages(-1); }
912 bool PageDown() { return ScrollPages(1); }
914 // context-sensitive help
915 // ----------------------
917 // these are the convenience functions wrapping wxHelpProvider methods
920 // associate this help text with this window
921 void SetHelpText(const wxString
& text
);
922 // associate this help text with all windows with the same id as this
924 void SetHelpTextForId(const wxString
& text
);
925 // get the help string associated with this window (may be empty)
926 wxString
GetHelpText() const;
933 // the easiest way to set a tooltip for a window is to use this method
934 void SetToolTip( const wxString
&tip
);
935 // attach a tooltip to the window
936 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
937 // get the associated tooltip or NULL if none
938 wxToolTip
* GetToolTip() const { return m_tooltip
; }
939 wxString
GetToolTipText() const ;
941 // make it much easier to compile apps in an environment
942 // that doesn't support tooltips, such as PocketPC
943 inline void SetToolTip( const wxString
& WXUNUSED(tip
) ) {}
944 #endif // wxUSE_TOOLTIPS
948 #if wxUSE_DRAG_AND_DROP
949 // set/retrieve the drop target associated with this window (may be
950 // NULL; it's owned by the window and will be deleted by it)
951 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
952 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
953 #endif // wxUSE_DRAG_AND_DROP
955 // constraints and sizers
956 // ----------------------
957 #if wxUSE_CONSTRAINTS
958 // set the constraints for this window or retrieve them (may be NULL)
959 void SetConstraints( wxLayoutConstraints
*constraints
);
960 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
962 // implementation only
963 void UnsetConstraints(wxLayoutConstraints
*c
);
964 wxWindowList
*GetConstraintsInvolvedIn() const
965 { return m_constraintsInvolvedIn
; }
966 void AddConstraintReference(wxWindowBase
*otherWin
);
967 void RemoveConstraintReference(wxWindowBase
*otherWin
);
968 void DeleteRelatedConstraints();
969 void ResetConstraints();
971 // these methods may be overriden for special layout algorithms
972 virtual void SetConstraintSizes(bool recurse
= true);
973 virtual bool LayoutPhase1(int *noChanges
);
974 virtual bool LayoutPhase2(int *noChanges
);
975 virtual bool DoPhase(int phase
);
977 // these methods are virtual but normally won't be overridden
978 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
979 virtual void MoveConstraint(int x
, int y
);
980 virtual void GetSizeConstraint(int *w
, int *h
) const ;
981 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
982 virtual void GetPositionConstraint(int *x
, int *y
) const ;
984 #endif // wxUSE_CONSTRAINTS
986 // when using constraints or sizers, it makes sense to update
987 // children positions automatically whenever the window is resized
988 // - this is done if autoLayout is on
989 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
990 bool GetAutoLayout() const { return m_autoLayout
; }
992 // lay out the window and its children
993 virtual bool Layout();
996 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
997 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
999 wxSizer
*GetSizer() const { return m_windowSizer
; }
1001 // Track if this window is a member of a sizer
1002 void SetContainingSizer(wxSizer
* sizer
);
1003 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1006 // ----------------------
1007 #if wxUSE_ACCESSIBILITY
1008 // Override to create a specific accessible object.
1009 virtual wxAccessible
* CreateAccessible();
1011 // Sets the accessible object.
1012 void SetAccessible(wxAccessible
* accessible
) ;
1014 // Returns the accessible object.
1015 wxAccessible
* GetAccessible() { return m_accessible
; };
1017 // Returns the accessible object, creating if necessary.
1018 wxAccessible
* GetOrCreateAccessible() ;
1025 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1026 void OnInitDialog( wxInitDialogEvent
&event
);
1027 void OnMiddleClick( wxMouseEvent
& event
);
1029 void OnHelp(wxHelpEvent
& event
);
1030 #endif // wxUSE_HELP
1032 // virtual function for implementing internal idle
1034 virtual void OnInternalIdle() {}
1036 // call internal idle recursively
1037 // void ProcessInternalIdle() ;
1039 // get the handle of the window for the underlying window system: this
1040 // is only used for wxWin itself or for user code which wants to call
1041 // platform-specific APIs
1042 virtual WXWidget
GetHandle() const = 0;
1043 // associate the window with a new native handle
1044 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1045 // dissociate the current native handle from the window
1046 virtual void DissociateHandle() { }
1049 // Store the palette used by DCs in wxWindow so that the dcs can share
1050 // a palette. And we can respond to palette messages.
1051 wxPalette
GetPalette() const { return m_palette
; }
1053 // When palette is changed tell the DC to set the system palette to the
1055 void SetPalette(const wxPalette
& pal
);
1057 // return true if we have a specific palette
1058 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1060 // return the first parent window with a custom palette or NULL
1061 wxWindow
*GetAncestorWithCustomPalette() const;
1062 #endif // wxUSE_PALETTE
1064 // inherit the parents visual attributes if they had been explicitly set
1065 // by the user (i.e. we don't inherit default attributes) and if we don't
1066 // have our own explicitly set
1067 virtual void InheritAttributes();
1069 // returns false from here if this window doesn't want to inherit the
1070 // parents colours even if InheritAttributes() would normally do it
1072 // this just provides a simple way to customize InheritAttributes()
1073 // behaviour in the most common case
1074 virtual bool ShouldInheritColours() const { return false; }
1077 // event handling specific to wxWindow
1078 virtual bool TryValidator(wxEvent
& event
);
1079 virtual bool TryParent(wxEvent
& event
);
1081 // common part of MoveBefore/AfterInTabOrder()
1084 MoveBefore
, // insert before the given window
1085 MoveAfter
// insert after the given window
1087 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
1089 #if wxUSE_CONSTRAINTS
1090 // satisfy the constraints for the windows but don't set the window sizes
1091 void SatisfyConstraints();
1092 #endif // wxUSE_CONSTRAINTS
1094 // Send the wxWindowDestroyEvent
1095 void SendDestroyEvent();
1097 // returns the main window of composite control; this is the window
1098 // that FindFocus returns if the focus is in one of composite control's
1100 virtual wxWindow
*GetMainWindowOfCompositeControl()
1101 { return (wxWindow
*)this; }
1103 // the window id - a number which uniquely identifies a window among
1104 // its siblings unless it is wxID_ANY
1105 wxWindowID m_windowId
;
1107 // the parent window of this window (or NULL) and the list of the children
1110 wxWindowList m_children
;
1112 // the minimal allowed size for the window (no minimal size if variable(s)
1113 // contain(s) wxDefaultCoord)
1119 // event handler for this window: usually is just 'this' but may be
1120 // changed with SetEventHandler()
1121 wxEvtHandler
*m_eventHandler
;
1123 #if wxUSE_VALIDATORS
1124 // associated validator or NULL if none
1125 wxValidator
*m_windowValidator
;
1126 #endif // wxUSE_VALIDATORS
1128 #if wxUSE_DRAG_AND_DROP
1129 wxDropTarget
*m_dropTarget
;
1130 #endif // wxUSE_DRAG_AND_DROP
1132 // visual window attributes
1134 wxFont m_font
; // see m_hasFont
1135 wxColour m_backgroundColour
, // m_hasBgCol
1136 m_foregroundColour
; // m_hasFgCol
1140 #endif // wxUSE_CARET
1142 // the region which should be repainted in response to paint event
1143 wxRegion m_updateRegion
;
1146 // the accelerator table for the window which translates key strokes into
1148 wxAcceleratorTable m_acceleratorTable
;
1149 #endif // wxUSE_ACCEL
1151 // the tooltip for this window (may be NULL)
1153 wxToolTip
*m_tooltip
;
1154 #endif // wxUSE_TOOLTIPS
1156 // constraints and sizers
1157 #if wxUSE_CONSTRAINTS
1158 // the constraints for this window or NULL
1159 wxLayoutConstraints
*m_constraints
;
1161 // constraints this window is involved in
1162 wxWindowList
*m_constraintsInvolvedIn
;
1163 #endif // wxUSE_CONSTRAINTS
1165 // this window's sizer
1166 wxSizer
*m_windowSizer
;
1168 // The sizer this window is a member of, if any
1169 wxSizer
*m_containingSizer
;
1171 // Layout() window automatically when its size changes?
1172 bool m_autoLayout
:1;
1177 bool m_isBeingDeleted
:1;
1179 // was the window colours/font explicitly changed by user?
1184 // and should it be inherited by children?
1185 bool m_inheritBgCol
:1;
1186 bool m_inheritFgCol
:1;
1187 bool m_inheritFont
:1;
1189 // window attributes
1192 wxString m_windowName
;
1193 bool m_themeEnabled
;
1194 wxBackgroundStyle m_backgroundStyle
;
1196 wxPalette m_palette
;
1197 bool m_hasCustomPalette
;
1198 #endif // wxUSE_PALETTE
1200 #if wxUSE_ACCESSIBILITY
1201 wxAccessible
* m_accessible
;
1204 // Virtual size (scrolling)
1205 wxSize m_virtualSize
;
1207 int m_minVirtualWidth
; // VirtualSizeHints
1208 int m_minVirtualHeight
;
1209 int m_maxVirtualWidth
;
1210 int m_maxVirtualHeight
;
1212 wxWindowVariant m_windowVariant
;
1214 // override this to change the default (i.e. used when no style is
1215 // specified) border for the window class
1216 virtual wxBorder
GetDefaultBorder() const;
1218 // Get the default size for the new window if no explicit size given. TLWs
1219 // have their own default size so this is just for non top-level windows.
1220 static int WidthDefault(int w
) { return w
== wxDefaultCoord
? 20 : w
; }
1221 static int HeightDefault(int h
) { return h
== wxDefaultCoord
? 20 : h
; }
1224 // Used to save the results of DoGetBestSize so it doesn't need to be
1225 // recalculated each time the value is needed.
1226 wxSize m_bestSizeCache
;
1228 // keep the old name for compatibility, at least until all the internal
1229 // usages of it are changed to SetBestFittingSize
1230 void SetBestSize(const wxSize
& size
) { SetBestFittingSize(size
); }
1232 // set the initial window size if none is given (i.e. at least one of the
1233 // components of the size passed to ctor/Create() is wxDefaultCoord)
1235 // normally just calls SetBestSize() for controls, but can be overridden
1236 // not to do it for the controls which have to do some additional
1237 // initialization (e.g. add strings to list box) before their best size
1238 // can be accurately calculated
1239 virtual void SetInitialBestSize(const wxSize
& WXUNUSED(size
)) {}
1243 // more pure virtual functions
1244 // ---------------------------
1246 // NB: we must have DoSomething() function when Something() is an overloaded
1247 // method: indeed, we can't just have "virtual Something()" in case when
1248 // the function is overloaded because then we'd have to make virtual all
1249 // the variants (otherwise only the virtual function may be called on a
1250 // pointer to derived class according to C++ rules) which is, in
1251 // general, absolutely not needed. So instead we implement all
1252 // overloaded Something()s in terms of DoSomething() which will be the
1253 // only one to be virtual.
1255 // coordinates translation
1256 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1257 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1259 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1261 // capture/release the mouse, used by Capture/ReleaseMouse()
1262 virtual void DoCaptureMouse() = 0;
1263 virtual void DoReleaseMouse() = 0;
1265 // retrieve the position/size of the window
1266 virtual void DoGetPosition( int *x
, int *y
) const = 0;
1267 virtual void DoGetSize( int *width
, int *height
) const = 0;
1268 virtual void DoGetClientSize( int *width
, int *height
) const = 0;
1270 // get the size which best suits the window: for a control, it would be
1271 // the minimal size which doesn't truncate the control, for a panel - the
1272 // same size as it would have after a call to Fit()
1273 virtual wxSize
DoGetBestSize() const;
1275 // this is the virtual function to be overriden in any derived class which
1276 // wants to change how SetSize() or Move() works - it is called by all
1277 // versions of these functions in the base class
1278 virtual void DoSetSize(int x
, int y
,
1279 int width
, int height
,
1280 int sizeFlags
= wxSIZE_AUTO
) = 0;
1282 // same as DoSetSize() for the client size
1283 virtual void DoSetClientSize(int width
, int height
) = 0;
1285 // move the window to the specified location and resize it: this is called
1286 // from both DoSetSize() and DoSetClientSize() and would usually just
1287 // reposition this window except for composite controls which will want to
1288 // arrange themselves inside the given rectangle
1289 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1292 virtual void DoSetToolTip( wxToolTip
*tip
);
1293 #endif // wxUSE_TOOLTIPS
1296 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1297 #endif // wxUSE_MENUS
1299 // Makes an adjustment to the window position to make it relative to the
1300 // parents client area, e.g. if the parent is a frame with a toolbar, its
1301 // (0, 0) is just below the toolbar
1302 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1303 int sizeFlags
= 0) const;
1305 // implements the window variants
1306 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1309 // contains the last id generated by NewControlId
1310 static int ms_lastControlId
;
1312 // the stack of windows which have captured the mouse
1313 static struct WXDLLEXPORT wxWindowNext
*ms_winCaptureNext
;
1315 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1316 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1317 DECLARE_EVENT_TABLE()
1320 // ----------------------------------------------------------------------------
1321 // now include the declaration of wxWindow class
1322 // ----------------------------------------------------------------------------
1324 // include the declaration of the platform-specific class
1325 #if defined(__WXPALMOS__)
1326 #ifdef __WXUNIVERSAL__
1327 #define wxWindowNative wxWindowPalm
1329 #define wxWindowPalm wxWindow
1330 #endif // wxUniv/!wxUniv
1331 #include "wx/palmos/window.h"
1332 #elif defined(__WXMSW__)
1333 #ifdef __WXUNIVERSAL__
1334 #define wxWindowNative wxWindowMSW
1336 #define wxWindowMSW wxWindow
1337 #endif // wxUniv/!wxUniv
1338 #include "wx/msw/window.h"
1339 #elif defined(__WXMOTIF__)
1340 #include "wx/motif/window.h"
1341 #elif defined(__WXGTK__)
1342 #ifdef __WXUNIVERSAL__
1343 #define wxWindowNative wxWindowGTK
1345 #define wxWindowGTK wxWindow
1347 #include "wx/gtk/window.h"
1348 #elif defined(__WXX11__)
1349 #ifdef __WXUNIVERSAL__
1350 #define wxWindowNative wxWindowX11
1352 #define wxWindowX11 wxWindow
1354 #include "wx/x11/window.h"
1355 #elif defined(__WXMGL__)
1356 #ifdef __WXUNIVERSAL__
1357 #define wxWindowNative wxWindowMGL
1359 #define wxWindowMGL wxWindow
1361 #include "wx/mgl/window.h"
1362 #elif defined(__WXMAC__)
1363 #ifdef __WXUNIVERSAL__
1364 #define wxWindowNative wxWindowMac
1366 #define wxWindowMac wxWindow
1368 #include "wx/mac/window.h"
1369 #elif defined(__WXCOCOA__)
1370 #ifdef __WXUNIVERSAL__
1371 #define wxWindowNative wxWindowCocoa
1373 #define wxWindowCocoa wxWindow
1375 #include "wx/cocoa/window.h"
1376 #elif defined(__WXPM__)
1377 #ifdef __WXUNIVERSAL__
1378 #define wxWindowNative wxWindowOS2
1380 #define wxWindowOS2 wxWindow
1381 #endif // wxUniv/!wxUniv
1382 #include "wx/os2/window.h"
1385 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1386 // for the native ports we already have defined it above
1387 #if defined(__WXUNIVERSAL__)
1388 #ifndef wxWindowNative
1389 #error "wxWindowNative must be defined above!"
1392 #include "wx/univ/window.h"
1395 // ----------------------------------------------------------------------------
1396 // inline functions which couldn't be declared in the class body because of
1397 // forward dependencies
1398 // ----------------------------------------------------------------------------
1400 inline wxWindow
*wxWindowBase::GetGrandParent() const
1402 return m_parent
? m_parent
->GetParent() : (wxWindow
*)NULL
;
1405 // ----------------------------------------------------------------------------
1407 // ----------------------------------------------------------------------------
1409 // Find the wxWindow at the current mouse position, also returning the mouse
1411 WXDLLEXPORT
extern wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1413 // Get the current mouse position.
1414 WXDLLEXPORT
extern wxPoint
wxGetMousePosition();
1416 // get the currently active window of this application or NULL
1417 WXDLLEXPORT
extern wxWindow
*wxGetActiveWindow();
1419 // get the (first) top level parent window
1420 WXDLLEXPORT wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1422 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1423 inline int NewControlId() { return wxWindowBase::NewControlId(); }
1425 #if wxUSE_ACCESSIBILITY
1426 // ----------------------------------------------------------------------------
1427 // accessible object for windows
1428 // ----------------------------------------------------------------------------
1430 class WXDLLEXPORT wxWindowAccessible
: public wxAccessible
1433 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1434 virtual ~wxWindowAccessible() {}
1438 // Can return either a child object, or an integer
1439 // representing the child element, starting from 1.
1440 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1442 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1443 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1445 // Navigates from fromId to toId/toObject.
1446 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1447 int* toId
, wxAccessible
** toObject
);
1449 // Gets the name of the specified object.
1450 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1452 // Gets the number of children.
1453 virtual wxAccStatus
GetChildCount(int* childCount
);
1455 // Gets the specified child (starting from 1).
1456 // If *child is NULL and return value is wxACC_OK,
1457 // this means that the child is a simple element and
1458 // not an accessible object.
1459 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1461 // Gets the parent, or NULL.
1462 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1464 // Performs the default action. childId is 0 (the action for this object)
1465 // or > 0 (the action for a child).
1466 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1467 // window (e.g. an edit control).
1468 virtual wxAccStatus
DoDefaultAction(int childId
);
1470 // Gets the default action for this object (0) or > 0 (the action for a child).
1471 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1472 // string if there is no action.
1473 // The retrieved string describes the action that is performed on an object,
1474 // not what the object does as a result. For example, a toolbar button that prints
1475 // a document has a default action of "Press" rather than "Prints the current document."
1476 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1478 // Returns the description for this object or a child.
1479 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1481 // Returns help text for this object or a child, similar to tooltip text.
1482 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1484 // Returns the keyboard shortcut for this object or child.
1485 // Return e.g. ALT+K
1486 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1488 // Returns a role constant.
1489 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1491 // Returns a state constant.
1492 virtual wxAccStatus
GetState(int childId
, long* state
);
1494 // Returns a localized string representing the value for the object
1496 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1498 // Selects the object or child.
1499 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1501 // Gets the window with the keyboard focus.
1502 // If childId is 0 and child is NULL, no object in
1503 // this subhierarchy has the focus.
1504 // If this object has the focus, child should be 'this'.
1505 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1507 // Gets a variant representing the selected children
1509 // Acceptable values:
1510 // - a null variant (IsNull() returns true)
1511 // - a list variant (GetType() == wxT("list")
1512 // - an integer representing the selected child element,
1513 // or 0 if this object is selected (GetType() == wxT("long")
1514 // - a "void*" pointer to a wxAccessible child object
1515 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1518 #endif // wxUSE_ACCESSIBILITY
1522 // _WX_WINDOW_H_BASE_