1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindowBase class - the interface of wxWindow
4 // Author: Vadim Zeitlin
5 // Modified by: Ron Lee
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_WINDOW_H_BASE_
13 #define _WX_WINDOW_H_BASE_
15 // ----------------------------------------------------------------------------
16 // headers which we must include here
17 // ----------------------------------------------------------------------------
19 #include "wx/event.h" // the base class
21 #include "wx/list.h" // defines wxWindowList
23 #include "wx/cursor.h" // we have member variables of these classes
24 #include "wx/font.h" // so we can't do without them
25 #include "wx/colour.h"
26 #include "wx/region.h"
30 #include "wx/validate.h" // for wxDefaultValidator (always include it)
33 #include "wx/palette.h"
34 #endif // wxUSE_PALETTE
40 #if wxUSE_ACCESSIBILITY
41 #include "wx/access.h"
44 // when building wxUniv/Foo we don't want the code for native menu use to be
45 // compiled in - it should only be used when building real wxFoo
46 #ifdef __WXUNIVERSAL__
47 #define wxUSE_MENUS_NATIVE 0
48 #else // !__WXUNIVERSAL__
49 #define wxUSE_MENUS_NATIVE wxUSE_MENUS
50 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
53 // Define this macro if the corresponding operating system handles the state
54 // of children windows automatically when the parent is enabled/disabled.
55 // Otherwise wx itself must ensure that when the parent is disabled its
56 // children are disabled too, and their initial state is restored when the
57 // parent is enabled back.
58 #if defined(__WXMSW__) || defined(__WXPM__)
59 // must do everything ourselves
60 #undef wxHAS_NATIVE_ENABLED_MANAGEMENT
62 #define wxHAS_NATIVE_ENABLED_MANAGEMENT
65 // ----------------------------------------------------------------------------
66 // forward declarations
67 // ----------------------------------------------------------------------------
69 class WXDLLIMPEXP_FWD_CORE wxCaret
;
70 class WXDLLIMPEXP_FWD_CORE wxControl
;
71 class WXDLLIMPEXP_FWD_CORE wxCursor
;
72 class WXDLLIMPEXP_FWD_CORE wxDC
;
73 class WXDLLIMPEXP_FWD_CORE wxDropTarget
;
74 class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints
;
75 class WXDLLIMPEXP_FWD_CORE wxSizer
;
76 class WXDLLIMPEXP_FWD_CORE wxToolTip
;
77 class WXDLLIMPEXP_FWD_CORE wxWindowBase
;
78 class WXDLLIMPEXP_FWD_CORE wxWindow
;
79 class WXDLLIMPEXP_FWD_CORE wxScrollHelper
;
81 #if wxUSE_ACCESSIBILITY
82 class WXDLLIMPEXP_FWD_CORE wxAccessible
;
85 // ----------------------------------------------------------------------------
86 // helper stuff used by wxWindow
87 // ----------------------------------------------------------------------------
89 // struct containing all the visual attributes of a control
90 struct WXDLLIMPEXP_CORE wxVisualAttributes
92 // the font used for control label/text inside it
95 // the foreground colour
98 // the background colour, may be wxNullColour if the controls background
99 // colour is not solid
103 // different window variants, on platforms like eg mac uses different
107 wxWINDOW_VARIANT_NORMAL
, // Normal size
108 wxWINDOW_VARIANT_SMALL
, // Smaller size (about 25 % smaller than normal)
109 wxWINDOW_VARIANT_MINI
, // Mini size (about 33 % smaller than normal)
110 wxWINDOW_VARIANT_LARGE
, // Large size (about 25 % larger than normal)
114 #if wxUSE_SYSTEM_OPTIONS
115 #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
118 // valid values for Show/HideWithEffect()
121 wxSHOW_EFFECT_ROLL_TO_LEFT
,
122 wxSHOW_EFFECT_ROLL_TO_RIGHT
,
123 wxSHOW_EFFECT_ROLL_TO_TOP
,
124 wxSHOW_EFFECT_ROLL_TO_BOTTOM
,
125 wxSHOW_EFFECT_SLIDE_TO_LEFT
,
126 wxSHOW_EFFECT_SLIDE_TO_RIGHT
,
127 wxSHOW_EFFECT_SLIDE_TO_TOP
,
128 wxSHOW_EFFECT_SLIDE_TO_BOTTOM
,
130 wxSHOW_EFFECT_EXPAND
,
134 // flags for SendSizeEvent()
137 wxSEND_EVENT_POST
= 1
140 // ----------------------------------------------------------------------------
141 // (pseudo)template list classes
142 // ----------------------------------------------------------------------------
144 WX_DECLARE_LIST_3(wxWindow
, wxWindowBase
, wxWindowList
, wxWindowListNode
, class WXDLLIMPEXP_CORE
);
146 // ----------------------------------------------------------------------------
148 // ----------------------------------------------------------------------------
150 extern WXDLLIMPEXP_DATA_CORE(wxWindowList
) wxTopLevelWindows
;
151 extern WXDLLIMPEXP_DATA_CORE(wxList
) wxPendingDelete
;
153 // ----------------------------------------------------------------------------
154 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
155 // interface of this class.
157 // Event handler: windows have themselves as their event handlers by default,
158 // but their event handlers could be set to another object entirely. This
159 // separation can reduce the amount of derivation required, and allow
160 // alteration of a window's functionality (e.g. by a resource editor that
161 // temporarily switches event handlers).
162 // ----------------------------------------------------------------------------
164 class WXDLLIMPEXP_CORE wxWindowBase
: public wxEvtHandler
167 // creating the window
168 // -------------------
170 // default ctor, initializes everything which can be initialized before
174 // pseudo ctor (can't be virtual, called from ctor)
175 bool CreateBase(wxWindowBase
*parent
,
177 const wxPoint
& pos
= wxDefaultPosition
,
178 const wxSize
& size
= wxDefaultSize
,
180 const wxValidator
& validator
= wxDefaultValidator
,
181 const wxString
& name
= wxPanelNameStr
);
183 virtual ~wxWindowBase();
185 // deleting the window
186 // -------------------
188 // ask the window to close itself, return true if the event handler
189 // honoured our request
190 bool Close( bool force
= false );
192 // the following functions delete the C++ objects (the window itself
193 // or its children) as well as the GUI windows and normally should
194 // never be used directly
196 // delete window unconditionally (dangerous!), returns true if ok
197 virtual bool Destroy();
198 // delete all children of this window, returns true if ok
199 bool DestroyChildren();
201 // is the window being deleted?
202 bool IsBeingDeleted() const;
207 // label is just the same as the title (but for, e.g., buttons it
208 // makes more sense to speak about labels), title access
209 // is available from wxTLW classes only (frames, dialogs)
210 virtual void SetLabel(const wxString
& label
) = 0;
211 virtual wxString
GetLabel() const = 0;
213 // the window name is used for ressource setting in X, it is not the
214 // same as the window title/label
215 virtual void SetName( const wxString
&name
) { m_windowName
= name
; }
216 virtual wxString
GetName() const { return m_windowName
; }
218 // sets the window variant, calls internally DoSetVariant if variant
220 void SetWindowVariant(wxWindowVariant variant
);
221 wxWindowVariant
GetWindowVariant() const { return m_windowVariant
; }
224 // get or change the layout direction (LTR or RTL) for this window,
225 // wxLayout_Default is returned if layout direction is not supported
226 virtual wxLayoutDirection
GetLayoutDirection() const
227 { return wxLayout_Default
; }
228 virtual void SetLayoutDirection(wxLayoutDirection
WXUNUSED(dir
))
231 // mirror coordinates for RTL layout if this window uses it and if the
232 // mirroring is not done automatically like Win32
233 virtual wxCoord
AdjustForLayoutDirection(wxCoord x
,
235 wxCoord widthTotal
) const;
238 // window id uniquely identifies the window among its siblings unless
239 // it is wxID_ANY which means "don't care"
240 void SetId( wxWindowID winid
) { m_windowId
= winid
; }
241 wxWindowID
GetId() const { return m_windowId
; }
243 // generate a unique id (or count of them consecutively), returns a
244 // valid id in the auto-id range or wxID_NONE if failed. If using
245 // autoid management, it will mark the id as reserved until it is
246 // used (by assigning it to a wxWindowIDRef) or unreserved.
247 static wxWindowID
NewControlId(int count
= 1)
249 return wxIdManager::ReserveId(count
);
252 // If an ID generated from NewControlId is not assigned to a wxWindowIDRef,
253 // it must be unreserved
254 static void UnreserveControlId(wxWindowID id
, int count
= 1)
256 wxIdManager::UnreserveId(id
, count
);
263 // set the window size and/or position
264 void SetSize( int x
, int y
, int width
, int height
,
265 int sizeFlags
= wxSIZE_AUTO
)
266 { DoSetSize(x
, y
, width
, height
, sizeFlags
); }
268 void SetSize( int width
, int height
)
269 { DoSetSize( wxDefaultCoord
, wxDefaultCoord
, width
, height
, wxSIZE_USE_EXISTING
); }
271 void SetSize( const wxSize
& size
)
272 { SetSize( size
.x
, size
.y
); }
274 void SetSize(const wxRect
& rect
, int sizeFlags
= wxSIZE_AUTO
)
275 { DoSetSize(rect
.x
, rect
.y
, rect
.width
, rect
.height
, sizeFlags
); }
277 void Move(int x
, int y
, int flags
= wxSIZE_USE_EXISTING
)
278 { DoSetSize(x
, y
, wxDefaultCoord
, wxDefaultCoord
, flags
); }
280 void Move(const wxPoint
& pt
, int flags
= wxSIZE_USE_EXISTING
)
281 { Move(pt
.x
, pt
.y
, flags
); }
283 void SetPosition(const wxPoint
& pt
) { Move(pt
); }
286 virtual void Raise() = 0;
287 virtual void Lower() = 0;
289 // client size is the size of area available for subwindows
290 void SetClientSize( int width
, int height
)
291 { DoSetClientSize(width
, height
); }
293 void SetClientSize( const wxSize
& size
)
294 { DoSetClientSize(size
.x
, size
.y
); }
296 void SetClientSize(const wxRect
& rect
)
297 { SetClientSize( rect
.width
, rect
.height
); }
299 // get the window position (pointers may be NULL): notice that it is in
300 // client coordinates for child windows and screen coordinates for the
301 // top level ones, use GetScreenPosition() if you need screen
302 // coordinates for all kinds of windows
303 void GetPosition( int *x
, int *y
) const { DoGetPosition(x
, y
); }
304 wxPoint
GetPosition() const
307 DoGetPosition(&x
, &y
);
309 return wxPoint(x
, y
);
312 // get the window position in screen coordinates
313 void GetScreenPosition(int *x
, int *y
) const { DoGetScreenPosition(x
, y
); }
314 wxPoint
GetScreenPosition() const
317 DoGetScreenPosition(&x
, &y
);
319 return wxPoint(x
, y
);
322 // get the window size (pointers may be NULL)
323 void GetSize( int *w
, int *h
) const { DoGetSize(w
, h
); }
324 wxSize
GetSize() const
331 void GetClientSize( int *w
, int *h
) const { DoGetClientSize(w
, h
); }
332 wxSize
GetClientSize() const
335 DoGetClientSize(&w
, &h
);
340 // get the position and size at once
341 wxRect
GetRect() const
347 return wxRect(x
, y
, w
, h
);
350 wxRect
GetScreenRect() const
353 GetScreenPosition(&x
, &y
);
356 return wxRect(x
, y
, w
, h
);
359 // get the origin of the client area of the window relative to the
360 // window top left corner (the client area may be shifted because of
361 // the borders, scrollbars, other decorations...)
362 virtual wxPoint
GetClientAreaOrigin() const;
364 // get the client rectangle in window (i.e. client) coordinates
365 wxRect
GetClientRect() const
367 return wxRect(GetClientAreaOrigin(), GetClientSize());
370 // client<->window size conversion
371 virtual wxSize
ClientToWindowSize(const wxSize
& size
) const;
372 virtual wxSize
WindowToClientSize(const wxSize
& size
) const;
374 // get the size best suited for the window (in fact, minimal
375 // acceptable size using which it will still look "nice" in
377 wxSize
GetBestSize() const
379 if (m_bestSizeCache
.IsFullySpecified())
380 return m_bestSizeCache
;
381 return DoGetBestSize();
383 void GetBestSize(int *w
, int *h
) const
385 wxSize s
= GetBestSize();
392 void SetScrollHelper( wxScrollHelper
*sh
) { m_scrollHelper
= sh
; }
393 wxScrollHelper
*GetScrollHelper() { return m_scrollHelper
; }
395 // reset the cached best size value so it will be recalculated the
396 // next time it is needed.
397 void InvalidateBestSize();
398 void CacheBestSize(const wxSize
& size
) const
399 { wxConstCast(this, wxWindowBase
)->m_bestSizeCache
= size
; }
402 // This function will merge the window's best size into the window's
403 // minimum size, giving priority to the min size components, and
404 // returns the results.
405 virtual wxSize
GetEffectiveMinSize() const;
406 wxDEPRECATED( wxSize
GetBestFittingSize() const ); // replaced by GetEffectiveMinSize
407 wxDEPRECATED( wxSize
GetAdjustedMinSize() const ); // replaced by GetEffectiveMinSize
409 // A 'Smart' SetSize that will fill in default size values with 'best'
410 // size. Sets the minsize to what was passed in.
411 void SetInitialSize(const wxSize
& size
=wxDefaultSize
);
412 wxDEPRECATED( void SetBestFittingSize(const wxSize
& size
=wxDefaultSize
) ); // replaced by SetInitialSize
415 // the generic centre function - centers the window on parent by`
416 // default or on screen if it doesn't have parent or
417 // wxCENTER_ON_SCREEN flag is given
418 void Centre(int dir
= wxBOTH
) { DoCentre(dir
); }
419 void Center(int dir
= wxBOTH
) { DoCentre(dir
); }
421 // centre with respect to the the parent window
422 void CentreOnParent(int dir
= wxBOTH
) { DoCentre(dir
); }
423 void CenterOnParent(int dir
= wxBOTH
) { CentreOnParent(dir
); }
425 // set window size to wrap around its children
428 // set virtual size to satisfy children
429 virtual void FitInside();
432 // SetSizeHints is actually for setting the size hints
433 // for the wxTLW for a Window Manager - hence the name -
434 // and it is therefore overridden in wxTLW to do that.
435 // In wxWindow(Base), it has (unfortunately) been abused
436 // to mean the same as SetMinSize() and SetMaxSize().
438 virtual void SetSizeHints( int minW
, int minH
,
439 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
,
440 int incW
= wxDefaultCoord
, int incH
= wxDefaultCoord
)
441 { DoSetSizeHints(minW
, minH
, maxW
, maxH
, incW
, incH
); }
443 void SetSizeHints( const wxSize
& minSize
,
444 const wxSize
& maxSize
=wxDefaultSize
,
445 const wxSize
& incSize
=wxDefaultSize
)
446 { DoSetSizeHints(minSize
.x
, minSize
.y
, maxSize
.x
, maxSize
.y
, incSize
.x
, incSize
.y
); }
449 #if WXWIN_COMPATIBILITY_2_8
450 // these are useless and do nothing since wxWidgets 2.9
451 wxDEPRECATED( virtual void SetVirtualSizeHints( int minW
, int minH
,
452 int maxW
= wxDefaultCoord
, int maxH
= wxDefaultCoord
) );
453 wxDEPRECATED( void SetVirtualSizeHints( const wxSize
& minSize
,
454 const wxSize
& maxSize
=wxDefaultSize
) );
455 #endif // WXWIN_COMPATIBILITY_2_8
458 // Call these to override what GetBestSize() returns. This
459 // method is only virtual because it is overriden in wxTLW
460 // as a different API for SetSizeHints().
461 virtual void SetMinSize(const wxSize
& minSize
) { m_minWidth
= minSize
.x
; m_minHeight
= minSize
.y
; }
462 virtual void SetMaxSize(const wxSize
& maxSize
) { m_maxWidth
= maxSize
.x
; m_maxHeight
= maxSize
.y
; }
464 // Like Set*Size, but for client, not window, size
465 virtual void SetMinClientSize(const wxSize
& size
)
466 { SetMinSize(ClientToWindowSize(size
)); }
467 virtual void SetMaxClientSize(const wxSize
& size
)
468 { SetMaxSize(ClientToWindowSize(size
)); }
470 // Override these methods to impose restrictions on min/max size.
471 // The easier way is to call SetMinSize() and SetMaxSize() which
472 // will have the same effect. Doing both is non-sense.
473 virtual wxSize
GetMinSize() const { return wxSize(m_minWidth
, m_minHeight
); }
474 virtual wxSize
GetMaxSize() const { return wxSize(m_maxWidth
, m_maxHeight
); }
476 // Like Get*Size, but for client, not window, size
477 virtual wxSize
GetMinClientSize() const
478 { return WindowToClientSize(GetMinSize()); }
479 virtual wxSize
GetMaxClientSize() const
480 { return WindowToClientSize(GetMaxSize()); }
482 // Get the min and max values one by one
483 int GetMinWidth() const { return GetMinSize().x
; }
484 int GetMinHeight() const { return GetMinSize().y
; }
485 int GetMaxWidth() const { return GetMaxSize().x
; }
486 int GetMaxHeight() const { return GetMaxSize().y
; }
489 // Methods for accessing the virtual size of a window. For most
490 // windows this is just the client area of the window, but for
491 // some like scrolled windows it is more or less independent of
492 // the screen window size. You may override the DoXXXVirtual
493 // methods below for classes where that is is the case.
495 void SetVirtualSize( const wxSize
&size
) { DoSetVirtualSize( size
.x
, size
.y
); }
496 void SetVirtualSize( int x
, int y
) { DoSetVirtualSize( x
, y
); }
498 wxSize
GetVirtualSize() const { return DoGetVirtualSize(); }
499 void GetVirtualSize( int *x
, int *y
) const
501 wxSize
s( DoGetVirtualSize() );
509 // Override these methods for windows that have a virtual size
510 // independent of their client size. eg. the virtual area of a
513 virtual void DoSetVirtualSize( int x
, int y
);
514 virtual wxSize
DoGetVirtualSize() const;
516 // Return the largest of ClientSize and BestSize (as determined
517 // by a sizer, interior children, or other means)
519 virtual wxSize
GetBestVirtualSize() const
521 wxSize
client( GetClientSize() );
522 wxSize
best( GetBestSize() );
524 return wxSize( wxMax( client
.x
, best
.x
), wxMax( client
.y
, best
.y
) );
527 // return the size of the left/right and top/bottom borders in x and y
528 // components of the result respectively
529 virtual wxSize
GetWindowBorderSize() const;
531 // wxSizer and friends use this to give a chance to a component to recalc
532 // its min size once one of the final size components is known. Override
533 // this function when that is useful (such as for wxStaticText which can
534 // stretch over several lines). Parameter availableOtherDir
535 // tells the item how much more space there is available in the opposite
536 // direction (-1 if unknown).
538 InformFirstDirection(int WXUNUSED(direction
),
540 int WXUNUSED(availableOtherDir
))
545 // sends a size event to the window using its current size -- this has an
546 // effect of refreshing the window layout
548 // by default the event is sent, i.e. processed immediately, but if flags
549 // value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule
550 // for later processing
551 virtual void SendSizeEvent(int flags
= 0);
553 // this is a safe wrapper for GetParent()->SendSizeEvent(): it checks that
554 // we have a parent window and it's not in process of being deleted
556 // this is used by controls such as tool/status bars changes to which must
557 // also result in parent re-layout
558 void SendSizeEventToParent(int flags
= 0);
560 // this is a more readable synonym for SendSizeEvent(wxSEND_EVENT_POST)
561 void PostSizeEvent() { SendSizeEvent(wxSEND_EVENT_POST
); }
563 // this is the same as SendSizeEventToParent() but using PostSizeEvent()
564 void PostSizeEventToParent() { SendSizeEventToParent(wxSEND_EVENT_POST
); }
570 // returns true if window was shown/hidden, false if the nothing was
571 // done (window was already shown/hidden)
572 virtual bool Show( bool show
= true );
573 bool Hide() { return Show(false); }
575 // show or hide the window with a special effect, not implemented on
576 // most platforms (where it is the same as Show()/Hide() respectively)
578 // timeout specifies how long the animation should take, in ms, the
579 // default value of 0 means to use the default (system-dependent) value
580 virtual bool ShowWithEffect(wxShowEffect
WXUNUSED(effect
),
581 unsigned WXUNUSED(timeout
) = 0)
586 virtual bool HideWithEffect(wxShowEffect
WXUNUSED(effect
),
587 unsigned WXUNUSED(timeout
) = 0)
592 // returns true if window was enabled/disabled, false if nothing done
593 virtual bool Enable( bool enable
= true );
594 bool Disable() { return Enable(false); }
596 virtual bool IsShown() const { return m_isShown
; }
597 // returns true if the window is really enabled and false otherwise,
598 // whether because it had been explicitly disabled itself or because
599 // its parent is currently disabled -- then this method returns false
600 // whatever is the intrinsic state of this window, use IsThisEnabled(0
601 // to retrieve it. In other words, this relation always holds:
603 // IsEnabled() == IsThisEnabled() && parent.IsEnabled()
605 bool IsEnabled() const;
607 // returns the internal window state independently of the parent(s)
608 // state, i.e. the state in which the window would be if all its
609 // parents were enabled (use IsEnabled() above to get the effective
611 bool IsThisEnabled() const { return m_isEnabled
; }
613 // returns true if the window is visible, i.e. IsShown() returns true
614 // if called on it and all its parents up to the first TLW
615 virtual bool IsShownOnScreen() const;
617 // get/set window style (setting style won't update the window and so
618 // is only useful for internal usage)
619 virtual void SetWindowStyleFlag( long style
) { m_windowStyle
= style
; }
620 virtual long GetWindowStyleFlag() const { return m_windowStyle
; }
622 // just some (somewhat shorter) synonims
623 void SetWindowStyle( long style
) { SetWindowStyleFlag(style
); }
624 long GetWindowStyle() const { return GetWindowStyleFlag(); }
626 // check if the flag is set
627 bool HasFlag(int flag
) const { return (m_windowStyle
& flag
) != 0; }
628 virtual bool IsRetained() const { return HasFlag(wxRETAINED
); }
630 // turn the flag on if it had been turned off before and vice versa,
631 // return true if the flag is currently turned on
632 bool ToggleWindowStyle(int flag
);
634 // extra style: the less often used style bits which can't be set with
635 // SetWindowStyleFlag()
636 virtual void SetExtraStyle(long exStyle
) { m_exStyle
= exStyle
; }
637 long GetExtraStyle() const { return m_exStyle
; }
639 bool HasExtraStyle(int exFlag
) const { return (m_exStyle
& exFlag
) != 0; }
641 // make the window modal (all other windows unresponsive)
642 virtual void MakeModal(bool modal
= true);
645 // (primitive) theming support
646 // ---------------------------
648 virtual void SetThemeEnabled(bool enableTheme
) { m_themeEnabled
= enableTheme
; }
649 virtual bool GetThemeEnabled() const { return m_themeEnabled
; }
652 // focus and keyboard handling
653 // ---------------------------
655 // set focus to this window
656 virtual void SetFocus() = 0;
658 // set focus to this window as the result of a keyboard action
659 virtual void SetFocusFromKbd() { SetFocus(); }
661 // return the window which currently has the focus or NULL
662 static wxWindow
*FindFocus();
664 static wxWindow
*DoFindFocus() /* = 0: implement in derived classes */;
666 // return true if the window has focus (handles composite windows
667 // correctly - returns true if GetMainWindowOfCompositeControl()
669 virtual bool HasFocus() const;
671 // can this window have focus in principle?
673 // the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus
674 // [FromKeyboard]() is that the former functions are meant to be
675 // overridden in the derived classes to simply return false if the
676 // control can't have focus, while the latter are meant to be used by
677 // this class clients and take into account the current window state
678 virtual bool AcceptsFocus() const { return true; }
680 // can this window or one of its children accept focus?
682 // usually it's the same as AcceptsFocus() but is overridden for
684 virtual bool AcceptsFocusRecursively() const { return AcceptsFocus(); }
686 // can this window be given focus by keyboard navigation? if not, the
687 // only way to give it focus (provided it accepts it at all) is to
689 virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
692 // this is mostly a helper for the various functions using it below
693 bool CanBeFocused() const { return IsShown() && IsEnabled(); }
695 // can this window itself have focus?
696 bool IsFocusable() const { return AcceptsFocus() && CanBeFocused(); }
698 // can this window have focus right now?
700 // if this method returns true, it means that calling SetFocus() will
701 // put focus either to this window or one of its children, if you need
702 // to know whether this window accepts focus itself, use IsFocusable()
703 bool CanAcceptFocus() const
704 { return AcceptsFocusRecursively() && CanBeFocused(); }
706 // can this window be assigned focus from keyboard right now?
707 bool CanAcceptFocusFromKeyboard() const
708 { return AcceptsFocusFromKeyboard() && CanBeFocused(); }
710 // call this when the return value of AcceptsFocus() changes
711 virtual void SetCanFocus(bool WXUNUSED(canFocus
)) { }
713 // navigates inside this window
714 bool NavigateIn(int flags
= wxNavigationKeyEvent::IsForward
)
715 { return DoNavigateIn(flags
); }
717 // navigates in the specified direction from this window, this is
718 // equivalent to GetParent()->NavigateIn()
719 bool Navigate(int flags
= wxNavigationKeyEvent::IsForward
)
720 { return m_parent
&& ((wxWindowBase
*)m_parent
)->DoNavigateIn(flags
); }
722 // this function will generate the appropriate call to Navigate() if the
723 // key event is one normally used for keyboard navigation and return true
725 bool HandleAsNavigationKey(const wxKeyEvent
& event
);
727 // move this window just before/after the specified one in tab order
728 // (the other window must be our sibling!)
729 void MoveBeforeInTabOrder(wxWindow
*win
)
730 { DoMoveInTabOrder(win
, OrderBefore
); }
731 void MoveAfterInTabOrder(wxWindow
*win
)
732 { DoMoveInTabOrder(win
, OrderAfter
); }
735 // parent/children relations
736 // -------------------------
738 // get the list of children
739 const wxWindowList
& GetChildren() const { return m_children
; }
740 wxWindowList
& GetChildren() { return m_children
; }
742 // needed just for extended runtime
743 const wxWindowList
& GetWindowChildren() const { return GetChildren() ; }
745 // get the window before/after this one in the parents children list,
746 // returns NULL if this is the first/last window
747 wxWindow
*GetPrevSibling() const { return DoGetSibling(OrderBefore
); }
748 wxWindow
*GetNextSibling() const { return DoGetSibling(OrderAfter
); }
750 // get the parent or the parent of the parent
751 wxWindow
*GetParent() const { return m_parent
; }
752 inline wxWindow
*GetGrandParent() const;
754 // is this window a top level one?
755 virtual bool IsTopLevel() const;
757 // it doesn't really change parent, use Reparent() instead
758 void SetParent( wxWindowBase
*parent
) { m_parent
= (wxWindow
*)parent
; }
759 // change the real parent of this window, return true if the parent
760 // was changed, false otherwise (error or newParent == oldParent)
761 virtual bool Reparent( wxWindowBase
*newParent
);
763 // implementation mostly
764 virtual void AddChild( wxWindowBase
*child
);
765 virtual void RemoveChild( wxWindowBase
*child
);
767 // returns true if the child is in the client area of the window, i.e. is
768 // not scrollbar, toolbar etc.
769 virtual bool IsClientAreaChild(const wxWindow
*WXUNUSED(child
)) const
772 // looking for windows
773 // -------------------
775 // find window among the descendants of this one either by id or by
776 // name (return NULL if not found)
777 wxWindow
*FindWindow(long winid
) const;
778 wxWindow
*FindWindow(const wxString
& name
) const;
780 // Find a window among any window (all return NULL if not found)
781 static wxWindow
*FindWindowById( long winid
, const wxWindow
*parent
= NULL
);
782 static wxWindow
*FindWindowByName( const wxString
& name
,
783 const wxWindow
*parent
= NULL
);
784 static wxWindow
*FindWindowByLabel( const wxString
& label
,
785 const wxWindow
*parent
= NULL
);
787 // event handler stuff
788 // -------------------
790 // get the current event handler
791 wxEvtHandler
*GetEventHandler() const { return m_eventHandler
; }
793 // replace the event handler (allows to completely subclass the
795 void SetEventHandler( wxEvtHandler
*handler
);
797 // push/pop event handler: allows to chain a custom event handler to
798 // alreasy existing ones
799 void PushEventHandler( wxEvtHandler
*handler
);
800 wxEvtHandler
*PopEventHandler( bool deleteHandler
= false );
802 // find the given handler in the event handler chain and remove (but
803 // not delete) it from the event handler chain, return true if it was
804 // found and false otherwise (this also results in an assert failure so
805 // this function should only be called when the handler is supposed to
807 bool RemoveEventHandler(wxEvtHandler
*handler
);
809 // Process an event by calling GetEventHandler()->ProcessEvent(): this
810 // is a straightforward replacement for ProcessEvent() itself which
811 // shouldn't be used directly with windows as it doesn't take into
812 // account any event handlers associated with the window
813 bool ProcessWindowEvent(wxEvent
& event
)
814 { return GetEventHandler()->ProcessEvent(event
); }
816 // Process an event by calling GetEventHandler()->ProcessEvent() and
817 // handling any exceptions thrown by event handlers. It's mostly useful
818 // when processing wx events when called from C code (e.g. in GTK+
819 // callback) when the exception wouldn't correctly propagate to
821 bool HandleWindowEvent(wxEvent
& event
) const;
823 // disable wxEvtHandler double-linked list mechanism:
824 virtual void SetNextHandler(wxEvtHandler
*handler
);
825 virtual void SetPreviousHandler(wxEvtHandler
*handler
);
829 // NOTE: we change the access specifier of the following wxEvtHandler functions
830 // so that the user won't be able to call them directly.
831 // Calling wxWindow::ProcessEvent in fact only works when there are NO
832 // event handlers pushed on the window.
833 // To ensure correct operation, instead of wxWindow::ProcessEvent
834 // you must always call wxWindow::GetEventHandler()->ProcessEvent()
835 // or HandleWindowEvent().
836 // The same holds for all other wxEvtHandler functions.
838 using wxEvtHandler::ProcessEvent
;
839 using wxEvtHandler::ProcessThreadEvent
;
840 using wxEvtHandler::SafelyProcessEvent
;
841 using wxEvtHandler::ProcessPendingEvents
;
842 using wxEvtHandler::AddPendingEvent
;
843 using wxEvtHandler::QueueEvent
;
851 // a window may have an associated validator which is used to control
853 virtual void SetValidator( const wxValidator
&validator
);
854 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
855 #endif // wxUSE_VALIDATORS
858 // dialog oriented functions
859 // -------------------------
861 // validate the correctness of input, return true if ok
862 virtual bool Validate();
864 // transfer data between internal and GUI representations
865 virtual bool TransferDataToWindow();
866 virtual bool TransferDataFromWindow();
868 virtual void InitDialog();
873 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
874 { m_acceleratorTable
= accel
; }
875 wxAcceleratorTable
*GetAcceleratorTable()
876 { return &m_acceleratorTable
; }
878 #endif // wxUSE_ACCEL
881 // hot keys (system wide accelerators)
882 // -----------------------------------
884 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
885 virtual bool UnregisterHotKey(int hotkeyId
);
886 #endif // wxUSE_HOTKEY
889 // dialog units translations
890 // -------------------------
892 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
893 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
894 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
896 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
898 return wxSize(pt
.x
, pt
.y
);
901 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
903 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
905 return wxSize(pt
.x
, pt
.y
);
911 // move the mouse to the specified position
912 virtual void WarpPointer(int x
, int y
) = 0;
914 // start or end mouse capture, these functions maintain the stack of
915 // windows having captured the mouse and after calling ReleaseMouse()
916 // the mouse is not released but returns to the window which had had
917 // captured it previously (if any)
921 // get the window which currently captures the mouse or NULL
922 static wxWindow
*GetCapture();
924 // does this window have the capture?
925 virtual bool HasCapture() const
926 { return (wxWindow
*)this == GetCapture(); }
928 // painting the window
929 // -------------------
931 // mark the specified rectangle (or the whole window) as "dirty" so it
933 virtual void Refresh( bool eraseBackground
= true,
934 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
936 // a less awkward wrapper for Refresh
937 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true)
939 Refresh(eraseBackground
, &rect
);
942 // repaint all invalid areas of the window immediately
943 virtual void Update() { }
945 // clear the window background
946 virtual void ClearBackground();
948 // freeze the window: don't redraw it until it is thawed
951 // thaw the window: redraw it after it had been frozen
954 // return true if window had been frozen and not unthawed yet
955 bool IsFrozen() const { return m_freezeCount
!= 0; }
957 // adjust DC for drawing on this window
958 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
960 // return true if the window contents is double buffered by the system
961 virtual bool IsDoubleBuffered() const { return false; }
963 // the update region of the window contains the areas which must be
964 // repainted by the program
965 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
966 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
968 // get the update rectangleregion bounding box in client coords
969 wxRect
GetUpdateClientRect() const;
971 // these functions verify whether the given point/rectangle belongs to
972 // (or at least intersects with) the update region
973 virtual bool DoIsExposed( int x
, int y
) const;
974 virtual bool DoIsExposed( int x
, int y
, int w
, int h
) const;
976 bool IsExposed( int x
, int y
) const
977 { return DoIsExposed(x
, y
); }
978 bool IsExposed( int x
, int y
, int w
, int h
) const
979 { return DoIsExposed(x
, y
, w
, h
); }
980 bool IsExposed( const wxPoint
& pt
) const
981 { return DoIsExposed(pt
.x
, pt
.y
); }
982 bool IsExposed( const wxRect
& rect
) const
983 { return DoIsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
985 // colours, fonts and cursors
986 // --------------------------
988 // get the default attributes for the controls of this class: we
989 // provide a virtual function which can be used to query the default
990 // attributes of an existing control and a static function which can
991 // be used even when no existing object of the given class is
992 // available, but which won't return any styles specific to this
993 // particular control, of course (e.g. "Ok" button might have
994 // different -- bold for example -- font)
995 virtual wxVisualAttributes
GetDefaultAttributes() const
997 return GetClassDefaultAttributes(GetWindowVariant());
1000 static wxVisualAttributes
1001 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
1003 // set/retrieve the window colours (system defaults are used by
1004 // default): SetXXX() functions return true if colour was changed,
1005 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
1006 // value to prevent it from being inherited by our children
1007 virtual bool SetBackgroundColour(const wxColour
& colour
);
1008 void SetOwnBackgroundColour(const wxColour
& colour
)
1010 if ( SetBackgroundColour(colour
) )
1011 m_inheritBgCol
= false;
1013 wxColour
GetBackgroundColour() const;
1014 bool InheritsBackgroundColour() const
1016 return m_inheritBgCol
;
1018 bool UseBgCol() const
1023 virtual bool SetForegroundColour(const wxColour
& colour
);
1024 void SetOwnForegroundColour(const wxColour
& colour
)
1026 if ( SetForegroundColour(colour
) )
1027 m_inheritFgCol
= false;
1029 wxColour
GetForegroundColour() const;
1031 // Set/get the background style.
1032 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1033 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) { m_backgroundStyle
= style
; return true; }
1034 virtual wxBackgroundStyle
GetBackgroundStyle() const { return m_backgroundStyle
; }
1036 // returns true if the control has "transparent" areas such as a
1037 // wxStaticText and wxCheckBox and the background should be adapted
1038 // from a parent window
1039 virtual bool HasTransparentBackground() { return false; }
1041 // set/retrieve the font for the window (SetFont() returns true if the
1042 // font really changed)
1043 virtual bool SetFont(const wxFont
& font
) = 0;
1044 void SetOwnFont(const wxFont
& font
)
1046 if ( SetFont(font
) )
1047 m_inheritFont
= false;
1049 wxFont
GetFont() const;
1051 // set/retrieve the cursor for this window (SetCursor() returns true
1052 // if the cursor was really changed)
1053 virtual bool SetCursor( const wxCursor
&cursor
);
1054 const wxCursor
& GetCursor() const { return m_cursor
; }
1057 // associate a caret with the window
1058 void SetCaret(wxCaret
*caret
);
1059 // get the current caret (may be NULL)
1060 wxCaret
*GetCaret() const { return m_caret
; }
1061 #endif // wxUSE_CARET
1063 // get the (average) character size for the current font
1064 virtual int GetCharHeight() const = 0;
1065 virtual int GetCharWidth() const = 0;
1067 // get the width/height/... of the text using current or specified
1069 virtual void GetTextExtent(const wxString
& string
,
1071 int *descent
= NULL
,
1072 int *externalLeading
= NULL
,
1073 const wxFont
*theFont
= (const wxFont
*) NULL
)
1076 wxSize
GetTextExtent(const wxString
& string
) const
1079 GetTextExtent(string
, &w
, &h
);
1080 return wxSize(w
, h
);
1083 // client <-> screen coords
1084 // ------------------------
1086 // translate to/from screen/client coordinates (pointers may be NULL)
1087 void ClientToScreen( int *x
, int *y
) const
1088 { DoClientToScreen(x
, y
); }
1089 void ScreenToClient( int *x
, int *y
) const
1090 { DoScreenToClient(x
, y
); }
1092 // wxPoint interface to do the same thing
1093 wxPoint
ClientToScreen(const wxPoint
& pt
) const
1095 int x
= pt
.x
, y
= pt
.y
;
1096 DoClientToScreen(&x
, &y
);
1098 return wxPoint(x
, y
);
1101 wxPoint
ScreenToClient(const wxPoint
& pt
) const
1103 int x
= pt
.x
, y
= pt
.y
;
1104 DoScreenToClient(&x
, &y
);
1106 return wxPoint(x
, y
);
1109 // test where the given (in client coords) point lies
1110 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
1111 { return DoHitTest(x
, y
); }
1113 wxHitTest
HitTest(const wxPoint
& pt
) const
1114 { return DoHitTest(pt
.x
, pt
.y
); }
1119 // get the window border style from the given flags: this is different from
1120 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
1121 // translate wxBORDER_DEFAULT to something reasonable
1122 wxBorder
GetBorder(long flags
) const;
1124 // get border for the flags of this window
1125 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
1127 // send wxUpdateUIEvents to this window, and children if recurse is true
1128 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
1130 // do the window-specific processing after processing the update event
1131 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
1134 // show popup menu at the given position, generate events for the items
1136 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
1137 { return PopupMenu(menu
, pos
.x
, pos
.y
); }
1138 bool PopupMenu(wxMenu
*menu
, int x
, int y
);
1140 // simply return the id of the selected item or wxID_NONE without
1141 // generating any events
1142 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, const wxPoint
& pos
)
1143 { return DoGetPopupMenuSelectionFromUser(menu
, pos
.x
, pos
.y
); }
1144 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
1145 { return DoGetPopupMenuSelectionFromUser(menu
, x
, y
); }
1146 #endif // wxUSE_MENUS
1148 // override this method to return true for controls having multiple pages
1149 virtual bool HasMultiplePages() const { return false; }
1155 // does the window have the scrollbar for this orientation?
1156 bool HasScrollbar(int orient
) const
1158 return (m_windowStyle
&
1159 (orient
== wxHORIZONTAL
? wxHSCROLL
: wxVSCROLL
)) != 0;
1162 // configure the window scrollbars
1163 virtual void SetScrollbar( int orient
,
1167 bool refresh
= true ) = 0;
1168 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
1169 virtual int GetScrollPos( int orient
) const = 0;
1170 virtual int GetScrollThumb( int orient
) const = 0;
1171 virtual int GetScrollRange( int orient
) const = 0;
1173 // scroll window to the specified position
1174 virtual void ScrollWindow( int dx
, int dy
,
1175 const wxRect
* rect
= NULL
) = 0;
1177 // scrolls window by line/page: note that not all controls support this
1179 // return true if the position changed, false otherwise
1180 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
1181 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
1183 // convenient wrappers for ScrollLines/Pages
1184 bool LineUp() { return ScrollLines(-1); }
1185 bool LineDown() { return ScrollLines(1); }
1186 bool PageUp() { return ScrollPages(-1); }
1187 bool PageDown() { return ScrollPages(1); }
1189 // call this to always show one or both scrollbars, even if the window
1190 // is big enough to not require them
1191 virtual void AlwaysShowScrollbars(bool WXUNUSED(horz
) = true,
1192 bool WXUNUSED(vert
) = true)
1196 // return true if AlwaysShowScrollbars() had been called before for the
1197 // corresponding orientation
1198 virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient
)) const
1203 // context-sensitive help
1204 // ----------------------
1206 // these are the convenience functions wrapping wxHelpProvider methods
1209 // associate this help text with this window
1210 void SetHelpText(const wxString
& text
);
1212 #if WXWIN_COMPATIBILITY_2_8
1213 // Associate this help text with all windows with the same id as this one.
1214 // Don't use this, do wxHelpProvider::Get()->AddHelp(id, text);
1215 wxDEPRECATED( void SetHelpTextForId(const wxString
& text
) );
1216 #endif // WXWIN_COMPATIBILITY_2_8
1218 // get the help string associated with the given position in this window
1220 // notice that pt may be invalid if event origin is keyboard or unknown
1221 // and this method should return the global window help text then
1222 virtual wxString
GetHelpTextAtPoint(const wxPoint
& pt
,
1223 wxHelpEvent::Origin origin
) const;
1224 // returns the position-independent help text
1225 wxString
GetHelpText() const
1227 return GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Unknown
);
1230 #else // !wxUSE_HELP
1231 // silently ignore SetHelpText() calls
1232 void SetHelpText(const wxString
& WXUNUSED(text
)) { }
1233 void SetHelpTextForId(const wxString
& WXUNUSED(text
)) { }
1234 #endif // wxUSE_HELP
1240 // the easiest way to set a tooltip for a window is to use this method
1241 void SetToolTip( const wxString
&tip
);
1242 // attach a tooltip to the window, pointer can be NULL to remove
1244 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
1245 // more readable synonym for SetToolTip(NULL)
1246 void UnsetToolTip() { SetToolTip(NULL
); }
1247 // get the associated tooltip or NULL if none
1248 wxToolTip
* GetToolTip() const { return m_tooltip
; }
1249 wxString
GetToolTipText() const;
1250 #else // !wxUSE_TOOLTIPS
1251 // make it much easier to compile apps in an environment
1252 // that doesn't support tooltips, such as PocketPC
1253 void SetToolTip(const wxString
& WXUNUSED(tip
)) { }
1254 void UnsetToolTip() { }
1255 #endif // wxUSE_TOOLTIPS/!wxUSE_TOOLTIPS
1259 #if wxUSE_DRAG_AND_DROP
1260 // set/retrieve the drop target associated with this window (may be
1261 // NULL; it's owned by the window and will be deleted by it)
1262 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
1263 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
1265 // Accept files for dragging
1266 virtual void DragAcceptFiles(bool accept
)
1268 // it does have common implementation but not for MSW which has its own
1269 // native version of it
1274 #endif // wxUSE_DRAG_AND_DROP
1276 // constraints and sizers
1277 // ----------------------
1278 #if wxUSE_CONSTRAINTS
1279 // set the constraints for this window or retrieve them (may be NULL)
1280 void SetConstraints( wxLayoutConstraints
*constraints
);
1281 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
1283 // implementation only
1284 void UnsetConstraints(wxLayoutConstraints
*c
);
1285 wxWindowList
*GetConstraintsInvolvedIn() const
1286 { return m_constraintsInvolvedIn
; }
1287 void AddConstraintReference(wxWindowBase
*otherWin
);
1288 void RemoveConstraintReference(wxWindowBase
*otherWin
);
1289 void DeleteRelatedConstraints();
1290 void ResetConstraints();
1292 // these methods may be overridden for special layout algorithms
1293 virtual void SetConstraintSizes(bool recurse
= true);
1294 virtual bool LayoutPhase1(int *noChanges
);
1295 virtual bool LayoutPhase2(int *noChanges
);
1296 virtual bool DoPhase(int phase
);
1298 // these methods are virtual but normally won't be overridden
1299 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
1300 virtual void MoveConstraint(int x
, int y
);
1301 virtual void GetSizeConstraint(int *w
, int *h
) const ;
1302 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
1303 virtual void GetPositionConstraint(int *x
, int *y
) const ;
1305 #endif // wxUSE_CONSTRAINTS
1307 // when using constraints or sizers, it makes sense to update
1308 // children positions automatically whenever the window is resized
1309 // - this is done if autoLayout is on
1310 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
1311 bool GetAutoLayout() const { return m_autoLayout
; }
1313 // lay out the window and its children
1314 virtual bool Layout();
1317 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
1318 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
1320 wxSizer
*GetSizer() const { return m_windowSizer
; }
1322 // Track if this window is a member of a sizer
1323 void SetContainingSizer(wxSizer
* sizer
);
1324 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1327 // ----------------------
1328 #if wxUSE_ACCESSIBILITY
1329 // Override to create a specific accessible object.
1330 virtual wxAccessible
* CreateAccessible();
1332 // Sets the accessible object.
1333 void SetAccessible(wxAccessible
* accessible
) ;
1335 // Returns the accessible object.
1336 wxAccessible
* GetAccessible() { return m_accessible
; }
1338 // Returns the accessible object, creating if necessary.
1339 wxAccessible
* GetOrCreateAccessible() ;
1343 // Set window transparency if the platform supports it
1344 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
)) { return false; }
1345 virtual bool CanSetTransparent() { return false; }
1352 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1353 void OnInitDialog( wxInitDialogEvent
&event
);
1354 void OnMiddleClick( wxMouseEvent
& event
);
1356 void OnHelp(wxHelpEvent
& event
);
1357 #endif // wxUSE_HELP
1359 // virtual function for implementing internal idle
1361 virtual void OnInternalIdle() {}
1363 // call internal idle recursively
1364 // void ProcessInternalIdle() ;
1366 // get the handle of the window for the underlying window system: this
1367 // is only used for wxWin itself or for user code which wants to call
1368 // platform-specific APIs
1369 virtual WXWidget
GetHandle() const = 0;
1370 // associate the window with a new native handle
1371 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1372 // dissociate the current native handle from the window
1373 virtual void DissociateHandle() { }
1376 // Store the palette used by DCs in wxWindow so that the dcs can share
1377 // a palette. And we can respond to palette messages.
1378 wxPalette
GetPalette() const { return m_palette
; }
1380 // When palette is changed tell the DC to set the system palette to the
1382 void SetPalette(const wxPalette
& pal
);
1384 // return true if we have a specific palette
1385 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1387 // return the first parent window with a custom palette or NULL
1388 wxWindow
*GetAncestorWithCustomPalette() const;
1389 #endif // wxUSE_PALETTE
1391 // inherit the parents visual attributes if they had been explicitly set
1392 // by the user (i.e. we don't inherit default attributes) and if we don't
1393 // have our own explicitly set
1394 virtual void InheritAttributes();
1396 // returns false from here if this window doesn't want to inherit the
1397 // parents colours even if InheritAttributes() would normally do it
1399 // this just provides a simple way to customize InheritAttributes()
1400 // behaviour in the most common case
1401 virtual bool ShouldInheritColours() const { return false; }
1403 // returns true if the window can be positioned outside of parent's client
1404 // area (normal windows can't, but e.g. menubar or statusbar can):
1405 virtual bool CanBeOutsideClientArea() const { return false; }
1407 // returns true if the platform should explicitly apply a theme border. Currently
1408 // used only by Windows
1409 virtual bool CanApplyThemeBorder() const { return true; }
1412 // event handling specific to wxWindow
1413 virtual bool TryValidator(wxEvent
& event
);
1414 virtual bool TryParent(wxEvent
& event
);
1418 OrderBefore
, // insert before the given window
1419 OrderAfter
// insert after the given window
1422 // common part of GetPrev/NextSibling()
1423 wxWindow
*DoGetSibling(WindowOrder order
) const;
1425 // common part of MoveBefore/AfterInTabOrder()
1426 virtual void DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
);
1428 // implementation of Navigate() and NavigateIn()
1429 virtual bool DoNavigateIn(int flags
);
1431 #if wxUSE_CONSTRAINTS
1432 // satisfy the constraints for the windows but don't set the window sizes
1433 void SatisfyConstraints();
1434 #endif // wxUSE_CONSTRAINTS
1436 // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
1438 void SendDestroyEvent();
1440 // returns the main window of composite control; this is the window
1441 // that FindFocus returns if the focus is in one of composite control's
1443 virtual wxWindow
*GetMainWindowOfCompositeControl()
1444 { return (wxWindow
*)this; }
1446 // this method should be implemented to use operating system specific code
1447 // to really enable/disable the widget, it will only be called when we
1448 // really need to enable/disable window and so no additional checks on the
1449 // widgets state are necessary
1450 virtual void DoEnable(bool WXUNUSED(enable
)) { }
1452 // called when the on-screen widget state changes and provides an
1453 // an opportunity for the widget to update its visual state (colours,
1454 // fonts, anything else) as necessary
1455 virtual void OnEnabled(bool WXUNUSED(enabled
)) { }
1458 // the window id - a number which uniquely identifies a window among
1459 // its siblings unless it is wxID_ANY
1460 wxWindowIDRef m_windowId
;
1462 // the parent window of this window (or NULL) and the list of the children
1465 wxWindowList m_children
;
1467 // the minimal allowed size for the window (no minimal size if variable(s)
1468 // contain(s) wxDefaultCoord)
1474 // event handler for this window: usually is just 'this' but may be
1475 // changed with SetEventHandler()
1476 wxEvtHandler
*m_eventHandler
;
1478 #if wxUSE_VALIDATORS
1479 // associated validator or NULL if none
1480 wxValidator
*m_windowValidator
;
1481 #endif // wxUSE_VALIDATORS
1483 #if wxUSE_DRAG_AND_DROP
1484 wxDropTarget
*m_dropTarget
;
1485 #endif // wxUSE_DRAG_AND_DROP
1487 // visual window attributes
1489 wxFont m_font
; // see m_hasFont
1490 wxColour m_backgroundColour
, // m_hasBgCol
1491 m_foregroundColour
; // m_hasFgCol
1495 #endif // wxUSE_CARET
1497 // the region which should be repainted in response to paint event
1498 wxRegion m_updateRegion
;
1501 // the accelerator table for the window which translates key strokes into
1503 wxAcceleratorTable m_acceleratorTable
;
1504 #endif // wxUSE_ACCEL
1506 // the tooltip for this window (may be NULL)
1508 wxToolTip
*m_tooltip
;
1509 #endif // wxUSE_TOOLTIPS
1511 // constraints and sizers
1512 #if wxUSE_CONSTRAINTS
1513 // the constraints for this window or NULL
1514 wxLayoutConstraints
*m_constraints
;
1516 // constraints this window is involved in
1517 wxWindowList
*m_constraintsInvolvedIn
;
1518 #endif // wxUSE_CONSTRAINTS
1520 // this window's sizer
1521 wxSizer
*m_windowSizer
;
1523 // The sizer this window is a member of, if any
1524 wxSizer
*m_containingSizer
;
1526 // Layout() window automatically when its size changes?
1527 bool m_autoLayout
:1;
1532 bool m_isBeingDeleted
:1;
1534 // was the window colours/font explicitly changed by user?
1539 // and should it be inherited by children?
1540 bool m_inheritBgCol
:1;
1541 bool m_inheritFgCol
:1;
1542 bool m_inheritFont
:1;
1544 // window attributes
1547 wxString m_windowName
;
1548 bool m_themeEnabled
;
1549 wxBackgroundStyle m_backgroundStyle
;
1551 wxPalette m_palette
;
1552 bool m_hasCustomPalette
;
1553 #endif // wxUSE_PALETTE
1555 #if wxUSE_ACCESSIBILITY
1556 wxAccessible
* m_accessible
;
1559 // Virtual size (scrolling)
1560 wxSize m_virtualSize
;
1562 wxScrollHelper
*m_scrollHelper
;
1564 wxWindowVariant m_windowVariant
;
1566 // override this to change the default (i.e. used when no style is
1567 // specified) border for the window class
1568 virtual wxBorder
GetDefaultBorder() const;
1570 // this allows you to implement standard control borders without
1571 // repeating the code in different classes that are not derived from
1573 virtual wxBorder
GetDefaultBorderForControl() const { return wxBORDER_THEME
; }
1575 // Get the default size for the new window if no explicit size given. TLWs
1576 // have their own default size so this is just for non top-level windows.
1577 static int WidthDefault(int w
) { return w
== wxDefaultCoord
? 20 : w
; }
1578 static int HeightDefault(int h
) { return h
== wxDefaultCoord
? 20 : h
; }
1581 // Used to save the results of DoGetBestSize so it doesn't need to be
1582 // recalculated each time the value is needed.
1583 wxSize m_bestSizeCache
;
1585 wxDEPRECATED( void SetBestSize(const wxSize
& size
) ); // use SetInitialSize
1586 wxDEPRECATED( virtual void SetInitialBestSize(const wxSize
& size
) ); // use SetInitialSize
1590 // more pure virtual functions
1591 // ---------------------------
1593 // NB: we must have DoSomething() function when Something() is an overloaded
1594 // method: indeed, we can't just have "virtual Something()" in case when
1595 // the function is overloaded because then we'd have to make virtual all
1596 // the variants (otherwise only the virtual function may be called on a
1597 // pointer to derived class according to C++ rules) which is, in
1598 // general, absolutely not needed. So instead we implement all
1599 // overloaded Something()s in terms of DoSomething() which will be the
1600 // only one to be virtual.
1602 // coordinates translation
1603 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1604 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1606 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1608 // capture/release the mouse, used by Capture/ReleaseMouse()
1609 virtual void DoCaptureMouse() = 0;
1610 virtual void DoReleaseMouse() = 0;
1612 // retrieve the position/size of the window
1613 virtual void DoGetPosition(int *x
, int *y
) const = 0;
1614 virtual void DoGetScreenPosition(int *x
, int *y
) const;
1615 virtual void DoGetSize(int *width
, int *height
) const = 0;
1616 virtual void DoGetClientSize(int *width
, int *height
) const = 0;
1618 // get the size which best suits the window: for a control, it would be
1619 // the minimal size which doesn't truncate the control, for a panel - the
1620 // same size as it would have after a call to Fit()
1621 virtual wxSize
DoGetBestSize() const;
1623 // this is the virtual function to be overriden in any derived class which
1624 // wants to change how SetSize() or Move() works - it is called by all
1625 // versions of these functions in the base class
1626 virtual void DoSetSize(int x
, int y
,
1627 int width
, int height
,
1628 int sizeFlags
= wxSIZE_AUTO
) = 0;
1630 // same as DoSetSize() for the client size
1631 virtual void DoSetClientSize(int width
, int height
) = 0;
1633 virtual void DoSetSizeHints( int minW
, int minH
,
1635 int incW
, int incH
);
1637 // move the window to the specified location and resize it: this is called
1638 // from both DoSetSize() and DoSetClientSize() and would usually just
1639 // reposition this window except for composite controls which will want to
1640 // arrange themselves inside the given rectangle
1642 // Important note: the coordinates passed to this method are in parent's
1643 // *window* coordinates and not parent's client coordinates (as the values
1644 // passed to DoSetSize and returned by DoGetPosition are)!
1645 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1647 // centre the window in the specified direction on parent, note that
1648 // wxCENTRE_ON_SCREEN shouldn't be specified here, it only makes sense for
1650 virtual void DoCentre(int dir
);
1653 virtual void DoSetToolTip( wxToolTip
*tip
);
1654 #endif // wxUSE_TOOLTIPS
1657 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1658 #endif // wxUSE_MENUS
1660 // Makes an adjustment to the window position to make it relative to the
1661 // parents client area, e.g. if the parent is a frame with a toolbar, its
1662 // (0, 0) is just below the toolbar
1663 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1664 int sizeFlags
= 0) const;
1666 // implements the window variants
1667 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1670 // really freeze/thaw the window (should have port-specific implementation)
1671 virtual void DoFreeze() { }
1672 virtual void DoThaw() { }
1675 // Must be called when mouse capture is lost to send
1676 // wxMouseCaptureLostEvent to windows on capture stack.
1677 static void NotifyCaptureLost();
1680 // recursively call our own and our children OnEnabled() when the
1681 // enabled/disabled status changed because a parent window had been
1683 void NotifyWindowOnEnableChange(bool enabled
);
1686 // temporary event handlers used by GetPopupMenuSelectionFromUser()
1687 void InternalOnPopupMenu(wxCommandEvent
& event
);
1688 void InternalOnPopupMenuUpdate(wxUpdateUIEvent
& event
);
1690 // implementation of the public GetPopupMenuSelectionFromUser() method
1691 int DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
);
1692 #endif // wxUSE_MENUS
1694 // the stack of windows which have captured the mouse
1695 static struct WXDLLIMPEXP_FWD_CORE wxWindowNext
*ms_winCaptureNext
;
1697 // the window that currently has mouse capture
1698 static wxWindow
*ms_winCaptureCurrent
;
1700 // indicates if execution is inside CaptureMouse/ReleaseMouse
1701 static bool ms_winCaptureChanging
;
1704 // number of Freeze() calls minus the number of Thaw() calls: we're frozen
1705 // (i.e. not being updated) if it is positive
1706 unsigned int m_freezeCount
;
1709 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1710 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1711 DECLARE_EVENT_TABLE()
1716 // Inlines for some deprecated methods
1717 inline wxSize
wxWindowBase::GetBestFittingSize() const
1719 return GetEffectiveMinSize();
1722 inline void wxWindowBase::SetBestFittingSize(const wxSize
& size
)
1724 SetInitialSize(size
);
1727 inline void wxWindowBase::SetBestSize(const wxSize
& size
)
1729 SetInitialSize(size
);
1732 inline void wxWindowBase::SetInitialBestSize(const wxSize
& size
)
1734 SetInitialSize(size
);
1738 // ----------------------------------------------------------------------------
1739 // now include the declaration of wxWindow class
1740 // ----------------------------------------------------------------------------
1742 // include the declaration of the platform-specific class
1743 #if defined(__WXPALMOS__)
1744 #ifdef __WXUNIVERSAL__
1745 #define wxWindowNative wxWindowPalm
1747 #define wxWindowPalm wxWindow
1748 #endif // wxUniv/!wxUniv
1749 #include "wx/palmos/window.h"
1750 #elif defined(__WXMSW__)
1751 #ifdef __WXUNIVERSAL__
1752 #define wxWindowNative wxWindowMSW
1754 #define wxWindowMSW wxWindow
1755 #endif // wxUniv/!wxUniv
1756 #include "wx/msw/window.h"
1757 #elif defined(__WXMOTIF__)
1758 #include "wx/motif/window.h"
1759 #elif defined(__WXGTK20__)
1760 #ifdef __WXUNIVERSAL__
1761 #define wxWindowNative wxWindowGTK
1763 #define wxWindowGTK wxWindow
1765 #include "wx/gtk/window.h"
1766 #elif defined(__WXGTK__)
1767 #ifdef __WXUNIVERSAL__
1768 #define wxWindowNative wxWindowGTK
1770 #define wxWindowGTK wxWindow
1772 #include "wx/gtk1/window.h"
1773 #elif defined(__WXX11__)
1774 #ifdef __WXUNIVERSAL__
1775 #define wxWindowNative wxWindowX11
1777 #define wxWindowX11 wxWindow
1779 #include "wx/x11/window.h"
1780 #elif defined(__WXMGL__)
1781 #define wxWindowNative wxWindowMGL
1782 #include "wx/mgl/window.h"
1783 #elif defined(__WXDFB__)
1784 #define wxWindowNative wxWindowDFB
1785 #include "wx/dfb/window.h"
1786 #elif defined(__WXMAC__)
1787 #ifdef __WXUNIVERSAL__
1788 #define wxWindowNative wxWindowMac
1790 #define wxWindowMac wxWindow
1792 #include "wx/osx/window.h"
1793 #elif defined(__WXCOCOA__)
1794 #ifdef __WXUNIVERSAL__
1795 #define wxWindowNative wxWindowCocoa
1797 #define wxWindowCocoa wxWindow
1799 #include "wx/cocoa/window.h"
1800 #elif defined(__WXPM__)
1801 #ifdef __WXUNIVERSAL__
1802 #define wxWindowNative wxWindowOS2
1804 #define wxWindowOS2 wxWindow
1805 #endif // wxUniv/!wxUniv
1806 #include "wx/os2/window.h"
1809 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1810 // for the native ports we already have defined it above
1811 #if defined(__WXUNIVERSAL__)
1812 #ifndef wxWindowNative
1813 #error "wxWindowNative must be defined above!"
1816 #include "wx/univ/window.h"
1819 // ----------------------------------------------------------------------------
1820 // inline functions which couldn't be declared in the class body because of
1821 // forward dependencies
1822 // ----------------------------------------------------------------------------
1824 inline wxWindow
*wxWindowBase::GetGrandParent() const
1826 return m_parent
? m_parent
->GetParent() : NULL
;
1829 // ----------------------------------------------------------------------------
1831 // ----------------------------------------------------------------------------
1833 // Find the wxWindow at the current mouse position, also returning the mouse
1835 extern WXDLLIMPEXP_CORE wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1837 // Get the current mouse position.
1838 extern WXDLLIMPEXP_CORE wxPoint
wxGetMousePosition();
1840 // get the currently active window of this application or NULL
1841 extern WXDLLIMPEXP_CORE wxWindow
*wxGetActiveWindow();
1843 // get the (first) top level parent window
1844 WXDLLIMPEXP_CORE wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1846 #if WXWIN_COMPATIBILITY_2_6
1847 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1848 wxDEPRECATED( wxWindowID
NewControlId() );
1849 inline wxWindowID
NewControlId() { return wxWindowBase::NewControlId(); }
1850 #endif // WXWIN_COMPATIBILITY_2_6
1852 #if wxUSE_ACCESSIBILITY
1853 // ----------------------------------------------------------------------------
1854 // accessible object for windows
1855 // ----------------------------------------------------------------------------
1857 class WXDLLIMPEXP_CORE wxWindowAccessible
: public wxAccessible
1860 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1861 virtual ~wxWindowAccessible() {}
1865 // Can return either a child object, or an integer
1866 // representing the child element, starting from 1.
1867 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1869 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1870 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1872 // Navigates from fromId to toId/toObject.
1873 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1874 int* toId
, wxAccessible
** toObject
);
1876 // Gets the name of the specified object.
1877 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1879 // Gets the number of children.
1880 virtual wxAccStatus
GetChildCount(int* childCount
);
1882 // Gets the specified child (starting from 1).
1883 // If *child is NULL and return value is wxACC_OK,
1884 // this means that the child is a simple element and
1885 // not an accessible object.
1886 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1888 // Gets the parent, or NULL.
1889 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1891 // Performs the default action. childId is 0 (the action for this object)
1892 // or > 0 (the action for a child).
1893 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1894 // window (e.g. an edit control).
1895 virtual wxAccStatus
DoDefaultAction(int childId
);
1897 // Gets the default action for this object (0) or > 0 (the action for a child).
1898 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1899 // string if there is no action.
1900 // The retrieved string describes the action that is performed on an object,
1901 // not what the object does as a result. For example, a toolbar button that prints
1902 // a document has a default action of "Press" rather than "Prints the current document."
1903 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1905 // Returns the description for this object or a child.
1906 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1908 // Returns help text for this object or a child, similar to tooltip text.
1909 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1911 // Returns the keyboard shortcut for this object or child.
1912 // Return e.g. ALT+K
1913 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1915 // Returns a role constant.
1916 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1918 // Returns a state constant.
1919 virtual wxAccStatus
GetState(int childId
, long* state
);
1921 // Returns a localized string representing the value for the object
1923 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1925 // Selects the object or child.
1926 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1928 // Gets the window with the keyboard focus.
1929 // If childId is 0 and child is NULL, no object in
1930 // this subhierarchy has the focus.
1931 // If this object has the focus, child should be 'this'.
1932 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1935 // Gets a variant representing the selected children
1937 // Acceptable values:
1938 // - a null variant (IsNull() returns true)
1939 // - a list variant (GetType() == wxT("list")
1940 // - an integer representing the selected child element,
1941 // or 0 if this object is selected (GetType() == wxT("long")
1942 // - a "void*" pointer to a wxAccessible child object
1943 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1944 #endif // wxUSE_VARIANT
1947 #endif // wxUSE_ACCESSIBILITY
1950 #endif // _WX_WINDOW_H_BASE_