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 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() and
810 // handling any exceptions thrown by event handlers. It's mostly useful
811 // when processing wx events when called from C code (e.g. in GTK+
812 // callback) when the exception wouldn't correctly propagate to
814 bool HandleWindowEvent(wxEvent
& event
) const;
816 // disable wxEvtHandler double-linked list mechanism:
817 virtual void SetNextHandler(wxEvtHandler
*handler
);
818 virtual void SetPreviousHandler(wxEvtHandler
*handler
);
824 // a window may have an associated validator which is used to control
826 virtual void SetValidator( const wxValidator
&validator
);
827 virtual wxValidator
*GetValidator() { return m_windowValidator
; }
828 #endif // wxUSE_VALIDATORS
831 // dialog oriented functions
832 // -------------------------
834 // validate the correctness of input, return true if ok
835 virtual bool Validate();
837 // transfer data between internal and GUI representations
838 virtual bool TransferDataToWindow();
839 virtual bool TransferDataFromWindow();
841 virtual void InitDialog();
846 virtual void SetAcceleratorTable( const wxAcceleratorTable
& accel
)
847 { m_acceleratorTable
= accel
; }
848 wxAcceleratorTable
*GetAcceleratorTable()
849 { return &m_acceleratorTable
; }
851 #endif // wxUSE_ACCEL
854 // hot keys (system wide accelerators)
855 // -----------------------------------
857 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
858 virtual bool UnregisterHotKey(int hotkeyId
);
859 #endif // wxUSE_HOTKEY
862 // dialog units translations
863 // -------------------------
865 wxPoint
ConvertPixelsToDialog( const wxPoint
& pt
);
866 wxPoint
ConvertDialogToPixels( const wxPoint
& pt
);
867 wxSize
ConvertPixelsToDialog( const wxSize
& sz
)
869 wxPoint
pt(ConvertPixelsToDialog(wxPoint(sz
.x
, sz
.y
)));
871 return wxSize(pt
.x
, pt
.y
);
874 wxSize
ConvertDialogToPixels( const wxSize
& sz
)
876 wxPoint
pt(ConvertDialogToPixels(wxPoint(sz
.x
, sz
.y
)));
878 return wxSize(pt
.x
, pt
.y
);
884 // move the mouse to the specified position
885 virtual void WarpPointer(int x
, int y
) = 0;
887 // start or end mouse capture, these functions maintain the stack of
888 // windows having captured the mouse and after calling ReleaseMouse()
889 // the mouse is not released but returns to the window which had had
890 // captured it previously (if any)
894 // get the window which currently captures the mouse or NULL
895 static wxWindow
*GetCapture();
897 // does this window have the capture?
898 virtual bool HasCapture() const
899 { return (wxWindow
*)this == GetCapture(); }
901 // painting the window
902 // -------------------
904 // mark the specified rectangle (or the whole window) as "dirty" so it
906 virtual void Refresh( bool eraseBackground
= true,
907 const wxRect
*rect
= (const wxRect
*) NULL
) = 0;
909 // a less awkward wrapper for Refresh
910 void RefreshRect(const wxRect
& rect
, bool eraseBackground
= true)
912 Refresh(eraseBackground
, &rect
);
915 // repaint all invalid areas of the window immediately
916 virtual void Update() { }
918 // clear the window background
919 virtual void ClearBackground();
921 // freeze the window: don't redraw it until it is thawed
924 // thaw the window: redraw it after it had been frozen
927 // return true if window had been frozen and not unthawed yet
928 bool IsFrozen() const { return m_freezeCount
!= 0; }
930 // adjust DC for drawing on this window
931 virtual void PrepareDC( wxDC
& WXUNUSED(dc
) ) { }
933 // return true if the window contents is double buffered by the system
934 virtual bool IsDoubleBuffered() const { return false; }
936 // the update region of the window contains the areas which must be
937 // repainted by the program
938 const wxRegion
& GetUpdateRegion() const { return m_updateRegion
; }
939 wxRegion
& GetUpdateRegion() { return m_updateRegion
; }
941 // get the update rectangleregion bounding box in client coords
942 wxRect
GetUpdateClientRect() const;
944 // these functions verify whether the given point/rectangle belongs to
945 // (or at least intersects with) the update region
946 virtual bool DoIsExposed( int x
, int y
) const;
947 virtual bool DoIsExposed( int x
, int y
, int w
, int h
) const;
949 bool IsExposed( int x
, int y
) const
950 { return DoIsExposed(x
, y
); }
951 bool IsExposed( int x
, int y
, int w
, int h
) const
952 { return DoIsExposed(x
, y
, w
, h
); }
953 bool IsExposed( const wxPoint
& pt
) const
954 { return DoIsExposed(pt
.x
, pt
.y
); }
955 bool IsExposed( const wxRect
& rect
) const
956 { return DoIsExposed(rect
.x
, rect
.y
, rect
.width
, rect
.height
); }
958 // colours, fonts and cursors
959 // --------------------------
961 // get the default attributes for the controls of this class: we
962 // provide a virtual function which can be used to query the default
963 // attributes of an existing control and a static function which can
964 // be used even when no existing object of the given class is
965 // available, but which won't return any styles specific to this
966 // particular control, of course (e.g. "Ok" button might have
967 // different -- bold for example -- font)
968 virtual wxVisualAttributes
GetDefaultAttributes() const
970 return GetClassDefaultAttributes(GetWindowVariant());
973 static wxVisualAttributes
974 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
976 // set/retrieve the window colours (system defaults are used by
977 // default): SetXXX() functions return true if colour was changed,
978 // SetDefaultXXX() reset the "m_inheritXXX" flag after setting the
979 // value to prevent it from being inherited by our children
980 virtual bool SetBackgroundColour(const wxColour
& colour
);
981 void SetOwnBackgroundColour(const wxColour
& colour
)
983 if ( SetBackgroundColour(colour
) )
984 m_inheritBgCol
= false;
986 wxColour
GetBackgroundColour() const;
987 bool InheritsBackgroundColour() const
989 return m_inheritBgCol
;
991 bool UseBgCol() const
996 virtual bool SetForegroundColour(const wxColour
& colour
);
997 void SetOwnForegroundColour(const wxColour
& colour
)
999 if ( SetForegroundColour(colour
) )
1000 m_inheritFgCol
= false;
1002 wxColour
GetForegroundColour() const;
1004 // Set/get the background style.
1005 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1006 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) { m_backgroundStyle
= style
; return true; }
1007 virtual wxBackgroundStyle
GetBackgroundStyle() const { return m_backgroundStyle
; }
1009 // returns true if the control has "transparent" areas such as a
1010 // wxStaticText and wxCheckBox and the background should be adapted
1011 // from a parent window
1012 virtual bool HasTransparentBackground() { return false; }
1014 // set/retrieve the font for the window (SetFont() returns true if the
1015 // font really changed)
1016 virtual bool SetFont(const wxFont
& font
) = 0;
1017 void SetOwnFont(const wxFont
& font
)
1019 if ( SetFont(font
) )
1020 m_inheritFont
= false;
1022 wxFont
GetFont() const;
1024 // set/retrieve the cursor for this window (SetCursor() returns true
1025 // if the cursor was really changed)
1026 virtual bool SetCursor( const wxCursor
&cursor
);
1027 const wxCursor
& GetCursor() const { return m_cursor
; }
1030 // associate a caret with the window
1031 void SetCaret(wxCaret
*caret
);
1032 // get the current caret (may be NULL)
1033 wxCaret
*GetCaret() const { return m_caret
; }
1034 #endif // wxUSE_CARET
1036 // get the (average) character size for the current font
1037 virtual int GetCharHeight() const = 0;
1038 virtual int GetCharWidth() const = 0;
1040 // get the width/height/... of the text using current or specified
1042 virtual void GetTextExtent(const wxString
& string
,
1044 int *descent
= NULL
,
1045 int *externalLeading
= NULL
,
1046 const wxFont
*theFont
= (const wxFont
*) NULL
)
1049 wxSize
GetTextExtent(const wxString
& string
) const
1052 GetTextExtent(string
, &w
, &h
);
1053 return wxSize(w
, h
);
1056 // client <-> screen coords
1057 // ------------------------
1059 // translate to/from screen/client coordinates (pointers may be NULL)
1060 void ClientToScreen( int *x
, int *y
) const
1061 { DoClientToScreen(x
, y
); }
1062 void ScreenToClient( int *x
, int *y
) const
1063 { DoScreenToClient(x
, y
); }
1065 // wxPoint interface to do the same thing
1066 wxPoint
ClientToScreen(const wxPoint
& pt
) const
1068 int x
= pt
.x
, y
= pt
.y
;
1069 DoClientToScreen(&x
, &y
);
1071 return wxPoint(x
, y
);
1074 wxPoint
ScreenToClient(const wxPoint
& pt
) const
1076 int x
= pt
.x
, y
= pt
.y
;
1077 DoScreenToClient(&x
, &y
);
1079 return wxPoint(x
, y
);
1082 // test where the given (in client coords) point lies
1083 wxHitTest
HitTest(wxCoord x
, wxCoord y
) const
1084 { return DoHitTest(x
, y
); }
1086 wxHitTest
HitTest(const wxPoint
& pt
) const
1087 { return DoHitTest(pt
.x
, pt
.y
); }
1092 // get the window border style from the given flags: this is different from
1093 // simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to
1094 // translate wxBORDER_DEFAULT to something reasonable
1095 wxBorder
GetBorder(long flags
) const;
1097 // get border for the flags of this window
1098 wxBorder
GetBorder() const { return GetBorder(GetWindowStyleFlag()); }
1100 // send wxUpdateUIEvents to this window, and children if recurse is true
1101 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
);
1103 // do the window-specific processing after processing the update event
1104 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
1107 // show popup menu at the given position, generate events for the items
1109 bool PopupMenu(wxMenu
*menu
, const wxPoint
& pos
= wxDefaultPosition
)
1110 { return PopupMenu(menu
, pos
.x
, pos
.y
); }
1111 bool PopupMenu(wxMenu
*menu
, int x
, int y
);
1113 // simply return the id of the selected item or wxID_NONE without
1114 // generating any events
1115 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, const wxPoint
& pos
)
1116 { return DoGetPopupMenuSelectionFromUser(menu
, pos
.x
, pos
.y
); }
1117 int GetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
1118 { return DoGetPopupMenuSelectionFromUser(menu
, x
, y
); }
1119 #endif // wxUSE_MENUS
1121 // override this method to return true for controls having multiple pages
1122 virtual bool HasMultiplePages() const { return false; }
1128 // does the window have the scrollbar for this orientation?
1129 bool HasScrollbar(int orient
) const
1131 return (m_windowStyle
&
1132 (orient
== wxHORIZONTAL
? wxHSCROLL
: wxVSCROLL
)) != 0;
1135 // configure the window scrollbars
1136 virtual void SetScrollbar( int orient
,
1140 bool refresh
= true ) = 0;
1141 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true ) = 0;
1142 virtual int GetScrollPos( int orient
) const = 0;
1143 virtual int GetScrollThumb( int orient
) const = 0;
1144 virtual int GetScrollRange( int orient
) const = 0;
1146 // scroll window to the specified position
1147 virtual void ScrollWindow( int dx
, int dy
,
1148 const wxRect
* rect
= NULL
) = 0;
1150 // scrolls window by line/page: note that not all controls support this
1152 // return true if the position changed, false otherwise
1153 virtual bool ScrollLines(int WXUNUSED(lines
)) { return false; }
1154 virtual bool ScrollPages(int WXUNUSED(pages
)) { return false; }
1156 // convenient wrappers for ScrollLines/Pages
1157 bool LineUp() { return ScrollLines(-1); }
1158 bool LineDown() { return ScrollLines(1); }
1159 bool PageUp() { return ScrollPages(-1); }
1160 bool PageDown() { return ScrollPages(1); }
1162 // call this to always show one or both scrollbars, even if the window
1163 // is big enough to not require them
1164 virtual void AlwaysShowScrollbars(bool WXUNUSED(horz
) = true,
1165 bool WXUNUSED(vert
) = true)
1169 // return true if AlwaysShowScrollbars() had been called before for the
1170 // corresponding orientation
1171 virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient
)) const
1176 // context-sensitive help
1177 // ----------------------
1179 // these are the convenience functions wrapping wxHelpProvider methods
1182 // associate this help text with this window
1183 void SetHelpText(const wxString
& text
);
1185 #if WXWIN_COMPATIBILITY_2_8
1186 // Associate this help text with all windows with the same id as this one.
1187 // Don't use this, do wxHelpProvider::Get()->AddHelp(id, text);
1188 wxDEPRECATED( void SetHelpTextForId(const wxString
& text
) );
1189 #endif // WXWIN_COMPATIBILITY_2_8
1191 // get the help string associated with the given position in this window
1193 // notice that pt may be invalid if event origin is keyboard or unknown
1194 // and this method should return the global window help text then
1195 virtual wxString
GetHelpTextAtPoint(const wxPoint
& pt
,
1196 wxHelpEvent::Origin origin
) const;
1197 // returns the position-independent help text
1198 wxString
GetHelpText() const
1200 return GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Unknown
);
1203 #else // !wxUSE_HELP
1204 // silently ignore SetHelpText() calls
1205 void SetHelpText(const wxString
& WXUNUSED(text
)) { }
1206 void SetHelpTextForId(const wxString
& WXUNUSED(text
)) { }
1207 #endif // wxUSE_HELP
1213 // the easiest way to set a tooltip for a window is to use this method
1214 void SetToolTip( const wxString
&tip
);
1215 // attach a tooltip to the window, pointer can be NULL to remove
1217 void SetToolTip( wxToolTip
*tip
) { DoSetToolTip(tip
); }
1218 // more readable synonym for SetToolTip(NULL)
1219 void UnsetToolTip() { SetToolTip(NULL
); }
1220 // get the associated tooltip or NULL if none
1221 wxToolTip
* GetToolTip() const { return m_tooltip
; }
1222 wxString
GetToolTipText() const;
1223 #else // !wxUSE_TOOLTIPS
1224 // make it much easier to compile apps in an environment
1225 // that doesn't support tooltips, such as PocketPC
1226 void SetToolTip(const wxString
& WXUNUSED(tip
)) { }
1227 void UnsetToolTip() { }
1228 #endif // wxUSE_TOOLTIPS/!wxUSE_TOOLTIPS
1232 #if wxUSE_DRAG_AND_DROP
1233 // set/retrieve the drop target associated with this window (may be
1234 // NULL; it's owned by the window and will be deleted by it)
1235 virtual void SetDropTarget( wxDropTarget
*dropTarget
) = 0;
1236 virtual wxDropTarget
*GetDropTarget() const { return m_dropTarget
; }
1238 // Accept files for dragging
1239 virtual void DragAcceptFiles(bool accept
)
1241 // it does have common implementation but not for MSW which has its own
1242 // native version of it
1247 #endif // wxUSE_DRAG_AND_DROP
1249 // constraints and sizers
1250 // ----------------------
1251 #if wxUSE_CONSTRAINTS
1252 // set the constraints for this window or retrieve them (may be NULL)
1253 void SetConstraints( wxLayoutConstraints
*constraints
);
1254 wxLayoutConstraints
*GetConstraints() const { return m_constraints
; }
1256 // implementation only
1257 void UnsetConstraints(wxLayoutConstraints
*c
);
1258 wxWindowList
*GetConstraintsInvolvedIn() const
1259 { return m_constraintsInvolvedIn
; }
1260 void AddConstraintReference(wxWindowBase
*otherWin
);
1261 void RemoveConstraintReference(wxWindowBase
*otherWin
);
1262 void DeleteRelatedConstraints();
1263 void ResetConstraints();
1265 // these methods may be overridden for special layout algorithms
1266 virtual void SetConstraintSizes(bool recurse
= true);
1267 virtual bool LayoutPhase1(int *noChanges
);
1268 virtual bool LayoutPhase2(int *noChanges
);
1269 virtual bool DoPhase(int phase
);
1271 // these methods are virtual but normally won't be overridden
1272 virtual void SetSizeConstraint(int x
, int y
, int w
, int h
);
1273 virtual void MoveConstraint(int x
, int y
);
1274 virtual void GetSizeConstraint(int *w
, int *h
) const ;
1275 virtual void GetClientSizeConstraint(int *w
, int *h
) const ;
1276 virtual void GetPositionConstraint(int *x
, int *y
) const ;
1278 #endif // wxUSE_CONSTRAINTS
1280 // when using constraints or sizers, it makes sense to update
1281 // children positions automatically whenever the window is resized
1282 // - this is done if autoLayout is on
1283 void SetAutoLayout( bool autoLayout
) { m_autoLayout
= autoLayout
; }
1284 bool GetAutoLayout() const { return m_autoLayout
; }
1286 // lay out the window and its children
1287 virtual bool Layout();
1290 void SetSizer(wxSizer
*sizer
, bool deleteOld
= true );
1291 void SetSizerAndFit( wxSizer
*sizer
, bool deleteOld
= true );
1293 wxSizer
*GetSizer() const { return m_windowSizer
; }
1295 // Track if this window is a member of a sizer
1296 void SetContainingSizer(wxSizer
* sizer
);
1297 wxSizer
*GetContainingSizer() const { return m_containingSizer
; }
1300 // ----------------------
1301 #if wxUSE_ACCESSIBILITY
1302 // Override to create a specific accessible object.
1303 virtual wxAccessible
* CreateAccessible();
1305 // Sets the accessible object.
1306 void SetAccessible(wxAccessible
* accessible
) ;
1308 // Returns the accessible object.
1309 wxAccessible
* GetAccessible() { return m_accessible
; }
1311 // Returns the accessible object, creating if necessary.
1312 wxAccessible
* GetOrCreateAccessible() ;
1316 // Set window transparency if the platform supports it
1317 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
)) { return false; }
1318 virtual bool CanSetTransparent() { return false; }
1325 void OnSysColourChanged( wxSysColourChangedEvent
& event
);
1326 void OnInitDialog( wxInitDialogEvent
&event
);
1327 void OnMiddleClick( wxMouseEvent
& event
);
1329 void OnHelp(wxHelpEvent
& event
);
1330 #endif // wxUSE_HELP
1332 // virtual function for implementing internal idle
1334 virtual void OnInternalIdle() {}
1336 // call internal idle recursively
1337 // void ProcessInternalIdle() ;
1339 // get the handle of the window for the underlying window system: this
1340 // is only used for wxWin itself or for user code which wants to call
1341 // platform-specific APIs
1342 virtual WXWidget
GetHandle() const = 0;
1343 // associate the window with a new native handle
1344 virtual void AssociateHandle(WXWidget
WXUNUSED(handle
)) { }
1345 // dissociate the current native handle from the window
1346 virtual void DissociateHandle() { }
1349 // Store the palette used by DCs in wxWindow so that the dcs can share
1350 // a palette. And we can respond to palette messages.
1351 wxPalette
GetPalette() const { return m_palette
; }
1353 // When palette is changed tell the DC to set the system palette to the
1355 void SetPalette(const wxPalette
& pal
);
1357 // return true if we have a specific palette
1358 bool HasCustomPalette() const { return m_hasCustomPalette
; }
1360 // return the first parent window with a custom palette or NULL
1361 wxWindow
*GetAncestorWithCustomPalette() const;
1362 #endif // wxUSE_PALETTE
1364 // inherit the parents visual attributes if they had been explicitly set
1365 // by the user (i.e. we don't inherit default attributes) and if we don't
1366 // have our own explicitly set
1367 virtual void InheritAttributes();
1369 // returns false from here if this window doesn't want to inherit the
1370 // parents colours even if InheritAttributes() would normally do it
1372 // this just provides a simple way to customize InheritAttributes()
1373 // behaviour in the most common case
1374 virtual bool ShouldInheritColours() const { return false; }
1376 // returns true if the window can be positioned outside of parent's client
1377 // area (normal windows can't, but e.g. menubar or statusbar can):
1378 virtual bool CanBeOutsideClientArea() const { return false; }
1380 // returns true if the platform should explicitly apply a theme border. Currently
1381 // used only by Windows
1382 virtual bool CanApplyThemeBorder() const { return true; }
1385 // event handling specific to wxWindow
1386 virtual bool TryValidator(wxEvent
& event
);
1387 virtual bool TryParent(wxEvent
& event
);
1391 OrderBefore
, // insert before the given window
1392 OrderAfter
// insert after the given window
1395 // common part of GetPrev/NextSibling()
1396 wxWindow
*DoGetSibling(WindowOrder order
) const;
1398 // common part of MoveBefore/AfterInTabOrder()
1399 virtual void DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
);
1401 // implementation of Navigate() and NavigateIn()
1402 virtual bool DoNavigateIn(int flags
);
1404 #if wxUSE_CONSTRAINTS
1405 // satisfy the constraints for the windows but don't set the window sizes
1406 void SatisfyConstraints();
1407 #endif // wxUSE_CONSTRAINTS
1409 // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
1411 void SendDestroyEvent();
1413 // returns the main window of composite control; this is the window
1414 // that FindFocus returns if the focus is in one of composite control's
1416 virtual wxWindow
*GetMainWindowOfCompositeControl()
1417 { return (wxWindow
*)this; }
1419 // this method should be implemented to use operating system specific code
1420 // to really enable/disable the widget, it will only be called when we
1421 // really need to enable/disable window and so no additional checks on the
1422 // widgets state are necessary
1423 virtual void DoEnable(bool WXUNUSED(enable
)) { }
1425 // called when the on-screen widget state changes and provides an
1426 // an opportunity for the widget to update its visual state (colours,
1427 // fonts, anything else) as necessary
1428 virtual void OnEnabled(bool WXUNUSED(enabled
)) { }
1431 // the window id - a number which uniquely identifies a window among
1432 // its siblings unless it is wxID_ANY
1433 wxWindowIDRef m_windowId
;
1435 // the parent window of this window (or NULL) and the list of the children
1438 wxWindowList m_children
;
1440 // the minimal allowed size for the window (no minimal size if variable(s)
1441 // contain(s) wxDefaultCoord)
1447 // event handler for this window: usually is just 'this' but may be
1448 // changed with SetEventHandler()
1449 wxEvtHandler
*m_eventHandler
;
1451 #if wxUSE_VALIDATORS
1452 // associated validator or NULL if none
1453 wxValidator
*m_windowValidator
;
1454 #endif // wxUSE_VALIDATORS
1456 #if wxUSE_DRAG_AND_DROP
1457 wxDropTarget
*m_dropTarget
;
1458 #endif // wxUSE_DRAG_AND_DROP
1460 // visual window attributes
1462 wxFont m_font
; // see m_hasFont
1463 wxColour m_backgroundColour
, // m_hasBgCol
1464 m_foregroundColour
; // m_hasFgCol
1468 #endif // wxUSE_CARET
1470 // the region which should be repainted in response to paint event
1471 wxRegion m_updateRegion
;
1474 // the accelerator table for the window which translates key strokes into
1476 wxAcceleratorTable m_acceleratorTable
;
1477 #endif // wxUSE_ACCEL
1479 // the tooltip for this window (may be NULL)
1481 wxToolTip
*m_tooltip
;
1482 #endif // wxUSE_TOOLTIPS
1484 // constraints and sizers
1485 #if wxUSE_CONSTRAINTS
1486 // the constraints for this window or NULL
1487 wxLayoutConstraints
*m_constraints
;
1489 // constraints this window is involved in
1490 wxWindowList
*m_constraintsInvolvedIn
;
1491 #endif // wxUSE_CONSTRAINTS
1493 // this window's sizer
1494 wxSizer
*m_windowSizer
;
1496 // The sizer this window is a member of, if any
1497 wxSizer
*m_containingSizer
;
1499 // Layout() window automatically when its size changes?
1500 bool m_autoLayout
:1;
1505 bool m_isBeingDeleted
:1;
1507 // was the window colours/font explicitly changed by user?
1512 // and should it be inherited by children?
1513 bool m_inheritBgCol
:1;
1514 bool m_inheritFgCol
:1;
1515 bool m_inheritFont
:1;
1517 // window attributes
1520 wxString m_windowName
;
1521 bool m_themeEnabled
;
1522 wxBackgroundStyle m_backgroundStyle
;
1524 wxPalette m_palette
;
1525 bool m_hasCustomPalette
;
1526 #endif // wxUSE_PALETTE
1528 #if wxUSE_ACCESSIBILITY
1529 wxAccessible
* m_accessible
;
1532 // Virtual size (scrolling)
1533 wxSize m_virtualSize
;
1535 wxScrollHelper
*m_scrollHelper
;
1537 wxWindowVariant m_windowVariant
;
1539 // override this to change the default (i.e. used when no style is
1540 // specified) border for the window class
1541 virtual wxBorder
GetDefaultBorder() const;
1543 // this allows you to implement standard control borders without
1544 // repeating the code in different classes that are not derived from
1546 virtual wxBorder
GetDefaultBorderForControl() const { return wxBORDER_THEME
; }
1548 // Get the default size for the new window if no explicit size given. TLWs
1549 // have their own default size so this is just for non top-level windows.
1550 static int WidthDefault(int w
) { return w
== wxDefaultCoord
? 20 : w
; }
1551 static int HeightDefault(int h
) { return h
== wxDefaultCoord
? 20 : h
; }
1554 // Used to save the results of DoGetBestSize so it doesn't need to be
1555 // recalculated each time the value is needed.
1556 wxSize m_bestSizeCache
;
1558 wxDEPRECATED( void SetBestSize(const wxSize
& size
) ); // use SetInitialSize
1559 wxDEPRECATED( virtual void SetInitialBestSize(const wxSize
& size
) ); // use SetInitialSize
1563 // more pure virtual functions
1564 // ---------------------------
1566 // NB: we must have DoSomething() function when Something() is an overloaded
1567 // method: indeed, we can't just have "virtual Something()" in case when
1568 // the function is overloaded because then we'd have to make virtual all
1569 // the variants (otherwise only the virtual function may be called on a
1570 // pointer to derived class according to C++ rules) which is, in
1571 // general, absolutely not needed. So instead we implement all
1572 // overloaded Something()s in terms of DoSomething() which will be the
1573 // only one to be virtual.
1575 // coordinates translation
1576 virtual void DoClientToScreen( int *x
, int *y
) const = 0;
1577 virtual void DoScreenToClient( int *x
, int *y
) const = 0;
1579 virtual wxHitTest
DoHitTest(wxCoord x
, wxCoord y
) const;
1581 // capture/release the mouse, used by Capture/ReleaseMouse()
1582 virtual void DoCaptureMouse() = 0;
1583 virtual void DoReleaseMouse() = 0;
1585 // retrieve the position/size of the window
1586 virtual void DoGetPosition(int *x
, int *y
) const = 0;
1587 virtual void DoGetScreenPosition(int *x
, int *y
) const;
1588 virtual void DoGetSize(int *width
, int *height
) const = 0;
1589 virtual void DoGetClientSize(int *width
, int *height
) const = 0;
1591 // get the size which best suits the window: for a control, it would be
1592 // the minimal size which doesn't truncate the control, for a panel - the
1593 // same size as it would have after a call to Fit()
1594 virtual wxSize
DoGetBestSize() const;
1596 // this is the virtual function to be overriden in any derived class which
1597 // wants to change how SetSize() or Move() works - it is called by all
1598 // versions of these functions in the base class
1599 virtual void DoSetSize(int x
, int y
,
1600 int width
, int height
,
1601 int sizeFlags
= wxSIZE_AUTO
) = 0;
1603 // same as DoSetSize() for the client size
1604 virtual void DoSetClientSize(int width
, int height
) = 0;
1606 virtual void DoSetSizeHints( int minW
, int minH
,
1608 int incW
, int incH
);
1610 // move the window to the specified location and resize it: this is called
1611 // from both DoSetSize() and DoSetClientSize() and would usually just
1612 // reposition this window except for composite controls which will want to
1613 // arrange themselves inside the given rectangle
1615 // Important note: the coordinates passed to this method are in parent's
1616 // *window* coordinates and not parent's client coordinates (as the values
1617 // passed to DoSetSize and returned by DoGetPosition are)!
1618 virtual void DoMoveWindow(int x
, int y
, int width
, int height
) = 0;
1620 // centre the window in the specified direction on parent, note that
1621 // wxCENTRE_ON_SCREEN shouldn't be specified here, it only makes sense for
1623 virtual void DoCentre(int dir
);
1626 virtual void DoSetToolTip( wxToolTip
*tip
);
1627 #endif // wxUSE_TOOLTIPS
1630 virtual bool DoPopupMenu(wxMenu
*menu
, int x
, int y
) = 0;
1631 #endif // wxUSE_MENUS
1633 // Makes an adjustment to the window position to make it relative to the
1634 // parents client area, e.g. if the parent is a frame with a toolbar, its
1635 // (0, 0) is just below the toolbar
1636 virtual void AdjustForParentClientOrigin(int& x
, int& y
,
1637 int sizeFlags
= 0) const;
1639 // implements the window variants
1640 virtual void DoSetWindowVariant( wxWindowVariant variant
) ;
1643 // really freeze/thaw the window (should have port-specific implementation)
1644 virtual void DoFreeze() { }
1645 virtual void DoThaw() { }
1648 // Must be called when mouse capture is lost to send
1649 // wxMouseCaptureLostEvent to windows on capture stack.
1650 static void NotifyCaptureLost();
1653 // recursively call our own and our children OnEnabled() when the
1654 // enabled/disabled status changed because a parent window had been
1656 void NotifyWindowOnEnableChange(bool enabled
);
1659 // temporary event handlers used by GetPopupMenuSelectionFromUser()
1660 void InternalOnPopupMenu(wxCommandEvent
& event
);
1661 void InternalOnPopupMenuUpdate(wxUpdateUIEvent
& event
);
1663 // implementation of the public GetPopupMenuSelectionFromUser() method
1664 int DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
);
1665 #endif // wxUSE_MENUS
1667 // the stack of windows which have captured the mouse
1668 static struct WXDLLIMPEXP_FWD_CORE wxWindowNext
*ms_winCaptureNext
;
1670 // the window that currently has mouse capture
1671 static wxWindow
*ms_winCaptureCurrent
;
1673 // indicates if execution is inside CaptureMouse/ReleaseMouse
1674 static bool ms_winCaptureChanging
;
1677 // number of Freeze() calls minus the number of Thaw() calls: we're frozen
1678 // (i.e. not being updated) if it is positive
1679 unsigned int m_freezeCount
;
1682 DECLARE_ABSTRACT_CLASS(wxWindowBase
)
1683 DECLARE_NO_COPY_CLASS(wxWindowBase
)
1684 DECLARE_EVENT_TABLE()
1689 // Inlines for some deprecated methods
1690 inline wxSize
wxWindowBase::GetBestFittingSize() const
1692 return GetEffectiveMinSize();
1695 inline void wxWindowBase::SetBestFittingSize(const wxSize
& size
)
1697 SetInitialSize(size
);
1700 inline void wxWindowBase::SetBestSize(const wxSize
& size
)
1702 SetInitialSize(size
);
1705 inline void wxWindowBase::SetInitialBestSize(const wxSize
& size
)
1707 SetInitialSize(size
);
1711 // ----------------------------------------------------------------------------
1712 // now include the declaration of wxWindow class
1713 // ----------------------------------------------------------------------------
1715 // include the declaration of the platform-specific class
1716 #if defined(__WXPALMOS__)
1717 #ifdef __WXUNIVERSAL__
1718 #define wxWindowNative wxWindowPalm
1720 #define wxWindowPalm wxWindow
1721 #endif // wxUniv/!wxUniv
1722 #include "wx/palmos/window.h"
1723 #elif defined(__WXMSW__)
1724 #ifdef __WXUNIVERSAL__
1725 #define wxWindowNative wxWindowMSW
1727 #define wxWindowMSW wxWindow
1728 #endif // wxUniv/!wxUniv
1729 #include "wx/msw/window.h"
1730 #elif defined(__WXMOTIF__)
1731 #include "wx/motif/window.h"
1732 #elif defined(__WXGTK20__)
1733 #ifdef __WXUNIVERSAL__
1734 #define wxWindowNative wxWindowGTK
1736 #define wxWindowGTK wxWindow
1738 #include "wx/gtk/window.h"
1739 #elif defined(__WXGTK__)
1740 #ifdef __WXUNIVERSAL__
1741 #define wxWindowNative wxWindowGTK
1743 #define wxWindowGTK wxWindow
1745 #include "wx/gtk1/window.h"
1746 #elif defined(__WXX11__)
1747 #ifdef __WXUNIVERSAL__
1748 #define wxWindowNative wxWindowX11
1750 #define wxWindowX11 wxWindow
1752 #include "wx/x11/window.h"
1753 #elif defined(__WXMGL__)
1754 #define wxWindowNative wxWindowMGL
1755 #include "wx/mgl/window.h"
1756 #elif defined(__WXDFB__)
1757 #define wxWindowNative wxWindowDFB
1758 #include "wx/dfb/window.h"
1759 #elif defined(__WXMAC__)
1760 #ifdef __WXUNIVERSAL__
1761 #define wxWindowNative wxWindowMac
1763 #define wxWindowMac wxWindow
1765 #include "wx/osx/window.h"
1766 #elif defined(__WXCOCOA__)
1767 #ifdef __WXUNIVERSAL__
1768 #define wxWindowNative wxWindowCocoa
1770 #define wxWindowCocoa wxWindow
1772 #include "wx/cocoa/window.h"
1773 #elif defined(__WXPM__)
1774 #ifdef __WXUNIVERSAL__
1775 #define wxWindowNative wxWindowOS2
1777 #define wxWindowOS2 wxWindow
1778 #endif // wxUniv/!wxUniv
1779 #include "wx/os2/window.h"
1782 // for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
1783 // for the native ports we already have defined it above
1784 #if defined(__WXUNIVERSAL__)
1785 #ifndef wxWindowNative
1786 #error "wxWindowNative must be defined above!"
1789 #include "wx/univ/window.h"
1792 // ----------------------------------------------------------------------------
1793 // inline functions which couldn't be declared in the class body because of
1794 // forward dependencies
1795 // ----------------------------------------------------------------------------
1797 inline wxWindow
*wxWindowBase::GetGrandParent() const
1799 return m_parent
? m_parent
->GetParent() : NULL
;
1802 // ----------------------------------------------------------------------------
1804 // ----------------------------------------------------------------------------
1806 // Find the wxWindow at the current mouse position, also returning the mouse
1808 extern WXDLLIMPEXP_CORE wxWindow
* wxFindWindowAtPointer(wxPoint
& pt
);
1810 // Get the current mouse position.
1811 extern WXDLLIMPEXP_CORE wxPoint
wxGetMousePosition();
1813 // get the currently active window of this application or NULL
1814 extern WXDLLIMPEXP_CORE wxWindow
*wxGetActiveWindow();
1816 // get the (first) top level parent window
1817 WXDLLIMPEXP_CORE wxWindow
* wxGetTopLevelParent(wxWindow
*win
);
1819 #if WXWIN_COMPATIBILITY_2_6
1820 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
1821 wxDEPRECATED( wxWindowID
NewControlId() );
1822 inline wxWindowID
NewControlId() { return wxWindowBase::NewControlId(); }
1823 #endif // WXWIN_COMPATIBILITY_2_6
1825 #if wxUSE_ACCESSIBILITY
1826 // ----------------------------------------------------------------------------
1827 // accessible object for windows
1828 // ----------------------------------------------------------------------------
1830 class WXDLLIMPEXP_CORE wxWindowAccessible
: public wxAccessible
1833 wxWindowAccessible(wxWindow
* win
): wxAccessible(win
) { if (win
) win
->SetAccessible(this); }
1834 virtual ~wxWindowAccessible() {}
1838 // Can return either a child object, or an integer
1839 // representing the child element, starting from 1.
1840 virtual wxAccStatus
HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
);
1842 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
1843 virtual wxAccStatus
GetLocation(wxRect
& rect
, int elementId
);
1845 // Navigates from fromId to toId/toObject.
1846 virtual wxAccStatus
Navigate(wxNavDir navDir
, int fromId
,
1847 int* toId
, wxAccessible
** toObject
);
1849 // Gets the name of the specified object.
1850 virtual wxAccStatus
GetName(int childId
, wxString
* name
);
1852 // Gets the number of children.
1853 virtual wxAccStatus
GetChildCount(int* childCount
);
1855 // Gets the specified child (starting from 1).
1856 // If *child is NULL and return value is wxACC_OK,
1857 // this means that the child is a simple element and
1858 // not an accessible object.
1859 virtual wxAccStatus
GetChild(int childId
, wxAccessible
** child
);
1861 // Gets the parent, or NULL.
1862 virtual wxAccStatus
GetParent(wxAccessible
** parent
);
1864 // Performs the default action. childId is 0 (the action for this object)
1865 // or > 0 (the action for a child).
1866 // Return wxACC_NOT_SUPPORTED if there is no default action for this
1867 // window (e.g. an edit control).
1868 virtual wxAccStatus
DoDefaultAction(int childId
);
1870 // Gets the default action for this object (0) or > 0 (the action for a child).
1871 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
1872 // string if there is no action.
1873 // The retrieved string describes the action that is performed on an object,
1874 // not what the object does as a result. For example, a toolbar button that prints
1875 // a document has a default action of "Press" rather than "Prints the current document."
1876 virtual wxAccStatus
GetDefaultAction(int childId
, wxString
* actionName
);
1878 // Returns the description for this object or a child.
1879 virtual wxAccStatus
GetDescription(int childId
, wxString
* description
);
1881 // Returns help text for this object or a child, similar to tooltip text.
1882 virtual wxAccStatus
GetHelpText(int childId
, wxString
* helpText
);
1884 // Returns the keyboard shortcut for this object or child.
1885 // Return e.g. ALT+K
1886 virtual wxAccStatus
GetKeyboardShortcut(int childId
, wxString
* shortcut
);
1888 // Returns a role constant.
1889 virtual wxAccStatus
GetRole(int childId
, wxAccRole
* role
);
1891 // Returns a state constant.
1892 virtual wxAccStatus
GetState(int childId
, long* state
);
1894 // Returns a localized string representing the value for the object
1896 virtual wxAccStatus
GetValue(int childId
, wxString
* strValue
);
1898 // Selects the object or child.
1899 virtual wxAccStatus
Select(int childId
, wxAccSelectionFlags selectFlags
);
1901 // Gets the window with the keyboard focus.
1902 // If childId is 0 and child is NULL, no object in
1903 // this subhierarchy has the focus.
1904 // If this object has the focus, child should be 'this'.
1905 virtual wxAccStatus
GetFocus(int* childId
, wxAccessible
** child
);
1908 // Gets a variant representing the selected children
1910 // Acceptable values:
1911 // - a null variant (IsNull() returns true)
1912 // - a list variant (GetType() == wxT("list")
1913 // - an integer representing the selected child element,
1914 // or 0 if this object is selected (GetType() == wxT("long")
1915 // - a "void*" pointer to a wxAccessible child object
1916 virtual wxAccStatus
GetSelections(wxVariant
* selections
);
1917 #endif // wxUSE_VARIANT
1920 #endif // wxUSE_ACCESSIBILITY
1923 #endif // _WX_WINDOW_H_BASE_