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
; }
171 #if !defined(__WXMSW__) && \
172 !defined(__WXMGL__) && \
173 !defined(__WXMOTIF__) && \
174 !defined(__WXPM__) && \
177 // FIXME: This is work in progress about moving SetTitle/GetTitle from wxWindow
178 // to wxTopLevelWindow so initially enabled in wxMSW only to observe results
179 // and continue on other platforms
181 virtual void SetTitle( const wxString
& WXUNUSED(title
) ) {}
182 virtual wxString
GetTitle() const { return wxEmptyString
; }
184 // label is just the same as the title (but for, e.g., buttons it
185 // makes more sense to speak about labels)
186 virtual void SetLabel(const wxString
& label
) { SetTitle(label
); }
187 virtual wxString
GetLabel() const { return GetTitle(); }
189 // label is just the same as the title (but for, e.g., buttons it
190 // makes more sense to speak about labels)
191 virtual void SetLabel(const wxString
& label
) = 0;
192 virtual wxString
GetLabel() const = 0;
195 // the window name is used for ressource setting in X, it is not the
196 // same as the window title/label
197 virtual void SetName( const wxString
&name
) { m_windowName
= name
; }
198 virtual wxString
GetName() const { return m_windowName
; }
200 // sets the window variant, calls internally DoSetVariant if variant has changed
201 void SetWindowVariant( wxWindowVariant variant
) ;
202 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
205 // window id uniquely identifies the window among its siblings unless
206 // it is wxID_ANY which means "don't care"
207 void SetId( wxWindowID winid
) { m_windowId
= winid
; }
208 wxWindowID
GetId() const { return m_windowId
; }
210 // generate a control id for the controls which were not given one by
212 static int NewControlId() { return --ms_lastControlId
; }
213 // get the id of the control following the one with the given
214 // (autogenerated) id
215 static int NextControlId(int winid
) { return winid
- 1; }
216 // get the id of the control preceding the one with the given
217 // (autogenerated) id
218 static int PrevControlId(int winid
) { return winid
+ 1; }
223 // set the window size and/or position
224 void SetSize( int x
, int y
, int width
, int height
,
225 int sizeFlags
= wxSIZE_AUTO
)
226 { DoSetSize(x
, y
, width
, height
, sizeFlags
); }
228 void SetSize( int width
, int height
)
229 { DoSetSize( wxDefaultCoord
, wxDefaultCoord
, width
, height
, wxSIZE_USE_EXISTING
); }
231 void SetSize( const wxSize
& size
)
232 { SetSize( size
.x
, size
.y
); }
234 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
235 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
237 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
238 { DoSetSize(x
, y
, wxDefaultCoord
, wxDefaultCoord
, flags
); }
240 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
241 { Move(pt
.x
, pt
.y
, flags
); }
244 virtual void Raise() = 0;
245 virtual void Lower() = 0;
247 // client size is the size of area available for subwindows
248 void SetClientSize( int width
, int height
)
249 { DoSetClientSize(width
, height
); }
251 void SetClientSize( const wxSize
& size
)
252 { DoSetClientSize(size
.x
, size
.y
); }
254 void SetClientSize(const wxRect
& rect
)
255 { SetClientSize( rect
.width
, rect
.height
); }
257 // get the window position and/or size (pointers may be NULL)
258 void GetPosition( int *x
, int *y
) const { DoGetPosition(x
, y
); }
259 wxPoint
GetPosition() const
262 DoGetPosition(&w
, &h
);
264 return wxPoint(w
, h
);
267 void SetPosition( const wxPoint
& pt
) { Move( pt
) ; }
269 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
270 wxSize
GetSize() const
277 wxRect
GetRect() const
280 GetPosition(& x
, & y
);
283 return wxRect(x
, y
, w
, h
);
286 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
287 wxSize
GetClientSize() const
290 DoGetClientSize(& w
, & h
);
295 // get the origin of the client area of the window relative to the
296 // window top left corner (the client area may be shifted because of
297 // the borders, scrollbars, other decorations...)
298 virtual wxPoint
GetClientAreaOrigin() const;
300 // get the client rectangle in window (i.e. client) coordinates
301 wxRect
GetClientRect() const
303 return wxRect(GetClientAreaOrigin(), GetClientSize());
306 // get the size best suited for the window (in fact, minimal
307 // acceptable size using which it will still look "nice" in
309 wxSize
GetBestSize() const
311 if (m_bestSizeCache
.IsFullySpecified())
312 return m_bestSizeCache
;
313 return DoGetBestSize();
315 void GetBestSize(int *w
, int *h
) const
317 wxSize s
= GetBestSize();
324 // reset the cached best size value so it will be recalculated the
325 // next time it is needed.
326 void InvalidateBestSize();
327 void CacheBestSize(const wxSize
& size
) const
328 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
330 // There are times (and windows) where 'Best' size and 'Min' size
331 // are vastly out of sync. This should be remedied somehow, but in
332 // the meantime, this method will return the larger of BestSize
333 // (the window's smallest legible size), and any user specified
335 wxSize
GetAdjustedBestSize() const
337 wxSize
s( GetBestSize() );
338 return wxSize( wxMax( s
.x
, GetMinWidth() ), wxMax( s
.y
, GetMinHeight() ) );
341 // This function will merge the window's best size into the window's
342 // minimum size, giving priority to the min size components, and
343 // returns the results.
344 wxSize
GetBestFittingSize() const;
346 // A 'Smart' SetSize that will fill in default size values with 'best'
347 // size. Sets the minsize to what was passed in.
348 void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
);
350 // the generic centre function - centers the window on parent by`
351 // default or on screen if it doesn't have parent or
352 // wxCENTER_ON_SCREEN flag is given
353 void Centre( int direction
= wxBOTH
);
354 void Center( int direction
= wxBOTH
) { Centre(direction
); }
356 // centre on screen (only works for top level windows)
357 void CentreOnScreen(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_ON_SCREEN
); }
358 void CenterOnScreen(int dir
= wxBOTH
) { CentreOnScreen(dir
); }
360 // centre with respect to the the parent window
361 void CentreOnParent(int dir
= wxBOTH
) { Centre(dir
| wxCENTER_FRAME
); }
362 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
364 // set window size to wrap around its children
367 // set virtual size to satisfy children
368 virtual void FitInside();
370 // set min/max size of the window
371 virtual void SetSizeHints( int minW
, int minH
,
372 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
373 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
)
375 DoSetSizeHints(minW
, minH
, maxW
, maxH
, incW
, incH
);
378 void SetSizeHints( const wxSize
& minSize
,
379 const wxSize
& maxSize
=wxDefaultSize
,
380 const wxSize
& incSize
=wxDefaultSize
)
382 DoSetSizeHints(minSize
.x
, minSize
.y
,
383 maxSize
.x
, maxSize
.y
,
384 incSize
.x
, incSize
.y
);
387 virtual void DoSetSizeHints(int minW
, int minH
,
388 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
389 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
);
391 virtual void SetVirtualSizeHints( int minW
, int minH
,
392 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
);
393 void SetVirtualSizeHints( const wxSize
& minSize
,
394 const wxSize
& maxSize
=wxDefaultSize
)
396 SetVirtualSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
);
399 virtual int GetMinWidth() const { return m_minWidth
; }
400 virtual int GetMinHeight() const { return m_minHeight
; }
401 int GetMaxWidth() const { return m_maxWidth
; }
402 int GetMaxHeight() const { return m_maxHeight
; }
404 // Override this method to control the values given to Sizers etc.
405 virtual wxSize
GetMaxSize() const { return wxSize( m_maxWidth
, m_maxHeight
); }
406 virtual wxSize
GetMinSize() const { return wxSize( m_minWidth
, m_minHeight
); }
408 void SetMinSize(const wxSize
& minSize
) { SetSizeHints(minSize
); }
409 void SetMaxSize(const wxSize
& maxSize
) { SetSizeHints(GetMinSize(), maxSize
); }
411 // Methods for accessing the virtual size of a window. For most
412 // windows this is just the client area of the window, but for
413 // some like scrolled windows it is more or less independent of
414 // the screen window size. You may override the DoXXXVirtual
415 // methods below for classes where that is is the case.
417 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
418 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
420 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
421 void GetVirtualSize( int *x
, int *y
) const
423 wxSize
s( DoGetVirtualSize() );
431 // Override these methods for windows that have a virtual size
432 // independent of their client size. eg. the virtual area of a
435 virtual void DoSetVirtualSize( int x
, int y
);
436 virtual wxSize
DoGetVirtualSize() const;
438 // Return the largest of ClientSize and BestSize (as determined
439 // by a sizer, interior children, or other means)
441 virtual wxSize
GetBestVirtualSize() const
443 wxSize
client( GetClientSize() );
444 wxSize
best( GetBestSize() );
446 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
452 // returns true if window was shown/hidden, false if the nothing was
453 // done (window was already shown/hidden)
454 virtual bool Show( bool show
= true );
455 bool Hide() { return Show(false); }
457 // returns true if window was enabled/disabled, false if nothing done
458 virtual bool Enable( bool enable
= true );
459 bool Disable() { return Enable(false); }
461 virtual bool IsShown() const { return m_isShown
; }
462 virtual bool IsEnabled() const { return m_isEnabled
; }
464 // get/set window style (setting style won't update the window and so
465 // is only useful for internal usage)
466 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
467 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
469 // just some (somewhat shorter) synonims
470 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
471 long GetWindowStyle() const { return GetWindowStyleFlag(); }
473 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
474 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
476 // extra style: the less often used style bits which can't be set with
477 // SetWindowStyleFlag()
478 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
479 long GetExtraStyle() const { return m_exStyle
; }
481 // make the window modal (all other windows unresponsive)
482 virtual void MakeModal(bool modal
= true);
485 // (primitive) theming support
486 // ---------------------------
488 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
489 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
492 // focus and keyboard handling
493 // ---------------------------
495 // set focus to this window
496 virtual void SetFocus() = 0;
498 // set focus to this window as the result of a keyboard action
499 virtual void SetFocusFromKbd() { SetFocus(); }
501 // return the window which currently has the focus or NULL
502 static wxWindow
*FindFocus();
504 static wxWindow
*DoFindFocus() /* = 0: implement in derived classes */;
506 // can this window have focus?
507 virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
509 // can this window be given focus by keyboard navigation? if not, the
510 // only way to give it focus (provided it accepts it at all) is to
512 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
514 // NB: these methods really don't belong here but with the current
515 // class hierarchy there is no other place for them :-(
517 // get the default child of this parent, i.e. the one which is
518 // activated by pressing <Enter>
519 virtual wxWindow
*GetDefaultItem() const { return NULL
; }
521 // set this child as default, return the old default
522 virtual wxWindow
*SetDefaultItem(wxWindow
* WXUNUSED(child
))
525 // set this child as temporary default
526 virtual void SetTmpDefaultItem(wxWindow
* WXUNUSED(win
)) { }
528 // navigates in the specified direction by sending a wxNavigationKeyEvent
529 virtual bool Navigate(int flags
= wxNavigationKeyEvent
::IsForward
);
531 // move this window just before/after the specified one in tab order
532 // (the other window must be our sibling!)
533 void MoveBeforeInTabOrder(wxWindow
*win
)
534 { DoMoveInTabOrder(win
, MoveBefore
); }
535 void MoveAfterInTabOrder(wxWindow
*win
)
536 { DoMoveInTabOrder(win
, MoveAfter
); }
539 // parent/children relations
540 // -------------------------
542 // get the list of children
543 const wxWindowList
& GetChildren() const { return m_children
; }
544 wxWindowList
& GetChildren() { return m_children
; }
546 // needed just for extended runtime
547 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
549 // get the parent or the parent of the parent
550 wxWindow
*GetParent() const { return m_parent
; }
551 inline wxWindow
*GetGrandParent() const;
553 // is this window a top level one?
554 virtual bool IsTopLevel() const;
556 // it doesn't really change parent, use Reparent() instead
557 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
558 // change the real parent of this window, return true if the parent
559 // was changed, false otherwise (error or newParent == oldParent)
560 virtual bool Reparent( wxWindowBase
*newParent
);
562 // implementation mostly
563 virtual void AddChild( wxWindowBase
*child
);
564 virtual void RemoveChild( wxWindowBase
*child
);
566 // looking for windows
567 // -------------------
569 // find window among the descendants of this one either by id or by
570 // name (return NULL if not found)
571 wxWindow
*FindWindow(long winid
) const;
572 wxWindow
*FindWindow(const wxString
& name
) const;
574 // Find a window among any window (all return NULL if not found)
575 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
576 static wxWindow
*FindWindowByName( const wxString
& name
,
577 const wxWindow
*parent
= NULL
);
578 static wxWindow
*FindWindowByLabel( const wxString
& label
,
579 const wxWindow
*parent
= NULL
);
581 // event handler stuff
582 // -------------------
584 // get the current event handler
585 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
587 // replace the event handler (allows to completely subclass the
589 void SetEventHandler( wxEvtHandler
*handler
) { m_eventHandler
= handler
; }
591 // push/pop event handler: allows to chain a custom event handler to
592 // alreasy existing ones
593 void PushEventHandler( wxEvtHandler
*handler
);
594 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
596 // find the given handler in the event handler chain and remove (but
597 // not delete) it from the event handler chain, return true if it was
598 // found and false otherwise (this also results in an assert failure so
599 // this function should only be called when the handler is supposed to
601 bool RemoveEventHandler(wxEvtHandler
*handler
);
607 // a window may have an associated validator which is used to control
609 virtual void SetValidator( const wxValidator
&validator
);
610 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
611 #endif // wxUSE_VALIDATORS
614 // dialog oriented functions
615 // -------------------------
617 // validate the correctness of input, return true if ok
618 virtual bool Validate();
620 // transfer data between internal and GUI representations
621 virtual bool TransferDataToWindow();
622 virtual bool TransferDataFromWindow();
624 virtual void InitDialog();
629 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
630 { m_acceleratorTable
= accel
; }
631 wxAcceleratorTable
*GetAcceleratorTable()
632 { return &m_acceleratorTable
; }
634 #endif // wxUSE_ACCEL
637 // hot keys (system wide accelerators)
638 // -----------------------------------
640 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
641 virtual bool UnregisterHotKey(int hotkeyId
);
642 #endif // wxUSE_HOTKEY
645 // dialog units translations
646 // -------------------------
648 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
649 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
650 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
652 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
654 return wxSize(pt
.x
, pt
.y
);
657 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
659 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
661 return wxSize(pt
.x
, pt
.y
);
667 // move the mouse to the specified position
668 virtual void WarpPointer(int x
, int y
) = 0;
670 // start or end mouse capture, these functions maintain the stack of
671 // windows having captured the mouse and after calling ReleaseMouse()
672 // the mouse is not released but returns to the window which had had
673 // captured it previously (if any)
677 // get the window which currently captures the mouse or NULL
678 static wxWindow
*GetCapture();
680 // does this window have the capture?
681 virtual bool HasCapture() const
682 { return (wxWindow
*)this == GetCapture(); }
684 // painting the window
685 // -------------------
687 // mark the specified rectangle (or the whole window) as "dirty" so it
689 virtual void Refresh( bool eraseBackground
= true,
690 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
692 // a less awkward wrapper for Refresh
693 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true)
695 Refresh(eraseBackground
, &rect
);
698 // repaint all invalid areas of the window immediately
699 virtual void Update() { }
701 // clear the window background
702 virtual void ClearBackground();
704 // freeze the window: don't redraw it until it is thawed
705 virtual void Freeze() { }
707 // thaw the window: redraw it after it had been frozen
708 virtual void Thaw() { }
710 // adjust DC for drawing on this window
711 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
713 // the update region of the window contains the areas which must be
714 // repainted by the program
715 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
716 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
718 // get the update rectangleregion bounding box in client coords
719 wxRect
GetUpdateClientRect() const;
721 // these functions verify whether the given point/rectangle belongs to
722 // (or at least intersects with) the update region
723 bool IsExposed( int x
, int y
) const;
724 bool IsExposed( int x
, int y
, int w
, int h
) const;
726 bool IsExposed( const wxPoint
& pt
) const
727 { return IsExposed(pt
.x
, pt
.y
); }
728 bool IsExposed( const wxRect
& rect
) const
729 { return IsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
731 // colours, fonts and cursors
732 // --------------------------
734 // get the default attributes for the controls of this class: we
735 // provide a virtual function which can be used to query the default
736 // attributes of an existing control and a static function which can
737 // be used even when no existing object of the given class is
738 // available, but which won't return any styles specific to this
739 // particular control, of course (e.g. "Ok" button might have
740 // different -- bold for example -- font)
741 virtual wxVisualAttributes
GetDefaultAttributes() const
743 return GetClassDefaultAttributes(GetWindowVariant());
746 static wxVisualAttributes
747 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
749 // set/retrieve the window colours (system defaults are used by
750 // default): SetXXX() functions return true if colour was changed,
751 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
752 // value to prevent it from being inherited by our children
753 virtual bool SetBackgroundColour(const wxColour
& colour
);
754 void SetOwnBackgroundColour(const wxColour
& colour
)
756 if ( SetBackgroundColour(colour
) )
757 m_inheritBgCol
= false;
759 wxColour
GetBackgroundColour() const;
760 bool InheritsBackgroundColour() const
762 return m_inheritBgCol
;
764 bool UseBgCol() const
769 virtual bool SetForegroundColour(const wxColour
& colour
);
770 void SetOwnForegroundColour(const wxColour
& colour
)
772 if ( SetForegroundColour(colour
) )
773 m_inheritFgCol
= false;
775 wxColour
GetForegroundColour() const;
777 // Set/get the background style.
778 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
779 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) { m_backgroundStyle
= style
; return true; }
780 virtual wxBackgroundStyle
GetBackgroundStyle() const { return m_backgroundStyle
; }
782 // returns true if the control has "transparent" areas such as a
783 // wxStaticText and wxCheckBox and the background should be adapted
784 // from a parent window
785 virtual bool HasTransparentBackground() { return false; }
787 // set/retrieve the font for the window (SetFont() returns true if the
788 // font really changed)
789 virtual bool SetFont(const wxFont
& font
) = 0;
790 void SetOwnFont(const wxFont
& font
)
793 m_inheritFont
= false;
795 wxFont
GetFont() const;
797 // set/retrieve the cursor for this window (SetCursor() returns true
798 // if the cursor was really changed)
799 virtual bool SetCursor( const wxCursor
&cursor
);
800 const wxCursor
& GetCursor() const { return m_cursor
; }
803 // associate a caret with the window
804 void SetCaret(wxCaret
*caret
);
805 // get the current caret (may be NULL)
806 wxCaret
*GetCaret() const { return m_caret
; }
807 #endif // wxUSE_CARET
809 // get the (average) character size for the current font
810 virtual int GetCharHeight() const = 0;
811 virtual int GetCharWidth() const = 0;
813 // get the width/height/... of the text using current or specified
815 virtual void GetTextExtent(const wxString
& string
,
817 int *descent
= (int *) NULL
,
818 int *externalLeading
= (int *) NULL
,
819 const wxFont
*theFont
= (const wxFont
*) NULL
)
822 // client <-> screen coords
823 // ------------------------
825 // translate to/from screen/client coordinates (pointers may be NULL)
826 void ClientToScreen( int *x
, int *y
) const
827 { DoClientToScreen(x
, y
); }
828 void ScreenToClient( int *x
, int *y
) const
829 { DoScreenToClient(x
, y
); }
831 // wxPoint interface to do the same thing
832 wxPoint
ClientToScreen(const wxPoint
& pt
) const
834 int x
= pt
.x
, y
= pt
.y
;
835 DoClientToScreen(&x
, &y
);
837 return wxPoint(x
, y
);
840 wxPoint
ScreenToClient(const wxPoint
& pt
) const
842 int x
= pt
.x
, y
= pt
.y
;
843 DoScreenToClient(&x
, &y
);
845 return wxPoint(x
, y
);
848 // test where the given (in client coords) point lies
849 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
850 { return DoHitTest(x
, y
); }
852 wxHitTest
HitTest(const wxPoint
& pt
) const
853 { return DoHitTest(pt
.x
, pt
.y
); }
858 // get the window border style from the given flags: this is different from
859 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
860 // translate wxBORDER_DEFAULT to something reasonable
861 wxBorder
GetBorder(long flags
) const;
863 // get border for the flags of this window
864 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
866 // send wxUpdateUIEvents to this window, and children if recurse is true
867 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
869 // do the window-specific processing after processing the update event
870 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
873 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
874 { return DoPopupMenu(menu
, pos
.x
, pos
.y
); }
875 bool PopupMenu(wxMenu
*menu
, int x
, int y
)
876 { return DoPopupMenu(menu
, x
, y
); }
877 #endif // wxUSE_MENUS
882 // does the window have the scrollbar for this orientation?
883 bool HasScrollbar(int orient
) const
885 return (m_windowStyle
&
886 (orient
== wxHORIZONTAL ? wxHSCROLL
: wxVSCROLL
)) != 0;
889 // configure the window scrollbars
890 virtual void SetScrollbar( int orient
,
894 bool refresh
= true ) = 0;
895 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
896 virtual int GetScrollPos( int orient
) const = 0;
897 virtual int GetScrollThumb( int orient
) const = 0;
898 virtual int GetScrollRange( int orient
) const = 0;
900 // scroll window to the specified position
901 virtual void ScrollWindow( int dx
, int dy
,
902 const wxRect
* rect
= (wxRect
*) NULL
) = 0;
904 // scrolls window by line/page: note that not all controls support this
906 // return true if the position changed, false otherwise
907 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
908 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
910 // convenient wrappers for ScrollLines/Pages
911 bool LineUp() { return ScrollLines(-1); }
912 bool LineDown() { return ScrollLines(1); }
913 bool PageUp() { return ScrollPages(-1); }
914 bool PageDown() { return ScrollPages(1); }
916 // context-sensitive help
917 // ----------------------
919 // these are the convenience functions wrapping wxHelpProvider methods
922 // associate this help text with this window
923 void SetHelpText(const wxString
& text
);
924 // associate this help text with all windows with the same id as this
926 void SetHelpTextForId(const wxString
& text
);
927 // get the help string associated with this window (may be empty)
928 wxString
GetHelpText() const;
930 // silently ignore SetHelpText() calls
931 void SetHelpText(const wxString
& WXUNUSED(text
)) { }
932 void SetHelpTextForId(const wxString
& WXUNUSED(text
)) { }
939 // the easiest way to set a tooltip for a window is to use this method
940 void SetToolTip( const wxString
&tip
);
941 // attach a tooltip to the window
942 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
943 // get the associated tooltip or NULL if none
944 wxToolTip
* GetToolTip() const { return m_tooltip
; }
945 wxString
GetToolTipText() const ;
947 // make it much easier to compile apps in an environment
948 // that doesn't support tooltips, such as PocketPC
949 inline void SetToolTip( const wxString
& WXUNUSED(tip
) ) {}
950 #endif // wxUSE_TOOLTIPS
954 #if wxUSE_DRAG_AND_DROP
955 // set/retrieve the drop target associated with this window (may be
956 // NULL; it's owned by the window and will be deleted by it)
957 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
958 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
959 #endif // wxUSE_DRAG_AND_DROP
961 // constraints and sizers
962 // ----------------------
963 #if wxUSE_CONSTRAINTS
964 // set the constraints for this window or retrieve them (may be NULL)
965 void SetConstraints( wxLayoutConstraints
*constraints
);
966 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
968 // implementation only
969 void UnsetConstraints(wxLayoutConstraints
*c
);
970 wxWindowList
*GetConstraintsInvolvedIn() const
971 { return m_constraintsInvolvedIn
; }
972 void AddConstraintReference(wxWindowBase
*otherWin
);
973 void RemoveConstraintReference(wxWindowBase
*otherWin
);
974 void DeleteRelatedConstraints();
975 void ResetConstraints();
977 // these methods may be overriden for special layout algorithms
978 virtual void SetConstraintSizes(bool recurse
= true);
979 virtual bool LayoutPhase1(int *noChanges
);
980 virtual bool LayoutPhase2(int *noChanges
);
981 virtual bool DoPhase(int phase
);
983 // these methods are virtual but normally won't be overridden
984 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
985 virtual void MoveConstraint(int x
, int y
);
986 virtual void GetSizeConstraint(int *w
, int *h
) const ;
987 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
988 virtual void GetPositionConstraint(int *x
, int *y
) const ;
990 #endif // wxUSE_CONSTRAINTS
992 // when using constraints or sizers, it makes sense to update
993 // children positions automatically whenever the window is resized
994 // - this is done if autoLayout is on
995 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
996 bool GetAutoLayout() const { return m_autoLayout
; }
998 // lay out the window and its children
999 virtual bool Layout();
1002 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
1003 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
1005 wxSizer
*GetSizer() const { return m_windowSizer
; }
1007 // Track if this window is a member of a sizer
1008 void SetContainingSizer(wxSizer
* sizer
);
1009 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1012 // ----------------------
1013 #if wxUSE_ACCESSIBILITY
1014 // Override to create a specific accessible object.
1015 virtual wxAccessible
* CreateAccessible();
1017 // Sets the accessible object.
1018 void SetAccessible(wxAccessible
* accessible
) ;
1020 // Returns the accessible object.
1021 wxAccessible
* GetAccessible() { return m_accessible
; };
1023 // Returns the accessible object, creating if necessary.
1024 wxAccessible
* GetOrCreateAccessible() ;
1031 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1032 void OnInitDialog( wxInitDialogEvent
&event
);
1033 void OnMiddleClick( wxMouseEvent
& event
);
1035 void OnHelp(wxHelpEvent
& event
);
1036 #endif // wxUSE_HELP
1038 // virtual function for implementing internal idle
1040 virtual void OnInternalIdle() {}
1042 // call internal idle recursively
1043 // void ProcessInternalIdle() ;
1045 // get the handle of the window for the underlying window system: this
1046 // is only used for wxWin itself or for user code which wants to call
1047 // platform-specific APIs
1048 virtual WXWidget
GetHandle() const = 0;
1049 // associate the window with a new native handle
1050 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1051 // dissociate the current native handle from the window
1052 virtual void DissociateHandle() { }
1055 // Store the palette used by DCs in wxWindow so that the dcs can share
1056 // a palette. And we can respond to palette messages.
1057 wxPalette
GetPalette() const { return m_palette
; }
1059 // When palette is changed tell the DC to set the system palette to the
1061 void SetPalette(const wxPalette
& pal
);
1063 // return true if we have a specific palette
1064 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1066 // return the first parent window with a custom palette or NULL
1067 wxWindow
*GetAncestorWithCustomPalette() const;
1068 #endif // wxUSE_PALETTE
1070 // inherit the parents visual attributes if they had been explicitly set
1071 // by the user (i.e. we don't inherit default attributes) and if we don't
1072 // have our own explicitly set
1073 virtual void InheritAttributes();
1075 // returns false from here if this window doesn't want to inherit the
1076 // parents colours even if InheritAttributes() would normally do it
1078 // this just provides a simple way to customize InheritAttributes()
1079 // behaviour in the most common case
1080 virtual bool ShouldInheritColours() const { return false; }
1082 // Reserved for future use
1083 virtual void ReservedWindowFunc1() {}
1084 virtual void ReservedWindowFunc2() {}
1085 virtual void ReservedWindowFunc3() {}
1086 virtual void ReservedWindowFunc4() {}
1087 virtual void ReservedWindowFunc5() {}
1088 virtual void ReservedWindowFunc6() {}
1089 virtual void ReservedWindowFunc7() {}
1090 virtual void ReservedWindowFunc8() {}
1091 virtual void ReservedWindowFunc9() {}
1094 // event handling specific to wxWindow
1095 virtual bool TryValidator(wxEvent
& event
);
1096 virtual bool TryParent(wxEvent
& event
);
1098 // common part of MoveBefore/AfterInTabOrder()
1101 MoveBefore
, // insert before the given window
1102 MoveAfter
// insert after the given window
1104 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
1106 #if wxUSE_CONSTRAINTS
1107 // satisfy the constraints for the windows but don't set the window sizes
1108 void SatisfyConstraints();
1109 #endif // wxUSE_CONSTRAINTS
1111 // Send the wxWindowDestroyEvent
1112 void SendDestroyEvent();
1114 // returns the main window of composite control; this is the window
1115 // that FindFocus returns if the focus is in one of composite control's
1117 virtual wxWindow
*GetMainWindowOfCompositeControl()
1118 { return (wxWindow
*)this; }
1120 // the window id - a number which uniquely identifies a window among
1121 // its siblings unless it is wxID_ANY
1122 wxWindowID m_windowId
;
1124 // the parent window of this window (or NULL) and the list of the children
1127 wxWindowList m_children
;
1129 // the minimal allowed size for the window (no minimal size if variable(s)
1130 // contain(s) wxDefaultCoord)
1136 // event handler for this window: usually is just 'this' but may be
1137 // changed with SetEventHandler()
1138 wxEvtHandler
*m_eventHandler
;
1140 #if wxUSE_VALIDATORS
1141 // associated validator or NULL if none
1142 wxValidator
*m_windowValidator
;
1143 #endif // wxUSE_VALIDATORS
1145 #if wxUSE_DRAG_AND_DROP
1146 wxDropTarget
*m_dropTarget
;
1147 #endif // wxUSE_DRAG_AND_DROP
1149 // visual window attributes
1151 wxFont m_font
; // see m_hasFont
1152 wxColour m_backgroundColour
, // m_hasBgCol
1153 m_foregroundColour
; // m_hasFgCol
1157 #endif // wxUSE_CARET
1159 // the region which should be repainted in response to paint event
1160 wxRegion m_updateRegion
;
1163 // the accelerator table for the window which translates key strokes into
1165 wxAcceleratorTable m_acceleratorTable
;
1166 #endif // wxUSE_ACCEL
1168 // the tooltip for this window (may be NULL)
1170 wxToolTip
*m_tooltip
;
1171 #endif // wxUSE_TOOLTIPS
1173 // constraints and sizers
1174 #if wxUSE_CONSTRAINTS
1175 // the constraints for this window or NULL
1176 wxLayoutConstraints
*m_constraints
;
1178 // constraints this window is involved in
1179 wxWindowList
*m_constraintsInvolvedIn
;
1180 #endif // wxUSE_CONSTRAINTS
1182 // this window's sizer
1183 wxSizer
*m_windowSizer
;
1185 // The sizer this window is a member of, if any
1186 wxSizer
*m_containingSizer
;
1188 // Layout() window automatically when its size changes?
1189 bool m_autoLayout
:1;
1194 bool m_isBeingDeleted
:1;
1196 // was the window colours/font explicitly changed by user?
1201 // and should it be inherited by children?
1202 bool m_inheritBgCol
:1;
1203 bool m_inheritFgCol
:1;
1204 bool m_inheritFont
:1;
1206 // window attributes
1209 wxString m_windowName
;
1210 bool m_themeEnabled
;
1211 wxBackgroundStyle m_backgroundStyle
;
1213 wxPalette m_palette
;
1214 bool m_hasCustomPalette
;
1215 #endif // wxUSE_PALETTE
1217 #if wxUSE_ACCESSIBILITY
1218 wxAccessible
* m_accessible
;
1221 // Virtual size (scrolling)
1222 wxSize m_virtualSize
;
1224 int m_minVirtualWidth
; // VirtualSizeHints
1225 int m_minVirtualHeight
;
1226 int m_maxVirtualWidth
;
1227 int m_maxVirtualHeight
;
1229 wxWindowVariant m_windowVariant
;
1231 // override this to change the default (i.e. used when no style is
1232 // specified) border for the window class
1233 virtual wxBorder
GetDefaultBorder() const;
1235 // Get the default size for the new window if no explicit size given. TLWs
1236 // have their own default size so this is just for non top-level windows.
1237 static int WidthDefault(int w
) { return w
== wxDefaultCoord ?
20 : w
; }
1238 static int HeightDefault(int h
) { return h
== wxDefaultCoord ?
20 : h
; }
1241 // Used to save the results of DoGetBestSize so it doesn't need to be
1242 // recalculated each time the value is needed.
1243 wxSize m_bestSizeCache
;
1245 // keep the old name for compatibility, at least until all the internal
1246 // usages of it are changed to SetBestFittingSize
1247 void SetBestSize(const wxSize
& size
) { SetBestFittingSize(size
); }
1249 // set the initial window size if none is given (i.e. at least one of the
1250 // components of the size passed to ctor/Create() is wxDefaultCoord)
1252 // normally just calls SetBestSize() for controls, but can be overridden
1253 // not to do it for the controls which have to do some additional
1254 // initialization (e.g. add strings to list box) before their best size
1255 // can be accurately calculated
1256 virtual void SetInitialBestSize(const wxSize
& WXUNUSED(size
)) {}
1260 // more pure virtual functions
1261 // ---------------------------
1263 // NB: we must have DoSomething() function when Something() is an overloaded
1264 // method: indeed, we can't just have "virtual Something()" in case when
1265 // the function is overloaded because then we'd have to make virtual all
1266 // the variants (otherwise only the virtual function may be called on a
1267 // pointer to derived class according to C++ rules) which is, in
1268 // general, absolutely not needed. So instead we implement all
1269 // overloaded Something()s in terms of DoSomething() which will be the
1270 // only one to be virtual.
1272 // coordinates translation
1273 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1274 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1276 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1278 // capture/release the mouse, used by Capture/ReleaseMouse()
1279 virtual void DoCaptureMouse() = 0;
1280 virtual void DoReleaseMouse() = 0;
1282 // retrieve the position/size of the window
1283 virtual void DoGetPosition( int *x
, int *y
) const = 0;
1284 virtual void DoGetSize( int *width
, int *height
) const = 0;
1285 virtual void DoGetClientSize( int *width
, int *height
) const = 0;
1287 // get the size which best suits the window: for a control, it would be
1288 // the minimal size which doesn't truncate the control, for a panel - the
1289 // same size as it would have after a call to Fit()
1290 virtual wxSize
DoGetBestSize() const;
1292 // called from DoGetBestSize() to convert best virtual size (returned by
1293 // the window sizer) to the best size for the window itself; this is
1294 // overridden at wxScrolledWindow level to clump down virtual size to real
1295 virtual wxSize
GetWindowSizeForVirtualSize(const wxSize
& size
) const
1300 // this is the virtual function to be overriden in any derived class which
1301 // wants to change how SetSize() or Move() works - it is called by all
1302 // versions of these functions in the base class
1303 virtual void DoSetSize(int x
, int y
,
1304 int width
, int height
,
1305 int sizeFlags
= wxSIZE_AUTO
) = 0;
1307 // same as DoSetSize() for the client size
1308 virtual void DoSetClientSize(int width
, int height
) = 0;
1310 // move the window to the specified location and resize it: this is called
1311 // from both DoSetSize() and DoSetClientSize() and would usually just
1312 // reposition this window except for composite controls which will want to
1313 // arrange themselves inside the given rectangle
1314 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1317 virtual void DoSetToolTip( wxToolTip
*tip
);
1318 #endif // wxUSE_TOOLTIPS
1321 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1322 #endif // wxUSE_MENUS
1324 // Makes an adjustment to the window position to make it relative to the
1325 // parents client area, e.g. if the parent is a frame with a toolbar, its
1326 // (0, 0) is just below the toolbar
1327 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1328 int sizeFlags
= 0) const;
1330 // implements the window variants
1331 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1333 // Reserved for future use
1334 void* m_windowReserved
;
1337 // contains the last id generated by NewControlId
1338 static int ms_lastControlId
;
1340 // the stack of windows which have captured the mouse
1341 static struct WXDLLEXPORT wxWindowNext
*ms_winCaptureNext
;
1343 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1344 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1345 DECLARE_EVENT_TABLE()
1348 // ----------------------------------------------------------------------------
1349 // now include the declaration of wxWindow class
1350 // ----------------------------------------------------------------------------
1352 // include the declaration of the platform-specific class
1353 #if defined(__WXPALMOS__)
1354 #ifdef __WXUNIVERSAL__
1355 #define wxWindowNative wxWindowPalm
1357 #define wxWindowPalm wxWindow
1358 #endif // wxUniv/!wxUniv
1359 #include "wx/palmos/window.h"
1360 #elif defined(__WXMSW__)
1361 #ifdef __WXUNIVERSAL__
1362 #define wxWindowNative wxWindowMSW
1364 #define wxWindowMSW wxWindow
1365 #endif // wxUniv/!wxUniv
1366 #include "wx/msw/window.h"
1367 #elif defined(__WXMOTIF__)
1368 #include "wx/motif/window.h"
1369 #elif defined(__WXGTK__)
1370 #ifdef __WXUNIVERSAL__
1371 #define wxWindowNative wxWindowGTK
1373 #define wxWindowGTK wxWindow
1375 #include "wx/gtk/window.h"
1376 #elif defined(__WXX11__)
1377 #ifdef __WXUNIVERSAL__
1378 #define wxWindowNative wxWindowX11
1380 #define wxWindowX11 wxWindow
1382 #include "wx/x11/window.h"
1383 #elif defined(__WXMGL__)
1384 #ifdef __WXUNIVERSAL__
1385 #define wxWindowNative wxWindowMGL
1387 #define wxWindowMGL wxWindow
1389 #include "wx/mgl/window.h"
1390 #elif defined(__WXMAC__)
1391 #ifdef __WXUNIVERSAL__
1392 #define wxWindowNative wxWindowMac
1394 #define wxWindowMac wxWindow
1396 #include "wx/mac/window.h"
1397 #elif defined(__WXCOCOA__)
1398 #ifdef __WXUNIVERSAL__
1399 #define wxWindowNative wxWindowCocoa
1401 #define wxWindowCocoa wxWindow
1403 #include "wx/cocoa/window.h"
1404 #elif defined(__WXPM__)
1405 #ifdef __WXUNIVERSAL__
1406 #define wxWindowNative wxWindowOS2
1408 #define wxWindowOS2 wxWindow
1409 #endif // wxUniv/!wxUniv
1410 #include "wx/os2/window.h"
1413 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1414 // for the native ports we already have defined it above
1415 #if defined(__WXUNIVERSAL__)
1416 #ifndef wxWindowNative
1417 #error "wxWindowNative must be defined above!"
1420 #include "wx/univ/window.h"
1423 // ----------------------------------------------------------------------------
1424 // inline functions which couldn't be declared in the class body because of
1425 // forward dependencies
1426 // ----------------------------------------------------------------------------
1428 inline wxWindow
*wxWindowBase
::GetGrandParent() const
1430 return m_parent ? m_parent
->GetParent() : (wxWindow
*)NULL
;
1433 // ----------------------------------------------------------------------------
1435 // ----------------------------------------------------------------------------
1437 // Find the wxWindow at the current mouse position, also returning the mouse
1439 extern WXDLLEXPORT wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1441 // Get the current mouse position.
1442 extern WXDLLEXPORT wxPoint
wxGetMousePosition();
1444 // get the currently active window of this application or NULL
1445 extern WXDLLEXPORT wxWindow
*wxGetActiveWindow();
1447 // get the (first) top level parent window
1448 WXDLLEXPORT wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1450 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1451 inline int NewControlId() { return wxWindowBase
::NewControlId(); }
1453 #if wxUSE_ACCESSIBILITY
1454 // ----------------------------------------------------------------------------
1455 // accessible object for windows
1456 // ----------------------------------------------------------------------------
1458 class WXDLLEXPORT wxWindowAccessible
: public wxAccessible
1461 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1462 virtual ~wxWindowAccessible() {}
1466 // Can return either a child object, or an integer
1467 // representing the child element, starting from 1.
1468 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1470 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1471 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1473 // Navigates from fromId to toId/toObject.
1474 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1475 int* toId
, wxAccessible
** toObject
);
1477 // Gets the name of the specified object.
1478 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1480 // Gets the number of children.
1481 virtual wxAccStatus
GetChildCount(int* childCount
);
1483 // Gets the specified child (starting from 1).
1484 // If *child is NULL and return value is wxACC_OK,
1485 // this means that the child is a simple element and
1486 // not an accessible object.
1487 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1489 // Gets the parent, or NULL.
1490 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1492 // Performs the default action. childId is 0 (the action for this object)
1493 // or > 0 (the action for a child).
1494 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1495 // window (e.g. an edit control).
1496 virtual wxAccStatus
DoDefaultAction(int childId
);
1498 // Gets the default action for this object (0) or > 0 (the action for a child).
1499 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1500 // string if there is no action.
1501 // The retrieved string describes the action that is performed on an object,
1502 // not what the object does as a result. For example, a toolbar button that prints
1503 // a document has a default action of "Press" rather than "Prints the current document."
1504 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1506 // Returns the description for this object or a child.
1507 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1509 // Returns help text for this object or a child, similar to tooltip text.
1510 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1512 // Returns the keyboard shortcut for this object or child.
1513 // Return e.g. ALT+K
1514 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1516 // Returns a role constant.
1517 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1519 // Returns a state constant.
1520 virtual wxAccStatus
GetState(int childId
, long* state
);
1522 // Returns a localized string representing the value for the object
1524 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1526 // Selects the object or child.
1527 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1529 // Gets the window with the keyboard focus.
1530 // If childId is 0 and child is NULL, no object in
1531 // this subhierarchy has the focus.
1532 // If this object has the focus, child should be 'this'.
1533 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1535 // Gets a variant representing the selected children
1537 // Acceptable values:
1538 // - a null variant (IsNull() returns true)
1539 // - a list variant (GetType() == wxT("list")
1540 // - an integer representing the selected child element,
1541 // or 0 if this object is selected (GetType() == wxT("long")
1542 // - a "void*" pointer to a wxAccessible child object
1543 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1546 #endif // wxUSE_ACCESSIBILITY
1549 #endif // _WX_WINDOW_H_BASE_