1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/window.cpp
3 // Purpose: common (to all ports) wxWindow functions
4 // Author: Julian Smart, Vadim Zeitlin
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
28 #include "wx/string.h"
32 #include "wx/window.h"
33 #include "wx/control.h"
34 #include "wx/checkbox.h"
35 #include "wx/radiobut.h"
36 #include "wx/statbox.h"
37 #include "wx/textctrl.h"
38 #include "wx/settings.h"
39 #include "wx/dialog.h"
40 #include "wx/msgdlg.h"
41 #include "wx/statusbr.h"
42 #include "wx/toolbar.h"
43 #include "wx/dcclient.h"
44 #include "wx/scrolbar.h"
45 #include "wx/layout.h"
49 #if wxUSE_DRAG_AND_DROP
51 #endif // wxUSE_DRAG_AND_DROP
53 #if wxUSE_ACCESSIBILITY
54 #include "wx/access.h"
58 #include "wx/cshelp.h"
62 #include "wx/tooltip.h"
63 #endif // wxUSE_TOOLTIPS
69 #if wxUSE_SYSTEM_OPTIONS
70 #include "wx/sysopt.h"
73 // For reporting compile- and runtime version of GTK+ in the ctrl+alt+mclick dialog.
74 // The gtk includes don't pull any other headers in, at least not on my system - MR
77 #include <gtk/gtkversion.h>
79 #include <gtk/gtkfeatures.h>
83 #include "wx/platinfo.h"
86 WXDLLIMPEXP_DATA_CORE(wxWindowList
) wxTopLevelWindows
;
88 // ----------------------------------------------------------------------------
90 // ----------------------------------------------------------------------------
93 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase
, wxEvtHandler
)
95 // ----------------------------------------------------------------------------
97 // ----------------------------------------------------------------------------
99 BEGIN_EVENT_TABLE(wxWindowBase
, wxEvtHandler
)
100 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged
)
101 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog
)
102 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick
)
105 EVT_HELP(wxID_ANY
, wxWindowBase::OnHelp
)
110 // ============================================================================
111 // implementation of the common functionality of the wxWindow class
112 // ============================================================================
114 // ----------------------------------------------------------------------------
116 // ----------------------------------------------------------------------------
118 // the default initialization
119 wxWindowBase::wxWindowBase()
121 // no window yet, no parent nor children
122 m_parent
= (wxWindow
*)NULL
;
123 m_windowId
= wxID_ANY
;
125 // no constraints on the minimal window size
127 m_maxWidth
= wxDefaultCoord
;
129 m_maxHeight
= wxDefaultCoord
;
131 // invalidiated cache value
132 m_bestSizeCache
= wxDefaultSize
;
134 // window are created enabled and visible by default
138 // the default event handler is just this window
139 m_eventHandler
= this;
143 m_windowValidator
= (wxValidator
*) NULL
;
144 #endif // wxUSE_VALIDATORS
146 // the colours/fonts are default for now, so leave m_font,
147 // m_backgroundColour and m_foregroundColour uninitialized and set those
153 m_inheritFont
= false;
159 m_backgroundStyle
= wxBG_STYLE_SYSTEM
;
161 #if wxUSE_CONSTRAINTS
162 // no constraints whatsoever
163 m_constraints
= (wxLayoutConstraints
*) NULL
;
164 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
165 #endif // wxUSE_CONSTRAINTS
167 m_windowSizer
= (wxSizer
*) NULL
;
168 m_containingSizer
= (wxSizer
*) NULL
;
169 m_autoLayout
= false;
172 #if wxUSE_DRAG_AND_DROP
173 m_dropTarget
= (wxDropTarget
*)NULL
;
174 #endif // wxUSE_DRAG_AND_DROP
177 m_tooltip
= (wxToolTip
*)NULL
;
178 #endif // wxUSE_TOOLTIPS
181 m_caret
= (wxCaret
*)NULL
;
182 #endif // wxUSE_CARET
185 m_hasCustomPalette
= false;
186 #endif // wxUSE_PALETTE
188 #if wxUSE_ACCESSIBILITY
192 m_virtualSize
= wxDefaultSize
;
194 m_scrollHelper
= (wxScrollHelper
*) NULL
;
197 m_maxVirtualWidth
= wxDefaultCoord
;
199 m_maxVirtualHeight
= wxDefaultCoord
;
201 m_windowVariant
= wxWINDOW_VARIANT_NORMAL
;
202 #if wxUSE_SYSTEM_OPTIONS
203 if ( wxSystemOptions::HasOption(wxWINDOW_DEFAULT_VARIANT
) )
205 m_windowVariant
= (wxWindowVariant
) wxSystemOptions::GetOptionInt( wxWINDOW_DEFAULT_VARIANT
) ;
209 // Whether we're using the current theme for this window (wxGTK only for now)
210 m_themeEnabled
= false;
212 // VZ: this one shouldn't exist...
213 m_isBeingDeleted
= false;
216 // common part of window creation process
217 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
219 const wxPoint
& WXUNUSED(pos
),
220 const wxSize
& WXUNUSED(size
),
222 const wxValidator
& wxVALIDATOR_PARAM(validator
),
223 const wxString
& name
)
226 // wxGTK doesn't allow to create controls with static box as the parent so
227 // this will result in a crash when the program is ported to wxGTK so warn
230 // if you get this assert, the correct solution is to create the controls
231 // as siblings of the static box
232 wxASSERT_MSG( !parent
|| !wxDynamicCast(parent
, wxStaticBox
),
233 _T("wxStaticBox can't be used as a window parent!") );
234 #endif // wxUSE_STATBOX
236 // ids are limited to 16 bits under MSW so if you care about portability,
237 // it's not a good idea to use ids out of this range (and negative ids are
238 // reserved for wxWidgets own usage)
239 wxASSERT_MSG( id
== wxID_ANY
|| (id
>= 0 && id
< 32767) ||
240 (id
>= wxID_AUTO_LOWEST
&& id
<= wxID_AUTO_HIGHEST
),
241 _T("invalid id value") );
243 // generate a new id if the user doesn't care about it
244 if ( id
== wxID_ANY
)
246 m_windowId
= NewControlId();
248 // remember to call ReleaseControlId() when this window is destroyed
251 else // valid id specified
256 // don't use SetWindowStyleFlag() here, this function should only be called
257 // to change the flag after creation as it tries to reflect the changes in
258 // flags by updating the window dynamically and we don't need this here
259 m_windowStyle
= style
;
265 SetValidator(validator
);
266 #endif // wxUSE_VALIDATORS
268 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
269 // have it too - like this it's possible to set it only in the top level
270 // dialog/frame and all children will inherit it by defult
271 if ( parent
&& (parent
->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) )
273 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY
);
279 bool wxWindowBase::ToggleWindowStyle(int flag
)
281 wxASSERT_MSG( flag
, _T("flags with 0 value can't be toggled") );
284 long style
= GetWindowStyleFlag();
290 else // currently off
296 SetWindowStyleFlag(style
);
301 // ----------------------------------------------------------------------------
303 // ----------------------------------------------------------------------------
306 wxWindowBase::~wxWindowBase()
308 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
310 // mark the id as unused if we allocated it for this control
312 ReleaseControlId(m_windowId
);
314 // FIXME if these 2 cases result from programming errors in the user code
315 // we should probably assert here instead of silently fixing them
317 // Just in case the window has been Closed, but we're then deleting
318 // immediately: don't leave dangling pointers.
319 wxPendingDelete
.DeleteObject(this);
321 // Just in case we've loaded a top-level window via LoadNativeDialog but
322 // we weren't a dialog class
323 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
325 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
327 // notify the parent about this window destruction
329 m_parent
->RemoveChild(this);
333 #endif // wxUSE_CARET
336 delete m_windowValidator
;
337 #endif // wxUSE_VALIDATORS
339 #if wxUSE_CONSTRAINTS
340 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
341 // at deleted windows as they delete themselves.
342 DeleteRelatedConstraints();
346 // This removes any dangling pointers to this window in other windows'
347 // constraintsInvolvedIn lists.
348 UnsetConstraints(m_constraints
);
349 delete m_constraints
;
350 m_constraints
= NULL
;
352 #endif // wxUSE_CONSTRAINTS
354 if ( m_containingSizer
)
355 m_containingSizer
->Detach( (wxWindow
*)this );
357 delete m_windowSizer
;
359 #if wxUSE_DRAG_AND_DROP
361 #endif // wxUSE_DRAG_AND_DROP
365 #endif // wxUSE_TOOLTIPS
367 #if wxUSE_ACCESSIBILITY
372 void wxWindowBase::SendDestroyEvent()
374 wxWindowDestroyEvent event
;
375 event
.SetEventObject(this);
376 event
.SetId(GetId());
377 GetEventHandler()->ProcessEvent(event
);
380 bool wxWindowBase::Destroy()
387 bool wxWindowBase::Close(bool force
)
389 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
390 event
.SetEventObject(this);
391 event
.SetCanVeto(!force
);
393 // return false if window wasn't closed because the application vetoed the
395 return GetEventHandler()->ProcessEvent(event
) && !event
.GetVeto();
398 bool wxWindowBase::DestroyChildren()
400 wxWindowList::compatibility_iterator node
;
403 // we iterate until the list becomes empty
404 node
= GetChildren().GetFirst();
408 wxWindow
*child
= node
->GetData();
410 // note that we really want to call delete and not ->Destroy() here
411 // because we want to delete the child immediately, before we are
412 // deleted, and delayed deletion would result in problems as our (top
413 // level) child could outlive its parent
416 wxASSERT_MSG( !GetChildren().Find(child
),
417 wxT("child didn't remove itself using RemoveChild()") );
423 // ----------------------------------------------------------------------------
424 // size/position related methods
425 // ----------------------------------------------------------------------------
427 // centre the window with respect to its parent in either (or both) directions
428 void wxWindowBase::DoCentre(int dir
)
430 wxCHECK_RET( !(dir
& wxCENTRE_ON_SCREEN
) && GetParent(),
431 _T("this method only implements centering child windows") );
433 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir
));
436 // fits the window around the children
437 void wxWindowBase::Fit()
439 if ( !GetChildren().empty() )
441 SetSize(GetBestSize());
443 //else: do nothing if we have no children
446 // fits virtual size (ie. scrolled area etc.) around children
447 void wxWindowBase::FitInside()
449 if ( GetChildren().GetCount() > 0 )
451 SetVirtualSize( GetBestVirtualSize() );
455 // On Mac, scrollbars are explicitly children.
457 static bool wxHasRealChildren(const wxWindowBase
* win
)
459 int realChildCount
= 0;
461 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
463 node
= node
->GetNext() )
465 wxWindow
*win
= node
->GetData();
466 if ( !win
->IsTopLevel() && win
->IsShown() && !win
->IsKindOf(CLASSINFO(wxScrollBar
)))
469 return (realChildCount
> 0);
473 void wxWindowBase::InvalidateBestSize()
475 m_bestSizeCache
= wxDefaultSize
;
477 // parent's best size calculation may depend on its children's
478 // as long as child window we are in is not top level window itself
479 // (because the TLW size is never resized automatically)
480 // so let's invalidate it as well to be safe:
481 if (m_parent
&& !IsTopLevel())
482 m_parent
->InvalidateBestSize();
485 // return the size best suited for the current window
486 wxSize
wxWindowBase::DoGetBestSize() const
492 best
= m_windowSizer
->GetMinSize();
494 #if wxUSE_CONSTRAINTS
495 else if ( m_constraints
)
497 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
499 // our minimal acceptable size is such that all our windows fit inside
503 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
505 node
= node
->GetNext() )
507 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
510 // it's not normal that we have an unconstrained child, but
511 // what can we do about it?
515 int x
= c
->right
.GetValue(),
516 y
= c
->bottom
.GetValue();
524 // TODO: we must calculate the overlaps somehow, otherwise we
525 // will never return a size bigger than the current one :-(
528 best
= wxSize(maxX
, maxY
);
530 #endif // wxUSE_CONSTRAINTS
531 else if ( !GetChildren().empty()
533 && wxHasRealChildren(this)
537 // our minimal acceptable size is such that all our visible child
538 // windows fit inside
542 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
544 node
= node
->GetNext() )
546 wxWindow
*win
= node
->GetData();
547 if ( win
->IsTopLevel()
550 || wxDynamicCast(win
, wxStatusBar
)
551 #endif // wxUSE_STATUSBAR
554 // dialogs and frames lie in different top level windows -
555 // don't deal with them here; as for the status bars, they
556 // don't lie in the client area at all
561 win
->GetPosition(&wx
, &wy
);
563 // if the window hadn't been positioned yet, assume that it is in
565 if ( wx
== wxDefaultCoord
)
567 if ( wy
== wxDefaultCoord
)
570 win
->GetSize(&ww
, &wh
);
571 if ( wx
+ ww
> maxX
)
573 if ( wy
+ wh
> maxY
)
577 best
= wxSize(maxX
, maxY
);
579 else // ! has children
581 // for a generic window there is no natural best size so, if the
582 // minimal size is not set, use the current size but take care to
583 // remember it as minimal size for the next time because our best size
584 // should be constant: otherwise we could get into a situation when the
585 // window is initially at some size, then expanded to a larger size and
586 // then, when the containing window is shrunk back (because our initial
587 // best size had been used for computing the parent min size), we can't
588 // be shrunk back any more because our best size is now bigger
589 wxSize size
= GetMinSize();
590 if ( !size
.IsFullySpecified() )
592 size
.SetDefaults(GetSize());
593 wxConstCast(this, wxWindowBase
)->SetMinSize(size
);
596 // return as-is, unadjusted by the client size difference.
600 // Add any difference between size and client size
601 wxSize diff
= GetSize() - GetClientSize();
602 best
.x
+= wxMax(0, diff
.x
);
603 best
.y
+= wxMax(0, diff
.y
);
608 // helper of GetWindowBorderSize(): as many ports don't implement support for
609 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
610 // fallbacks in this case
611 static int wxGetMetricOrDefault(wxSystemMetric what
)
613 int rc
= wxSystemSettings::GetMetric(what
);
620 // 2D border is by default 1 pixel wide
626 // 3D borders are by default 2 pixels
631 wxFAIL_MSG( _T("unexpected wxGetMetricOrDefault() argument") );
639 wxSize
wxWindowBase::GetWindowBorderSize() const
643 switch ( GetBorder() )
646 // nothing to do, size is already (0, 0)
649 case wxBORDER_SIMPLE
:
650 case wxBORDER_STATIC
:
651 size
.x
= wxGetMetricOrDefault(wxSYS_BORDER_X
);
652 size
.y
= wxGetMetricOrDefault(wxSYS_BORDER_Y
);
655 case wxBORDER_SUNKEN
:
656 case wxBORDER_RAISED
:
657 size
.x
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X
),
658 wxGetMetricOrDefault(wxSYS_BORDER_X
));
659 size
.y
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y
),
660 wxGetMetricOrDefault(wxSYS_BORDER_Y
));
663 case wxBORDER_DOUBLE
:
664 size
.x
= wxGetMetricOrDefault(wxSYS_EDGE_X
) +
665 wxGetMetricOrDefault(wxSYS_BORDER_X
);
666 size
.y
= wxGetMetricOrDefault(wxSYS_EDGE_Y
) +
667 wxGetMetricOrDefault(wxSYS_BORDER_Y
);
671 wxFAIL_MSG(_T("Unknown border style."));
675 // we have borders on both sides
679 wxSize
wxWindowBase::GetEffectiveMinSize() const
681 // merge the best size with the min size, giving priority to the min size
682 wxSize min
= GetMinSize();
683 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
685 wxSize best
= GetBestSize();
686 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
687 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
693 void wxWindowBase::SetInitialSize(const wxSize
& size
)
695 // Set the min size to the size passed in. This will usually either be
696 // wxDefaultSize or the size passed to this window's ctor/Create function.
699 // Merge the size with the best size if needed
700 wxSize best
= GetEffectiveMinSize();
702 // If the current size doesn't match then change it
703 if (GetSize() != best
)
708 // by default the origin is not shifted
709 wxPoint
wxWindowBase::GetClientAreaOrigin() const
714 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
716 if ( m_windowVariant
!= variant
)
718 m_windowVariant
= variant
;
720 DoSetWindowVariant(variant
);
724 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
726 // adjust the font height to correspond to our new variant (notice that
727 // we're only called if something really changed)
728 wxFont font
= GetFont();
729 int size
= font
.GetPointSize();
732 case wxWINDOW_VARIANT_NORMAL
:
735 case wxWINDOW_VARIANT_SMALL
:
740 case wxWINDOW_VARIANT_MINI
:
745 case wxWINDOW_VARIANT_LARGE
:
751 wxFAIL_MSG(_T("unexpected window variant"));
755 font
.SetPointSize(size
);
759 void wxWindowBase::DoSetSizeHints( int minW
, int minH
,
761 int WXUNUSED(incW
), int WXUNUSED(incH
) )
763 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
764 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
765 _T("min width/height must be less than max width/height!") );
774 void wxWindowBase::SetVirtualSizeHints( int minW
, int minH
,
777 m_minVirtualWidth
= minW
;
778 m_maxVirtualWidth
= maxW
;
779 m_minVirtualHeight
= minH
;
780 m_maxVirtualHeight
= maxH
;
783 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
785 if ( m_minVirtualWidth
!= wxDefaultCoord
&& m_minVirtualWidth
> x
)
786 x
= m_minVirtualWidth
;
787 if ( m_maxVirtualWidth
!= wxDefaultCoord
&& m_maxVirtualWidth
< x
)
788 x
= m_maxVirtualWidth
;
789 if ( m_minVirtualHeight
!= wxDefaultCoord
&& m_minVirtualHeight
> y
)
790 y
= m_minVirtualHeight
;
791 if ( m_maxVirtualHeight
!= wxDefaultCoord
&& m_maxVirtualHeight
< y
)
792 y
= m_maxVirtualHeight
;
794 m_virtualSize
= wxSize(x
, y
);
797 wxSize
wxWindowBase::DoGetVirtualSize() const
799 // we should use the entire client area so if it is greater than our
800 // virtual size, expand it to fit (otherwise if the window is big enough we
801 // wouldn't be using parts of it)
802 wxSize size
= GetClientSize();
803 if ( m_virtualSize
.x
> size
.x
)
804 size
.x
= m_virtualSize
.x
;
806 if ( m_virtualSize
.y
>= size
.y
)
807 size
.y
= m_virtualSize
.y
;
812 void wxWindowBase::DoGetScreenPosition(int *x
, int *y
) const
814 // screen position is the same as (0, 0) in client coords for non TLWs (and
815 // TLWs override this method)
821 ClientToScreen(x
, y
);
824 // ----------------------------------------------------------------------------
825 // show/hide/enable/disable the window
826 // ----------------------------------------------------------------------------
828 bool wxWindowBase::Show(bool show
)
830 if ( show
!= m_isShown
)
842 bool wxWindowBase::IsEnabled() const
844 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
847 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled
)
849 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
851 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
855 // If we are top-level then the logic doesn't apply - otherwise
856 // showing a modal dialog would result in total greying out (and ungreying
857 // out later) of everything which would be really ugly
861 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
863 node
= node
->GetNext() )
865 wxWindowBase
* const child
= node
->GetData();
866 if ( !child
->IsTopLevel() && child
->IsThisEnabled() )
867 child
->NotifyWindowOnEnableChange(enabled
);
871 bool wxWindowBase::Enable(bool enable
)
873 if ( enable
== IsThisEnabled() )
876 m_isEnabled
= enable
;
878 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
880 #else // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
881 wxWindowBase
* const parent
= GetParent();
882 if( !IsTopLevel() && parent
&& !parent
->IsEnabled() )
886 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
888 NotifyWindowOnEnableChange(enable
);
893 bool wxWindowBase::IsShownOnScreen() const
896 (GetParent() == NULL
|| GetParent()->IsShownOnScreen());
899 // ----------------------------------------------------------------------------
901 // ----------------------------------------------------------------------------
903 bool wxWindowBase::IsTopLevel() const
908 // ----------------------------------------------------------------------------
909 // reparenting the window
910 // ----------------------------------------------------------------------------
912 void wxWindowBase::AddChild(wxWindowBase
*child
)
914 wxCHECK_RET( child
, wxT("can't add a NULL child") );
916 // this should never happen and it will lead to a crash later if it does
917 // because RemoveChild() will remove only one node from the children list
918 // and the other(s) one(s) will be left with dangling pointers in them
919 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), _T("AddChild() called twice") );
921 GetChildren().Append((wxWindow
*)child
);
922 child
->SetParent(this);
925 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
927 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
929 GetChildren().DeleteObject((wxWindow
*)child
);
930 child
->SetParent(NULL
);
933 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
935 wxWindow
*oldParent
= GetParent();
936 if ( newParent
== oldParent
)
942 const bool oldEnabledState
= IsEnabled();
944 // unlink this window from the existing parent.
947 oldParent
->RemoveChild(this);
951 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
954 // add it to the new one
957 newParent
->AddChild(this);
961 wxTopLevelWindows
.Append((wxWindow
*)this);
964 // We need to notify window (and its subwindows) if by changing the parent
965 // we also change our enabled/disabled status.
966 const bool newEnabledState
= IsEnabled();
967 if ( newEnabledState
!= oldEnabledState
)
969 NotifyWindowOnEnableChange(newEnabledState
);
975 // ----------------------------------------------------------------------------
976 // event handler stuff
977 // ----------------------------------------------------------------------------
979 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
981 wxEvtHandler
*handlerOld
= GetEventHandler();
983 handler
->SetNextHandler(handlerOld
);
986 GetEventHandler()->SetPreviousHandler(handler
);
988 SetEventHandler(handler
);
991 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
993 wxEvtHandler
*handlerA
= GetEventHandler();
996 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
997 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
1000 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
1001 SetEventHandler(handlerB
);
1003 if ( deleteHandler
)
1006 handlerA
= (wxEvtHandler
*)NULL
;
1013 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
1015 wxCHECK_MSG( handler
, false, _T("RemoveEventHandler(NULL) called") );
1017 wxEvtHandler
*handlerPrev
= NULL
,
1018 *handlerCur
= GetEventHandler();
1019 while ( handlerCur
)
1021 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1023 if ( handlerCur
== handler
)
1027 handlerPrev
->SetNextHandler(handlerNext
);
1031 SetEventHandler(handlerNext
);
1036 handlerNext
->SetPreviousHandler ( handlerPrev
);
1039 handler
->SetNextHandler(NULL
);
1040 handler
->SetPreviousHandler(NULL
);
1045 handlerPrev
= handlerCur
;
1046 handlerCur
= handlerNext
;
1049 wxFAIL_MSG( _T("where has the event handler gone?") );
1054 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1056 return GetEventHandler()->SafelyProcessEvent(event
);
1059 // ----------------------------------------------------------------------------
1060 // colours, fonts &c
1061 // ----------------------------------------------------------------------------
1063 void wxWindowBase::InheritAttributes()
1065 const wxWindowBase
* const parent
= GetParent();
1069 // we only inherit attributes which had been explicitly set for the parent
1070 // which ensures that this only happens if the user really wants it and
1071 // not by default which wouldn't make any sense in modern GUIs where the
1072 // controls don't all use the same fonts (nor colours)
1073 if ( parent
->m_inheritFont
&& !m_hasFont
)
1074 SetFont(parent
->GetFont());
1076 // in addition, there is a possibility to explicitly forbid inheriting
1077 // colours at each class level by overriding ShouldInheritColours()
1078 if ( ShouldInheritColours() )
1080 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1081 SetForegroundColour(parent
->GetForegroundColour());
1083 // inheriting (solid) background colour is wrong as it totally breaks
1084 // any kind of themed backgrounds
1086 // instead, the controls should use the same background as their parent
1087 // (ideally by not drawing it at all)
1089 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1090 SetBackgroundColour(parent
->GetBackgroundColour());
1095 /* static */ wxVisualAttributes
1096 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1098 // it is important to return valid values for all attributes from here,
1099 // GetXXX() below rely on this
1100 wxVisualAttributes attrs
;
1101 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1102 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1104 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1105 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1106 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1107 // colour on other platforms.
1109 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1110 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1112 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1117 wxColour
wxWindowBase::GetBackgroundColour() const
1119 if ( !m_backgroundColour
.Ok() )
1121 wxASSERT_MSG( !m_hasBgCol
, _T("we have invalid explicit bg colour?") );
1123 // get our default background colour
1124 wxColour colBg
= GetDefaultAttributes().colBg
;
1126 // we must return some valid colour to avoid redoing this every time
1127 // and also to avoid surprizing the applications written for older
1128 // wxWidgets versions where GetBackgroundColour() always returned
1129 // something -- so give them something even if it doesn't make sense
1130 // for this window (e.g. it has a themed background)
1132 colBg
= GetClassDefaultAttributes().colBg
;
1137 return m_backgroundColour
;
1140 wxColour
wxWindowBase::GetForegroundColour() const
1142 // logic is the same as above
1143 if ( !m_hasFgCol
&& !m_foregroundColour
.Ok() )
1145 wxColour colFg
= GetDefaultAttributes().colFg
;
1148 colFg
= GetClassDefaultAttributes().colFg
;
1153 return m_foregroundColour
;
1156 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1158 if ( colour
== m_backgroundColour
)
1161 m_hasBgCol
= colour
.Ok();
1162 if ( m_backgroundStyle
!= wxBG_STYLE_CUSTOM
)
1163 m_backgroundStyle
= m_hasBgCol
? wxBG_STYLE_COLOUR
: wxBG_STYLE_SYSTEM
;
1165 m_inheritBgCol
= m_hasBgCol
;
1166 m_backgroundColour
= colour
;
1167 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.Ok() );
1171 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1173 if (colour
== m_foregroundColour
)
1176 m_hasFgCol
= colour
.Ok();
1177 m_inheritFgCol
= m_hasFgCol
;
1178 m_foregroundColour
= colour
;
1179 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.Ok() );
1183 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1185 // setting an invalid cursor is ok, it means that we don't have any special
1187 if ( m_cursor
.IsSameAs(cursor
) )
1198 wxFont
wxWindowBase::GetFont() const
1200 // logic is the same as in GetBackgroundColour()
1203 wxASSERT_MSG( !m_hasFont
, _T("we have invalid explicit font?") );
1205 wxFont font
= GetDefaultAttributes().font
;
1207 font
= GetClassDefaultAttributes().font
;
1215 bool wxWindowBase::SetFont(const wxFont
& font
)
1217 if ( font
== m_font
)
1224 m_hasFont
= font
.Ok();
1225 m_inheritFont
= m_hasFont
;
1227 InvalidateBestSize();
1234 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1236 m_hasCustomPalette
= true;
1239 // VZ: can anyone explain me what do we do here?
1240 wxWindowDC
d((wxWindow
*) this);
1244 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1246 wxWindow
*win
= (wxWindow
*)this;
1247 while ( win
&& !win
->HasCustomPalette() )
1249 win
= win
->GetParent();
1255 #endif // wxUSE_PALETTE
1258 void wxWindowBase::SetCaret(wxCaret
*caret
)
1269 wxASSERT_MSG( m_caret
->GetWindow() == this,
1270 wxT("caret should be created associated to this window") );
1273 #endif // wxUSE_CARET
1275 #if wxUSE_VALIDATORS
1276 // ----------------------------------------------------------------------------
1278 // ----------------------------------------------------------------------------
1280 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1282 if ( m_windowValidator
)
1283 delete m_windowValidator
;
1285 m_windowValidator
= (wxValidator
*)validator
.Clone();
1287 if ( m_windowValidator
)
1288 m_windowValidator
->SetWindow(this);
1290 #endif // wxUSE_VALIDATORS
1292 // ----------------------------------------------------------------------------
1293 // update region stuff
1294 // ----------------------------------------------------------------------------
1296 wxRect
wxWindowBase::GetUpdateClientRect() const
1298 wxRegion rgnUpdate
= GetUpdateRegion();
1299 rgnUpdate
.Intersect(GetClientRect());
1300 wxRect rectUpdate
= rgnUpdate
.GetBox();
1301 wxPoint ptOrigin
= GetClientAreaOrigin();
1302 rectUpdate
.x
-= ptOrigin
.x
;
1303 rectUpdate
.y
-= ptOrigin
.y
;
1308 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1310 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1313 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1315 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1318 void wxWindowBase::ClearBackground()
1320 // wxGTK uses its own version, no need to add never used code
1322 wxClientDC
dc((wxWindow
*)this);
1323 wxBrush
brush(GetBackgroundColour(), wxSOLID
);
1324 dc
.SetBackground(brush
);
1329 // ----------------------------------------------------------------------------
1330 // find child window by id or name
1331 // ----------------------------------------------------------------------------
1333 wxWindow
*wxWindowBase::FindWindow(long id
) const
1335 if ( id
== m_windowId
)
1336 return (wxWindow
*)this;
1338 wxWindowBase
*res
= (wxWindow
*)NULL
;
1339 wxWindowList::compatibility_iterator node
;
1340 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1342 wxWindowBase
*child
= node
->GetData();
1343 res
= child
->FindWindow( id
);
1346 return (wxWindow
*)res
;
1349 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1351 if ( name
== m_windowName
)
1352 return (wxWindow
*)this;
1354 wxWindowBase
*res
= (wxWindow
*)NULL
;
1355 wxWindowList::compatibility_iterator node
;
1356 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1358 wxWindow
*child
= node
->GetData();
1359 res
= child
->FindWindow(name
);
1362 return (wxWindow
*)res
;
1366 // find any window by id or name or label: If parent is non-NULL, look through
1367 // children for a label or title matching the specified string. If NULL, look
1368 // through all top-level windows.
1370 // to avoid duplicating code we reuse the same helper function but with
1371 // different comparators
1373 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1374 const wxString
& label
, long id
);
1377 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1380 return win
->GetLabel() == label
;
1384 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1387 return win
->GetName() == label
;
1391 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1394 return win
->GetId() == id
;
1397 // recursive helper for the FindWindowByXXX() functions
1399 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1400 const wxString
& label
,
1402 wxFindWindowCmp cmp
)
1406 // see if this is the one we're looking for
1407 if ( (*cmp
)(parent
, label
, id
) )
1408 return (wxWindow
*)parent
;
1410 // It wasn't, so check all its children
1411 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1413 node
= node
->GetNext() )
1415 // recursively check each child
1416 wxWindow
*win
= (wxWindow
*)node
->GetData();
1417 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1427 // helper for FindWindowByXXX()
1429 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1430 const wxString
& label
,
1432 wxFindWindowCmp cmp
)
1436 // just check parent and all its children
1437 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1440 // start at very top of wx's windows
1441 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1443 node
= node
->GetNext() )
1445 // recursively check each window & its children
1446 wxWindow
*win
= node
->GetData();
1447 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1457 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1459 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1464 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1466 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1470 // fall back to the label
1471 win
= FindWindowByLabel(title
, parent
);
1479 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1481 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1484 // ----------------------------------------------------------------------------
1485 // dialog oriented functions
1486 // ----------------------------------------------------------------------------
1488 void wxWindowBase::MakeModal(bool modal
)
1490 // Disable all other windows
1493 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1496 wxWindow
*win
= node
->GetData();
1498 win
->Enable(!modal
);
1500 node
= node
->GetNext();
1505 bool wxWindowBase::Validate()
1507 #if wxUSE_VALIDATORS
1508 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1510 wxWindowList::compatibility_iterator node
;
1511 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1513 wxWindowBase
*child
= node
->GetData();
1514 wxValidator
*validator
= child
->GetValidator();
1515 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1520 if ( recurse
&& !child
->Validate() )
1525 #endif // wxUSE_VALIDATORS
1530 bool wxWindowBase::TransferDataToWindow()
1532 #if wxUSE_VALIDATORS
1533 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1535 wxWindowList::compatibility_iterator node
;
1536 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1538 wxWindowBase
*child
= node
->GetData();
1539 wxValidator
*validator
= child
->GetValidator();
1540 if ( validator
&& !validator
->TransferToWindow() )
1542 wxLogWarning(_("Could not transfer data to window"));
1544 wxLog::FlushActive();
1552 if ( !child
->TransferDataToWindow() )
1554 // warning already given
1559 #endif // wxUSE_VALIDATORS
1564 bool wxWindowBase::TransferDataFromWindow()
1566 #if wxUSE_VALIDATORS
1567 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1569 wxWindowList::compatibility_iterator node
;
1570 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1572 wxWindow
*child
= node
->GetData();
1573 wxValidator
*validator
= child
->GetValidator();
1574 if ( validator
&& !validator
->TransferFromWindow() )
1576 // nop warning here because the application is supposed to give
1577 // one itself - we don't know here what might have gone wrongly
1584 if ( !child
->TransferDataFromWindow() )
1586 // warning already given
1591 #endif // wxUSE_VALIDATORS
1596 void wxWindowBase::InitDialog()
1598 wxInitDialogEvent
event(GetId());
1599 event
.SetEventObject( this );
1600 GetEventHandler()->ProcessEvent(event
);
1603 // ----------------------------------------------------------------------------
1604 // context-sensitive help support
1605 // ----------------------------------------------------------------------------
1609 // associate this help text with this window
1610 void wxWindowBase::SetHelpText(const wxString
& text
)
1612 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1615 helpProvider
->AddHelp(this, text
);
1619 // associate this help text with all windows with the same id as this
1621 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1623 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1626 helpProvider
->AddHelp(GetId(), text
);
1630 // get the help string associated with this window (may be empty)
1631 // default implementation forwards calls to the help provider
1633 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
1634 wxHelpEvent::Origin
WXUNUSED(origin
)) const
1637 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1640 text
= helpProvider
->GetHelp(this);
1646 // show help for this window
1647 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1649 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1652 if ( helpProvider
->ShowHelpAtPoint(this, event
.GetPosition(), event
.GetOrigin()) )
1654 // skip the event.Skip() below
1662 #endif // wxUSE_HELP
1664 // ----------------------------------------------------------------------------
1666 // ----------------------------------------------------------------------------
1670 void wxWindowBase::SetToolTip( const wxString
&tip
)
1672 // don't create the new tooltip if we already have one
1675 m_tooltip
->SetTip( tip
);
1679 SetToolTip( new wxToolTip( tip
) );
1682 // setting empty tooltip text does not remove the tooltip any more - use
1683 // SetToolTip((wxToolTip *)NULL) for this
1686 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1688 if ( m_tooltip
!= tooltip
)
1693 m_tooltip
= tooltip
;
1697 #endif // wxUSE_TOOLTIPS
1699 // ----------------------------------------------------------------------------
1700 // constraints and sizers
1701 // ----------------------------------------------------------------------------
1703 #if wxUSE_CONSTRAINTS
1705 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1707 if ( m_constraints
)
1709 UnsetConstraints(m_constraints
);
1710 delete m_constraints
;
1712 m_constraints
= constraints
;
1713 if ( m_constraints
)
1715 // Make sure other windows know they're part of a 'meaningful relationship'
1716 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1717 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1718 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1719 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1720 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1721 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1722 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1723 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1724 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1725 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1726 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1727 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1728 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1729 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1730 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1731 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1735 // This removes any dangling pointers to this window in other windows'
1736 // constraintsInvolvedIn lists.
1737 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1741 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1742 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1743 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1744 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1745 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1746 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1747 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1748 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1749 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1750 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1751 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1752 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1753 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1754 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1755 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1756 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1760 // Back-pointer to other windows we're involved with, so if we delete this
1761 // window, we must delete any constraints we're involved with.
1762 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1764 if ( !m_constraintsInvolvedIn
)
1765 m_constraintsInvolvedIn
= new wxWindowList
;
1766 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
1767 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
1770 // REMOVE back-pointer to other windows we're involved with.
1771 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1773 if ( m_constraintsInvolvedIn
)
1774 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
1777 // Reset any constraints that mention this window
1778 void wxWindowBase::DeleteRelatedConstraints()
1780 if ( m_constraintsInvolvedIn
)
1782 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
1785 wxWindow
*win
= node
->GetData();
1786 wxLayoutConstraints
*constr
= win
->GetConstraints();
1788 // Reset any constraints involving this window
1791 constr
->left
.ResetIfWin(this);
1792 constr
->top
.ResetIfWin(this);
1793 constr
->right
.ResetIfWin(this);
1794 constr
->bottom
.ResetIfWin(this);
1795 constr
->width
.ResetIfWin(this);
1796 constr
->height
.ResetIfWin(this);
1797 constr
->centreX
.ResetIfWin(this);
1798 constr
->centreY
.ResetIfWin(this);
1801 wxWindowList::compatibility_iterator next
= node
->GetNext();
1802 m_constraintsInvolvedIn
->Erase(node
);
1806 delete m_constraintsInvolvedIn
;
1807 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1811 #endif // wxUSE_CONSTRAINTS
1813 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1815 if ( sizer
== m_windowSizer
)
1818 if ( m_windowSizer
)
1820 m_windowSizer
->SetContainingWindow(NULL
);
1823 delete m_windowSizer
;
1826 m_windowSizer
= sizer
;
1827 if ( m_windowSizer
)
1829 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
1832 SetAutoLayout(m_windowSizer
!= NULL
);
1835 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1837 SetSizer( sizer
, deleteOld
);
1838 sizer
->SetSizeHints( (wxWindow
*) this );
1842 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
1844 // adding a window to a sizer twice is going to result in fatal and
1845 // hard to debug problems later because when deleting the second
1846 // associated wxSizerItem we're going to dereference a dangling
1847 // pointer; so try to detect this as early as possible
1848 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
1849 _T("Adding a window to the same sizer twice?") );
1851 m_containingSizer
= sizer
;
1854 #if wxUSE_CONSTRAINTS
1856 void wxWindowBase::SatisfyConstraints()
1858 wxLayoutConstraints
*constr
= GetConstraints();
1859 bool wasOk
= constr
&& constr
->AreSatisfied();
1861 ResetConstraints(); // Mark all constraints as unevaluated
1865 // if we're a top level panel (i.e. our parent is frame/dialog), our
1866 // own constraints will never be satisfied any more unless we do it
1870 while ( noChanges
> 0 )
1872 LayoutPhase1(&noChanges
);
1876 LayoutPhase2(&noChanges
);
1879 #endif // wxUSE_CONSTRAINTS
1881 bool wxWindowBase::Layout()
1883 // If there is a sizer, use it instead of the constraints
1887 GetVirtualSize(&w
, &h
);
1888 GetSizer()->SetDimension( 0, 0, w
, h
);
1890 #if wxUSE_CONSTRAINTS
1893 SatisfyConstraints(); // Find the right constraints values
1894 SetConstraintSizes(); // Recursively set the real window sizes
1901 #if wxUSE_CONSTRAINTS
1903 // first phase of the constraints evaluation: set our own constraints
1904 bool wxWindowBase::LayoutPhase1(int *noChanges
)
1906 wxLayoutConstraints
*constr
= GetConstraints();
1908 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
1911 // second phase: set the constraints for our children
1912 bool wxWindowBase::LayoutPhase2(int *noChanges
)
1919 // Layout grand children
1925 // Do a phase of evaluating child constraints
1926 bool wxWindowBase::DoPhase(int phase
)
1928 // the list containing the children for which the constraints are already
1930 wxWindowList succeeded
;
1932 // the max number of iterations we loop before concluding that we can't set
1934 static const int maxIterations
= 500;
1936 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
1940 // loop over all children setting their constraints
1941 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1943 node
= node
->GetNext() )
1945 wxWindow
*child
= node
->GetData();
1946 if ( child
->IsTopLevel() )
1948 // top level children are not inside our client area
1952 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
1954 // this one is either already ok or nothing we can do about it
1958 int tempNoChanges
= 0;
1959 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
1960 : child
->LayoutPhase2(&tempNoChanges
);
1961 noChanges
+= tempNoChanges
;
1965 succeeded
.Append(child
);
1971 // constraints are set
1979 void wxWindowBase::ResetConstraints()
1981 wxLayoutConstraints
*constr
= GetConstraints();
1984 constr
->left
.SetDone(false);
1985 constr
->top
.SetDone(false);
1986 constr
->right
.SetDone(false);
1987 constr
->bottom
.SetDone(false);
1988 constr
->width
.SetDone(false);
1989 constr
->height
.SetDone(false);
1990 constr
->centreX
.SetDone(false);
1991 constr
->centreY
.SetDone(false);
1994 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1997 wxWindow
*win
= node
->GetData();
1998 if ( !win
->IsTopLevel() )
1999 win
->ResetConstraints();
2000 node
= node
->GetNext();
2004 // Need to distinguish between setting the 'fake' size for windows and sizers,
2005 // and setting the real values.
2006 void wxWindowBase::SetConstraintSizes(bool recurse
)
2008 wxLayoutConstraints
*constr
= GetConstraints();
2009 if ( constr
&& constr
->AreSatisfied() )
2011 int x
= constr
->left
.GetValue();
2012 int y
= constr
->top
.GetValue();
2013 int w
= constr
->width
.GetValue();
2014 int h
= constr
->height
.GetValue();
2016 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2017 (constr
->height
.GetRelationship() != wxAsIs
) )
2019 SetSize(x
, y
, w
, h
);
2023 // If we don't want to resize this window, just move it...
2029 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2030 GetClassInfo()->GetClassName(),
2036 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2039 wxWindow
*win
= node
->GetData();
2040 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2041 win
->SetConstraintSizes();
2042 node
= node
->GetNext();
2047 // Only set the size/position of the constraint (if any)
2048 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2050 wxLayoutConstraints
*constr
= GetConstraints();
2053 if ( x
!= wxDefaultCoord
)
2055 constr
->left
.SetValue(x
);
2056 constr
->left
.SetDone(true);
2058 if ( y
!= wxDefaultCoord
)
2060 constr
->top
.SetValue(y
);
2061 constr
->top
.SetDone(true);
2063 if ( w
!= wxDefaultCoord
)
2065 constr
->width
.SetValue(w
);
2066 constr
->width
.SetDone(true);
2068 if ( h
!= wxDefaultCoord
)
2070 constr
->height
.SetValue(h
);
2071 constr
->height
.SetDone(true);
2076 void wxWindowBase::MoveConstraint(int x
, int y
)
2078 wxLayoutConstraints
*constr
= GetConstraints();
2081 if ( x
!= wxDefaultCoord
)
2083 constr
->left
.SetValue(x
);
2084 constr
->left
.SetDone(true);
2086 if ( y
!= wxDefaultCoord
)
2088 constr
->top
.SetValue(y
);
2089 constr
->top
.SetDone(true);
2094 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2096 wxLayoutConstraints
*constr
= GetConstraints();
2099 *w
= constr
->width
.GetValue();
2100 *h
= constr
->height
.GetValue();
2106 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2108 wxLayoutConstraints
*constr
= GetConstraints();
2111 *w
= constr
->width
.GetValue();
2112 *h
= constr
->height
.GetValue();
2115 GetClientSize(w
, h
);
2118 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2120 wxLayoutConstraints
*constr
= GetConstraints();
2123 *x
= constr
->left
.GetValue();
2124 *y
= constr
->top
.GetValue();
2130 #endif // wxUSE_CONSTRAINTS
2132 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2134 // don't do it for the dialogs/frames - they float independently of their
2136 if ( !IsTopLevel() )
2138 wxWindow
*parent
= GetParent();
2139 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2141 wxPoint
pt(parent
->GetClientAreaOrigin());
2148 // ----------------------------------------------------------------------------
2149 // Update UI processing
2150 // ----------------------------------------------------------------------------
2152 void wxWindowBase::UpdateWindowUI(long flags
)
2154 wxUpdateUIEvent
event(GetId());
2155 event
.SetEventObject(this);
2157 if ( GetEventHandler()->ProcessEvent(event
) )
2159 DoUpdateWindowUI(event
);
2162 if (flags
& wxUPDATE_UI_RECURSE
)
2164 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2167 wxWindow
* child
= (wxWindow
*) node
->GetData();
2168 child
->UpdateWindowUI(flags
);
2169 node
= node
->GetNext();
2174 // do the window-specific processing after processing the update event
2175 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2177 if ( event
.GetSetEnabled() )
2178 Enable(event
.GetEnabled());
2180 if ( event
.GetSetShown() )
2181 Show(event
.GetShown());
2184 // ----------------------------------------------------------------------------
2185 // dialog units translations
2186 // ----------------------------------------------------------------------------
2188 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
2190 int charWidth
= GetCharWidth();
2191 int charHeight
= GetCharHeight();
2192 wxPoint pt2
= wxDefaultPosition
;
2193 if (pt
.x
!= wxDefaultCoord
)
2194 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
);
2195 if (pt
.y
!= wxDefaultCoord
)
2196 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
);
2201 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
2203 int charWidth
= GetCharWidth();
2204 int charHeight
= GetCharHeight();
2205 wxPoint pt2
= wxDefaultPosition
;
2206 if (pt
.x
!= wxDefaultCoord
)
2207 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4);
2208 if (pt
.y
!= wxDefaultCoord
)
2209 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8);
2214 // ----------------------------------------------------------------------------
2216 // ----------------------------------------------------------------------------
2218 // propagate the colour change event to the subwindows
2219 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
2221 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2224 // Only propagate to non-top-level windows
2225 wxWindow
*win
= node
->GetData();
2226 if ( !win
->IsTopLevel() )
2228 wxSysColourChangedEvent event2
;
2229 event
.SetEventObject(win
);
2230 win
->GetEventHandler()->ProcessEvent(event2
);
2233 node
= node
->GetNext();
2239 // the default action is to populate dialog with data when it's created,
2240 // and nudge the UI into displaying itself correctly in case
2241 // we've turned the wxUpdateUIEvents frequency down low.
2242 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2244 TransferDataToWindow();
2246 // Update the UI at this point
2247 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2250 // ----------------------------------------------------------------------------
2251 // menu-related functions
2252 // ----------------------------------------------------------------------------
2256 // this is used to pass the id of the selected item from the menu event handler
2257 // to the main function itself
2259 // it's ok to use a global here as there can be at most one popup menu shown at
2261 static int gs_popupMenuSelection
= wxID_NONE
;
2263 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2265 // store the id in a global variable where we'll retrieve it from later
2266 gs_popupMenuSelection
= event
.GetId();
2270 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2272 gs_popupMenuSelection
= wxID_NONE
;
2274 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2275 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2279 PopupMenu(&menu
, x
, y
);
2281 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2282 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2286 return gs_popupMenuSelection
;
2289 #endif // wxUSE_MENUS
2291 // methods for drawing the sizers in a visible way
2294 static void DrawSizers(wxWindowBase
*win
);
2296 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
= false)
2298 wxClientDC
dc((wxWindow
*)win
);
2299 dc
.SetPen(*wxRED_PEN
);
2300 dc
.SetBrush(fill
? wxBrush(*wxRED
, wxCROSSDIAG_HATCH
): *wxTRANSPARENT_BRUSH
);
2301 dc
.DrawRectangle(rect
.Deflate(1, 1));
2304 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2306 const wxSizerItemList
& items
= sizer
->GetChildren();
2307 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2312 wxSizerItem
*item
= *i
;
2313 if ( item
->IsSizer() )
2315 DrawBorder(win
, item
->GetRect().Deflate(2));
2316 DrawSizer(win
, item
->GetSizer());
2318 else if ( item
->IsSpacer() )
2320 DrawBorder(win
, item
->GetRect().Deflate(2), true);
2322 else if ( item
->IsWindow() )
2324 DrawSizers(item
->GetWindow());
2329 static void DrawSizers(wxWindowBase
*win
)
2331 wxSizer
*sizer
= win
->GetSizer();
2334 DrawBorder(win
, win
->GetClientSize());
2335 DrawSizer(win
, sizer
);
2337 else // no sizer, still recurse into the children
2339 const wxWindowList
& children
= win
->GetChildren();
2340 for ( wxWindowList::const_iterator i
= children
.begin(),
2341 end
= children
.end();
2350 #endif // __WXDEBUG__
2352 // process special middle clicks
2353 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2355 if ( event
.ControlDown() && event
.AltDown() )
2358 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
2359 if ( event
.ShiftDown() )
2364 #endif // __WXDEBUG__
2365 ::wxInfoMessageBox((wxWindow
*)this);
2373 // ----------------------------------------------------------------------------
2375 // ----------------------------------------------------------------------------
2377 #if wxUSE_ACCESSIBILITY
2378 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
2380 if (m_accessible
&& (accessible
!= m_accessible
))
2381 delete m_accessible
;
2382 m_accessible
= accessible
;
2384 m_accessible
->SetWindow((wxWindow
*) this);
2387 // Returns the accessible object, creating if necessary.
2388 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
2391 m_accessible
= CreateAccessible();
2392 return m_accessible
;
2395 // Override to create a specific accessible object.
2396 wxAccessible
* wxWindowBase::CreateAccessible()
2398 return new wxWindowAccessible((wxWindow
*) this);
2403 // ----------------------------------------------------------------------------
2404 // list classes implementation
2405 // ----------------------------------------------------------------------------
2409 #include "wx/listimpl.cpp"
2410 WX_DEFINE_LIST(wxWindowList
)
2414 void wxWindowListNode::DeleteData()
2416 delete (wxWindow
*)GetData();
2419 #endif // wxUSE_STL/!wxUSE_STL
2421 // ----------------------------------------------------------------------------
2423 // ----------------------------------------------------------------------------
2425 wxBorder
wxWindowBase::GetBorder(long flags
) const
2427 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
2428 if ( border
== wxBORDER_DEFAULT
)
2430 border
= GetDefaultBorder();
2432 else if ( border
== wxBORDER_THEME
)
2434 border
= GetDefaultBorderForControl();
2440 wxBorder
wxWindowBase::GetDefaultBorder() const
2442 return wxBORDER_NONE
;
2445 // ----------------------------------------------------------------------------
2447 // ----------------------------------------------------------------------------
2449 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2451 // here we just check if the point is inside the window or not
2453 // check the top and left border first
2454 bool outside
= x
< 0 || y
< 0;
2457 // check the right and bottom borders too
2458 wxSize size
= GetSize();
2459 outside
= x
>= size
.x
|| y
>= size
.y
;
2462 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2465 // ----------------------------------------------------------------------------
2467 // ----------------------------------------------------------------------------
2469 struct WXDLLEXPORT wxWindowNext
2473 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2474 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
2475 bool wxWindowBase::ms_winCaptureChanging
= false;
2477 void wxWindowBase::CaptureMouse()
2479 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), wx_static_cast(void*, this));
2481 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive CaptureMouse call?") );
2483 ms_winCaptureChanging
= true;
2485 wxWindow
*winOld
= GetCapture();
2488 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2491 wxWindowNext
*item
= new wxWindowNext
;
2493 item
->next
= ms_winCaptureNext
;
2494 ms_winCaptureNext
= item
;
2496 //else: no mouse capture to save
2499 ms_winCaptureCurrent
= (wxWindow
*)this;
2501 ms_winCaptureChanging
= false;
2504 void wxWindowBase::ReleaseMouse()
2506 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), wx_static_cast(void*, this));
2508 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive ReleaseMouse call?") );
2510 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2512 ms_winCaptureChanging
= true;
2515 ms_winCaptureCurrent
= NULL
;
2517 if ( ms_winCaptureNext
)
2519 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2520 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
2522 wxWindowNext
*item
= ms_winCaptureNext
;
2523 ms_winCaptureNext
= item
->next
;
2526 //else: stack is empty, no previous capture
2528 ms_winCaptureChanging
= false;
2530 wxLogTrace(_T("mousecapture"),
2531 (const wxChar
*) _T("After ReleaseMouse() mouse is captured by %p"),
2532 wx_static_cast(void*, GetCapture()));
2535 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
2537 wxMouseCaptureLostEvent
event(win
->GetId());
2538 event
.SetEventObject(win
);
2539 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
2541 // windows must handle this event, otherwise the app wouldn't behave
2542 // correctly if it loses capture unexpectedly; see the discussion here:
2543 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
2544 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
2545 wxFAIL_MSG( _T("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
2550 void wxWindowBase::NotifyCaptureLost()
2552 // don't do anything if capture lost was expected, i.e. resulted from
2553 // a wx call to ReleaseMouse or CaptureMouse:
2554 if ( ms_winCaptureChanging
)
2557 // if the capture was lost unexpectedly, notify every window that has
2558 // capture (on stack or current) about it and clear the stack:
2560 if ( ms_winCaptureCurrent
)
2562 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
2563 ms_winCaptureCurrent
= NULL
;
2566 while ( ms_winCaptureNext
)
2568 wxWindowNext
*item
= ms_winCaptureNext
;
2569 ms_winCaptureNext
= item
->next
;
2571 DoNotifyWindowAboutCaptureLost(item
->win
);
2580 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
2581 int WXUNUSED(modifiers
),
2582 int WXUNUSED(keycode
))
2588 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
2594 #endif // wxUSE_HOTKEY
2596 // ----------------------------------------------------------------------------
2598 // ----------------------------------------------------------------------------
2600 bool wxWindowBase::TryValidator(wxEvent
& wxVALIDATOR_PARAM(event
))
2602 #if wxUSE_VALIDATORS
2603 // Can only use the validator of the window which
2604 // is receiving the event
2605 if ( event
.GetEventObject() == this )
2607 wxValidator
*validator
= GetValidator();
2608 if ( validator
&& validator
->ProcessEvent(event
) )
2613 #endif // wxUSE_VALIDATORS
2618 bool wxWindowBase::TryParent(wxEvent
& event
)
2620 // carry on up the parent-child hierarchy if the propagation count hasn't
2622 if ( event
.ShouldPropagate() )
2624 // honour the requests to stop propagation at this window: this is
2625 // used by the dialogs, for example, to prevent processing the events
2626 // from the dialog controls in the parent frame which rarely, if ever,
2628 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
2630 wxWindow
*parent
= GetParent();
2631 if ( parent
&& !parent
->IsBeingDeleted() )
2633 wxPropagateOnce
propagateOnce(event
);
2635 return parent
->GetEventHandler()->ProcessEvent(event
);
2640 return wxEvtHandler::TryParent(event
);
2643 // ----------------------------------------------------------------------------
2644 // window relationships
2645 // ----------------------------------------------------------------------------
2647 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
2649 wxCHECK_MSG( GetParent(), NULL
,
2650 _T("GetPrev/NextSibling() don't work for TLWs!") );
2652 wxWindowList
& siblings
= GetParent()->GetChildren();
2653 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
2654 wxCHECK_MSG( i
, NULL
, _T("window not a child of its parent?") );
2656 if ( order
== OrderBefore
)
2657 i
= i
->GetPrevious();
2661 return i
? i
->GetData() : NULL
;
2664 // ----------------------------------------------------------------------------
2665 // keyboard navigation
2666 // ----------------------------------------------------------------------------
2668 // Navigates in the specified direction inside this window
2669 bool wxWindowBase::DoNavigateIn(int flags
)
2671 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
2672 // native code doesn't process our wxNavigationKeyEvents anyhow
2675 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
2676 wxNavigationKeyEvent eventNav
;
2677 eventNav
.SetFlags(flags
);
2678 eventNav
.SetEventObject(FindFocus());
2679 return GetEventHandler()->ProcessEvent(eventNav
);
2680 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
2683 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
2685 // check that we're not a top level window
2686 wxCHECK_RET( GetParent(),
2687 _T("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
2689 // detect the special case when we have nothing to do anyhow and when the
2690 // code below wouldn't work
2694 // find the target window in the siblings list
2695 wxWindowList
& siblings
= GetParent()->GetChildren();
2696 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
2697 wxCHECK_RET( i
, _T("MoveBefore/AfterInTabOrder(): win is not a sibling") );
2699 // unfortunately, when wxUSE_STL == 1 DetachNode() is not implemented so we
2700 // can't just move the node around
2701 wxWindow
*self
= (wxWindow
*)this;
2702 siblings
.DeleteObject(self
);
2703 if ( move
== OrderAfter
)
2710 siblings
.Insert(i
, self
);
2712 else // OrderAfter and win was the last sibling
2714 siblings
.Append(self
);
2718 // ----------------------------------------------------------------------------
2720 // ----------------------------------------------------------------------------
2722 /*static*/ wxWindow
* wxWindowBase::FindFocus()
2724 wxWindowBase
*win
= DoFindFocus();
2725 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
2728 // ----------------------------------------------------------------------------
2730 // ----------------------------------------------------------------------------
2732 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2734 while ( win
&& !win
->IsTopLevel() )
2735 win
= win
->GetParent();
2740 #if wxUSE_ACCESSIBILITY
2741 // ----------------------------------------------------------------------------
2742 // accessible object for windows
2743 // ----------------------------------------------------------------------------
2745 // Can return either a child object, or an integer
2746 // representing the child element, starting from 1.
2747 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
2749 wxASSERT( GetWindow() != NULL
);
2753 return wxACC_NOT_IMPLEMENTED
;
2756 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2757 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2759 wxASSERT( GetWindow() != NULL
);
2763 wxWindow
* win
= NULL
;
2770 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2772 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
2779 rect
= win
->GetRect();
2780 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2781 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2785 return wxACC_NOT_IMPLEMENTED
;
2788 // Navigates from fromId to toId/toObject.
2789 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2790 int* WXUNUSED(toId
), wxAccessible
** toObject
)
2792 wxASSERT( GetWindow() != NULL
);
2798 case wxNAVDIR_FIRSTCHILD
:
2800 if (GetWindow()->GetChildren().GetCount() == 0)
2802 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2803 *toObject
= childWindow
->GetOrCreateAccessible();
2807 case wxNAVDIR_LASTCHILD
:
2809 if (GetWindow()->GetChildren().GetCount() == 0)
2811 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2812 *toObject
= childWindow
->GetOrCreateAccessible();
2816 case wxNAVDIR_RIGHT
:
2820 wxWindowList::compatibility_iterator node
=
2821 wxWindowList::compatibility_iterator();
2824 // Can't navigate to sibling of this window
2825 // if we're a top-level window.
2826 if (!GetWindow()->GetParent())
2827 return wxACC_NOT_IMPLEMENTED
;
2829 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2833 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2834 node
= GetWindow()->GetChildren().Item(fromId
-1);
2837 if (node
&& node
->GetNext())
2839 wxWindow
* nextWindow
= node
->GetNext()->GetData();
2840 *toObject
= nextWindow
->GetOrCreateAccessible();
2848 case wxNAVDIR_PREVIOUS
:
2850 wxWindowList::compatibility_iterator node
=
2851 wxWindowList::compatibility_iterator();
2854 // Can't navigate to sibling of this window
2855 // if we're a top-level window.
2856 if (!GetWindow()->GetParent())
2857 return wxACC_NOT_IMPLEMENTED
;
2859 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2863 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2864 node
= GetWindow()->GetChildren().Item(fromId
-1);
2867 if (node
&& node
->GetPrevious())
2869 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
2870 *toObject
= previousWindow
->GetOrCreateAccessible();
2878 return wxACC_NOT_IMPLEMENTED
;
2881 // Gets the name of the specified object.
2882 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
2884 wxASSERT( GetWindow() != NULL
);
2890 // If a child, leave wxWidgets to call the function on the actual
2893 return wxACC_NOT_IMPLEMENTED
;
2895 // This will eventually be replaced by specialised
2896 // accessible classes, one for each kind of wxWidgets
2897 // control or window.
2899 if (GetWindow()->IsKindOf(CLASSINFO(wxButton
)))
2900 title
= ((wxButton
*) GetWindow())->GetLabel();
2903 title
= GetWindow()->GetName();
2911 return wxACC_NOT_IMPLEMENTED
;
2914 // Gets the number of children.
2915 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
2917 wxASSERT( GetWindow() != NULL
);
2921 *childId
= (int) GetWindow()->GetChildren().GetCount();
2925 // Gets the specified child (starting from 1).
2926 // If *child is NULL and return value is wxACC_OK,
2927 // this means that the child is a simple element and
2928 // not an accessible object.
2929 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
2931 wxASSERT( GetWindow() != NULL
);
2941 if (childId
> (int) GetWindow()->GetChildren().GetCount())
2944 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
2945 *child
= childWindow
->GetOrCreateAccessible();
2952 // Gets the parent, or NULL.
2953 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
2955 wxASSERT( GetWindow() != NULL
);
2959 wxWindow
* parentWindow
= GetWindow()->GetParent();
2967 *parent
= parentWindow
->GetOrCreateAccessible();
2975 // Performs the default action. childId is 0 (the action for this object)
2976 // or > 0 (the action for a child).
2977 // Return wxACC_NOT_SUPPORTED if there is no default action for this
2978 // window (e.g. an edit control).
2979 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
2981 wxASSERT( GetWindow() != NULL
);
2985 return wxACC_NOT_IMPLEMENTED
;
2988 // Gets the default action for this object (0) or > 0 (the action for a child).
2989 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
2990 // string if there is no action.
2991 // The retrieved string describes the action that is performed on an object,
2992 // not what the object does as a result. For example, a toolbar button that prints
2993 // a document has a default action of "Press" rather than "Prints the current document."
2994 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
2996 wxASSERT( GetWindow() != NULL
);
3000 return wxACC_NOT_IMPLEMENTED
;
3003 // Returns the description for this object or a child.
3004 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3006 wxASSERT( GetWindow() != NULL
);
3010 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3016 return wxACC_NOT_IMPLEMENTED
;
3019 // Returns help text for this object or a child, similar to tooltip text.
3020 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3022 wxASSERT( GetWindow() != NULL
);
3026 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3032 return wxACC_NOT_IMPLEMENTED
;
3035 // Returns the keyboard shortcut for this object or child.
3036 // Return e.g. ALT+K
3037 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3039 wxASSERT( GetWindow() != NULL
);
3043 return wxACC_NOT_IMPLEMENTED
;
3046 // Returns a role constant.
3047 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3049 wxASSERT( GetWindow() != NULL
);
3053 // If a child, leave wxWidgets to call the function on the actual
3056 return wxACC_NOT_IMPLEMENTED
;
3058 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3059 return wxACC_NOT_IMPLEMENTED
;
3061 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3062 return wxACC_NOT_IMPLEMENTED
;
3065 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3066 return wxACC_NOT_IMPLEMENTED
;
3069 //*role = wxROLE_SYSTEM_CLIENT;
3070 *role
= wxROLE_SYSTEM_CLIENT
;
3074 return wxACC_NOT_IMPLEMENTED
;
3078 // Returns a state constant.
3079 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3081 wxASSERT( GetWindow() != NULL
);
3085 // If a child, leave wxWidgets to call the function on the actual
3088 return wxACC_NOT_IMPLEMENTED
;
3090 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3091 return wxACC_NOT_IMPLEMENTED
;
3094 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3095 return wxACC_NOT_IMPLEMENTED
;
3098 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3099 return wxACC_NOT_IMPLEMENTED
;
3106 return wxACC_NOT_IMPLEMENTED
;
3110 // Returns a localized string representing the value for the object
3112 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3114 wxASSERT( GetWindow() != NULL
);
3118 return wxACC_NOT_IMPLEMENTED
;
3121 // Selects the object or child.
3122 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3124 wxASSERT( GetWindow() != NULL
);
3128 return wxACC_NOT_IMPLEMENTED
;
3131 // Gets the window with the keyboard focus.
3132 // If childId is 0 and child is NULL, no object in
3133 // this subhierarchy has the focus.
3134 // If this object has the focus, child should be 'this'.
3135 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3137 wxASSERT( GetWindow() != NULL
);
3141 return wxACC_NOT_IMPLEMENTED
;
3145 // Gets a variant representing the selected children
3147 // Acceptable values:
3148 // - a null variant (IsNull() returns true)
3149 // - a list variant (GetType() == wxT("list")
3150 // - an integer representing the selected child element,
3151 // or 0 if this object is selected (GetType() == wxT("long")
3152 // - a "void*" pointer to a wxAccessible child object
3153 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3155 wxASSERT( GetWindow() != NULL
);
3159 return wxACC_NOT_IMPLEMENTED
;
3161 #endif // wxUSE_VARIANT
3163 #endif // wxUSE_ACCESSIBILITY
3165 // ----------------------------------------------------------------------------
3167 // ----------------------------------------------------------------------------
3170 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3172 wxCoord widthTotal
) const
3174 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3176 x
= widthTotal
- x
- width
;
3182 // ----------------------------------------------------------------------------
3183 // Window (and menu items) identifiers management
3184 // ----------------------------------------------------------------------------
3189 // this array contains, in packed form, the "in use" flags for the entire
3190 // auto-generated ids range: N-th element of the array contains the flags for
3191 // ids in [wxID_AUTO_LOWEST + 8*N, wxID_AUTO_LOWEST + 8*N + 7] range
3193 // initially no ids are in use and we allocate them consecutively, but after we
3194 // exhaust the entire range, we wrap around and reuse the ids freed in the
3196 wxByte gs_autoIdsInUse
[(wxID_AUTO_HIGHEST
- wxID_AUTO_LOWEST
+ 1)/8 + 1] = { 0 };
3198 // this is an optimization used until we wrap around wxID_AUTO_HIGHEST: if this
3199 // value is < wxID_AUTO_HIGHEST we know that we haven't wrapped yet and so can
3200 // allocate the ids simply by incrementing it
3201 static wxWindowID gs_nextControlId
= wxID_AUTO_LOWEST
;
3203 void MarkAutoIdUsed(wxWindowID id
)
3205 id
-= wxID_AUTO_LOWEST
;
3207 const int theByte
= id
/ 8;
3208 const int theBit
= id
% 8;
3210 gs_autoIdsInUse
[theByte
] |= 1 << theBit
;
3213 void FreeAutoId(wxWindowID id
)
3215 id
-= wxID_AUTO_LOWEST
;
3217 const int theByte
= id
/ 8;
3218 const int theBit
= id
% 8;
3220 gs_autoIdsInUse
[theByte
] &= ~(1 << theBit
);
3223 bool IsAutoIdInUse(wxWindowID id
)
3225 id
-= wxID_AUTO_LOWEST
;
3227 const int theByte
= id
/ 8;
3228 const int theBit
= id
% 8;
3230 return (gs_autoIdsInUse
[theByte
] & (1 << theBit
)) != 0;
3233 } // anonymous namespace
3237 bool wxWindowBase::IsAutoGeneratedId(wxWindowID id
)
3239 if ( id
< wxID_AUTO_LOWEST
|| id
> wxID_AUTO_HIGHEST
)
3242 // we shouldn't have any stray ids in this range
3243 wxASSERT_MSG( IsAutoIdInUse(id
), "unused automatically generated id?" );
3248 wxWindowID
wxWindowBase::NewControlId(int count
)
3250 wxASSERT_MSG( count
> 0, "can't allocate less than 1 id" );
3252 if ( gs_nextControlId
+ count
- 1 <= wxID_AUTO_HIGHEST
)
3254 // we haven't wrapped yet, so we can just grab the next count ids
3255 wxWindowID id
= gs_nextControlId
;
3258 MarkAutoIdUsed(gs_nextControlId
++);
3262 else // we've already wrapped or are now going to
3264 // brute-force search for the id values
3266 // number of consecutive free ids found so far
3269 for ( wxWindowID id
= wxID_AUTO_LOWEST
; id
<= wxID_AUTO_HIGHEST
; id
++ )
3271 if ( !IsAutoIdInUse(id
) )
3273 // found another consecutive available id
3275 if ( found
== count
)
3277 // mark all count consecutive free ids we found as being in
3278 // use now and rewind back to the start of available range
3281 MarkAutoIdUsed(id
--);
3286 else // this id is in use
3288 // reset the number of consecutive free values found
3294 // if we get here, there are not enough consecutive free ids
3298 void wxWindowBase::ReleaseControlId(wxWindowID id
)
3300 wxCHECK_RET( IsAutoGeneratedId(id
), "can't release non auto-generated id" );