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"
29 #include "wx/validate.h" // for wxDefaultValidator (always include it)
32 #include "wx/palette.h"
33 #endif // wxUSE_PALETTE
39 #if wxUSE_ACCESSIBILITY
40 #include "wx/access.h"
43 // when building wxUniv/Foo we don't want the code for native menu use to be
44 // compiled in - it should only be used when building real wxFoo
45 #ifdef __WXUNIVERSAL__
46 #define wxUSE_MENUS_NATIVE 0
47 #else // !__WXUNIVERSAL__
48 #define wxUSE_MENUS_NATIVE wxUSE_MENUS
49 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
51 // ----------------------------------------------------------------------------
52 // forward declarations
53 // ----------------------------------------------------------------------------
55 class WXDLLEXPORT wxCaret
;
56 class WXDLLEXPORT wxControl
;
57 class WXDLLEXPORT wxCursor
;
58 class WXDLLEXPORT wxDC
;
59 class WXDLLEXPORT wxDropTarget
;
60 class WXDLLEXPORT wxItemResource
;
61 class WXDLLEXPORT wxLayoutConstraints
;
62 class WXDLLEXPORT wxResourceTable
;
63 class WXDLLEXPORT wxSizer
;
64 class WXDLLEXPORT wxToolTip
;
65 class WXDLLEXPORT wxWindowBase
;
66 class WXDLLEXPORT wxWindow
;
68 #if wxUSE_ACCESSIBILITY
69 class WXDLLEXPORT wxAccessible
;
72 // ----------------------------------------------------------------------------
73 // helper stuff used by wxWindow
74 // ----------------------------------------------------------------------------
76 // struct containing all the visual attributes of a control
77 struct WXDLLEXPORT wxVisualAttributes
79 // the font used for control label/text inside it
82 // the foreground colour
85 // the background colour, may be wxNullColour if the controls background
86 // colour is not solid
90 // different window variants, on platforms like eg mac uses different
94 wxWINDOW_VARIANT_NORMAL
, // Normal size
95 wxWINDOW_VARIANT_SMALL
, // Smaller size (about 25 % smaller than normal)
96 wxWINDOW_VARIANT_MINI
, // Mini size (about 33 % smaller than normal)
97 wxWINDOW_VARIANT_LARGE
, // Large size (about 25 % larger than normal)
101 #if wxUSE_SYSTEM_OPTIONS
102 #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
105 // ----------------------------------------------------------------------------
106 // (pseudo)template list classes
107 // ----------------------------------------------------------------------------
109 WX_DECLARE_LIST_3(wxWindow
, wxWindowBase
, wxWindowList
, wxWindowListNode
, class WXDLLEXPORT
);
111 // ----------------------------------------------------------------------------
113 // ----------------------------------------------------------------------------
115 extern WXDLLEXPORT_DATA(wxWindowList
) wxTopLevelWindows
;
117 // ----------------------------------------------------------------------------
118 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
119 // interface of this class.
121 // Event handler: windows have themselves as their event handlers by default,
122 // but their event handlers could be set to another object entirely. This
123 // separation can reduce the amount of derivation required, and allow
124 // alteration of a window's functionality (e.g. by a resource editor that
125 // temporarily switches event handlers).
126 // ----------------------------------------------------------------------------
128 class WXDLLEXPORT wxWindowBase
: public wxEvtHandler
131 // creating the window
132 // -------------------
134 // default ctor, initializes everything which can be initialized before
138 // pseudo ctor (can't be virtual, called from ctor)
139 bool CreateBase(wxWindowBase
*parent
,
141 const wxPoint
& pos
= wxDefaultPosition
,
142 const wxSize
& size
= wxDefaultSize
,
144 const wxValidator
& validator
= wxDefaultValidator
,
145 const wxString
& name
= wxPanelNameStr
);
147 virtual ~wxWindowBase();
149 // deleting the window
150 // -------------------
152 // ask the window to close itself, return true if the event handler
153 // honoured our request
154 bool Close( bool force
= false );
156 // the following functions delete the C++ objects (the window itself
157 // or its children) as well as the GUI windows and normally should
158 // never be used directly
160 // delete window unconditionally (dangerous!), returns true if ok
161 virtual bool Destroy();
162 // delete all children of this window, returns true if ok
163 bool DestroyChildren();
165 // is the window being deleted?
166 bool IsBeingDeleted() const { return m_isBeingDeleted
; }
172 // FIXME: This is work in progress about moving SetTitle/GetTitle from wxWindow
173 // to wxTopLevelWindow so initially enabled in wxMSW only to observe results
174 // and continue on other platforms
176 virtual void SetTitle( const wxString
& WXUNUSED(title
) ) {}
177 virtual wxString
GetTitle() const { return wxEmptyString
; }
179 // label is just the same as the title (but for, e.g., buttons it
180 // makes more sense to speak about labels)
181 virtual void SetLabel(const wxString
& label
) { SetTitle(label
); }
182 virtual wxString
GetLabel() const { return GetTitle(); }
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
) = 0;
187 virtual wxString
GetLabel() const = 0;
190 // the window name is used for ressource setting in X, it is not the
191 // same as the window title/label
192 virtual void SetName( const wxString
&name
) { m_windowName
= name
; }
193 virtual wxString
GetName() const { return m_windowName
; }
195 // sets the window variant, calls internally DoSetVariant if variant has changed
196 void SetWindowVariant( wxWindowVariant variant
) ;
197 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
200 // window id uniquely identifies the window among its siblings unless
201 // it is wxID_ANY which means "don't care"
202 void SetId( wxWindowID winid
) { m_windowId
= winid
; }
203 wxWindowID
GetId() const { return m_windowId
; }
205 // generate a control id for the controls which were not given one by
207 static int NewControlId() { return --ms_lastControlId
; }
208 // get the id of the control following the one with the given
209 // (autogenerated) id
210 static int NextControlId(int winid
) { return winid
- 1; }
211 // get the id of the control preceding the one with the given
212 // (autogenerated) id
213 static int PrevControlId(int winid
) { return winid
+ 1; }
218 // set the window size and/or position
219 void SetSize( int x
, int y
, int width
, int height
,
220 int sizeFlags
= wxSIZE_AUTO
)
221 { DoSetSize(x
, y
, width
, height
, sizeFlags
); }
223 void SetSize( int width
, int height
)
224 { DoSetSize( wxDefaultCoord
, wxDefaultCoord
, width
, height
, wxSIZE_USE_EXISTING
); }
226 void SetSize( const wxSize
& size
)
227 { SetSize( size
.x
, size
.y
); }
229 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
230 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
232 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
233 { DoSetSize(x
, y
, wxDefaultCoord
, wxDefaultCoord
, flags
); }
235 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
236 { Move(pt
.x
, pt
.y
, flags
); }
239 virtual void Raise() = 0;
240 virtual void Lower() = 0;
242 // client size is the size of area available for subwindows
243 void SetClientSize( int width
, int height
)
244 { DoSetClientSize(width
, height
); }
246 void SetClientSize( const wxSize
& size
)
247 { DoSetClientSize(size
.x
, size
.y
); }
249 void SetClientSize(const wxRect
& rect
)
250 { SetClientSize( rect
.width
, rect
.height
); }
252 // get the window position and/or size (pointers may be NULL)
253 void GetPosition( int *x
, int *y
) const { DoGetPosition(x
, y
); }
254 wxPoint
GetPosition() const
257 DoGetPosition(&w
, &h
);
259 return wxPoint(w
, h
);
262 void SetPosition( const wxPoint
& pt
) { Move( pt
) ; }
264 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
265 wxSize
GetSize() const
272 wxRect
GetRect() const
275 GetPosition(& x
, & y
);
278 return wxRect(x
, y
, w
, h
);
281 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
282 wxSize
GetClientSize() const
285 DoGetClientSize(& w
, & h
);
290 // get the origin of the client area of the window relative to the
291 // window top left corner (the client area may be shifted because of
292 // the borders, scrollbars, other decorations...)
293 virtual wxPoint
GetClientAreaOrigin() const;
295 // get the client rectangle in window (i.e. client) coordinates
296 wxRect
GetClientRect() const
298 return wxRect(GetClientAreaOrigin(), GetClientSize());
301 // get the size best suited for the window (in fact, minimal
302 // acceptable size using which it will still look "nice" in
304 wxSize
GetBestSize() const
306 if (m_bestSizeCache
.IsFullySpecified())
307 return m_bestSizeCache
;
308 return DoGetBestSize();
310 void GetBestSize(int *w
, int *h
) const
312 wxSize s
= GetBestSize();
319 // reset the cached best size value so it will be recalculated the
320 // next time it is needed.
321 void InvalidateBestSize();
322 void CacheBestSize(const wxSize
& size
) const
323 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
325 // There are times (and windows) where 'Best' size and 'Min' size
326 // are vastly out of sync. This should be remedied somehow, but in
327 // the meantime, this method will return the larger of BestSize
328 // (the window's smallest legible size), and any user specified
330 wxSize
GetAdjustedBestSize() const
332 wxSize
s( GetBestSize() );
333 return wxSize( wxMax( s
.x
, GetMinWidth() ), wxMax( s
.y
, GetMinHeight() ) );
336 // This function will merge the window's best size into the window's
337 // minimum size, giving priority to the min size components, and
338 // returns the results.
339 wxSize
GetBestFittingSize() const;
341 // A 'Smart' SetSize that will fill in default size values with 'best'
342 // size. Sets the minsize to what was passed in.
343 void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
);
345 // the generic centre function - centers the window on parent by`
346 // default or on screen if it doesn't have parent or
347 // wxCENTER_ON_SCREEN flag is given
348 void Centre( int direction
= wxBOTH
);
349 void Center( int direction
= wxBOTH
) { Centre(direction
); }
351 // centre on screen (only works for top level windows)
352 void CentreOnScreen(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_ON_SCREEN
); }
353 void CenterOnScreen(int dir
= wxBOTH
) { CentreOnScreen(dir
); }
355 // centre with respect to the the parent window
356 void CentreOnParent(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_FRAME
); }
357 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
359 // set window size to wrap around its children
362 // set virtual size to satisfy children
363 virtual void FitInside();
365 // set min/max size of the window
366 virtual void SetSizeHints( int minW
, int minH
,
367 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
368 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
)
370 DoSetSizeHints(minW
, minH
, maxW
, maxH
, incW
, incH
);
373 void SetSizeHints( const wxSize
& minSize
,
374 const wxSize
& maxSize
=wxDefaultSize
,
375 const wxSize
& incSize
=wxDefaultSize
)
377 DoSetSizeHints(minSize
.x
, minSize
.y
,
378 maxSize
.x
, maxSize
.y
,
379 incSize
.x
, incSize
.y
);
382 virtual void DoSetSizeHints(int minW
, int minH
,
383 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
384 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
);
386 virtual void SetVirtualSizeHints( int minW
, int minH
,
387 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
);
388 void SetVirtualSizeHints( const wxSize
& minSize
,
389 const wxSize
& maxSize
=wxDefaultSize
)
391 SetVirtualSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
);
394 virtual int GetMinWidth() const { return m_minWidth
; }
395 virtual int GetMinHeight() const { return m_minHeight
; }
396 int GetMaxWidth() const { return m_maxWidth
; }
397 int GetMaxHeight() const { return m_maxHeight
; }
399 // Override this method to control the values given to Sizers etc.
400 virtual wxSize
GetMaxSize() const { return wxSize( m_maxWidth
, m_maxHeight
); }
401 virtual wxSize
GetMinSize() const { return wxSize( m_minWidth
, m_minHeight
); }
403 void SetMinSize(const wxSize
& minSize
) { SetSizeHints(minSize
); }
404 void SetMaxSize(const wxSize
& maxSize
) { SetSizeHints(GetMinSize(), maxSize
); }
406 // Methods for accessing the virtual size of a window. For most
407 // windows this is just the client area of the window, but for
408 // some like scrolled windows it is more or less independent of
409 // the screen window size. You may override the DoXXXVirtual
410 // methods below for classes where that is is the case.
412 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
413 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
415 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
416 void GetVirtualSize( int *x
, int *y
) const
418 wxSize
s( DoGetVirtualSize() );
426 // Override these methods for windows that have a virtual size
427 // independent of their client size. eg. the virtual area of a
430 virtual void DoSetVirtualSize( int x
, int y
);
431 virtual wxSize
DoGetVirtualSize() const;
433 // Return the largest of ClientSize and BestSize (as determined
434 // by a sizer, interior children, or other means)
436 virtual wxSize
GetBestVirtualSize() const
438 wxSize
client( GetClientSize() );
439 wxSize
best( GetBestSize() );
441 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
447 // returns true if window was shown/hidden, false if the nothing was
448 // done (window was already shown/hidden)
449 virtual bool Show( bool show
= true );
450 bool Hide() { return Show(false); }
452 // returns true if window was enabled/disabled, false if nothing done
453 virtual bool Enable( bool enable
= true );
454 bool Disable() { return Enable(false); }
456 virtual bool IsShown() const { return m_isShown
; }
457 virtual bool IsEnabled() const { return m_isEnabled
; }
459 // get/set window style (setting style won't update the window and so
460 // is only useful for internal usage)
461 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
462 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
464 // just some (somewhat shorter) synonims
465 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
466 long GetWindowStyle() const { return GetWindowStyleFlag(); }
468 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
469 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
471 // extra style: the less often used style bits which can't be set with
472 // SetWindowStyleFlag()
473 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
474 long GetExtraStyle() const { return m_exStyle
; }
476 // make the window modal (all other windows unresponsive)
477 virtual void MakeModal(bool modal
= true);
480 // (primitive) theming support
481 // ---------------------------
483 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
484 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
487 // focus and keyboard handling
488 // ---------------------------
490 // set focus to this window
491 virtual void SetFocus() = 0;
493 // set focus to this window as the result of a keyboard action
494 virtual void SetFocusFromKbd() { SetFocus(); }
496 // return the window which currently has the focus or NULL
497 static wxWindow
*FindFocus();
499 static wxWindow
*DoFindFocus() /* = 0: implement in derived classes */;
501 // can this window have focus?
502 virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
504 // can this window be given focus by keyboard navigation? if not, the
505 // only way to give it focus (provided it accepts it at all) is to
507 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
509 // NB: these methods really don't belong here but with the current
510 // class hierarchy there is no other place for them :-(
512 // get the default child of this parent, i.e. the one which is
513 // activated by pressing <Enter>
514 virtual wxWindow
*GetDefaultItem() const { return NULL
; }
516 // set this child as default, return the old default
517 virtual wxWindow
*SetDefaultItem(wxWindow
* WXUNUSED(child
))
520 // set this child as temporary default
521 virtual void SetTmpDefaultItem(wxWindow
* WXUNUSED(win
)) { }
523 // navigates in the specified direction by sending a wxNavigationKeyEvent
524 virtual bool Navigate(int flags
= wxNavigationKeyEvent
::IsForward
);
526 // move this window just before/after the specified one in tab order
527 // (the other window must be our sibling!)
528 void MoveBeforeInTabOrder(wxWindow
*win
)
529 { DoMoveInTabOrder(win
, MoveBefore
); }
530 void MoveAfterInTabOrder(wxWindow
*win
)
531 { DoMoveInTabOrder(win
, MoveAfter
); }
534 // parent/children relations
535 // -------------------------
537 // get the list of children
538 const wxWindowList
& GetChildren() const { return m_children
; }
539 wxWindowList
& GetChildren() { return m_children
; }
541 // needed just for extended runtime
542 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
544 // get the parent or the parent of the parent
545 wxWindow
*GetParent() const { return m_parent
; }
546 inline wxWindow
*GetGrandParent() const;
548 // is this window a top level one?
549 virtual bool IsTopLevel() const;
551 // it doesn't really change parent, use Reparent() instead
552 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
553 // change the real parent of this window, return true if the parent
554 // was changed, false otherwise (error or newParent == oldParent)
555 virtual bool Reparent( wxWindowBase
*newParent
);
557 // implementation mostly
558 virtual void AddChild( wxWindowBase
*child
);
559 virtual void RemoveChild( wxWindowBase
*child
);
561 // looking for windows
562 // -------------------
564 // find window among the descendants of this one either by id or by
565 // name (return NULL if not found)
566 wxWindow
*FindWindow(long winid
) const;
567 wxWindow
*FindWindow(const wxString
& name
) const;
569 // Find a window among any window (all return NULL if not found)
570 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
571 static wxWindow
*FindWindowByName( const wxString
& name
,
572 const wxWindow
*parent
= NULL
);
573 static wxWindow
*FindWindowByLabel( const wxString
& label
,
574 const wxWindow
*parent
= NULL
);
576 // event handler stuff
577 // -------------------
579 // get the current event handler
580 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
582 // replace the event handler (allows to completely subclass the
584 void SetEventHandler( wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
586 // push/pop event handler: allows to chain a custom event handler to
587 // alreasy existing ones
588 void PushEventHandler( wxEvtHandler
*handler
);
589 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
591 // find the given handler in the event handler chain and remove (but
592 // not delete) it from the event handler chain, return true if it was
593 // found and false otherwise (this also results in an assert failure so
594 // this function should only be called when the handler is supposed to
596 bool RemoveEventHandler(wxEvtHandler
*handler
);
602 // a window may have an associated validator which is used to control
604 virtual void SetValidator( const wxValidator
&validator
);
605 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
606 #endif // wxUSE_VALIDATORS
609 // dialog oriented functions
610 // -------------------------
612 // validate the correctness of input, return true if ok
613 virtual bool Validate();
615 // transfer data between internal and GUI representations
616 virtual bool TransferDataToWindow();
617 virtual bool TransferDataFromWindow();
619 virtual void InitDialog();
624 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
625 { m_acceleratorTable
= accel
; }
626 wxAcceleratorTable
*GetAcceleratorTable()
627 { return &m_acceleratorTable
; }
629 #endif // wxUSE_ACCEL
632 // hot keys (system wide accelerators)
633 // -----------------------------------
635 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
636 virtual bool UnregisterHotKey(int hotkeyId
);
637 #endif // wxUSE_HOTKEY
640 // dialog units translations
641 // -------------------------
643 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
644 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
645 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
647 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
649 return wxSize(pt
.x
, pt
.y
);
652 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
654 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
656 return wxSize(pt
.x
, pt
.y
);
662 // move the mouse to the specified position
663 virtual void WarpPointer(int x
, int y
) = 0;
665 // start or end mouse capture, these functions maintain the stack of
666 // windows having captured the mouse and after calling ReleaseMouse()
667 // the mouse is not released but returns to the window which had had
668 // captured it previously (if any)
672 // get the window which currently captures the mouse or NULL
673 static wxWindow
*GetCapture();
675 // does this window have the capture?
676 virtual bool HasCapture() const
677 { return (wxWindow
*)this == GetCapture(); }
679 // painting the window
680 // -------------------
682 // mark the specified rectangle (or the whole window) as "dirty" so it
684 virtual void Refresh( bool eraseBackground
= true,
685 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
687 // a less awkward wrapper for Refresh
688 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true)
690 Refresh(eraseBackground
, &rect
);
693 // repaint all invalid areas of the window immediately
694 virtual void Update() { }
696 // clear the window background
697 virtual void ClearBackground();
699 // freeze the window: don't redraw it until it is thawed
700 virtual void Freeze() { }
702 // thaw the window: redraw it after it had been frozen
703 virtual void Thaw() { }
705 // adjust DC for drawing on this window
706 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
708 // the update region of the window contains the areas which must be
709 // repainted by the program
710 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
711 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
713 // get the update rectangleregion bounding box in client coords
714 wxRect
GetUpdateClientRect() const;
716 // these functions verify whether the given point/rectangle belongs to
717 // (or at least intersects with) the update region
718 bool IsExposed( int x
, int y
) const;
719 bool IsExposed( int x
, int y
, int w
, int h
) const;
721 bool IsExposed( const wxPoint
& pt
) const
722 { return IsExposed(pt
.x
, pt
.y
); }
723 bool IsExposed( const wxRect
& rect
) const
724 { return IsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
726 // colours, fonts and cursors
727 // --------------------------
729 // get the default attributes for the controls of this class: we
730 // provide a virtual function which can be used to query the default
731 // attributes of an existing control and a static function which can
732 // be used even when no existing object of the given class is
733 // available, but which won't return any styles specific to this
734 // particular control, of course (e.g. "Ok" button might have
735 // different -- bold for example -- font)
736 virtual wxVisualAttributes
GetDefaultAttributes() const
738 return GetClassDefaultAttributes(GetWindowVariant());
741 static wxVisualAttributes
742 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
744 // set/retrieve the window colours (system defaults are used by
745 // default): SetXXX() functions return true if colour was changed,
746 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
747 // value to prevent it from being inherited by our children
748 virtual bool SetBackgroundColour(const wxColour
& colour
);
749 void SetOwnBackgroundColour(const wxColour
& colour
)
751 if ( SetBackgroundColour(colour
) )
752 m_inheritBgCol
= false;
754 wxColour
GetBackgroundColour() const;
755 bool InheritsBackgroundColour() const
757 return m_inheritBgCol
;
759 bool UseBgCol() const
764 virtual bool SetForegroundColour(const wxColour
& colour
);
765 void SetOwnForegroundColour(const wxColour
& colour
)
767 if ( SetForegroundColour(colour
) )
768 m_inheritFgCol
= false;
770 wxColour
GetForegroundColour() const;
772 // Set/get the background style.
773 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
774 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) { m_backgroundStyle
= style
; return true; }
775 virtual wxBackgroundStyle
GetBackgroundStyle() const { return m_backgroundStyle
; }
777 // returns true if the control has "transparent" areas such as a
778 // wxStaticText and wxCheckBox and the background should be adapted
779 // from a parent window
780 virtual bool HasTransparentBackground() { return false; }
782 // set/retrieve the font for the window (SetFont() returns true if the
783 // font really changed)
784 virtual bool SetFont(const wxFont
& font
) = 0;
785 void SetOwnFont(const wxFont
& font
)
788 m_inheritFont
= false;
790 wxFont
GetFont() const;
792 // set/retrieve the cursor for this window (SetCursor() returns true
793 // if the cursor was really changed)
794 virtual bool SetCursor( const wxCursor
&cursor
);
795 const wxCursor
& GetCursor() const { return m_cursor
; }
798 // associate a caret with the window
799 void SetCaret(wxCaret
*caret
);
800 // get the current caret (may be NULL)
801 wxCaret
*GetCaret() const { return m_caret
; }
802 #endif // wxUSE_CARET
804 // get the (average) character size for the current font
805 virtual int GetCharHeight() const = 0;
806 virtual int GetCharWidth() const = 0;
808 // get the width/height/... of the text using current or specified
810 virtual void GetTextExtent(const wxString
& string
,
812 int *descent
= (int *) NULL
,
813 int *externalLeading
= (int *) NULL
,
814 const wxFont
*theFont
= (const wxFont
*) NULL
)
817 // client <-> screen coords
818 // ------------------------
820 // translate to/from screen/client coordinates (pointers may be NULL)
821 void ClientToScreen( int *x
, int *y
) const
822 { DoClientToScreen(x
, y
); }
823 void ScreenToClient( int *x
, int *y
) const
824 { DoScreenToClient(x
, y
); }
826 // wxPoint interface to do the same thing
827 wxPoint
ClientToScreen(const wxPoint
& pt
) const
829 int x
= pt
.x
, y
= pt
.y
;
830 DoClientToScreen(&x
, &y
);
832 return wxPoint(x
, y
);
835 wxPoint
ScreenToClient(const wxPoint
& pt
) const
837 int x
= pt
.x
, y
= pt
.y
;
838 DoScreenToClient(&x
, &y
);
840 return wxPoint(x
, y
);
843 // test where the given (in client coords) point lies
844 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
845 { return DoHitTest(x
, y
); }
847 wxHitTest
HitTest(const wxPoint
& pt
) const
848 { return DoHitTest(pt
.x
, pt
.y
); }
853 // get the window border style from the given flags: this is different from
854 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
855 // translate wxBORDER_DEFAULT to something reasonable
856 wxBorder
GetBorder(long flags
) const;
858 // get border for the flags of this window
859 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
861 // send wxUpdateUIEvents to this window, and children if recurse is true
862 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
864 // do the window-specific processing after processing the update event
865 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
868 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
869 { return DoPopupMenu(menu
, pos
.x
, pos
.y
); }
870 bool PopupMenu(wxMenu
*menu
, int x
, int y
)
871 { return DoPopupMenu(menu
, x
, y
); }
872 #endif // wxUSE_MENUS
877 // does the window have the scrollbar for this orientation?
878 bool HasScrollbar(int orient
) const
880 return (m_windowStyle
&
881 (orient
== wxHORIZONTAL ? wxHSCROLL
: wxVSCROLL
)) != 0;
884 // configure the window scrollbars
885 virtual void SetScrollbar( int orient
,
889 bool refresh
= true ) = 0;
890 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
891 virtual int GetScrollPos( int orient
) const = 0;
892 virtual int GetScrollThumb( int orient
) const = 0;
893 virtual int GetScrollRange( int orient
) const = 0;
895 // scroll window to the specified position
896 virtual void ScrollWindow( int dx
, int dy
,
897 const wxRect
* rect
= (wxRect
*) NULL
) = 0;
899 // scrolls window by line/page: note that not all controls support this
901 // return true if the position changed, false otherwise
902 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
903 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
905 // convenient wrappers for ScrollLines/Pages
906 bool LineUp() { return ScrollLines(-1); }
907 bool LineDown() { return ScrollLines(1); }
908 bool PageUp() { return ScrollPages(-1); }
909 bool PageDown() { return ScrollPages(1); }
911 // context-sensitive help
912 // ----------------------
914 // these are the convenience functions wrapping wxHelpProvider methods
917 // associate this help text with this window
918 void SetHelpText(const wxString
& text
);
919 // associate this help text with all windows with the same id as this
921 void SetHelpTextForId(const wxString
& text
);
922 // get the help string associated with this window (may be empty)
923 wxString
GetHelpText() const;
925 // silently ignore SetHelpText() calls
926 void SetHelpText(const wxString
& WXUNUSED(text
)) { }
927 void SetHelpTextForId(const wxString
& WXUNUSED(text
)) { }
934 // the easiest way to set a tooltip for a window is to use this method
935 void SetToolTip( const wxString
&tip
);
936 // attach a tooltip to the window
937 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
938 // get the associated tooltip or NULL if none
939 wxToolTip
* GetToolTip() const { return m_tooltip
; }
940 wxString
GetToolTipText() const ;
942 // make it much easier to compile apps in an environment
943 // that doesn't support tooltips, such as PocketPC
944 inline void SetToolTip( const wxString
& WXUNUSED(tip
) ) {}
945 #endif // wxUSE_TOOLTIPS
949 #if wxUSE_DRAG_AND_DROP
950 // set/retrieve the drop target associated with this window (may be
951 // NULL; it's owned by the window and will be deleted by it)
952 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
953 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
954 #endif // wxUSE_DRAG_AND_DROP
956 // constraints and sizers
957 // ----------------------
958 #if wxUSE_CONSTRAINTS
959 // set the constraints for this window or retrieve them (may be NULL)
960 void SetConstraints( wxLayoutConstraints
*constraints
);
961 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
963 // implementation only
964 void UnsetConstraints(wxLayoutConstraints
*c
);
965 wxWindowList
*GetConstraintsInvolvedIn() const
966 { return m_constraintsInvolvedIn
; }
967 void AddConstraintReference(wxWindowBase
*otherWin
);
968 void RemoveConstraintReference(wxWindowBase
*otherWin
);
969 void DeleteRelatedConstraints();
970 void ResetConstraints();
972 // these methods may be overriden for special layout algorithms
973 virtual void SetConstraintSizes(bool recurse
= true);
974 virtual bool LayoutPhase1(int *noChanges
);
975 virtual bool LayoutPhase2(int *noChanges
);
976 virtual bool DoPhase(int phase
);
978 // these methods are virtual but normally won't be overridden
979 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
980 virtual void MoveConstraint(int x
, int y
);
981 virtual void GetSizeConstraint(int *w
, int *h
) const ;
982 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
983 virtual void GetPositionConstraint(int *x
, int *y
) const ;
985 #endif // wxUSE_CONSTRAINTS
987 // when using constraints or sizers, it makes sense to update
988 // children positions automatically whenever the window is resized
989 // - this is done if autoLayout is on
990 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
991 bool GetAutoLayout() const { return m_autoLayout
; }
993 // lay out the window and its children
994 virtual bool Layout();
997 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
998 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
1000 wxSizer
*GetSizer() const { return m_windowSizer
; }
1002 // Track if this window is a member of a sizer
1003 void SetContainingSizer(wxSizer
* sizer
);
1004 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1007 // ----------------------
1008 #if wxUSE_ACCESSIBILITY
1009 // Override to create a specific accessible object.
1010 virtual wxAccessible
* CreateAccessible();
1012 // Sets the accessible object.
1013 void SetAccessible(wxAccessible
* accessible
) ;
1015 // Returns the accessible object.
1016 wxAccessible
* GetAccessible() { return m_accessible
; };
1018 // Returns the accessible object, creating if necessary.
1019 wxAccessible
* GetOrCreateAccessible() ;
1026 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1027 void OnInitDialog( wxInitDialogEvent
&event
);
1028 void OnMiddleClick( wxMouseEvent
& event
);
1030 void OnHelp(wxHelpEvent
& event
);
1031 #endif // wxUSE_HELP
1033 // virtual function for implementing internal idle
1035 virtual void OnInternalIdle() {}
1037 // call internal idle recursively
1038 // void ProcessInternalIdle() ;
1040 // get the handle of the window for the underlying window system: this
1041 // is only used for wxWin itself or for user code which wants to call
1042 // platform-specific APIs
1043 virtual WXWidget
GetHandle() const = 0;
1044 // associate the window with a new native handle
1045 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1046 // dissociate the current native handle from the window
1047 virtual void DissociateHandle() { }
1050 // Store the palette used by DCs in wxWindow so that the dcs can share
1051 // a palette. And we can respond to palette messages.
1052 wxPalette
GetPalette() const { return m_palette
; }
1054 // When palette is changed tell the DC to set the system palette to the
1056 void SetPalette(const wxPalette
& pal
);
1058 // return true if we have a specific palette
1059 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1061 // return the first parent window with a custom palette or NULL
1062 wxWindow
*GetAncestorWithCustomPalette() const;
1063 #endif // wxUSE_PALETTE
1065 // inherit the parents visual attributes if they had been explicitly set
1066 // by the user (i.e. we don't inherit default attributes) and if we don't
1067 // have our own explicitly set
1068 virtual void InheritAttributes();
1070 // returns false from here if this window doesn't want to inherit the
1071 // parents colours even if InheritAttributes() would normally do it
1073 // this just provides a simple way to customize InheritAttributes()
1074 // behaviour in the most common case
1075 virtual bool ShouldInheritColours() const { return false; }
1077 // Reserved for future use
1078 virtual void ReservedWindowFunc1() {}
1079 virtual void ReservedWindowFunc2() {}
1080 virtual void ReservedWindowFunc3() {}
1081 virtual void ReservedWindowFunc4() {}
1082 virtual void ReservedWindowFunc5() {}
1083 virtual void ReservedWindowFunc6() {}
1084 virtual void ReservedWindowFunc7() {}
1085 virtual void ReservedWindowFunc8() {}
1086 virtual void ReservedWindowFunc9() {}
1089 // event handling specific to wxWindow
1090 virtual bool TryValidator(wxEvent
& event
);
1091 virtual bool TryParent(wxEvent
& event
);
1093 // common part of MoveBefore/AfterInTabOrder()
1096 MoveBefore
, // insert before the given window
1097 MoveAfter
// insert after the given window
1099 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
1101 #if wxUSE_CONSTRAINTS
1102 // satisfy the constraints for the windows but don't set the window sizes
1103 void SatisfyConstraints();
1104 #endif // wxUSE_CONSTRAINTS
1106 // Send the wxWindowDestroyEvent
1107 void SendDestroyEvent();
1109 // returns the main window of composite control; this is the window
1110 // that FindFocus returns if the focus is in one of composite control's
1112 virtual wxWindow
*GetMainWindowOfCompositeControl()
1113 { return (wxWindow
*)this; }
1115 // the window id - a number which uniquely identifies a window among
1116 // its siblings unless it is wxID_ANY
1117 wxWindowID m_windowId
;
1119 // the parent window of this window (or NULL) and the list of the children
1122 wxWindowList m_children
;
1124 // the minimal allowed size for the window (no minimal size if variable(s)
1125 // contain(s) wxDefaultCoord)
1131 // event handler for this window: usually is just 'this' but may be
1132 // changed with SetEventHandler()
1133 wxEvtHandler
*m_eventHandler
;
1135 #if wxUSE_VALIDATORS
1136 // associated validator or NULL if none
1137 wxValidator
*m_windowValidator
;
1138 #endif // wxUSE_VALIDATORS
1140 #if wxUSE_DRAG_AND_DROP
1141 wxDropTarget
*m_dropTarget
;
1142 #endif // wxUSE_DRAG_AND_DROP
1144 // visual window attributes
1146 wxFont m_font
; // see m_hasFont
1147 wxColour m_backgroundColour
, // m_hasBgCol
1148 m_foregroundColour
; // m_hasFgCol
1152 #endif // wxUSE_CARET
1154 // the region which should be repainted in response to paint event
1155 wxRegion m_updateRegion
;
1158 // the accelerator table for the window which translates key strokes into
1160 wxAcceleratorTable m_acceleratorTable
;
1161 #endif // wxUSE_ACCEL
1163 // the tooltip for this window (may be NULL)
1165 wxToolTip
*m_tooltip
;
1166 #endif // wxUSE_TOOLTIPS
1168 // constraints and sizers
1169 #if wxUSE_CONSTRAINTS
1170 // the constraints for this window or NULL
1171 wxLayoutConstraints
*m_constraints
;
1173 // constraints this window is involved in
1174 wxWindowList
*m_constraintsInvolvedIn
;
1175 #endif // wxUSE_CONSTRAINTS
1177 // this window's sizer
1178 wxSizer
*m_windowSizer
;
1180 // The sizer this window is a member of, if any
1181 wxSizer
*m_containingSizer
;
1183 // Layout() window automatically when its size changes?
1184 bool m_autoLayout
:1;
1189 bool m_isBeingDeleted
:1;
1191 // was the window colours/font explicitly changed by user?
1196 // and should it be inherited by children?
1197 bool m_inheritBgCol
:1;
1198 bool m_inheritFgCol
:1;
1199 bool m_inheritFont
:1;
1201 // window attributes
1204 wxString m_windowName
;
1205 bool m_themeEnabled
;
1206 wxBackgroundStyle m_backgroundStyle
;
1208 wxPalette m_palette
;
1209 bool m_hasCustomPalette
;
1210 #endif // wxUSE_PALETTE
1212 #if wxUSE_ACCESSIBILITY
1213 wxAccessible
* m_accessible
;
1216 // Virtual size (scrolling)
1217 wxSize m_virtualSize
;
1219 int m_minVirtualWidth
; // VirtualSizeHints
1220 int m_minVirtualHeight
;
1221 int m_maxVirtualWidth
;
1222 int m_maxVirtualHeight
;
1224 wxWindowVariant m_windowVariant
;
1226 // override this to change the default (i.e. used when no style is
1227 // specified) border for the window class
1228 virtual wxBorder
GetDefaultBorder() const;
1230 // Get the default size for the new window if no explicit size given. TLWs
1231 // have their own default size so this is just for non top-level windows.
1232 static int WidthDefault(int w
) { return w
== wxDefaultCoord ?
20 : w
; }
1233 static int HeightDefault(int h
) { return h
== wxDefaultCoord ?
20 : h
; }
1236 // Used to save the results of DoGetBestSize so it doesn't need to be
1237 // recalculated each time the value is needed.
1238 wxSize m_bestSizeCache
;
1240 // keep the old name for compatibility, at least until all the internal
1241 // usages of it are changed to SetBestFittingSize
1242 void SetBestSize(const wxSize
& size
) { SetBestFittingSize(size
); }
1244 // set the initial window size if none is given (i.e. at least one of the
1245 // components of the size passed to ctor/Create() is wxDefaultCoord)
1247 // normally just calls SetBestSize() for controls, but can be overridden
1248 // not to do it for the controls which have to do some additional
1249 // initialization (e.g. add strings to list box) before their best size
1250 // can be accurately calculated
1251 virtual void SetInitialBestSize(const wxSize
& WXUNUSED(size
)) {}
1255 // more pure virtual functions
1256 // ---------------------------
1258 // NB: we must have DoSomething() function when Something() is an overloaded
1259 // method: indeed, we can't just have "virtual Something()" in case when
1260 // the function is overloaded because then we'd have to make virtual all
1261 // the variants (otherwise only the virtual function may be called on a
1262 // pointer to derived class according to C++ rules) which is, in
1263 // general, absolutely not needed. So instead we implement all
1264 // overloaded Something()s in terms of DoSomething() which will be the
1265 // only one to be virtual.
1267 // coordinates translation
1268 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1269 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1271 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1273 // capture/release the mouse, used by Capture/ReleaseMouse()
1274 virtual void DoCaptureMouse() = 0;
1275 virtual void DoReleaseMouse() = 0;
1277 // retrieve the position/size of the window
1278 virtual void DoGetPosition( int *x
, int *y
) const = 0;
1279 virtual void DoGetSize( int *width
, int *height
) const = 0;
1280 virtual void DoGetClientSize( int *width
, int *height
) const = 0;
1282 // get the size which best suits the window: for a control, it would be
1283 // the minimal size which doesn't truncate the control, for a panel - the
1284 // same size as it would have after a call to Fit()
1285 virtual wxSize
DoGetBestSize() const;
1287 // called from DoGetBestSize() to convert best virtual size (returned by
1288 // the window sizer) to the best size for the window itself; this is
1289 // overridden at wxScrolledWindow level to clump down virtual size to real
1290 virtual wxSize
GetWindowSizeForVirtualSize(const wxSize
& size
) const
1295 // this is the virtual function to be overriden in any derived class which
1296 // wants to change how SetSize() or Move() works - it is called by all
1297 // versions of these functions in the base class
1298 virtual void DoSetSize(int x
, int y
,
1299 int width
, int height
,
1300 int sizeFlags
= wxSIZE_AUTO
) = 0;
1302 // same as DoSetSize() for the client size
1303 virtual void DoSetClientSize(int width
, int height
) = 0;
1305 // move the window to the specified location and resize it: this is called
1306 // from both DoSetSize() and DoSetClientSize() and would usually just
1307 // reposition this window except for composite controls which will want to
1308 // arrange themselves inside the given rectangle
1309 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1312 virtual void DoSetToolTip( wxToolTip
*tip
);
1313 #endif // wxUSE_TOOLTIPS
1316 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1317 #endif // wxUSE_MENUS
1319 // Makes an adjustment to the window position to make it relative to the
1320 // parents client area, e.g. if the parent is a frame with a toolbar, its
1321 // (0, 0) is just below the toolbar
1322 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1323 int sizeFlags
= 0) const;
1325 // implements the window variants
1326 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1328 // Reserved for future use
1329 void* m_windowReserved
;
1332 // contains the last id generated by NewControlId
1333 static int ms_lastControlId
;
1335 // the stack of windows which have captured the mouse
1336 static struct WXDLLEXPORT wxWindowNext
*ms_winCaptureNext
;
1338 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1339 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1340 DECLARE_EVENT_TABLE()
1343 // ----------------------------------------------------------------------------
1344 // now include the declaration of wxWindow class
1345 // ----------------------------------------------------------------------------
1347 // include the declaration of the platform-specific class
1348 #if defined(__WXPALMOS__)
1349 #ifdef __WXUNIVERSAL__
1350 #define wxWindowNative wxWindowPalm
1352 #define wxWindowPalm wxWindow
1353 #endif // wxUniv/!wxUniv
1354 #include "wx/palmos/window.h"
1355 #elif defined(__WXMSW__)
1356 #ifdef __WXUNIVERSAL__
1357 #define wxWindowNative wxWindowMSW
1359 #define wxWindowMSW wxWindow
1360 #endif // wxUniv/!wxUniv
1361 #include "wx/msw/window.h"
1362 #elif defined(__WXMOTIF__)
1363 #include "wx/motif/window.h"
1364 #elif defined(__WXGTK__)
1365 #ifdef __WXUNIVERSAL__
1366 #define wxWindowNative wxWindowGTK
1368 #define wxWindowGTK wxWindow
1370 #include "wx/gtk/window.h"
1371 #elif defined(__WXX11__)
1372 #ifdef __WXUNIVERSAL__
1373 #define wxWindowNative wxWindowX11
1375 #define wxWindowX11 wxWindow
1377 #include "wx/x11/window.h"
1378 #elif defined(__WXMGL__)
1379 #ifdef __WXUNIVERSAL__
1380 #define wxWindowNative wxWindowMGL
1382 #define wxWindowMGL wxWindow
1384 #include "wx/mgl/window.h"
1385 #elif defined(__WXMAC__)
1386 #ifdef __WXUNIVERSAL__
1387 #define wxWindowNative wxWindowMac
1389 #define wxWindowMac wxWindow
1391 #include "wx/mac/window.h"
1392 #elif defined(__WXCOCOA__)
1393 #ifdef __WXUNIVERSAL__
1394 #define wxWindowNative wxWindowCocoa
1396 #define wxWindowCocoa wxWindow
1398 #include "wx/cocoa/window.h"
1399 #elif defined(__WXPM__)
1400 #ifdef __WXUNIVERSAL__
1401 #define wxWindowNative wxWindowOS2
1403 #define wxWindowOS2 wxWindow
1404 #endif // wxUniv/!wxUniv
1405 #include "wx/os2/window.h"
1408 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1409 // for the native ports we already have defined it above
1410 #if defined(__WXUNIVERSAL__)
1411 #ifndef wxWindowNative
1412 #error "wxWindowNative must be defined above!"
1415 #include "wx/univ/window.h"
1418 // ----------------------------------------------------------------------------
1419 // inline functions which couldn't be declared in the class body because of
1420 // forward dependencies
1421 // ----------------------------------------------------------------------------
1423 inline wxWindow
*wxWindowBase
::GetGrandParent() const
1425 return m_parent ? m_parent
->GetParent() : (wxWindow
*)NULL
;
1428 // ----------------------------------------------------------------------------
1430 // ----------------------------------------------------------------------------
1432 // Find the wxWindow at the current mouse position, also returning the mouse
1434 extern WXDLLEXPORT wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1436 // Get the current mouse position.
1437 extern WXDLLEXPORT wxPoint
wxGetMousePosition();
1439 // get the currently active window of this application or NULL
1440 extern WXDLLEXPORT wxWindow
*wxGetActiveWindow();
1442 // get the (first) top level parent window
1443 WXDLLEXPORT wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1445 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1446 inline int NewControlId() { return wxWindowBase
::NewControlId(); }
1448 #if wxUSE_ACCESSIBILITY
1449 // ----------------------------------------------------------------------------
1450 // accessible object for windows
1451 // ----------------------------------------------------------------------------
1453 class WXDLLEXPORT wxWindowAccessible
: public wxAccessible
1456 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1457 virtual ~wxWindowAccessible() {}
1461 // Can return either a child object, or an integer
1462 // representing the child element, starting from 1.
1463 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1465 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1466 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1468 // Navigates from fromId to toId/toObject.
1469 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1470 int* toId
, wxAccessible
** toObject
);
1472 // Gets the name of the specified object.
1473 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1475 // Gets the number of children.
1476 virtual wxAccStatus
GetChildCount(int* childCount
);
1478 // Gets the specified child (starting from 1).
1479 // If *child is NULL and return value is wxACC_OK,
1480 // this means that the child is a simple element and
1481 // not an accessible object.
1482 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1484 // Gets the parent, or NULL.
1485 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1487 // Performs the default action. childId is 0 (the action for this object)
1488 // or > 0 (the action for a child).
1489 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1490 // window (e.g. an edit control).
1491 virtual wxAccStatus
DoDefaultAction(int childId
);
1493 // Gets the default action for this object (0) or > 0 (the action for a child).
1494 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1495 // string if there is no action.
1496 // The retrieved string describes the action that is performed on an object,
1497 // not what the object does as a result. For example, a toolbar button that prints
1498 // a document has a default action of "Press" rather than "Prints the current document."
1499 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1501 // Returns the description for this object or a child.
1502 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1504 // Returns help text for this object or a child, similar to tooltip text.
1505 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1507 // Returns the keyboard shortcut for this object or child.
1508 // Return e.g. ALT+K
1509 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1511 // Returns a role constant.
1512 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1514 // Returns a state constant.
1515 virtual wxAccStatus
GetState(int childId
, long* state
);
1517 // Returns a localized string representing the value for the object
1519 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1521 // Selects the object or child.
1522 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1524 // Gets the window with the keyboard focus.
1525 // If childId is 0 and child is NULL, no object in
1526 // this subhierarchy has the focus.
1527 // If this object has the focus, child should be 'this'.
1528 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1530 // Gets a variant representing the selected children
1532 // Acceptable values:
1533 // - a null variant (IsNull() returns true)
1534 // - a list variant (GetType() == wxT("list")
1535 // - an integer representing the selected child element,
1536 // or 0 if this object is selected (GetType() == wxT("long")
1537 // - a "void*" pointer to a wxAccessible child object
1538 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1541 #endif // wxUSE_ACCESSIBILITY
1544 #endif // _WX_WINDOW_H_BASE_