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 // ----------------------------------------------------------------------------
106 // (pseudo)template list classes
107 // ----------------------------------------------------------------------------
109 WX_DECLARE_LIST_3(wxWindow
, wxWindowBase
, wxWindowList
, wxWindowListNode
, class WXDLLEXPORT
);
111 // ----------------------------------------------------------------------------
113 // ----------------------------------------------------------------------------
115 WXDLLEXPORT_DATA(extern 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
; }
171 // NB: in future versions of wxWidgets Set/GetTitle() will only work
172 // with the top level windows (such as dialogs and frames) and
173 // Set/GetLabel() only with the other ones (i.e. all controls).
175 // the title (or label, see below) of the window: the text which the
177 virtual void SetTitle( const wxString
& WXUNUSED(title
) ) {}
178 virtual wxString
GetTitle() const { return wxEmptyString
; }
180 // label is just the same as the title (but for, e.g., buttons it
181 // makes more sense to speak about labels)
182 virtual void SetLabel(const wxString
& label
) { SetTitle(label
); }
183 virtual wxString
GetLabel() const { return GetTitle(); }
185 // the window name is used for ressource setting in X, it is not the
186 // same as the window title/label
187 virtual void SetName( const wxString
&name
) { m_windowName
= name
; }
188 virtual wxString
GetName() const { return m_windowName
; }
190 // sets the window variant, calls internally DoSetVariant if variant has changed
191 void SetWindowVariant( wxWindowVariant variant
) ;
192 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
195 // window id uniquely identifies the window among its siblings unless
196 // it is -1 which means "don't care"
197 void SetId( wxWindowID winid
) { m_windowId
= winid
; }
198 wxWindowID
GetId() const { return m_windowId
; }
200 // generate a control id for the controls which were not given one by
202 static int NewControlId() { return --ms_lastControlId
; }
203 // get the id of the control following the one with the given
204 // (autogenerated) id
205 static int NextControlId(int winid
) { return winid
- 1; }
206 // get the id of the control preceding the one with the given
207 // (autogenerated) id
208 static int PrevControlId(int winid
) { return winid
+ 1; }
213 // set the window size and/or position
214 void SetSize( int x
, int y
, int width
, int height
,
215 int sizeFlags
= wxSIZE_AUTO
)
216 { DoSetSize(x
, y
, width
, height
, sizeFlags
); }
218 void SetSize( int width
, int height
)
219 { DoSetSize( -1, -1, width
, height
, wxSIZE_USE_EXISTING
); }
221 void SetSize( const wxSize
& size
)
222 { SetSize( size
.x
, size
.y
); }
224 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
225 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
227 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
228 { DoSetSize(x
, y
, -1, -1, flags
); }
230 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
231 { Move(pt
.x
, pt
.y
, flags
); }
234 virtual void Raise() = 0;
235 virtual void Lower() = 0;
237 // client size is the size of area available for subwindows
238 void SetClientSize( int width
, int height
)
239 { DoSetClientSize(width
, height
); }
241 void SetClientSize( const wxSize
& size
)
242 { DoSetClientSize(size
.x
, size
.y
); }
244 void SetClientSize(const wxRect
& rect
)
245 { SetClientSize( rect
.width
, rect
.height
); }
247 // get the window position and/or size (pointers may be NULL)
248 void GetPosition( int *x
, int *y
) const { DoGetPosition(x
, y
); }
249 wxPoint
GetPosition() const
252 DoGetPosition(&w
, &h
);
254 return wxPoint(w
, h
);
257 void SetPosition( const wxPoint
& pt
) { Move( pt
) ; }
259 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
260 wxSize
GetSize() const
267 wxRect
GetRect() const
270 GetPosition(& x
, & y
);
273 return wxRect(x
, y
, w
, h
);
276 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
277 wxSize
GetClientSize() const
280 DoGetClientSize(& w
, & h
);
285 // get the origin of the client area of the window relative to the
286 // window top left corner (the client area may be shifted because of
287 // the borders, scrollbars, other decorations...)
288 virtual wxPoint
GetClientAreaOrigin() const;
290 // get the client rectangle in window (i.e. client) coordinates
291 wxRect
GetClientRect() const
293 return wxRect(GetClientAreaOrigin(), GetClientSize());
296 // get the size best suited for the window (in fact, minimal
297 // acceptable size using which it will still look "nice" in
299 wxSize
GetBestSize() const
301 if (m_bestSizeCache
.IsFullySpecified())
302 return m_bestSizeCache
;
303 return DoGetBestSize();
305 void GetBestSize(int *w
, int *h
) const
307 wxSize s
= GetBestSize();
314 // reset the cached best size value so it will be recalculated the
315 // next time it is needed.
316 void InvalidateBestSize() { m_bestSizeCache
= wxDefaultSize
; }
317 void CacheBestSize(const wxSize
& size
) const
318 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
320 // There are times (and windows) where 'Best' size and 'Min' size
321 // are vastly out of sync. This should be remedied somehow, but in
322 // the meantime, this method will return the larger of BestSize
323 // (the window's smallest legible size), and any user specified
325 wxSize
GetAdjustedBestSize() const
327 wxSize
s( GetBestSize() );
328 return wxSize( wxMax( s
.x
, GetMinWidth() ), wxMax( s
.y
, GetMinHeight() ) );
331 // This function will merge the window's best size into the window's
332 // minimum size, giving priority to the min size components, and
333 // returns the results.
334 wxSize
GetBestFittingSize() const;
336 // A 'Smart' SetSize that will fill in default size values with 'best'
337 // size. Sets the minsize to what was passed in.
338 void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
);
340 // the generic centre function - centers the window on parent by`
341 // default or on screen if it doesn't have parent or
342 // wxCENTER_ON_SCREEN flag is given
343 void Centre( int direction
= wxBOTH
);
344 void Center( int direction
= wxBOTH
) { Centre(direction
); }
346 // centre on screen (only works for top level windows)
347 void CentreOnScreen(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_ON_SCREEN
); }
348 void CenterOnScreen(int dir
= wxBOTH
) { CentreOnScreen(dir
); }
350 // centre with respect to the the parent window
351 void CentreOnParent(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_FRAME
); }
352 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
354 // set window size to wrap around its children
357 // set virtual size to satisfy children
358 virtual void FitInside();
360 // set min/max size of the window
361 virtual void SetSizeHints( int minW
, int minH
,
362 int maxW
= -1, int maxH
= -1,
363 int incW
= -1, int incH
= -1 );
364 void SetSizeHints( const wxSize
& minSize
,
365 const wxSize
& maxSize
=wxDefaultSize
,
366 const wxSize
& incSize
=wxDefaultSize
)
368 SetSizeHints(minSize
.x
, minSize
.y
,
369 maxSize
.x
, maxSize
.y
,
370 incSize
.x
, incSize
.y
);
373 virtual void SetVirtualSizeHints( int minW
, int minH
,
374 int maxW
= -1, int maxH
= -1 );
375 void SetVirtualSizeHints( const wxSize
& minSize
,
376 const wxSize
& maxSize
=wxDefaultSize
)
378 SetVirtualSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
);
381 virtual int GetMinWidth() const { return m_minWidth
; }
382 virtual int GetMinHeight() const { return m_minHeight
; }
383 int GetMaxWidth() const { return m_maxWidth
; }
384 int GetMaxHeight() const { return m_maxHeight
; }
386 // Override this method to control the values given to Sizers etc.
387 virtual wxSize
GetMaxSize() const { return wxSize( m_maxWidth
, m_maxHeight
); }
388 virtual wxSize
GetMinSize() const { return wxSize( m_minWidth
, m_minHeight
); }
390 void SetMinSize(const wxSize
& minSize
) { SetSizeHints(minSize
); }
391 void SetMaxSize(const wxSize
& maxSize
) { SetSizeHints(GetMinSize(), maxSize
); }
393 // Methods for accessing the virtual size of a window. For most
394 // windows this is just the client area of the window, but for
395 // some like scrolled windows it is more or less independent of
396 // the screen window size. You may override the DoXXXVirtual
397 // methods below for classes where that is is the case.
399 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
400 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
402 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
403 void GetVirtualSize( int *x
, int *y
) const
405 wxSize
s( DoGetVirtualSize() );
413 // Override these methods for windows that have a virtual size
414 // independent of their client size. eg. the virtual area of a
415 // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
417 virtual void DoSetVirtualSize( int x
, int y
);
418 virtual wxSize
DoGetVirtualSize() const; // { return m_virtualSize; }
420 // Return the largest of ClientSize and BestSize (as determined
421 // by a sizer, interior children, or other means)
423 virtual wxSize
GetBestVirtualSize() const
425 wxSize
client( GetClientSize() );
426 wxSize
best( GetBestSize() );
428 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
434 // returns true if window was shown/hidden, false if the nothing was
435 // done (window was already shown/hidden)
436 virtual bool Show( bool show
= true );
437 bool Hide() { return Show(false); }
439 // returns true if window was enabled/disabled, false if nothing done
440 virtual bool Enable( bool enable
= true );
441 bool Disable() { return Enable(false); }
443 bool IsShown() const { return m_isShown
; }
444 bool IsEnabled() const { return m_isEnabled
; }
446 // get/set window style (setting style won't update the window and so
447 // is only useful for internal usage)
448 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
449 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
451 // just some (somewhat shorter) synonims
452 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
453 long GetWindowStyle() const { return GetWindowStyleFlag(); }
455 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
456 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
458 // extra style: the less often used style bits which can't be set with
459 // SetWindowStyleFlag()
460 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
461 long GetExtraStyle() const { return m_exStyle
; }
463 // make the window modal (all other windows unresponsive)
464 virtual void MakeModal(bool modal
= true);
467 // (primitive) theming support
468 // ---------------------------
470 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
471 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
473 // Returns true if this class should have the background colour
474 // changed to match the parent window's theme. For example when a
475 // page is added to a notebook it and it's children may need to have
476 // the colours adjusted depending on the current theme settings, but
477 // not all windows/controls can do this without looking wrong.
478 virtual void ApplyParentThemeBackground(const wxColour
& WXUNUSED(bg
))
482 // focus and keyboard handling
483 // ---------------------------
485 // set focus to this window
486 virtual void SetFocus() = 0;
488 // set focus to this window as the result of a keyboard action
489 virtual void SetFocusFromKbd() { SetFocus(); }
491 // return the window which currently has the focus or NULL
492 static wxWindow
*FindFocus() /* = 0: implement in derived classes */;
494 // can this window have focus?
495 virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
497 // can this window be given focus by keyboard navigation? if not, the
498 // only way to give it focus (provided it accepts it at all) is to
500 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
502 // NB: these methods really don't belong here but with the current
503 // class hierarchy there is no other place for them :-(
505 // get the default child of this parent, i.e. the one which is
506 // activated by pressing <Enter>
507 virtual wxWindow
*GetDefaultItem() const { return NULL
; }
509 // set this child as default, return the old default
510 virtual wxWindow
*SetDefaultItem(wxWindow
* WXUNUSED(child
))
513 // set this child as temporary default
514 virtual void SetTmpDefaultItem(wxWindow
* WXUNUSED(win
)) { }
516 // Navigates in the specified direction by sending a wxNavigationKeyEvent
517 virtual bool Navigate(int flags
= wxNavigationKeyEvent::IsForward
);
519 // parent/children relations
520 // -------------------------
522 // get the list of children
523 const wxWindowList
& GetChildren() const { return m_children
; }
524 wxWindowList
& GetChildren() { return m_children
; }
526 // needed just for extended runtime
527 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
529 // get the parent or the parent of the parent
530 wxWindow
*GetParent() const { return m_parent
; }
531 inline wxWindow
*GetGrandParent() const;
533 // is this window a top level one?
534 virtual bool IsTopLevel() const;
536 // it doesn't really change parent, use ReParent() instead
537 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
538 // change the real parent of this window, return true if the parent
539 // was changed, false otherwise (error or newParent == oldParent)
540 virtual bool Reparent( wxWindowBase
*newParent
);
542 // implementation mostly
543 virtual void AddChild( wxWindowBase
*child
);
544 virtual void RemoveChild( wxWindowBase
*child
);
546 // looking for windows
547 // -------------------
549 // find window among the descendants of this one either by id or by
550 // name (return NULL if not found)
551 wxWindow
*FindWindow( long winid
);
552 wxWindow
*FindWindow( const wxString
& name
);
554 // Find a window among any window (all return NULL if not found)
555 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
556 static wxWindow
*FindWindowByName( const wxString
& name
,
557 const wxWindow
*parent
= NULL
);
558 static wxWindow
*FindWindowByLabel( const wxString
& label
,
559 const wxWindow
*parent
= NULL
);
561 // event handler stuff
562 // -------------------
564 // get the current event handler
565 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
567 // replace the event handler (allows to completely subclass the
569 void SetEventHandler( wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
571 // push/pop event handler: allows to chain a custom event handler to
572 // alreasy existing ones
573 void PushEventHandler( wxEvtHandler
*handler
);
574 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
576 // find the given handler in the event handler chain and remove (but
577 // not delete) it from the event handler chain, return true if it was
578 // found and false otherwise (this also results in an assert failure so
579 // this function should only be called when the handler is supposed to
581 bool RemoveEventHandler(wxEvtHandler
*handler
);
587 // a window may have an associated validator which is used to control
589 virtual void SetValidator( const wxValidator
&validator
);
590 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
591 #endif // wxUSE_VALIDATORS
594 // dialog oriented functions
595 // -------------------------
597 // validate the correctness of input, return true if ok
598 virtual bool Validate();
600 // transfer data between internal and GUI representations
601 virtual bool TransferDataToWindow();
602 virtual bool TransferDataFromWindow();
604 virtual void InitDialog();
609 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
610 { m_acceleratorTable
= accel
; }
611 wxAcceleratorTable
*GetAcceleratorTable()
612 { return &m_acceleratorTable
; }
614 #endif // wxUSE_ACCEL
617 // hot keys (system wide accelerators)
618 // -----------------------------------
620 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
621 virtual bool UnregisterHotKey(int hotkeyId
);
622 #endif // wxUSE_HOTKEY
625 // dialog units translations
626 // -------------------------
628 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
629 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
630 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
632 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
634 return wxSize(pt
.x
, pt
.y
);
637 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
639 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
641 return wxSize(pt
.x
, pt
.y
);
647 // move the mouse to the specified position
648 virtual void WarpPointer(int x
, int y
) = 0;
650 // start or end mouse capture, these functions maintain the stack of
651 // windows having captured the mouse and after calling ReleaseMouse()
652 // the mouse is not released but returns to the window which had had
653 // captured it previously (if any)
657 // get the window which currently captures the mouse or NULL
658 static wxWindow
*GetCapture();
660 // does this window have the capture?
661 virtual bool HasCapture() const
662 { return (wxWindow
*)this == GetCapture(); }
664 // painting the window
665 // -------------------
667 // mark the specified rectangle (or the whole window) as "dirty" so it
669 virtual void Refresh( bool eraseBackground
= true,
670 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
672 // a less awkward wrapper for Refresh
673 void RefreshRect(const wxRect
& rect
) { Refresh(true, &rect
); }
675 // repaint all invalid areas of the window immediately
676 virtual void Update() { }
678 // clear the window background
679 virtual void ClearBackground();
681 // freeze the window: don't redraw it until it is thawed
682 virtual void Freeze() { }
684 // thaw the window: redraw it after it had been frozen
685 virtual void Thaw() { }
687 // adjust DC for drawing on this window
688 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
690 // the update region of the window contains the areas which must be
691 // repainted by the program
692 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
693 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
695 // get the update rectangleregion bounding box in client coords
696 wxRect
GetUpdateClientRect() const;
698 // these functions verify whether the given point/rectangle belongs to
699 // (or at least intersects with) the update region
700 bool IsExposed( int x
, int y
) const;
701 bool IsExposed( int x
, int y
, int w
, int h
) const;
703 bool IsExposed( const wxPoint
& pt
) const
704 { return IsExposed(pt
.x
, pt
.y
); }
705 bool IsExposed( const wxRect
& rect
) const
706 { return IsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
708 // colours, fonts and cursors
709 // --------------------------
711 // get the default attributes for the controls of this class: we
712 // provide a virtual function which can be used to query the default
713 // attributes of an existing control and a static function which can
714 // be used even when no existing object of the given class is
715 // available, but which won't return any styles specific to this
716 // particular control, of course (e.g. "Ok" button might have
717 // different -- bold for example -- font)
718 virtual wxVisualAttributes
GetDefaultAttributes() const
720 return GetClassDefaultAttributes(GetWindowVariant());
723 static wxVisualAttributes
724 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
726 // set/retrieve the window colours (system defaults are used by
727 // default): SetXXX() functions return true if colour was changed,
728 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
729 // value to prevent it from being inherited by our children
730 virtual bool SetBackgroundColour(const wxColour
& colour
);
731 void SetOwnBackgroundColour(const wxColour
& colour
)
733 if ( SetBackgroundColour(colour
) )
734 m_inheritBgCol
= false;
736 wxColour
GetBackgroundColour() const;
738 virtual bool SetForegroundColour(const wxColour
& colour
);
739 void SetOwnForegroundColour(const wxColour
& colour
)
741 if ( SetForegroundColour(colour
) )
742 m_inheritFgCol
= false;
744 wxColour
GetForegroundColour() const;
746 // set/retrieve the font for the window (SetFont() returns true if the
747 // font really changed)
748 virtual bool SetFont(const wxFont
& font
) = 0;
749 void SetOwnFont(const wxFont
& font
)
752 m_inheritFont
= false;
754 wxFont
GetFont() const;
756 // set/retrieve the cursor for this window (SetCursor() returns true
757 // if the cursor was really changed)
758 virtual bool SetCursor( const wxCursor
&cursor
);
759 const wxCursor
& GetCursor() const { return m_cursor
; }
762 // associate a caret with the window
763 void SetCaret(wxCaret
*caret
);
764 // get the current caret (may be NULL)
765 wxCaret
*GetCaret() const { return m_caret
; }
766 #endif // wxUSE_CARET
768 // get the (average) character size for the current font
769 virtual int GetCharHeight() const = 0;
770 virtual int GetCharWidth() const = 0;
772 // get the width/height/... of the text using current or specified
774 virtual void GetTextExtent(const wxString
& string
,
776 int *descent
= (int *) NULL
,
777 int *externalLeading
= (int *) NULL
,
778 const wxFont
*theFont
= (const wxFont
*) NULL
)
781 // client <-> screen coords
782 // ------------------------
784 // translate to/from screen/client coordinates (pointers may be NULL)
785 void ClientToScreen( int *x
, int *y
) const
786 { DoClientToScreen(x
, y
); }
787 void ScreenToClient( int *x
, int *y
) const
788 { DoScreenToClient(x
, y
); }
790 // wxPoint interface to do the same thing
791 wxPoint
ClientToScreen(const wxPoint
& pt
) const
793 int x
= pt
.x
, y
= pt
.y
;
794 DoClientToScreen(&x
, &y
);
796 return wxPoint(x
, y
);
799 wxPoint
ScreenToClient(const wxPoint
& pt
) const
801 int x
= pt
.x
, y
= pt
.y
;
802 DoScreenToClient(&x
, &y
);
804 return wxPoint(x
, y
);
807 // test where the given (in client coords) point lies
808 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
809 { return DoHitTest(x
, y
); }
811 wxHitTest
HitTest(const wxPoint
& pt
) const
812 { return DoHitTest(pt
.x
, pt
.y
); }
817 // get the window border style from the given flags: this is different from
818 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
819 // translate wxBORDER_DEFAULT to something reasonable
820 wxBorder
GetBorder(long flags
) const;
822 // get border for the flags of this window
823 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
825 // send wxUpdateUIEvents to this window, and children if recurse is true
826 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
828 // do the window-specific processing after processing the update event
829 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
832 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
833 { return DoPopupMenu(menu
, pos
.x
, pos
.y
); }
834 bool PopupMenu(wxMenu
*menu
, int x
, int y
)
835 { return DoPopupMenu(menu
, x
, y
); }
836 #endif // wxUSE_MENUS
841 // does the window have the scrollbar for this orientation?
842 bool HasScrollbar(int orient
) const
844 return (m_windowStyle
&
845 (orient
== wxHORIZONTAL
? wxHSCROLL
: wxVSCROLL
)) != 0;
848 // configure the window scrollbars
849 virtual void SetScrollbar( int orient
,
853 bool refresh
= true ) = 0;
854 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
855 virtual int GetScrollPos( int orient
) const = 0;
856 virtual int GetScrollThumb( int orient
) const = 0;
857 virtual int GetScrollRange( int orient
) const = 0;
859 // scroll window to the specified position
860 virtual void ScrollWindow( int dx
, int dy
,
861 const wxRect
* rect
= (wxRect
*) NULL
) = 0;
863 // scrolls window by line/page: note that not all controls support this
865 // return true if the position changed, false otherwise
866 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
867 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
869 // convenient wrappers for ScrollLines/Pages
870 bool LineUp() { return ScrollLines(-1); }
871 bool LineDown() { return ScrollLines(1); }
872 bool PageUp() { return ScrollPages(-1); }
873 bool PageDown() { return ScrollPages(1); }
875 // context-sensitive help
876 // ----------------------
878 // these are the convenience functions wrapping wxHelpProvider methods
881 // associate this help text with this window
882 void SetHelpText(const wxString
& text
);
883 // associate this help text with all windows with the same id as this
885 void SetHelpTextForId(const wxString
& text
);
886 // get the help string associated with this window (may be empty)
887 wxString
GetHelpText() const;
894 // the easiest way to set a tooltip for a window is to use this method
895 void SetToolTip( const wxString
&tip
);
896 // attach a tooltip to the window
897 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
898 // get the associated tooltip or NULL if none
899 wxToolTip
* GetToolTip() const { return m_tooltip
; }
900 wxString
GetToolTipText() const ;
901 #endif // wxUSE_TOOLTIPS
905 #if wxUSE_DRAG_AND_DROP
906 // set/retrieve the drop target associated with this window (may be
907 // NULL; it's owned by the window and will be deleted by it)
908 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
909 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
910 #endif // wxUSE_DRAG_AND_DROP
912 // constraints and sizers
913 // ----------------------
914 #if wxUSE_CONSTRAINTS
915 // set the constraints for this window or retrieve them (may be NULL)
916 void SetConstraints( wxLayoutConstraints
*constraints
);
917 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
919 // implementation only
920 void UnsetConstraints(wxLayoutConstraints
*c
);
921 wxWindowList
*GetConstraintsInvolvedIn() const
922 { return m_constraintsInvolvedIn
; }
923 void AddConstraintReference(wxWindowBase
*otherWin
);
924 void RemoveConstraintReference(wxWindowBase
*otherWin
);
925 void DeleteRelatedConstraints();
926 void ResetConstraints();
928 // these methods may be overriden for special layout algorithms
929 virtual void SetConstraintSizes(bool recurse
= true);
930 virtual bool LayoutPhase1(int *noChanges
);
931 virtual bool LayoutPhase2(int *noChanges
);
932 virtual bool DoPhase(int phase
);
934 // these methods are virtual but normally won't be overridden
935 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
936 virtual void MoveConstraint(int x
, int y
);
937 virtual void GetSizeConstraint(int *w
, int *h
) const ;
938 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
939 virtual void GetPositionConstraint(int *x
, int *y
) const ;
941 #endif // wxUSE_CONSTRAINTS
943 // when using constraints or sizers, it makes sense to update
944 // children positions automatically whenever the window is resized
945 // - this is done if autoLayout is on
946 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
947 bool GetAutoLayout() const { return m_autoLayout
; }
949 // lay out the window and its children
950 virtual bool Layout();
953 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
954 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
956 wxSizer
*GetSizer() const { return m_windowSizer
; }
958 // Track if this window is a member of a sizer
959 void SetContainingSizer(wxSizer
* sizer
);
960 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
963 // ----------------------
964 #if wxUSE_ACCESSIBILITY
965 // Override to create a specific accessible object.
966 virtual wxAccessible
* CreateAccessible();
968 // Sets the accessible object.
969 void SetAccessible(wxAccessible
* accessible
) ;
971 // Returns the accessible object.
972 wxAccessible
* GetAccessible() { return m_accessible
; };
974 // Returns the accessible object, creating if necessary.
975 wxAccessible
* GetOrCreateAccessible() ;
982 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
983 void OnInitDialog( wxInitDialogEvent
&event
);
984 void OnMiddleClick( wxMouseEvent
& event
);
986 void OnHelp(wxHelpEvent
& event
);
989 // virtual function for implementing internal idle
991 virtual void OnInternalIdle() {}
993 // call internal idle recursively
994 // void ProcessInternalIdle() ;
996 // get the handle of the window for the underlying window system: this
997 // is only used for wxWin itself or for user code which wants to call
998 // platform-specific APIs
999 virtual WXWidget
GetHandle() const = 0;
1002 // Store the palette used by DCs in wxWindow so that the dcs can share
1003 // a palette. And we can respond to palette messages.
1004 wxPalette
GetPalette() const { return m_palette
; }
1006 // When palette is changed tell the DC to set the system palette to the
1008 void SetPalette(const wxPalette
& pal
);
1010 // return true if we have a specific palette
1011 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1013 // return the first parent window with a custom palette or NULL
1014 wxWindow
*GetAncestorWithCustomPalette() const;
1015 #endif // wxUSE_PALETTE
1017 // inherit the parents visual attributes if they had been explicitly set
1018 // by the user (i.e. we don't inherit default attributes) and if we don't
1019 // have our own explicitly set
1020 virtual void InheritAttributes();
1022 // returns false from here if this window doesn't want to inherit the
1023 // parents colours even if InheritAttributes() would normally do it
1025 // this just provides a simple way to customize InheritAttributes()
1026 // behaviour in the most common case
1027 virtual bool ShouldInheritColours() const { return false; }
1030 // event handling specific to wxWindow
1031 virtual bool TryValidator(wxEvent
& event
);
1032 virtual bool TryParent(wxEvent
& event
);
1035 #if wxUSE_CONSTRAINTS
1036 // satisfy the constraints for the windows but don't set the window sizes
1037 void SatisfyConstraints();
1038 #endif // wxUSE_CONSTRAINTS
1040 // Send the wxWindowDestroyEvent
1041 void SendDestroyEvent();
1043 // the window id - a number which uniquely identifies a window among
1044 // its siblings unless it is -1
1045 wxWindowID m_windowId
;
1047 // the parent window of this window (or NULL) and the list of the children
1050 wxWindowList m_children
;
1052 // the minimal allowed size for the window (no minimal size if variable(s)
1059 // event handler for this window: usually is just 'this' but may be
1060 // changed with SetEventHandler()
1061 wxEvtHandler
*m_eventHandler
;
1063 #if wxUSE_VALIDATORS
1064 // associated validator or NULL if none
1065 wxValidator
*m_windowValidator
;
1066 #endif // wxUSE_VALIDATORS
1068 #if wxUSE_DRAG_AND_DROP
1069 wxDropTarget
*m_dropTarget
;
1070 #endif // wxUSE_DRAG_AND_DROP
1072 // visual window attributes
1074 wxFont m_font
; // see m_hasFont
1075 wxColour m_backgroundColour
, // m_hasBgCol
1076 m_foregroundColour
; // m_hasFgCol
1080 #endif // wxUSE_CARET
1082 // the region which should be repainted in response to paint event
1083 wxRegion m_updateRegion
;
1086 // the accelerator table for the window which translates key strokes into
1088 wxAcceleratorTable m_acceleratorTable
;
1089 #endif // wxUSE_ACCEL
1091 // the tooltip for this window (may be NULL)
1093 wxToolTip
*m_tooltip
;
1094 #endif // wxUSE_TOOLTIPS
1096 // constraints and sizers
1097 #if wxUSE_CONSTRAINTS
1098 // the constraints for this window or NULL
1099 wxLayoutConstraints
*m_constraints
;
1101 // constraints this window is involved in
1102 wxWindowList
*m_constraintsInvolvedIn
;
1103 #endif // wxUSE_CONSTRAINTS
1105 // this window's sizer
1106 wxSizer
*m_windowSizer
;
1108 // The sizer this window is a member of, if any
1109 wxSizer
*m_containingSizer
;
1111 // Layout() window automatically when its size changes?
1112 bool m_autoLayout
:1;
1117 bool m_isBeingDeleted
:1;
1119 // was the window colours/font explicitly changed by user?
1124 // and should it be inherited by children?
1125 bool m_inheritBgCol
:1;
1126 bool m_inheritFgCol
:1;
1127 bool m_inheritFont
:1;
1129 // window attributes
1132 wxString m_windowName
;
1133 bool m_themeEnabled
;
1136 wxPalette m_palette
;
1137 bool m_hasCustomPalette
;
1138 #endif // wxUSE_PALETTE
1140 #if wxUSE_ACCESSIBILITY
1141 wxAccessible
* m_accessible
;
1144 // Virtual size (scrolling)
1145 wxSize m_virtualSize
;
1147 int m_minVirtualWidth
; // VirtualSizeHints
1148 int m_minVirtualHeight
;
1149 int m_maxVirtualWidth
;
1150 int m_maxVirtualHeight
;
1152 wxWindowVariant m_windowVariant
;
1154 // override this to change the default (i.e. used when no style is
1155 // specified) border for the window class
1156 virtual wxBorder
GetDefaultBorder() const;
1158 // Get the default size for the new window if no explicit size given. TLWs
1159 // have their own default size so this is just for non top-level windows.
1160 static int WidthDefault(int w
) { return w
== -1 ? 20 : w
; }
1161 static int HeightDefault(int h
) { return h
== -1 ? 20 : h
; }
1164 // Used to save the results of DoGetBestSize so it doesn't need to be
1165 // recalculated each time the value is needed.
1166 wxSize m_bestSizeCache
;
1168 // keep the old name for compatibility, at least until all the internal
1169 // usages of it are changed to SetBestFittingSize
1170 void SetBestSize(const wxSize
& size
) { SetBestFittingSize(size
); }
1172 // set the initial window size if none is given (i.e. at least one of the
1173 // components of the size passed to ctor/Create() is -1)
1175 // normally just calls SetBestSize() for controls, but can be overridden
1176 // not to do it for the controls which have to do some additional
1177 // initialization (e.g. add strings to list box) before their best size
1178 // can be accurately calculated
1179 virtual void SetInitialBestSize(const wxSize
& WXUNUSED(size
)) {}
1183 // more pure virtual functions
1184 // ---------------------------
1186 // NB: we must have DoSomething() function when Something() is an overloaded
1187 // method: indeed, we can't just have "virtual Something()" in case when
1188 // the function is overloaded because then we'd have to make virtual all
1189 // the variants (otherwise only the virtual function may be called on a
1190 // pointer to derived class according to C++ rules) which is, in
1191 // general, absolutely not needed. So instead we implement all
1192 // overloaded Something()s in terms of DoSomething() which will be the
1193 // only one to be virtual.
1195 // coordinates translation
1196 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1197 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1199 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1201 // capture/release the mouse, used by Capture/ReleaseMouse()
1202 virtual void DoCaptureMouse() = 0;
1203 virtual void DoReleaseMouse() = 0;
1205 // retrieve the position/size of the window
1206 virtual void DoGetPosition( int *x
, int *y
) const = 0;
1207 virtual void DoGetSize( int *width
, int *height
) const = 0;
1208 virtual void DoGetClientSize( int *width
, int *height
) const = 0;
1210 // get the size which best suits the window: for a control, it would be
1211 // the minimal size which doesn't truncate the control, for a panel - the
1212 // same size as it would have after a call to Fit()
1213 virtual wxSize
DoGetBestSize() const;
1215 // this is the virtual function to be overriden in any derived class which
1216 // wants to change how SetSize() or Move() works - it is called by all
1217 // versions of these functions in the base class
1218 virtual void DoSetSize(int x
, int y
,
1219 int width
, int height
,
1220 int sizeFlags
= wxSIZE_AUTO
) = 0;
1222 // same as DoSetSize() for the client size
1223 virtual void DoSetClientSize(int width
, int height
) = 0;
1225 // move the window to the specified location and resize it: this is called
1226 // from both DoSetSize() and DoSetClientSize() and would usually just
1227 // reposition this window except for composite controls which will want to
1228 // arrange themselves inside the given rectangle
1229 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1232 virtual void DoSetToolTip( wxToolTip
*tip
);
1233 #endif // wxUSE_TOOLTIPS
1236 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1237 #endif // wxUSE_MENUS
1239 // Makes an adjustment to the window position to make it relative to the
1240 // parents client area, e.g. if the parent is a frame with a toolbar, its
1241 // (0, 0) is just below the toolbar
1242 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1243 int sizeFlags
= 0) const;
1245 // implements the window variants
1246 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1249 // contains the last id generated by NewControlId
1250 static int ms_lastControlId
;
1252 // the stack of windows which have captured the mouse
1253 static struct WXDLLEXPORT wxWindowNext
*ms_winCaptureNext
;
1255 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1256 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1257 DECLARE_EVENT_TABLE()
1260 // ----------------------------------------------------------------------------
1261 // now include the declaration of wxWindow class
1262 // ----------------------------------------------------------------------------
1264 // include the declaration of the platform-specific class
1265 #if defined(__WXMSW__)
1266 #ifdef __WXUNIVERSAL__
1267 #define wxWindowNative wxWindowMSW
1269 #define wxWindowMSW wxWindow
1270 #endif // wxUniv/!wxUniv
1271 #include "wx/msw/window.h"
1272 #elif defined(__WXMOTIF__)
1273 #include "wx/motif/window.h"
1274 #elif defined(__WXGTK__)
1275 #ifdef __WXUNIVERSAL__
1276 #define wxWindowNative wxWindowGTK
1278 #define wxWindowGTK wxWindow
1280 #include "wx/gtk/window.h"
1281 #elif defined(__WXX11__)
1282 #ifdef __WXUNIVERSAL__
1283 #define wxWindowNative wxWindowX11
1285 #define wxWindowX11 wxWindow
1287 #include "wx/x11/window.h"
1288 #elif defined(__WXMGL__)
1289 #ifdef __WXUNIVERSAL__
1290 #define wxWindowNative wxWindowMGL
1292 #define wxWindowMGL wxWindow
1294 #include "wx/mgl/window.h"
1295 #elif defined(__WXMAC__)
1296 #ifdef __WXUNIVERSAL__
1297 #define wxWindowNative wxWindowMac
1299 #define wxWindowMac wxWindow
1301 #include "wx/mac/window.h"
1302 #elif defined(__WXCOCOA__)
1303 #ifdef __WXUNIVERSAL__
1304 #define wxWindowNative wxWindowCocoa
1306 #define wxWindowCocoa wxWindow
1308 #include "wx/cocoa/window.h"
1309 #elif defined(__WXPM__)
1310 #ifdef __WXUNIVERSAL__
1311 #define wxWindowNative wxWindowOS2
1313 #define wxWindowOS2 wxWindow
1314 #endif // wxUniv/!wxUniv
1315 #include "wx/os2/window.h"
1318 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1319 // for the native ports we already have defined it above
1320 #if defined(__WXUNIVERSAL__)
1321 #ifndef wxWindowNative
1322 #error "wxWindowNative must be defined above!"
1325 #include "wx/univ/window.h"
1328 // ----------------------------------------------------------------------------
1329 // inline functions which couldn't be declared in the class body because of
1330 // forward dependencies
1331 // ----------------------------------------------------------------------------
1333 inline wxWindow
*wxWindowBase::GetGrandParent() const
1335 return m_parent
? m_parent
->GetParent() : (wxWindow
*)NULL
;
1338 // ----------------------------------------------------------------------------
1340 // ----------------------------------------------------------------------------
1342 // Find the wxWindow at the current mouse position, also returning the mouse
1344 WXDLLEXPORT
extern wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1346 // Get the current mouse position.
1347 WXDLLEXPORT
extern wxPoint
wxGetMousePosition();
1349 // get the currently active window of this application or NULL
1350 WXDLLEXPORT
extern wxWindow
*wxGetActiveWindow();
1352 // get the (first) top level parent window
1353 WXDLLEXPORT wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1355 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1356 inline int NewControlId() { return wxWindowBase::NewControlId(); }
1358 #if wxUSE_ACCESSIBILITY
1359 // ----------------------------------------------------------------------------
1360 // accessible object for windows
1361 // ----------------------------------------------------------------------------
1363 class WXDLLEXPORT wxWindowAccessible
: public wxAccessible
1366 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1367 virtual ~wxWindowAccessible() {};
1371 // Can return either a child object, or an integer
1372 // representing the child element, starting from 1.
1373 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1375 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1376 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1378 // Navigates from fromId to toId/toObject.
1379 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1380 int* toId
, wxAccessible
** toObject
);
1382 // Gets the name of the specified object.
1383 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1385 // Gets the number of children.
1386 virtual wxAccStatus
GetChildCount(int* childCount
);
1388 // Gets the specified child (starting from 1).
1389 // If *child is NULL and return value is wxACC_OK,
1390 // this means that the child is a simple element and
1391 // not an accessible object.
1392 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1394 // Gets the parent, or NULL.
1395 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1397 // Performs the default action. childId is 0 (the action for this object)
1398 // or > 0 (the action for a child).
1399 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1400 // window (e.g. an edit control).
1401 virtual wxAccStatus
DoDefaultAction(int childId
);
1403 // Gets the default action for this object (0) or > 0 (the action for a child).
1404 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1405 // string if there is no action.
1406 // The retrieved string describes the action that is performed on an object,
1407 // not what the object does as a result. For example, a toolbar button that prints
1408 // a document has a default action of "Press" rather than "Prints the current document."
1409 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1411 // Returns the description for this object or a child.
1412 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1414 // Returns help text for this object or a child, similar to tooltip text.
1415 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1417 // Returns the keyboard shortcut for this object or child.
1418 // Return e.g. ALT+K
1419 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1421 // Returns a role constant.
1422 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1424 // Returns a state constant.
1425 virtual wxAccStatus
GetState(int childId
, long* state
);
1427 // Returns a localized string representing the value for the object
1429 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1431 // Selects the object or child.
1432 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1434 // Gets the window with the keyboard focus.
1435 // If childId is 0 and child is NULL, no object in
1436 // this subhierarchy has the focus.
1437 // If this object has the focus, child should be 'this'.
1438 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1440 // Gets a variant representing the selected children
1442 // Acceptable values:
1443 // - a null variant (IsNull() returns true)
1444 // - a list variant (GetType() == wxT("list")
1445 // - an integer representing the selected child element,
1446 // or 0 if this object is selected (GetType() == wxT("long")
1447 // - a "void*" pointer to a wxAccessible child object
1448 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1451 #endif // wxUSE_ACCESSIBILITY
1455 // _WX_WINDOW_H_BASE_