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"
50 #if wxUSE_DRAG_AND_DROP
52 #endif // wxUSE_DRAG_AND_DROP
54 #if wxUSE_ACCESSIBILITY
55 #include "wx/access.h"
59 #include "wx/cshelp.h"
63 #include "wx/tooltip.h"
64 #endif // wxUSE_TOOLTIPS
70 #if wxUSE_SYSTEM_OPTIONS
71 #include "wx/sysopt.h"
74 // For reporting compile- and runtime version of GTK+ in the ctrl+alt+mclick dialog.
75 // The gtk includes don't pull any other headers in, at least not on my system - MR
78 #include <gtk/gtkversion.h>
80 #include <gtk/gtkfeatures.h>
84 #include "wx/platinfo.h"
87 WXDLLIMPEXP_DATA_CORE(wxWindowList
) wxTopLevelWindows
;
91 wxMenu
*wxCurrentPopupMenu
= NULL
;
94 // ----------------------------------------------------------------------------
96 // ----------------------------------------------------------------------------
99 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase
, wxEvtHandler
)
101 // ----------------------------------------------------------------------------
103 // ----------------------------------------------------------------------------
105 BEGIN_EVENT_TABLE(wxWindowBase
, wxEvtHandler
)
106 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged
)
107 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog
)
108 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick
)
111 EVT_HELP(wxID_ANY
, wxWindowBase::OnHelp
)
116 // ============================================================================
117 // implementation of the common functionality of the wxWindow class
118 // ============================================================================
120 // ----------------------------------------------------------------------------
122 // ----------------------------------------------------------------------------
124 // the default initialization
125 wxWindowBase::wxWindowBase()
127 // no window yet, no parent nor children
128 m_parent
= (wxWindow
*)NULL
;
129 m_windowId
= wxID_ANY
;
131 // no constraints on the minimal window size
133 m_maxWidth
= wxDefaultCoord
;
135 m_maxHeight
= wxDefaultCoord
;
137 // invalidiated cache value
138 m_bestSizeCache
= wxDefaultSize
;
140 // window are created enabled and visible by default
144 // the default event handler is just this window
145 m_eventHandler
= this;
149 m_windowValidator
= (wxValidator
*) NULL
;
150 #endif // wxUSE_VALIDATORS
152 // the colours/fonts are default for now, so leave m_font,
153 // m_backgroundColour and m_foregroundColour uninitialized and set those
159 m_inheritFont
= false;
165 m_backgroundStyle
= wxBG_STYLE_SYSTEM
;
167 #if wxUSE_CONSTRAINTS
168 // no constraints whatsoever
169 m_constraints
= (wxLayoutConstraints
*) NULL
;
170 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
171 #endif // wxUSE_CONSTRAINTS
173 m_windowSizer
= (wxSizer
*) NULL
;
174 m_containingSizer
= (wxSizer
*) NULL
;
175 m_autoLayout
= false;
177 #if wxUSE_DRAG_AND_DROP
178 m_dropTarget
= (wxDropTarget
*)NULL
;
179 #endif // wxUSE_DRAG_AND_DROP
182 m_tooltip
= (wxToolTip
*)NULL
;
183 #endif // wxUSE_TOOLTIPS
186 m_caret
= (wxCaret
*)NULL
;
187 #endif // wxUSE_CARET
190 m_hasCustomPalette
= false;
191 #endif // wxUSE_PALETTE
193 #if wxUSE_ACCESSIBILITY
197 m_virtualSize
= wxDefaultSize
;
199 m_scrollHelper
= (wxScrollHelper
*) NULL
;
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;
218 // common part of window creation process
219 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
221 const wxPoint
& WXUNUSED(pos
),
222 const wxSize
& WXUNUSED(size
),
224 const wxValidator
& wxVALIDATOR_PARAM(validator
),
225 const wxString
& name
)
228 // wxGTK doesn't allow to create controls with static box as the parent so
229 // this will result in a crash when the program is ported to wxGTK so warn
232 // if you get this assert, the correct solution is to create the controls
233 // as siblings of the static box
234 wxASSERT_MSG( !parent
|| !wxDynamicCast(parent
, wxStaticBox
),
235 _T("wxStaticBox can't be used as a window parent!") );
236 #endif // wxUSE_STATBOX
238 // ids are limited to 16 bits under MSW so if you care about portability,
239 // it's not a good idea to use ids out of this range (and negative ids are
240 // reserved for wxWidgets own usage)
241 wxASSERT_MSG( id
== wxID_ANY
|| (id
>= 0 && id
< 32767) ||
242 (id
>= wxID_AUTO_LOWEST
&& id
<= wxID_AUTO_HIGHEST
),
243 _T("invalid id value") );
245 // generate a new id if the user doesn't care about it
246 if ( id
== wxID_ANY
)
248 m_windowId
= NewControlId();
250 else // valid id specified
255 // don't use SetWindowStyleFlag() here, this function should only be called
256 // to change the flag after creation as it tries to reflect the changes in
257 // flags by updating the window dynamically and we don't need this here
258 m_windowStyle
= style
;
264 SetValidator(validator
);
265 #endif // wxUSE_VALIDATORS
267 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
268 // have it too - like this it's possible to set it only in the top level
269 // dialog/frame and all children will inherit it by defult
270 if ( parent
&& (parent
->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) )
272 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY
);
278 bool wxWindowBase::ToggleWindowStyle(int flag
)
280 wxASSERT_MSG( flag
, _T("flags with 0 value can't be toggled") );
283 long style
= GetWindowStyleFlag();
289 else // currently off
295 SetWindowStyleFlag(style
);
300 // ----------------------------------------------------------------------------
302 // ----------------------------------------------------------------------------
305 wxWindowBase::~wxWindowBase()
307 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
309 // FIXME if these 2 cases result from programming errors in the user code
310 // we should probably assert here instead of silently fixing them
312 // Just in case the window has been Closed, but we're then deleting
313 // immediately: don't leave dangling pointers.
314 wxPendingDelete
.DeleteObject(this);
316 // Just in case we've loaded a top-level window via LoadNativeDialog but
317 // we weren't a dialog class
318 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
321 // The associated popup menu can still be alive, disassociate from it in
323 if ( wxCurrentPopupMenu
&& wxCurrentPopupMenu
->GetInvokingWindow() == this )
324 wxCurrentPopupMenu
->SetInvokingWindow(NULL
);
325 #endif // wxUSE_MENUS
327 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
329 // notify the parent about this window destruction
331 m_parent
->RemoveChild(this);
335 #endif // wxUSE_CARET
338 delete m_windowValidator
;
339 #endif // wxUSE_VALIDATORS
341 #if wxUSE_CONSTRAINTS
342 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
343 // at deleted windows as they delete themselves.
344 DeleteRelatedConstraints();
348 // This removes any dangling pointers to this window in other windows'
349 // constraintsInvolvedIn lists.
350 UnsetConstraints(m_constraints
);
351 delete m_constraints
;
352 m_constraints
= NULL
;
354 #endif // wxUSE_CONSTRAINTS
356 if ( m_containingSizer
)
357 m_containingSizer
->Detach( (wxWindow
*)this );
359 delete m_windowSizer
;
361 #if wxUSE_DRAG_AND_DROP
363 #endif // wxUSE_DRAG_AND_DROP
367 #endif // wxUSE_TOOLTIPS
369 #if wxUSE_ACCESSIBILITY
374 // NB: this has to be called unconditionally, because we don't know
375 // whether this window has associated help text or not
376 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
378 helpProvider
->RemoveHelp(this);
382 void wxWindowBase::SendDestroyEvent()
384 wxWindowDestroyEvent event
;
385 event
.SetEventObject(this);
386 event
.SetId(GetId());
387 GetEventHandler()->ProcessEvent(event
);
390 bool wxWindowBase::Destroy()
397 bool wxWindowBase::Close(bool force
)
399 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
400 event
.SetEventObject(this);
401 event
.SetCanVeto(!force
);
403 // return false if window wasn't closed because the application vetoed the
405 return HandleWindowEvent(event
) && !event
.GetVeto();
408 bool wxWindowBase::DestroyChildren()
410 wxWindowList::compatibility_iterator node
;
413 // we iterate until the list becomes empty
414 node
= GetChildren().GetFirst();
418 wxWindow
*child
= node
->GetData();
420 // note that we really want to call delete and not ->Destroy() here
421 // because we want to delete the child immediately, before we are
422 // deleted, and delayed deletion would result in problems as our (top
423 // level) child could outlive its parent
426 wxASSERT_MSG( !GetChildren().Find(child
),
427 wxT("child didn't remove itself using RemoveChild()") );
433 // ----------------------------------------------------------------------------
434 // size/position related methods
435 // ----------------------------------------------------------------------------
437 // centre the window with respect to its parent in either (or both) directions
438 void wxWindowBase::DoCentre(int dir
)
440 wxCHECK_RET( !(dir
& wxCENTRE_ON_SCREEN
) && GetParent(),
441 _T("this method only implements centering child windows") );
443 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir
));
446 // fits the window around the children
447 void wxWindowBase::Fit()
449 if ( !GetChildren().empty() )
451 SetSize(GetBestSize());
453 //else: do nothing if we have no children
456 // fits virtual size (ie. scrolled area etc.) around children
457 void wxWindowBase::FitInside()
459 if ( GetChildren().GetCount() > 0 )
461 SetVirtualSize( GetBestVirtualSize() );
465 // On Mac, scrollbars are explicitly children.
467 static bool wxHasRealChildren(const wxWindowBase
* win
)
469 int realChildCount
= 0;
471 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
473 node
= node
->GetNext() )
475 wxWindow
*win
= node
->GetData();
476 if ( !win
->IsTopLevel() && win
->IsShown() && !win
->IsKindOf(CLASSINFO(wxScrollBar
)))
479 return (realChildCount
> 0);
483 void wxWindowBase::InvalidateBestSize()
485 m_bestSizeCache
= wxDefaultSize
;
487 // parent's best size calculation may depend on its children's
488 // as long as child window we are in is not top level window itself
489 // (because the TLW size is never resized automatically)
490 // so let's invalidate it as well to be safe:
491 if (m_parent
&& !IsTopLevel())
492 m_parent
->InvalidateBestSize();
495 // return the size best suited for the current window
496 wxSize
wxWindowBase::DoGetBestSize() const
502 best
= m_windowSizer
->GetMinSize();
504 #if wxUSE_CONSTRAINTS
505 else if ( m_constraints
)
507 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
509 // our minimal acceptable size is such that all our windows fit inside
513 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
515 node
= node
->GetNext() )
517 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
520 // it's not normal that we have an unconstrained child, but
521 // what can we do about it?
525 int x
= c
->right
.GetValue(),
526 y
= c
->bottom
.GetValue();
534 // TODO: we must calculate the overlaps somehow, otherwise we
535 // will never return a size bigger than the current one :-(
538 best
= wxSize(maxX
, maxY
);
540 #endif // wxUSE_CONSTRAINTS
541 else if ( !GetChildren().empty()
543 && wxHasRealChildren(this)
547 // our minimal acceptable size is such that all our visible child
548 // windows fit inside
552 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
554 node
= node
->GetNext() )
556 wxWindow
*win
= node
->GetData();
557 if ( win
->IsTopLevel()
560 || wxDynamicCast(win
, wxStatusBar
)
561 #endif // wxUSE_STATUSBAR
564 // dialogs and frames lie in different top level windows -
565 // don't deal with them here; as for the status bars, they
566 // don't lie in the client area at all
571 win
->GetPosition(&wx
, &wy
);
573 // if the window hadn't been positioned yet, assume that it is in
575 if ( wx
== wxDefaultCoord
)
577 if ( wy
== wxDefaultCoord
)
580 win
->GetSize(&ww
, &wh
);
581 if ( wx
+ ww
> maxX
)
583 if ( wy
+ wh
> maxY
)
587 best
= wxSize(maxX
, maxY
);
589 else // ! has children
591 // for a generic window there is no natural best size so, if the
592 // minimal size is not set, use the current size but take care to
593 // remember it as minimal size for the next time because our best size
594 // should be constant: otherwise we could get into a situation when the
595 // window is initially at some size, then expanded to a larger size and
596 // then, when the containing window is shrunk back (because our initial
597 // best size had been used for computing the parent min size), we can't
598 // be shrunk back any more because our best size is now bigger
599 wxSize size
= GetMinSize();
600 if ( !size
.IsFullySpecified() )
602 size
.SetDefaults(GetSize());
603 wxConstCast(this, wxWindowBase
)->SetMinSize(size
);
606 // return as-is, unadjusted by the client size difference.
610 // Add any difference between size and client size
611 wxSize diff
= GetSize() - GetClientSize();
612 best
.x
+= wxMax(0, diff
.x
);
613 best
.y
+= wxMax(0, diff
.y
);
618 // helper of GetWindowBorderSize(): as many ports don't implement support for
619 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
620 // fallbacks in this case
621 static int wxGetMetricOrDefault(wxSystemMetric what
)
623 int rc
= wxSystemSettings::GetMetric(what
);
630 // 2D border is by default 1 pixel wide
636 // 3D borders are by default 2 pixels
641 wxFAIL_MSG( _T("unexpected wxGetMetricOrDefault() argument") );
649 wxSize
wxWindowBase::GetWindowBorderSize() const
653 switch ( GetBorder() )
656 // nothing to do, size is already (0, 0)
659 case wxBORDER_SIMPLE
:
660 case wxBORDER_STATIC
:
661 size
.x
= wxGetMetricOrDefault(wxSYS_BORDER_X
);
662 size
.y
= wxGetMetricOrDefault(wxSYS_BORDER_Y
);
665 case wxBORDER_SUNKEN
:
666 case wxBORDER_RAISED
:
667 size
.x
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X
),
668 wxGetMetricOrDefault(wxSYS_BORDER_X
));
669 size
.y
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y
),
670 wxGetMetricOrDefault(wxSYS_BORDER_Y
));
673 case wxBORDER_DOUBLE
:
674 size
.x
= wxGetMetricOrDefault(wxSYS_EDGE_X
) +
675 wxGetMetricOrDefault(wxSYS_BORDER_X
);
676 size
.y
= wxGetMetricOrDefault(wxSYS_EDGE_Y
) +
677 wxGetMetricOrDefault(wxSYS_BORDER_Y
);
681 wxFAIL_MSG(_T("Unknown border style."));
685 // we have borders on both sides
689 wxSize
wxWindowBase::GetEffectiveMinSize() const
691 // merge the best size with the min size, giving priority to the min size
692 wxSize min
= GetMinSize();
693 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
695 wxSize best
= GetBestSize();
696 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
697 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
703 void wxWindowBase::SetInitialSize(const wxSize
& size
)
705 // Set the min size to the size passed in. This will usually either be
706 // wxDefaultSize or the size passed to this window's ctor/Create function.
709 // Merge the size with the best size if needed
710 wxSize best
= GetEffectiveMinSize();
712 // If the current size doesn't match then change it
713 if (GetSize() != best
)
718 // by default the origin is not shifted
719 wxPoint
wxWindowBase::GetClientAreaOrigin() const
724 wxSize
wxWindowBase::ClientToWindowSize(const wxSize
& size
) const
726 const wxSize
diff(GetSize() - GetClientSize());
728 return wxSize(size
.x
== -1 ? -1 : size
.x
+ diff
.x
,
729 size
.y
== -1 ? -1 : size
.y
+ diff
.y
);
732 wxSize
wxWindowBase::WindowToClientSize(const wxSize
& size
) const
734 const wxSize
diff(GetSize() - GetClientSize());
736 return wxSize(size
.x
== -1 ? -1 : size
.x
- diff
.x
,
737 size
.y
== -1 ? -1 : size
.y
- diff
.y
);
740 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
742 if ( m_windowVariant
!= variant
)
744 m_windowVariant
= variant
;
746 DoSetWindowVariant(variant
);
750 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
752 // adjust the font height to correspond to our new variant (notice that
753 // we're only called if something really changed)
754 wxFont font
= GetFont();
755 int size
= font
.GetPointSize();
758 case wxWINDOW_VARIANT_NORMAL
:
761 case wxWINDOW_VARIANT_SMALL
:
766 case wxWINDOW_VARIANT_MINI
:
771 case wxWINDOW_VARIANT_LARGE
:
777 wxFAIL_MSG(_T("unexpected window variant"));
781 font
.SetPointSize(size
);
785 void wxWindowBase::DoSetSizeHints( int minW
, int minH
,
787 int WXUNUSED(incW
), int WXUNUSED(incH
) )
789 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
790 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
791 _T("min width/height must be less than max width/height!") );
800 #if WXWIN_COMPATIBILITY_2_8
801 void wxWindowBase::SetVirtualSizeHints(int WXUNUSED(minW
), int WXUNUSED(minH
),
802 int WXUNUSED(maxW
), int WXUNUSED(maxH
))
806 void wxWindowBase::SetVirtualSizeHints(const wxSize
& WXUNUSED(minsize
),
807 const wxSize
& WXUNUSED(maxsize
))
810 #endif // WXWIN_COMPATIBILITY_2_8
812 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
814 m_virtualSize
= wxSize(x
, y
);
817 wxSize
wxWindowBase::DoGetVirtualSize() const
819 // we should use the entire client area so if it is greater than our
820 // virtual size, expand it to fit (otherwise if the window is big enough we
821 // wouldn't be using parts of it)
822 wxSize size
= GetClientSize();
823 if ( m_virtualSize
.x
> size
.x
)
824 size
.x
= m_virtualSize
.x
;
826 if ( m_virtualSize
.y
>= size
.y
)
827 size
.y
= m_virtualSize
.y
;
832 void wxWindowBase::DoGetScreenPosition(int *x
, int *y
) const
834 // screen position is the same as (0, 0) in client coords for non TLWs (and
835 // TLWs override this method)
841 ClientToScreen(x
, y
);
844 void wxWindowBase::SendSizeEvent()
846 wxSizeEvent
event(GetSize(), GetId());
847 event
.SetEventObject(this);
848 HandleWindowEvent(event
);
851 void wxWindowBase::SendSizeEventToParent()
853 wxWindow
* const parent
= GetParent();
854 if ( parent
&& !parent
->IsBeingDeleted() )
855 parent
->SendSizeEvent();
858 // ----------------------------------------------------------------------------
859 // show/hide/enable/disable the window
860 // ----------------------------------------------------------------------------
862 bool wxWindowBase::Show(bool show
)
864 if ( show
!= m_isShown
)
876 bool wxWindowBase::IsEnabled() const
878 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
881 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled
)
883 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
885 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
889 // If we are top-level then the logic doesn't apply - otherwise
890 // showing a modal dialog would result in total greying out (and ungreying
891 // out later) of everything which would be really ugly
895 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
897 node
= node
->GetNext() )
899 wxWindowBase
* const child
= node
->GetData();
900 if ( !child
->IsTopLevel() && child
->IsThisEnabled() )
901 child
->NotifyWindowOnEnableChange(enabled
);
905 bool wxWindowBase::Enable(bool enable
)
907 if ( enable
== IsThisEnabled() )
910 m_isEnabled
= enable
;
912 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
914 #else // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
915 wxWindowBase
* const parent
= GetParent();
916 if( !IsTopLevel() && parent
&& !parent
->IsEnabled() )
920 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
922 NotifyWindowOnEnableChange(enable
);
927 bool wxWindowBase::IsShownOnScreen() const
929 // A window is shown on screen if it itself is shown and so are all its
930 // parents. But if a window is toplevel one, then its always visible on
931 // screen if IsShown() returns true, even if it has a hidden parent.
933 (IsTopLevel() || GetParent() == NULL
|| GetParent()->IsShownOnScreen());
936 // ----------------------------------------------------------------------------
938 // ----------------------------------------------------------------------------
940 bool wxWindowBase::IsTopLevel() const
945 // ----------------------------------------------------------------------------
947 // ----------------------------------------------------------------------------
949 void wxWindowBase::Freeze()
951 if ( !m_freezeCount
++ )
953 // physically freeze this window:
956 // and recursively freeze all children:
957 for ( wxWindowList::iterator i
= GetChildren().begin();
958 i
!= GetChildren().end(); ++i
)
960 wxWindow
*child
= *i
;
961 if ( child
->IsTopLevel() )
969 void wxWindowBase::Thaw()
971 wxASSERT_MSG( m_freezeCount
, "Thaw() without matching Freeze()" );
973 if ( !--m_freezeCount
)
975 // recursively thaw all children:
976 for ( wxWindowList::iterator i
= GetChildren().begin();
977 i
!= GetChildren().end(); ++i
)
979 wxWindow
*child
= *i
;
980 if ( child
->IsTopLevel() )
986 // physically thaw this window:
991 // ----------------------------------------------------------------------------
992 // reparenting the window
993 // ----------------------------------------------------------------------------
995 void wxWindowBase::AddChild(wxWindowBase
*child
)
997 wxCHECK_RET( child
, wxT("can't add a NULL child") );
999 // this should never happen and it will lead to a crash later if it does
1000 // because RemoveChild() will remove only one node from the children list
1001 // and the other(s) one(s) will be left with dangling pointers in them
1002 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), _T("AddChild() called twice") );
1004 GetChildren().Append((wxWindow
*)child
);
1005 child
->SetParent(this);
1007 // adding a child while frozen will assert when thawn, so freeze it as if
1008 // it had been already present when we were frozen
1009 if ( IsFrozen() && !child
->IsTopLevel() )
1013 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
1015 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
1017 // removing a child while frozen may result in permanently frozen window
1018 // if used e.g. from Reparent(), so thaw it
1019 if ( IsFrozen() && !child
->IsTopLevel() )
1022 GetChildren().DeleteObject((wxWindow
*)child
);
1023 child
->SetParent(NULL
);
1026 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
1028 wxWindow
*oldParent
= GetParent();
1029 if ( newParent
== oldParent
)
1035 const bool oldEnabledState
= IsEnabled();
1037 // unlink this window from the existing parent.
1040 oldParent
->RemoveChild(this);
1044 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
1047 // add it to the new one
1050 newParent
->AddChild(this);
1054 wxTopLevelWindows
.Append((wxWindow
*)this);
1057 // We need to notify window (and its subwindows) if by changing the parent
1058 // we also change our enabled/disabled status.
1059 const bool newEnabledState
= IsEnabled();
1060 if ( newEnabledState
!= oldEnabledState
)
1062 NotifyWindowOnEnableChange(newEnabledState
);
1068 // ----------------------------------------------------------------------------
1069 // event handler stuff
1070 // ----------------------------------------------------------------------------
1072 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
1074 wxEvtHandler
*handlerOld
= GetEventHandler();
1076 handler
->SetNextHandler(handlerOld
);
1079 GetEventHandler()->SetPreviousHandler(handler
);
1081 SetEventHandler(handler
);
1084 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
1086 wxEvtHandler
*handlerA
= GetEventHandler();
1089 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
1090 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
1093 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
1094 SetEventHandler(handlerB
);
1096 if ( deleteHandler
)
1099 handlerA
= (wxEvtHandler
*)NULL
;
1106 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
1108 wxCHECK_MSG( handler
, false, _T("RemoveEventHandler(NULL) called") );
1110 wxEvtHandler
*handlerPrev
= NULL
,
1111 *handlerCur
= GetEventHandler();
1112 while ( handlerCur
)
1114 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1116 if ( handlerCur
== handler
)
1120 handlerPrev
->SetNextHandler(handlerNext
);
1124 SetEventHandler(handlerNext
);
1129 handlerNext
->SetPreviousHandler ( handlerPrev
);
1132 handler
->SetNextHandler(NULL
);
1133 handler
->SetPreviousHandler(NULL
);
1138 handlerPrev
= handlerCur
;
1139 handlerCur
= handlerNext
;
1142 wxFAIL_MSG( _T("where has the event handler gone?") );
1147 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1149 return GetEventHandler()->SafelyProcessEvent(event
);
1152 // ----------------------------------------------------------------------------
1153 // colours, fonts &c
1154 // ----------------------------------------------------------------------------
1156 void wxWindowBase::InheritAttributes()
1158 const wxWindowBase
* const parent
= GetParent();
1162 // we only inherit attributes which had been explicitly set for the parent
1163 // which ensures that this only happens if the user really wants it and
1164 // not by default which wouldn't make any sense in modern GUIs where the
1165 // controls don't all use the same fonts (nor colours)
1166 if ( parent
->m_inheritFont
&& !m_hasFont
)
1167 SetFont(parent
->GetFont());
1169 // in addition, there is a possibility to explicitly forbid inheriting
1170 // colours at each class level by overriding ShouldInheritColours()
1171 if ( ShouldInheritColours() )
1173 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1174 SetForegroundColour(parent
->GetForegroundColour());
1176 // inheriting (solid) background colour is wrong as it totally breaks
1177 // any kind of themed backgrounds
1179 // instead, the controls should use the same background as their parent
1180 // (ideally by not drawing it at all)
1182 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1183 SetBackgroundColour(parent
->GetBackgroundColour());
1188 /* static */ wxVisualAttributes
1189 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1191 // it is important to return valid values for all attributes from here,
1192 // GetXXX() below rely on this
1193 wxVisualAttributes attrs
;
1194 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1195 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1197 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1198 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1199 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1200 // colour on other platforms.
1202 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1203 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1205 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1210 wxColour
wxWindowBase::GetBackgroundColour() const
1212 if ( !m_backgroundColour
.IsOk() )
1214 wxASSERT_MSG( !m_hasBgCol
, _T("we have invalid explicit bg colour?") );
1216 // get our default background colour
1217 wxColour colBg
= GetDefaultAttributes().colBg
;
1219 // we must return some valid colour to avoid redoing this every time
1220 // and also to avoid surprizing the applications written for older
1221 // wxWidgets versions where GetBackgroundColour() always returned
1222 // something -- so give them something even if it doesn't make sense
1223 // for this window (e.g. it has a themed background)
1225 colBg
= GetClassDefaultAttributes().colBg
;
1230 return m_backgroundColour
;
1233 wxColour
wxWindowBase::GetForegroundColour() const
1235 // logic is the same as above
1236 if ( !m_hasFgCol
&& !m_foregroundColour
.Ok() )
1238 wxColour colFg
= GetDefaultAttributes().colFg
;
1240 if ( !colFg
.IsOk() )
1241 colFg
= GetClassDefaultAttributes().colFg
;
1246 return m_foregroundColour
;
1249 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1251 if ( colour
== m_backgroundColour
)
1254 m_hasBgCol
= colour
.IsOk();
1255 if ( m_backgroundStyle
!= wxBG_STYLE_CUSTOM
)
1256 m_backgroundStyle
= m_hasBgCol
? wxBG_STYLE_COLOUR
: wxBG_STYLE_SYSTEM
;
1258 m_inheritBgCol
= m_hasBgCol
;
1259 m_backgroundColour
= colour
;
1260 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.Ok() );
1264 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1266 if (colour
== m_foregroundColour
)
1269 m_hasFgCol
= colour
.IsOk();
1270 m_inheritFgCol
= m_hasFgCol
;
1271 m_foregroundColour
= colour
;
1272 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.Ok() );
1276 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1278 // setting an invalid cursor is ok, it means that we don't have any special
1280 if ( m_cursor
.IsSameAs(cursor
) )
1291 wxFont
wxWindowBase::GetFont() const
1293 // logic is the same as in GetBackgroundColour()
1294 if ( !m_font
.IsOk() )
1296 wxASSERT_MSG( !m_hasFont
, _T("we have invalid explicit font?") );
1298 wxFont font
= GetDefaultAttributes().font
;
1300 font
= GetClassDefaultAttributes().font
;
1308 bool wxWindowBase::SetFont(const wxFont
& font
)
1310 if ( font
== m_font
)
1317 m_hasFont
= font
.IsOk();
1318 m_inheritFont
= m_hasFont
;
1320 InvalidateBestSize();
1327 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1329 m_hasCustomPalette
= true;
1332 // VZ: can anyone explain me what do we do here?
1333 wxWindowDC
d((wxWindow
*) this);
1337 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1339 wxWindow
*win
= (wxWindow
*)this;
1340 while ( win
&& !win
->HasCustomPalette() )
1342 win
= win
->GetParent();
1348 #endif // wxUSE_PALETTE
1351 void wxWindowBase::SetCaret(wxCaret
*caret
)
1362 wxASSERT_MSG( m_caret
->GetWindow() == this,
1363 wxT("caret should be created associated to this window") );
1366 #endif // wxUSE_CARET
1368 #if wxUSE_VALIDATORS
1369 // ----------------------------------------------------------------------------
1371 // ----------------------------------------------------------------------------
1373 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1375 if ( m_windowValidator
)
1376 delete m_windowValidator
;
1378 m_windowValidator
= (wxValidator
*)validator
.Clone();
1380 if ( m_windowValidator
)
1381 m_windowValidator
->SetWindow(this);
1383 #endif // wxUSE_VALIDATORS
1385 // ----------------------------------------------------------------------------
1386 // update region stuff
1387 // ----------------------------------------------------------------------------
1389 wxRect
wxWindowBase::GetUpdateClientRect() const
1391 wxRegion rgnUpdate
= GetUpdateRegion();
1392 rgnUpdate
.Intersect(GetClientRect());
1393 wxRect rectUpdate
= rgnUpdate
.GetBox();
1394 wxPoint ptOrigin
= GetClientAreaOrigin();
1395 rectUpdate
.x
-= ptOrigin
.x
;
1396 rectUpdate
.y
-= ptOrigin
.y
;
1401 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1403 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1406 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1408 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1411 void wxWindowBase::ClearBackground()
1413 // wxGTK uses its own version, no need to add never used code
1415 wxClientDC
dc((wxWindow
*)this);
1416 wxBrush
brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID
);
1417 dc
.SetBackground(brush
);
1422 // ----------------------------------------------------------------------------
1423 // find child window by id or name
1424 // ----------------------------------------------------------------------------
1426 wxWindow
*wxWindowBase::FindWindow(long id
) const
1428 if ( id
== m_windowId
)
1429 return (wxWindow
*)this;
1431 wxWindowBase
*res
= (wxWindow
*)NULL
;
1432 wxWindowList::compatibility_iterator node
;
1433 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1435 wxWindowBase
*child
= node
->GetData();
1436 res
= child
->FindWindow( id
);
1439 return (wxWindow
*)res
;
1442 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1444 if ( name
== m_windowName
)
1445 return (wxWindow
*)this;
1447 wxWindowBase
*res
= (wxWindow
*)NULL
;
1448 wxWindowList::compatibility_iterator node
;
1449 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1451 wxWindow
*child
= node
->GetData();
1452 res
= child
->FindWindow(name
);
1455 return (wxWindow
*)res
;
1459 // find any window by id or name or label: If parent is non-NULL, look through
1460 // children for a label or title matching the specified string. If NULL, look
1461 // through all top-level windows.
1463 // to avoid duplicating code we reuse the same helper function but with
1464 // different comparators
1466 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1467 const wxString
& label
, long id
);
1470 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1473 return win
->GetLabel() == label
;
1477 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1480 return win
->GetName() == label
;
1484 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1487 return win
->GetId() == id
;
1490 // recursive helper for the FindWindowByXXX() functions
1492 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1493 const wxString
& label
,
1495 wxFindWindowCmp cmp
)
1499 // see if this is the one we're looking for
1500 if ( (*cmp
)(parent
, label
, id
) )
1501 return (wxWindow
*)parent
;
1503 // It wasn't, so check all its children
1504 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1506 node
= node
->GetNext() )
1508 // recursively check each child
1509 wxWindow
*win
= (wxWindow
*)node
->GetData();
1510 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1520 // helper for FindWindowByXXX()
1522 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1523 const wxString
& label
,
1525 wxFindWindowCmp cmp
)
1529 // just check parent and all its children
1530 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1533 // start at very top of wx's windows
1534 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1536 node
= node
->GetNext() )
1538 // recursively check each window & its children
1539 wxWindow
*win
= node
->GetData();
1540 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1550 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1552 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1557 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1559 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1563 // fall back to the label
1564 win
= FindWindowByLabel(title
, parent
);
1572 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1574 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1577 // ----------------------------------------------------------------------------
1578 // dialog oriented functions
1579 // ----------------------------------------------------------------------------
1581 void wxWindowBase::MakeModal(bool modal
)
1583 // Disable all other windows
1586 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1589 wxWindow
*win
= node
->GetData();
1591 win
->Enable(!modal
);
1593 node
= node
->GetNext();
1598 bool wxWindowBase::Validate()
1600 #if wxUSE_VALIDATORS
1601 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1603 wxWindowList::compatibility_iterator node
;
1604 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1606 wxWindowBase
*child
= node
->GetData();
1607 wxValidator
*validator
= child
->GetValidator();
1608 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1613 if ( recurse
&& !child
->Validate() )
1618 #endif // wxUSE_VALIDATORS
1623 bool wxWindowBase::TransferDataToWindow()
1625 #if wxUSE_VALIDATORS
1626 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1628 wxWindowList::compatibility_iterator node
;
1629 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1631 wxWindowBase
*child
= node
->GetData();
1632 wxValidator
*validator
= child
->GetValidator();
1633 if ( validator
&& !validator
->TransferToWindow() )
1635 wxLogWarning(_("Could not transfer data to window"));
1637 wxLog::FlushActive();
1645 if ( !child
->TransferDataToWindow() )
1647 // warning already given
1652 #endif // wxUSE_VALIDATORS
1657 bool wxWindowBase::TransferDataFromWindow()
1659 #if wxUSE_VALIDATORS
1660 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1662 wxWindowList::compatibility_iterator node
;
1663 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1665 wxWindow
*child
= node
->GetData();
1666 wxValidator
*validator
= child
->GetValidator();
1667 if ( validator
&& !validator
->TransferFromWindow() )
1669 // nop warning here because the application is supposed to give
1670 // one itself - we don't know here what might have gone wrongly
1677 if ( !child
->TransferDataFromWindow() )
1679 // warning already given
1684 #endif // wxUSE_VALIDATORS
1689 void wxWindowBase::InitDialog()
1691 wxInitDialogEvent
event(GetId());
1692 event
.SetEventObject( this );
1693 GetEventHandler()->ProcessEvent(event
);
1696 // ----------------------------------------------------------------------------
1697 // context-sensitive help support
1698 // ----------------------------------------------------------------------------
1702 // associate this help text with this window
1703 void wxWindowBase::SetHelpText(const wxString
& text
)
1705 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1708 helpProvider
->AddHelp(this, text
);
1712 #if WXWIN_COMPATIBILITY_2_8
1713 // associate this help text with all windows with the same id as this
1715 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1717 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1720 helpProvider
->AddHelp(GetId(), text
);
1723 #endif // WXWIN_COMPATIBILITY_2_8
1725 // get the help string associated with this window (may be empty)
1726 // default implementation forwards calls to the help provider
1728 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
1729 wxHelpEvent::Origin
WXUNUSED(origin
)) const
1732 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1735 text
= helpProvider
->GetHelp(this);
1741 // show help for this window
1742 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1744 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1747 wxPoint pos
= event
.GetPosition();
1748 const wxHelpEvent::Origin origin
= event
.GetOrigin();
1749 if ( origin
== wxHelpEvent::Origin_Keyboard
)
1751 // if the help event was generated from keyboard it shouldn't
1752 // appear at the mouse position (which is still the only position
1753 // associated with help event) if the mouse is far away, although
1754 // we still do use the mouse position if it's over the window
1755 // because we suppose the user looks approximately at the mouse
1756 // already and so it would be more convenient than showing tooltip
1757 // at some arbitrary position which can be quite far from it
1758 const wxRect rectClient
= GetClientRect();
1759 if ( !rectClient
.Contains(ScreenToClient(pos
)) )
1761 // position help slightly under and to the right of this window
1762 pos
= ClientToScreen(wxPoint(
1764 rectClient
.height
+ GetCharHeight()
1769 if ( helpProvider
->ShowHelpAtPoint(this, pos
, origin
) )
1771 // skip the event.Skip() below
1779 #endif // wxUSE_HELP
1781 // ----------------------------------------------------------------------------
1783 // ----------------------------------------------------------------------------
1787 void wxWindowBase::SetToolTip( const wxString
&tip
)
1789 // don't create the new tooltip if we already have one
1792 m_tooltip
->SetTip( tip
);
1796 SetToolTip( new wxToolTip( tip
) );
1799 // setting empty tooltip text does not remove the tooltip any more - use
1800 // SetToolTip((wxToolTip *)NULL) for this
1803 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1805 if ( m_tooltip
!= tooltip
)
1810 m_tooltip
= tooltip
;
1814 #endif // wxUSE_TOOLTIPS
1816 // ----------------------------------------------------------------------------
1817 // constraints and sizers
1818 // ----------------------------------------------------------------------------
1820 #if wxUSE_CONSTRAINTS
1822 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1824 if ( m_constraints
)
1826 UnsetConstraints(m_constraints
);
1827 delete m_constraints
;
1829 m_constraints
= constraints
;
1830 if ( m_constraints
)
1832 // Make sure other windows know they're part of a 'meaningful relationship'
1833 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1834 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1835 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1836 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1837 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1838 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1839 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1840 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1841 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1842 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1843 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1844 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1845 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1846 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1847 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1848 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1852 // This removes any dangling pointers to this window in other windows'
1853 // constraintsInvolvedIn lists.
1854 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1858 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1859 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1860 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1861 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1862 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1863 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1864 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1865 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1866 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1867 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1868 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1869 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1870 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1871 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1872 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1873 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1877 // Back-pointer to other windows we're involved with, so if we delete this
1878 // window, we must delete any constraints we're involved with.
1879 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1881 if ( !m_constraintsInvolvedIn
)
1882 m_constraintsInvolvedIn
= new wxWindowList
;
1883 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
1884 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
1887 // REMOVE back-pointer to other windows we're involved with.
1888 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1890 if ( m_constraintsInvolvedIn
)
1891 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
1894 // Reset any constraints that mention this window
1895 void wxWindowBase::DeleteRelatedConstraints()
1897 if ( m_constraintsInvolvedIn
)
1899 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
1902 wxWindow
*win
= node
->GetData();
1903 wxLayoutConstraints
*constr
= win
->GetConstraints();
1905 // Reset any constraints involving this window
1908 constr
->left
.ResetIfWin(this);
1909 constr
->top
.ResetIfWin(this);
1910 constr
->right
.ResetIfWin(this);
1911 constr
->bottom
.ResetIfWin(this);
1912 constr
->width
.ResetIfWin(this);
1913 constr
->height
.ResetIfWin(this);
1914 constr
->centreX
.ResetIfWin(this);
1915 constr
->centreY
.ResetIfWin(this);
1918 wxWindowList::compatibility_iterator next
= node
->GetNext();
1919 m_constraintsInvolvedIn
->Erase(node
);
1923 delete m_constraintsInvolvedIn
;
1924 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1928 #endif // wxUSE_CONSTRAINTS
1930 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1932 if ( sizer
== m_windowSizer
)
1935 if ( m_windowSizer
)
1937 m_windowSizer
->SetContainingWindow(NULL
);
1940 delete m_windowSizer
;
1943 m_windowSizer
= sizer
;
1944 if ( m_windowSizer
)
1946 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
1949 SetAutoLayout(m_windowSizer
!= NULL
);
1952 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1954 SetSizer( sizer
, deleteOld
);
1955 sizer
->SetSizeHints( (wxWindow
*) this );
1959 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
1961 // adding a window to a sizer twice is going to result in fatal and
1962 // hard to debug problems later because when deleting the second
1963 // associated wxSizerItem we're going to dereference a dangling
1964 // pointer; so try to detect this as early as possible
1965 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
1966 _T("Adding a window to the same sizer twice?") );
1968 m_containingSizer
= sizer
;
1971 #if wxUSE_CONSTRAINTS
1973 void wxWindowBase::SatisfyConstraints()
1975 wxLayoutConstraints
*constr
= GetConstraints();
1976 bool wasOk
= constr
&& constr
->AreSatisfied();
1978 ResetConstraints(); // Mark all constraints as unevaluated
1982 // if we're a top level panel (i.e. our parent is frame/dialog), our
1983 // own constraints will never be satisfied any more unless we do it
1987 while ( noChanges
> 0 )
1989 LayoutPhase1(&noChanges
);
1993 LayoutPhase2(&noChanges
);
1996 #endif // wxUSE_CONSTRAINTS
1998 bool wxWindowBase::Layout()
2000 // If there is a sizer, use it instead of the constraints
2004 GetVirtualSize(&w
, &h
);
2005 GetSizer()->SetDimension( 0, 0, w
, h
);
2007 #if wxUSE_CONSTRAINTS
2010 SatisfyConstraints(); // Find the right constraints values
2011 SetConstraintSizes(); // Recursively set the real window sizes
2018 #if wxUSE_CONSTRAINTS
2020 // first phase of the constraints evaluation: set our own constraints
2021 bool wxWindowBase::LayoutPhase1(int *noChanges
)
2023 wxLayoutConstraints
*constr
= GetConstraints();
2025 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
2028 // second phase: set the constraints for our children
2029 bool wxWindowBase::LayoutPhase2(int *noChanges
)
2036 // Layout grand children
2042 // Do a phase of evaluating child constraints
2043 bool wxWindowBase::DoPhase(int phase
)
2045 // the list containing the children for which the constraints are already
2047 wxWindowList succeeded
;
2049 // the max number of iterations we loop before concluding that we can't set
2051 static const int maxIterations
= 500;
2053 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
2057 // loop over all children setting their constraints
2058 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2060 node
= node
->GetNext() )
2062 wxWindow
*child
= node
->GetData();
2063 if ( child
->IsTopLevel() )
2065 // top level children are not inside our client area
2069 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
2071 // this one is either already ok or nothing we can do about it
2075 int tempNoChanges
= 0;
2076 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
2077 : child
->LayoutPhase2(&tempNoChanges
);
2078 noChanges
+= tempNoChanges
;
2082 succeeded
.Append(child
);
2088 // constraints are set
2096 void wxWindowBase::ResetConstraints()
2098 wxLayoutConstraints
*constr
= GetConstraints();
2101 constr
->left
.SetDone(false);
2102 constr
->top
.SetDone(false);
2103 constr
->right
.SetDone(false);
2104 constr
->bottom
.SetDone(false);
2105 constr
->width
.SetDone(false);
2106 constr
->height
.SetDone(false);
2107 constr
->centreX
.SetDone(false);
2108 constr
->centreY
.SetDone(false);
2111 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2114 wxWindow
*win
= node
->GetData();
2115 if ( !win
->IsTopLevel() )
2116 win
->ResetConstraints();
2117 node
= node
->GetNext();
2121 // Need to distinguish between setting the 'fake' size for windows and sizers,
2122 // and setting the real values.
2123 void wxWindowBase::SetConstraintSizes(bool recurse
)
2125 wxLayoutConstraints
*constr
= GetConstraints();
2126 if ( constr
&& constr
->AreSatisfied() )
2128 int x
= constr
->left
.GetValue();
2129 int y
= constr
->top
.GetValue();
2130 int w
= constr
->width
.GetValue();
2131 int h
= constr
->height
.GetValue();
2133 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2134 (constr
->height
.GetRelationship() != wxAsIs
) )
2136 SetSize(x
, y
, w
, h
);
2140 // If we don't want to resize this window, just move it...
2146 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2147 GetClassInfo()->GetClassName(),
2153 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2156 wxWindow
*win
= node
->GetData();
2157 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2158 win
->SetConstraintSizes();
2159 node
= node
->GetNext();
2164 // Only set the size/position of the constraint (if any)
2165 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2167 wxLayoutConstraints
*constr
= GetConstraints();
2170 if ( x
!= wxDefaultCoord
)
2172 constr
->left
.SetValue(x
);
2173 constr
->left
.SetDone(true);
2175 if ( y
!= wxDefaultCoord
)
2177 constr
->top
.SetValue(y
);
2178 constr
->top
.SetDone(true);
2180 if ( w
!= wxDefaultCoord
)
2182 constr
->width
.SetValue(w
);
2183 constr
->width
.SetDone(true);
2185 if ( h
!= wxDefaultCoord
)
2187 constr
->height
.SetValue(h
);
2188 constr
->height
.SetDone(true);
2193 void wxWindowBase::MoveConstraint(int x
, int y
)
2195 wxLayoutConstraints
*constr
= GetConstraints();
2198 if ( x
!= wxDefaultCoord
)
2200 constr
->left
.SetValue(x
);
2201 constr
->left
.SetDone(true);
2203 if ( y
!= wxDefaultCoord
)
2205 constr
->top
.SetValue(y
);
2206 constr
->top
.SetDone(true);
2211 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2213 wxLayoutConstraints
*constr
= GetConstraints();
2216 *w
= constr
->width
.GetValue();
2217 *h
= constr
->height
.GetValue();
2223 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2225 wxLayoutConstraints
*constr
= GetConstraints();
2228 *w
= constr
->width
.GetValue();
2229 *h
= constr
->height
.GetValue();
2232 GetClientSize(w
, h
);
2235 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2237 wxLayoutConstraints
*constr
= GetConstraints();
2240 *x
= constr
->left
.GetValue();
2241 *y
= constr
->top
.GetValue();
2247 #endif // wxUSE_CONSTRAINTS
2249 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2251 // don't do it for the dialogs/frames - they float independently of their
2253 if ( !IsTopLevel() )
2255 wxWindow
*parent
= GetParent();
2256 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2258 wxPoint
pt(parent
->GetClientAreaOrigin());
2265 // ----------------------------------------------------------------------------
2266 // Update UI processing
2267 // ----------------------------------------------------------------------------
2269 void wxWindowBase::UpdateWindowUI(long flags
)
2271 wxUpdateUIEvent
event(GetId());
2272 event
.SetEventObject(this);
2274 if ( GetEventHandler()->ProcessEvent(event
) )
2276 DoUpdateWindowUI(event
);
2279 if (flags
& wxUPDATE_UI_RECURSE
)
2281 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2284 wxWindow
* child
= (wxWindow
*) node
->GetData();
2285 child
->UpdateWindowUI(flags
);
2286 node
= node
->GetNext();
2291 // do the window-specific processing after processing the update event
2292 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2294 if ( event
.GetSetEnabled() )
2295 Enable(event
.GetEnabled());
2297 if ( event
.GetSetShown() )
2298 Show(event
.GetShown());
2301 // ----------------------------------------------------------------------------
2302 // dialog units translations
2303 // ----------------------------------------------------------------------------
2305 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
2307 int charWidth
= GetCharWidth();
2308 int charHeight
= GetCharHeight();
2309 wxPoint pt2
= wxDefaultPosition
;
2310 if (pt
.x
!= wxDefaultCoord
)
2311 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
);
2312 if (pt
.y
!= wxDefaultCoord
)
2313 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
);
2318 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
2320 int charWidth
= GetCharWidth();
2321 int charHeight
= GetCharHeight();
2322 wxPoint pt2
= wxDefaultPosition
;
2323 if (pt
.x
!= wxDefaultCoord
)
2324 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4);
2325 if (pt
.y
!= wxDefaultCoord
)
2326 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8);
2331 // ----------------------------------------------------------------------------
2333 // ----------------------------------------------------------------------------
2335 // propagate the colour change event to the subwindows
2336 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
2338 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2341 // Only propagate to non-top-level windows
2342 wxWindow
*win
= node
->GetData();
2343 if ( !win
->IsTopLevel() )
2345 wxSysColourChangedEvent event2
;
2346 event
.SetEventObject(win
);
2347 win
->GetEventHandler()->ProcessEvent(event2
);
2350 node
= node
->GetNext();
2356 // the default action is to populate dialog with data when it's created,
2357 // and nudge the UI into displaying itself correctly in case
2358 // we've turned the wxUpdateUIEvents frequency down low.
2359 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2361 TransferDataToWindow();
2363 // Update the UI at this point
2364 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2367 // ----------------------------------------------------------------------------
2368 // menu-related functions
2369 // ----------------------------------------------------------------------------
2373 bool wxWindowBase::PopupMenu(wxMenu
*menu
, int x
, int y
)
2375 wxCHECK_MSG( menu
, false, "can't popup NULL menu" );
2377 wxCurrentPopupMenu
= menu
;
2378 const bool rc
= DoPopupMenu(menu
, x
, y
);
2379 wxCurrentPopupMenu
= NULL
;
2384 // this is used to pass the id of the selected item from the menu event handler
2385 // to the main function itself
2387 // it's ok to use a global here as there can be at most one popup menu shown at
2389 static int gs_popupMenuSelection
= wxID_NONE
;
2391 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2393 // store the id in a global variable where we'll retrieve it from later
2394 gs_popupMenuSelection
= event
.GetId();
2398 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2400 gs_popupMenuSelection
= wxID_NONE
;
2402 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2403 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2407 PopupMenu(&menu
, x
, y
);
2409 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2410 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2414 return gs_popupMenuSelection
;
2417 #endif // wxUSE_MENUS
2419 // methods for drawing the sizers in a visible way
2422 static void DrawSizers(wxWindowBase
*win
);
2424 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
= false)
2426 wxClientDC
dc((wxWindow
*)win
);
2427 dc
.SetPen(*wxRED_PEN
);
2428 dc
.SetBrush(fill
? wxBrush(*wxRED
, wxBRUSHSTYLE_CROSSDIAG_HATCH
) : *wxTRANSPARENT_BRUSH
);
2429 dc
.DrawRectangle(rect
.Deflate(1, 1));
2432 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2434 const wxSizerItemList
& items
= sizer
->GetChildren();
2435 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2440 wxSizerItem
*item
= *i
;
2441 if ( item
->IsSizer() )
2443 DrawBorder(win
, item
->GetRect().Deflate(2));
2444 DrawSizer(win
, item
->GetSizer());
2446 else if ( item
->IsSpacer() )
2448 DrawBorder(win
, item
->GetRect().Deflate(2), true);
2450 else if ( item
->IsWindow() )
2452 DrawSizers(item
->GetWindow());
2457 static void DrawSizers(wxWindowBase
*win
)
2459 wxSizer
*sizer
= win
->GetSizer();
2462 DrawBorder(win
, win
->GetClientSize());
2463 DrawSizer(win
, sizer
);
2465 else // no sizer, still recurse into the children
2467 const wxWindowList
& children
= win
->GetChildren();
2468 for ( wxWindowList::const_iterator i
= children
.begin(),
2469 end
= children
.end();
2478 #endif // __WXDEBUG__
2480 // process special middle clicks
2481 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2483 if ( event
.ControlDown() && event
.AltDown() )
2486 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
2487 if ( event
.ShiftDown() )
2492 #endif // __WXDEBUG__
2493 ::wxInfoMessageBox((wxWindow
*)this);
2501 // ----------------------------------------------------------------------------
2503 // ----------------------------------------------------------------------------
2505 #if wxUSE_ACCESSIBILITY
2506 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
2508 if (m_accessible
&& (accessible
!= m_accessible
))
2509 delete m_accessible
;
2510 m_accessible
= accessible
;
2512 m_accessible
->SetWindow((wxWindow
*) this);
2515 // Returns the accessible object, creating if necessary.
2516 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
2519 m_accessible
= CreateAccessible();
2520 return m_accessible
;
2523 // Override to create a specific accessible object.
2524 wxAccessible
* wxWindowBase::CreateAccessible()
2526 return new wxWindowAccessible((wxWindow
*) this);
2531 // ----------------------------------------------------------------------------
2532 // list classes implementation
2533 // ----------------------------------------------------------------------------
2537 #include "wx/listimpl.cpp"
2538 WX_DEFINE_LIST(wxWindowList
)
2542 void wxWindowListNode::DeleteData()
2544 delete (wxWindow
*)GetData();
2547 #endif // wxUSE_STL/!wxUSE_STL
2549 // ----------------------------------------------------------------------------
2551 // ----------------------------------------------------------------------------
2553 wxBorder
wxWindowBase::GetBorder(long flags
) const
2555 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
2556 if ( border
== wxBORDER_DEFAULT
)
2558 border
= GetDefaultBorder();
2560 else if ( border
== wxBORDER_THEME
)
2562 border
= GetDefaultBorderForControl();
2568 wxBorder
wxWindowBase::GetDefaultBorder() const
2570 return wxBORDER_NONE
;
2573 // ----------------------------------------------------------------------------
2575 // ----------------------------------------------------------------------------
2577 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2579 // here we just check if the point is inside the window or not
2581 // check the top and left border first
2582 bool outside
= x
< 0 || y
< 0;
2585 // check the right and bottom borders too
2586 wxSize size
= GetSize();
2587 outside
= x
>= size
.x
|| y
>= size
.y
;
2590 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2593 // ----------------------------------------------------------------------------
2595 // ----------------------------------------------------------------------------
2597 struct WXDLLEXPORT wxWindowNext
2601 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2602 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
2603 bool wxWindowBase::ms_winCaptureChanging
= false;
2605 void wxWindowBase::CaptureMouse()
2607 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), wx_static_cast(void*, this));
2609 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive CaptureMouse call?") );
2611 ms_winCaptureChanging
= true;
2613 wxWindow
*winOld
= GetCapture();
2616 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2619 wxWindowNext
*item
= new wxWindowNext
;
2621 item
->next
= ms_winCaptureNext
;
2622 ms_winCaptureNext
= item
;
2624 //else: no mouse capture to save
2627 ms_winCaptureCurrent
= (wxWindow
*)this;
2629 ms_winCaptureChanging
= false;
2632 void wxWindowBase::ReleaseMouse()
2634 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), wx_static_cast(void*, this));
2636 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive ReleaseMouse call?") );
2638 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2640 ms_winCaptureChanging
= true;
2643 ms_winCaptureCurrent
= NULL
;
2645 if ( ms_winCaptureNext
)
2647 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2648 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
2650 wxWindowNext
*item
= ms_winCaptureNext
;
2651 ms_winCaptureNext
= item
->next
;
2654 //else: stack is empty, no previous capture
2656 ms_winCaptureChanging
= false;
2658 wxLogTrace(_T("mousecapture"),
2659 (const wxChar
*) _T("After ReleaseMouse() mouse is captured by %p"),
2660 wx_static_cast(void*, GetCapture()));
2663 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
2665 wxMouseCaptureLostEvent
event(win
->GetId());
2666 event
.SetEventObject(win
);
2667 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
2669 // windows must handle this event, otherwise the app wouldn't behave
2670 // correctly if it loses capture unexpectedly; see the discussion here:
2671 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
2672 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
2673 wxFAIL_MSG( _T("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
2678 void wxWindowBase::NotifyCaptureLost()
2680 // don't do anything if capture lost was expected, i.e. resulted from
2681 // a wx call to ReleaseMouse or CaptureMouse:
2682 if ( ms_winCaptureChanging
)
2685 // if the capture was lost unexpectedly, notify every window that has
2686 // capture (on stack or current) about it and clear the stack:
2688 if ( ms_winCaptureCurrent
)
2690 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
2691 ms_winCaptureCurrent
= NULL
;
2694 while ( ms_winCaptureNext
)
2696 wxWindowNext
*item
= ms_winCaptureNext
;
2697 ms_winCaptureNext
= item
->next
;
2699 DoNotifyWindowAboutCaptureLost(item
->win
);
2708 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
2709 int WXUNUSED(modifiers
),
2710 int WXUNUSED(keycode
))
2716 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
2722 #endif // wxUSE_HOTKEY
2724 // ----------------------------------------------------------------------------
2726 // ----------------------------------------------------------------------------
2728 bool wxWindowBase::TryValidator(wxEvent
& wxVALIDATOR_PARAM(event
))
2730 #if wxUSE_VALIDATORS
2731 // Can only use the validator of the window which
2732 // is receiving the event
2733 if ( event
.GetEventObject() == this )
2735 wxValidator
*validator
= GetValidator();
2736 if ( validator
&& validator
->ProcessEvent(event
) )
2741 #endif // wxUSE_VALIDATORS
2746 bool wxWindowBase::TryParent(wxEvent
& event
)
2748 // carry on up the parent-child hierarchy if the propagation count hasn't
2750 if ( event
.ShouldPropagate() )
2752 // honour the requests to stop propagation at this window: this is
2753 // used by the dialogs, for example, to prevent processing the events
2754 // from the dialog controls in the parent frame which rarely, if ever,
2756 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
2758 wxWindow
*parent
= GetParent();
2759 if ( parent
&& !parent
->IsBeingDeleted() )
2761 wxPropagateOnce
propagateOnce(event
);
2763 return parent
->GetEventHandler()->ProcessEvent(event
);
2768 return wxEvtHandler::TryParent(event
);
2771 // ----------------------------------------------------------------------------
2772 // window relationships
2773 // ----------------------------------------------------------------------------
2775 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
2777 wxCHECK_MSG( GetParent(), NULL
,
2778 _T("GetPrev/NextSibling() don't work for TLWs!") );
2780 wxWindowList
& siblings
= GetParent()->GetChildren();
2781 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
2782 wxCHECK_MSG( i
, NULL
, _T("window not a child of its parent?") );
2784 if ( order
== OrderBefore
)
2785 i
= i
->GetPrevious();
2789 return i
? i
->GetData() : NULL
;
2792 // ----------------------------------------------------------------------------
2793 // keyboard navigation
2794 // ----------------------------------------------------------------------------
2796 // Navigates in the specified direction inside this window
2797 bool wxWindowBase::DoNavigateIn(int flags
)
2799 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
2800 // native code doesn't process our wxNavigationKeyEvents anyhow
2803 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
2804 wxNavigationKeyEvent eventNav
;
2805 wxWindow
*focused
= FindFocus();
2806 eventNav
.SetCurrentFocus(focused
);
2807 eventNav
.SetEventObject(focused
);
2808 eventNav
.SetFlags(flags
);
2809 return GetEventHandler()->ProcessEvent(eventNav
);
2810 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
2813 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent
& event
)
2815 if ( event
.GetKeyCode() != WXK_TAB
)
2818 int flags
= wxNavigationKeyEvent::FromTab
;
2820 if ( event
.ShiftDown() )
2821 flags
|= wxNavigationKeyEvent::IsBackward
;
2823 flags
|= wxNavigationKeyEvent::IsForward
;
2825 if ( event
.ControlDown() )
2826 flags
|= wxNavigationKeyEvent::WinChange
;
2832 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
2834 // check that we're not a top level window
2835 wxCHECK_RET( GetParent(),
2836 _T("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
2838 // detect the special case when we have nothing to do anyhow and when the
2839 // code below wouldn't work
2843 // find the target window in the siblings list
2844 wxWindowList
& siblings
= GetParent()->GetChildren();
2845 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
2846 wxCHECK_RET( i
, _T("MoveBefore/AfterInTabOrder(): win is not a sibling") );
2848 // unfortunately, when wxUSE_STL == 1 DetachNode() is not implemented so we
2849 // can't just move the node around
2850 wxWindow
*self
= (wxWindow
*)this;
2851 siblings
.DeleteObject(self
);
2852 if ( move
== OrderAfter
)
2859 siblings
.Insert(i
, self
);
2861 else // OrderAfter and win was the last sibling
2863 siblings
.Append(self
);
2867 // ----------------------------------------------------------------------------
2869 // ----------------------------------------------------------------------------
2871 /*static*/ wxWindow
* wxWindowBase::FindFocus()
2873 wxWindowBase
*win
= DoFindFocus();
2874 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
2877 bool wxWindowBase::HasFocus() const
2879 wxWindowBase
*win
= DoFindFocus();
2880 return win
== this ||
2881 win
== wxConstCast(this, wxWindowBase
)->GetMainWindowOfCompositeControl();
2884 // ----------------------------------------------------------------------------
2886 // ----------------------------------------------------------------------------
2888 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2890 while ( win
&& !win
->IsTopLevel() )
2891 win
= win
->GetParent();
2896 #if wxUSE_ACCESSIBILITY
2897 // ----------------------------------------------------------------------------
2898 // accessible object for windows
2899 // ----------------------------------------------------------------------------
2901 // Can return either a child object, or an integer
2902 // representing the child element, starting from 1.
2903 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
2905 wxASSERT( GetWindow() != NULL
);
2909 return wxACC_NOT_IMPLEMENTED
;
2912 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2913 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2915 wxASSERT( GetWindow() != NULL
);
2919 wxWindow
* win
= NULL
;
2926 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2928 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
2935 rect
= win
->GetRect();
2936 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2937 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2941 return wxACC_NOT_IMPLEMENTED
;
2944 // Navigates from fromId to toId/toObject.
2945 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2946 int* WXUNUSED(toId
), wxAccessible
** toObject
)
2948 wxASSERT( GetWindow() != NULL
);
2954 case wxNAVDIR_FIRSTCHILD
:
2956 if (GetWindow()->GetChildren().GetCount() == 0)
2958 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2959 *toObject
= childWindow
->GetOrCreateAccessible();
2963 case wxNAVDIR_LASTCHILD
:
2965 if (GetWindow()->GetChildren().GetCount() == 0)
2967 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2968 *toObject
= childWindow
->GetOrCreateAccessible();
2972 case wxNAVDIR_RIGHT
:
2976 wxWindowList::compatibility_iterator node
=
2977 wxWindowList::compatibility_iterator();
2980 // Can't navigate to sibling of this window
2981 // if we're a top-level window.
2982 if (!GetWindow()->GetParent())
2983 return wxACC_NOT_IMPLEMENTED
;
2985 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2989 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2990 node
= GetWindow()->GetChildren().Item(fromId
-1);
2993 if (node
&& node
->GetNext())
2995 wxWindow
* nextWindow
= node
->GetNext()->GetData();
2996 *toObject
= nextWindow
->GetOrCreateAccessible();
3004 case wxNAVDIR_PREVIOUS
:
3006 wxWindowList::compatibility_iterator node
=
3007 wxWindowList::compatibility_iterator();
3010 // Can't navigate to sibling of this window
3011 // if we're a top-level window.
3012 if (!GetWindow()->GetParent())
3013 return wxACC_NOT_IMPLEMENTED
;
3015 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3019 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3020 node
= GetWindow()->GetChildren().Item(fromId
-1);
3023 if (node
&& node
->GetPrevious())
3025 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
3026 *toObject
= previousWindow
->GetOrCreateAccessible();
3034 return wxACC_NOT_IMPLEMENTED
;
3037 // Gets the name of the specified object.
3038 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
3040 wxASSERT( GetWindow() != NULL
);
3046 // If a child, leave wxWidgets to call the function on the actual
3049 return wxACC_NOT_IMPLEMENTED
;
3051 // This will eventually be replaced by specialised
3052 // accessible classes, one for each kind of wxWidgets
3053 // control or window.
3055 if (GetWindow()->IsKindOf(CLASSINFO(wxButton
)))
3056 title
= ((wxButton
*) GetWindow())->GetLabel();
3059 title
= GetWindow()->GetName();
3067 return wxACC_NOT_IMPLEMENTED
;
3070 // Gets the number of children.
3071 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
3073 wxASSERT( GetWindow() != NULL
);
3077 *childId
= (int) GetWindow()->GetChildren().GetCount();
3081 // Gets the specified child (starting from 1).
3082 // If *child is NULL and return value is wxACC_OK,
3083 // this means that the child is a simple element and
3084 // not an accessible object.
3085 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
3087 wxASSERT( GetWindow() != NULL
);
3097 if (childId
> (int) GetWindow()->GetChildren().GetCount())
3100 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
3101 *child
= childWindow
->GetOrCreateAccessible();
3108 // Gets the parent, or NULL.
3109 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
3111 wxASSERT( GetWindow() != NULL
);
3115 wxWindow
* parentWindow
= GetWindow()->GetParent();
3123 *parent
= parentWindow
->GetOrCreateAccessible();
3131 // Performs the default action. childId is 0 (the action for this object)
3132 // or > 0 (the action for a child).
3133 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3134 // window (e.g. an edit control).
3135 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
3137 wxASSERT( GetWindow() != NULL
);
3141 return wxACC_NOT_IMPLEMENTED
;
3144 // Gets the default action for this object (0) or > 0 (the action for a child).
3145 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3146 // string if there is no action.
3147 // The retrieved string describes the action that is performed on an object,
3148 // not what the object does as a result. For example, a toolbar button that prints
3149 // a document has a default action of "Press" rather than "Prints the current document."
3150 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
3152 wxASSERT( GetWindow() != NULL
);
3156 return wxACC_NOT_IMPLEMENTED
;
3159 // Returns the description for this object or a child.
3160 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3162 wxASSERT( GetWindow() != NULL
);
3166 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3172 return wxACC_NOT_IMPLEMENTED
;
3175 // Returns help text for this object or a child, similar to tooltip text.
3176 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3178 wxASSERT( GetWindow() != NULL
);
3182 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3188 return wxACC_NOT_IMPLEMENTED
;
3191 // Returns the keyboard shortcut for this object or child.
3192 // Return e.g. ALT+K
3193 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3195 wxASSERT( GetWindow() != NULL
);
3199 return wxACC_NOT_IMPLEMENTED
;
3202 // Returns a role constant.
3203 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3205 wxASSERT( GetWindow() != NULL
);
3209 // If a child, leave wxWidgets to call the function on the actual
3212 return wxACC_NOT_IMPLEMENTED
;
3214 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3215 return wxACC_NOT_IMPLEMENTED
;
3217 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3218 return wxACC_NOT_IMPLEMENTED
;
3221 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3222 return wxACC_NOT_IMPLEMENTED
;
3225 //*role = wxROLE_SYSTEM_CLIENT;
3226 *role
= wxROLE_SYSTEM_CLIENT
;
3230 return wxACC_NOT_IMPLEMENTED
;
3234 // Returns a state constant.
3235 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3237 wxASSERT( GetWindow() != NULL
);
3241 // If a child, leave wxWidgets to call the function on the actual
3244 return wxACC_NOT_IMPLEMENTED
;
3246 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3247 return wxACC_NOT_IMPLEMENTED
;
3250 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3251 return wxACC_NOT_IMPLEMENTED
;
3254 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3255 return wxACC_NOT_IMPLEMENTED
;
3262 return wxACC_NOT_IMPLEMENTED
;
3266 // Returns a localized string representing the value for the object
3268 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3270 wxASSERT( GetWindow() != NULL
);
3274 return wxACC_NOT_IMPLEMENTED
;
3277 // Selects the object or child.
3278 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3280 wxASSERT( GetWindow() != NULL
);
3284 return wxACC_NOT_IMPLEMENTED
;
3287 // Gets the window with the keyboard focus.
3288 // If childId is 0 and child is NULL, no object in
3289 // this subhierarchy has the focus.
3290 // If this object has the focus, child should be 'this'.
3291 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3293 wxASSERT( GetWindow() != NULL
);
3297 return wxACC_NOT_IMPLEMENTED
;
3301 // Gets a variant representing the selected children
3303 // Acceptable values:
3304 // - a null variant (IsNull() returns true)
3305 // - a list variant (GetType() == wxT("list")
3306 // - an integer representing the selected child element,
3307 // or 0 if this object is selected (GetType() == wxT("long")
3308 // - a "void*" pointer to a wxAccessible child object
3309 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3311 wxASSERT( GetWindow() != NULL
);
3315 return wxACC_NOT_IMPLEMENTED
;
3317 #endif // wxUSE_VARIANT
3319 #endif // wxUSE_ACCESSIBILITY
3321 // ----------------------------------------------------------------------------
3323 // ----------------------------------------------------------------------------
3326 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3328 wxCoord widthTotal
) const
3330 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3332 x
= widthTotal
- x
- width
;