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 bool wxWindowBase::IsBeingDeleted() const
384 return m_isBeingDeleted
||
385 (!IsTopLevel() && m_parent
&& m_parent
->IsBeingDeleted());
388 void wxWindowBase::SendDestroyEvent()
390 wxWindowDestroyEvent event
;
391 event
.SetEventObject(this);
392 event
.SetId(GetId());
393 GetEventHandler()->ProcessEvent(event
);
396 bool wxWindowBase::Destroy()
403 bool wxWindowBase::Close(bool force
)
405 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
406 event
.SetEventObject(this);
407 event
.SetCanVeto(!force
);
409 // return false if window wasn't closed because the application vetoed the
411 return HandleWindowEvent(event
) && !event
.GetVeto();
414 bool wxWindowBase::DestroyChildren()
416 wxWindowList::compatibility_iterator node
;
419 // we iterate until the list becomes empty
420 node
= GetChildren().GetFirst();
424 wxWindow
*child
= node
->GetData();
426 // note that we really want to call delete and not ->Destroy() here
427 // because we want to delete the child immediately, before we are
428 // deleted, and delayed deletion would result in problems as our (top
429 // level) child could outlive its parent
432 wxASSERT_MSG( !GetChildren().Find(child
),
433 wxT("child didn't remove itself using RemoveChild()") );
439 // ----------------------------------------------------------------------------
440 // size/position related methods
441 // ----------------------------------------------------------------------------
443 // centre the window with respect to its parent in either (or both) directions
444 void wxWindowBase::DoCentre(int dir
)
446 wxCHECK_RET( !(dir
& wxCENTRE_ON_SCREEN
) && GetParent(),
447 _T("this method only implements centering child windows") );
449 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir
));
452 // fits the window around the children
453 void wxWindowBase::Fit()
455 if ( !GetChildren().empty() )
457 SetSize(GetBestSize());
459 //else: do nothing if we have no children
462 // fits virtual size (ie. scrolled area etc.) around children
463 void wxWindowBase::FitInside()
465 if ( GetChildren().GetCount() > 0 )
467 SetVirtualSize( GetBestVirtualSize() );
471 // On Mac, scrollbars are explicitly children.
473 static bool wxHasRealChildren(const wxWindowBase
* win
)
475 int realChildCount
= 0;
477 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
479 node
= node
->GetNext() )
481 wxWindow
*win
= node
->GetData();
482 if ( !win
->IsTopLevel() && win
->IsShown() && !win
->IsKindOf(CLASSINFO(wxScrollBar
)))
485 return (realChildCount
> 0);
489 void wxWindowBase::InvalidateBestSize()
491 m_bestSizeCache
= wxDefaultSize
;
493 // parent's best size calculation may depend on its children's
494 // as long as child window we are in is not top level window itself
495 // (because the TLW size is never resized automatically)
496 // so let's invalidate it as well to be safe:
497 if (m_parent
&& !IsTopLevel())
498 m_parent
->InvalidateBestSize();
501 // return the size best suited for the current window
502 wxSize
wxWindowBase::DoGetBestSize() const
508 best
= m_windowSizer
->GetMinSize();
510 #if wxUSE_CONSTRAINTS
511 else if ( m_constraints
)
513 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
515 // our minimal acceptable size is such that all our windows fit inside
519 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
521 node
= node
->GetNext() )
523 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
526 // it's not normal that we have an unconstrained child, but
527 // what can we do about it?
531 int x
= c
->right
.GetValue(),
532 y
= c
->bottom
.GetValue();
540 // TODO: we must calculate the overlaps somehow, otherwise we
541 // will never return a size bigger than the current one :-(
544 best
= wxSize(maxX
, maxY
);
546 #endif // wxUSE_CONSTRAINTS
547 else if ( !GetChildren().empty()
549 && wxHasRealChildren(this)
553 // our minimal acceptable size is such that all our visible child
554 // windows fit inside
558 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
560 node
= node
->GetNext() )
562 wxWindow
*win
= node
->GetData();
563 if ( win
->IsTopLevel()
566 || wxDynamicCast(win
, wxStatusBar
)
567 #endif // wxUSE_STATUSBAR
570 // dialogs and frames lie in different top level windows -
571 // don't deal with them here; as for the status bars, they
572 // don't lie in the client area at all
577 win
->GetPosition(&wx
, &wy
);
579 // if the window hadn't been positioned yet, assume that it is in
581 if ( wx
== wxDefaultCoord
)
583 if ( wy
== wxDefaultCoord
)
586 win
->GetSize(&ww
, &wh
);
587 if ( wx
+ ww
> maxX
)
589 if ( wy
+ wh
> maxY
)
593 best
= wxSize(maxX
, maxY
);
595 else // ! has children
597 // for a generic window there is no natural best size so, if the
598 // minimal size is not set, use the current size but take care to
599 // remember it as minimal size for the next time because our best size
600 // should be constant: otherwise we could get into a situation when the
601 // window is initially at some size, then expanded to a larger size and
602 // then, when the containing window is shrunk back (because our initial
603 // best size had been used for computing the parent min size), we can't
604 // be shrunk back any more because our best size is now bigger
605 wxSize size
= GetMinSize();
606 if ( !size
.IsFullySpecified() )
608 size
.SetDefaults(GetSize());
609 wxConstCast(this, wxWindowBase
)->SetMinSize(size
);
612 // return as-is, unadjusted by the client size difference.
616 // Add any difference between size and client size
617 wxSize diff
= GetSize() - GetClientSize();
618 best
.x
+= wxMax(0, diff
.x
);
619 best
.y
+= wxMax(0, diff
.y
);
624 // helper of GetWindowBorderSize(): as many ports don't implement support for
625 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
626 // fallbacks in this case
627 static int wxGetMetricOrDefault(wxSystemMetric what
)
629 int rc
= wxSystemSettings::GetMetric(what
);
636 // 2D border is by default 1 pixel wide
642 // 3D borders are by default 2 pixels
647 wxFAIL_MSG( _T("unexpected wxGetMetricOrDefault() argument") );
655 wxSize
wxWindowBase::GetWindowBorderSize() const
659 switch ( GetBorder() )
662 // nothing to do, size is already (0, 0)
665 case wxBORDER_SIMPLE
:
666 case wxBORDER_STATIC
:
667 size
.x
= wxGetMetricOrDefault(wxSYS_BORDER_X
);
668 size
.y
= wxGetMetricOrDefault(wxSYS_BORDER_Y
);
671 case wxBORDER_SUNKEN
:
672 case wxBORDER_RAISED
:
673 size
.x
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X
),
674 wxGetMetricOrDefault(wxSYS_BORDER_X
));
675 size
.y
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y
),
676 wxGetMetricOrDefault(wxSYS_BORDER_Y
));
679 case wxBORDER_DOUBLE
:
680 size
.x
= wxGetMetricOrDefault(wxSYS_EDGE_X
) +
681 wxGetMetricOrDefault(wxSYS_BORDER_X
);
682 size
.y
= wxGetMetricOrDefault(wxSYS_EDGE_Y
) +
683 wxGetMetricOrDefault(wxSYS_BORDER_Y
);
687 wxFAIL_MSG(_T("Unknown border style."));
691 // we have borders on both sides
695 wxSize
wxWindowBase::GetEffectiveMinSize() const
697 // merge the best size with the min size, giving priority to the min size
698 wxSize min
= GetMinSize();
699 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
701 wxSize best
= GetBestSize();
702 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
703 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
709 void wxWindowBase::SetInitialSize(const wxSize
& size
)
711 // Set the min size to the size passed in. This will usually either be
712 // wxDefaultSize or the size passed to this window's ctor/Create function.
715 // Merge the size with the best size if needed
716 wxSize best
= GetEffectiveMinSize();
718 // If the current size doesn't match then change it
719 if (GetSize() != best
)
724 // by default the origin is not shifted
725 wxPoint
wxWindowBase::GetClientAreaOrigin() const
730 wxSize
wxWindowBase::ClientToWindowSize(const wxSize
& size
) const
732 const wxSize
diff(GetSize() - GetClientSize());
734 return wxSize(size
.x
== -1 ? -1 : size
.x
+ diff
.x
,
735 size
.y
== -1 ? -1 : size
.y
+ diff
.y
);
738 wxSize
wxWindowBase::WindowToClientSize(const wxSize
& size
) const
740 const wxSize
diff(GetSize() - GetClientSize());
742 return wxSize(size
.x
== -1 ? -1 : size
.x
- diff
.x
,
743 size
.y
== -1 ? -1 : size
.y
- diff
.y
);
746 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
748 if ( m_windowVariant
!= variant
)
750 m_windowVariant
= variant
;
752 DoSetWindowVariant(variant
);
756 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
758 // adjust the font height to correspond to our new variant (notice that
759 // we're only called if something really changed)
760 wxFont font
= GetFont();
761 int size
= font
.GetPointSize();
764 case wxWINDOW_VARIANT_NORMAL
:
767 case wxWINDOW_VARIANT_SMALL
:
772 case wxWINDOW_VARIANT_MINI
:
777 case wxWINDOW_VARIANT_LARGE
:
783 wxFAIL_MSG(_T("unexpected window variant"));
787 font
.SetPointSize(size
);
791 void wxWindowBase::DoSetSizeHints( int minW
, int minH
,
793 int WXUNUSED(incW
), int WXUNUSED(incH
) )
795 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
796 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
797 _T("min width/height must be less than max width/height!") );
806 #if WXWIN_COMPATIBILITY_2_8
807 void wxWindowBase::SetVirtualSizeHints(int WXUNUSED(minW
), int WXUNUSED(minH
),
808 int WXUNUSED(maxW
), int WXUNUSED(maxH
))
812 void wxWindowBase::SetVirtualSizeHints(const wxSize
& WXUNUSED(minsize
),
813 const wxSize
& WXUNUSED(maxsize
))
816 #endif // WXWIN_COMPATIBILITY_2_8
818 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
820 m_virtualSize
= wxSize(x
, y
);
823 wxSize
wxWindowBase::DoGetVirtualSize() const
825 // we should use the entire client area so if it is greater than our
826 // virtual size, expand it to fit (otherwise if the window is big enough we
827 // wouldn't be using parts of it)
828 wxSize size
= GetClientSize();
829 if ( m_virtualSize
.x
> size
.x
)
830 size
.x
= m_virtualSize
.x
;
832 if ( m_virtualSize
.y
>= size
.y
)
833 size
.y
= m_virtualSize
.y
;
838 void wxWindowBase::DoGetScreenPosition(int *x
, int *y
) const
840 // screen position is the same as (0, 0) in client coords for non TLWs (and
841 // TLWs override this method)
847 ClientToScreen(x
, y
);
850 void wxWindowBase::SendSizeEvent(int flags
)
852 wxSizeEvent
event(GetSize(), GetId());
853 event
.SetEventObject(this);
854 if ( flags
& wxSEND_EVENT_POST
)
855 wxPostEvent(this, event
);
857 HandleWindowEvent(event
);
860 void wxWindowBase::SendSizeEventToParent(int flags
)
862 wxWindow
* const parent
= GetParent();
863 if ( parent
&& !parent
->IsBeingDeleted() )
864 parent
->SendSizeEvent(flags
);
867 // ----------------------------------------------------------------------------
868 // show/hide/enable/disable the window
869 // ----------------------------------------------------------------------------
871 bool wxWindowBase::Show(bool show
)
873 if ( show
!= m_isShown
)
885 bool wxWindowBase::IsEnabled() const
887 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
890 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled
)
892 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
894 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
898 // If we are top-level then the logic doesn't apply - otherwise
899 // showing a modal dialog would result in total greying out (and ungreying
900 // out later) of everything which would be really ugly
904 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
906 node
= node
->GetNext() )
908 wxWindowBase
* const child
= node
->GetData();
909 if ( !child
->IsTopLevel() && child
->IsThisEnabled() )
910 child
->NotifyWindowOnEnableChange(enabled
);
914 bool wxWindowBase::Enable(bool enable
)
916 if ( enable
== IsThisEnabled() )
919 m_isEnabled
= enable
;
921 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
923 #else // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
924 wxWindowBase
* const parent
= GetParent();
925 if( !IsTopLevel() && parent
&& !parent
->IsEnabled() )
929 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
931 NotifyWindowOnEnableChange(enable
);
936 bool wxWindowBase::IsShownOnScreen() const
938 // A window is shown on screen if it itself is shown and so are all its
939 // parents. But if a window is toplevel one, then its always visible on
940 // screen if IsShown() returns true, even if it has a hidden parent.
942 (IsTopLevel() || GetParent() == NULL
|| GetParent()->IsShownOnScreen());
945 // ----------------------------------------------------------------------------
947 // ----------------------------------------------------------------------------
949 bool wxWindowBase::IsTopLevel() const
954 // ----------------------------------------------------------------------------
956 // ----------------------------------------------------------------------------
958 void wxWindowBase::Freeze()
960 if ( !m_freezeCount
++ )
962 // physically freeze this window:
965 // and recursively freeze all children:
966 for ( wxWindowList::iterator i
= GetChildren().begin();
967 i
!= GetChildren().end(); ++i
)
969 wxWindow
*child
= *i
;
970 if ( child
->IsTopLevel() )
978 void wxWindowBase::Thaw()
980 wxASSERT_MSG( m_freezeCount
, "Thaw() without matching Freeze()" );
982 if ( !--m_freezeCount
)
984 // recursively thaw all children:
985 for ( wxWindowList::iterator i
= GetChildren().begin();
986 i
!= GetChildren().end(); ++i
)
988 wxWindow
*child
= *i
;
989 if ( child
->IsTopLevel() )
995 // physically thaw this window:
1000 // ----------------------------------------------------------------------------
1001 // reparenting the window
1002 // ----------------------------------------------------------------------------
1004 void wxWindowBase::AddChild(wxWindowBase
*child
)
1006 wxCHECK_RET( child
, wxT("can't add a NULL child") );
1008 // this should never happen and it will lead to a crash later if it does
1009 // because RemoveChild() will remove only one node from the children list
1010 // and the other(s) one(s) will be left with dangling pointers in them
1011 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), _T("AddChild() called twice") );
1013 GetChildren().Append((wxWindow
*)child
);
1014 child
->SetParent(this);
1016 // adding a child while frozen will assert when thawed, so freeze it as if
1017 // it had been already present when we were frozen
1018 if ( IsFrozen() && !child
->IsTopLevel() )
1022 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
1024 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
1026 // removing a child while frozen may result in permanently frozen window
1027 // if used e.g. from Reparent(), so thaw it
1029 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1030 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1031 if ( IsFrozen() && !child
->IsBeingDeleted() && !child
->IsTopLevel() )
1034 GetChildren().DeleteObject((wxWindow
*)child
);
1035 child
->SetParent(NULL
);
1038 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
1040 wxWindow
*oldParent
= GetParent();
1041 if ( newParent
== oldParent
)
1047 const bool oldEnabledState
= IsEnabled();
1049 // unlink this window from the existing parent.
1052 oldParent
->RemoveChild(this);
1056 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
1059 // add it to the new one
1062 newParent
->AddChild(this);
1066 wxTopLevelWindows
.Append((wxWindow
*)this);
1069 // We need to notify window (and its subwindows) if by changing the parent
1070 // we also change our enabled/disabled status.
1071 const bool newEnabledState
= IsEnabled();
1072 if ( newEnabledState
!= oldEnabledState
)
1074 NotifyWindowOnEnableChange(newEnabledState
);
1080 // ----------------------------------------------------------------------------
1081 // event handler stuff
1082 // ----------------------------------------------------------------------------
1084 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
1086 wxEvtHandler
*handlerOld
= GetEventHandler();
1088 handler
->SetNextHandler(handlerOld
);
1091 GetEventHandler()->SetPreviousHandler(handler
);
1093 SetEventHandler(handler
);
1096 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
1098 wxEvtHandler
*handlerA
= GetEventHandler();
1101 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
1102 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
1105 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
1106 SetEventHandler(handlerB
);
1108 if ( deleteHandler
)
1111 handlerA
= (wxEvtHandler
*)NULL
;
1118 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
1120 wxCHECK_MSG( handler
, false, _T("RemoveEventHandler(NULL) called") );
1122 wxEvtHandler
*handlerPrev
= NULL
,
1123 *handlerCur
= GetEventHandler();
1124 while ( handlerCur
)
1126 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1128 if ( handlerCur
== handler
)
1132 handlerPrev
->SetNextHandler(handlerNext
);
1136 SetEventHandler(handlerNext
);
1141 handlerNext
->SetPreviousHandler ( handlerPrev
);
1144 handler
->SetNextHandler(NULL
);
1145 handler
->SetPreviousHandler(NULL
);
1150 handlerPrev
= handlerCur
;
1151 handlerCur
= handlerNext
;
1154 wxFAIL_MSG( _T("where has the event handler gone?") );
1159 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1161 return GetEventHandler()->SafelyProcessEvent(event
);
1164 // ----------------------------------------------------------------------------
1165 // colours, fonts &c
1166 // ----------------------------------------------------------------------------
1168 void wxWindowBase::InheritAttributes()
1170 const wxWindowBase
* const parent
= GetParent();
1174 // we only inherit attributes which had been explicitly set for the parent
1175 // which ensures that this only happens if the user really wants it and
1176 // not by default which wouldn't make any sense in modern GUIs where the
1177 // controls don't all use the same fonts (nor colours)
1178 if ( parent
->m_inheritFont
&& !m_hasFont
)
1179 SetFont(parent
->GetFont());
1181 // in addition, there is a possibility to explicitly forbid inheriting
1182 // colours at each class level by overriding ShouldInheritColours()
1183 if ( ShouldInheritColours() )
1185 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1186 SetForegroundColour(parent
->GetForegroundColour());
1188 // inheriting (solid) background colour is wrong as it totally breaks
1189 // any kind of themed backgrounds
1191 // instead, the controls should use the same background as their parent
1192 // (ideally by not drawing it at all)
1194 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1195 SetBackgroundColour(parent
->GetBackgroundColour());
1200 /* static */ wxVisualAttributes
1201 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1203 // it is important to return valid values for all attributes from here,
1204 // GetXXX() below rely on this
1205 wxVisualAttributes attrs
;
1206 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1207 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1209 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1210 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1211 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1212 // colour on other platforms.
1214 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1215 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1217 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1222 wxColour
wxWindowBase::GetBackgroundColour() const
1224 if ( !m_backgroundColour
.IsOk() )
1226 wxASSERT_MSG( !m_hasBgCol
, _T("we have invalid explicit bg colour?") );
1228 // get our default background colour
1229 wxColour colBg
= GetDefaultAttributes().colBg
;
1231 // we must return some valid colour to avoid redoing this every time
1232 // and also to avoid surprizing the applications written for older
1233 // wxWidgets versions where GetBackgroundColour() always returned
1234 // something -- so give them something even if it doesn't make sense
1235 // for this window (e.g. it has a themed background)
1237 colBg
= GetClassDefaultAttributes().colBg
;
1242 return m_backgroundColour
;
1245 wxColour
wxWindowBase::GetForegroundColour() const
1247 // logic is the same as above
1248 if ( !m_hasFgCol
&& !m_foregroundColour
.Ok() )
1250 wxColour colFg
= GetDefaultAttributes().colFg
;
1252 if ( !colFg
.IsOk() )
1253 colFg
= GetClassDefaultAttributes().colFg
;
1258 return m_foregroundColour
;
1261 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1263 if ( colour
== m_backgroundColour
)
1266 m_hasBgCol
= colour
.IsOk();
1267 if ( m_backgroundStyle
!= wxBG_STYLE_CUSTOM
)
1268 m_backgroundStyle
= m_hasBgCol
? wxBG_STYLE_COLOUR
: wxBG_STYLE_SYSTEM
;
1270 m_inheritBgCol
= m_hasBgCol
;
1271 m_backgroundColour
= colour
;
1272 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.Ok() );
1276 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1278 if (colour
== m_foregroundColour
)
1281 m_hasFgCol
= colour
.IsOk();
1282 m_inheritFgCol
= m_hasFgCol
;
1283 m_foregroundColour
= colour
;
1284 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.Ok() );
1288 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1290 // setting an invalid cursor is ok, it means that we don't have any special
1292 if ( m_cursor
.IsSameAs(cursor
) )
1303 wxFont
wxWindowBase::GetFont() const
1305 // logic is the same as in GetBackgroundColour()
1306 if ( !m_font
.IsOk() )
1308 wxASSERT_MSG( !m_hasFont
, _T("we have invalid explicit font?") );
1310 wxFont font
= GetDefaultAttributes().font
;
1312 font
= GetClassDefaultAttributes().font
;
1320 bool wxWindowBase::SetFont(const wxFont
& font
)
1322 if ( font
== m_font
)
1329 m_hasFont
= font
.IsOk();
1330 m_inheritFont
= m_hasFont
;
1332 InvalidateBestSize();
1339 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1341 m_hasCustomPalette
= true;
1344 // VZ: can anyone explain me what do we do here?
1345 wxWindowDC
d((wxWindow
*) this);
1349 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1351 wxWindow
*win
= (wxWindow
*)this;
1352 while ( win
&& !win
->HasCustomPalette() )
1354 win
= win
->GetParent();
1360 #endif // wxUSE_PALETTE
1363 void wxWindowBase::SetCaret(wxCaret
*caret
)
1374 wxASSERT_MSG( m_caret
->GetWindow() == this,
1375 wxT("caret should be created associated to this window") );
1378 #endif // wxUSE_CARET
1380 #if wxUSE_VALIDATORS
1381 // ----------------------------------------------------------------------------
1383 // ----------------------------------------------------------------------------
1385 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1387 if ( m_windowValidator
)
1388 delete m_windowValidator
;
1390 m_windowValidator
= (wxValidator
*)validator
.Clone();
1392 if ( m_windowValidator
)
1393 m_windowValidator
->SetWindow(this);
1395 #endif // wxUSE_VALIDATORS
1397 // ----------------------------------------------------------------------------
1398 // update region stuff
1399 // ----------------------------------------------------------------------------
1401 wxRect
wxWindowBase::GetUpdateClientRect() const
1403 wxRegion rgnUpdate
= GetUpdateRegion();
1404 rgnUpdate
.Intersect(GetClientRect());
1405 wxRect rectUpdate
= rgnUpdate
.GetBox();
1406 wxPoint ptOrigin
= GetClientAreaOrigin();
1407 rectUpdate
.x
-= ptOrigin
.x
;
1408 rectUpdate
.y
-= ptOrigin
.y
;
1413 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1415 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1418 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1420 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1423 void wxWindowBase::ClearBackground()
1425 // wxGTK uses its own version, no need to add never used code
1427 wxClientDC
dc((wxWindow
*)this);
1428 wxBrush
brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID
);
1429 dc
.SetBackground(brush
);
1434 // ----------------------------------------------------------------------------
1435 // find child window by id or name
1436 // ----------------------------------------------------------------------------
1438 wxWindow
*wxWindowBase::FindWindow(long id
) const
1440 if ( id
== m_windowId
)
1441 return (wxWindow
*)this;
1443 wxWindowBase
*res
= (wxWindow
*)NULL
;
1444 wxWindowList::compatibility_iterator node
;
1445 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1447 wxWindowBase
*child
= node
->GetData();
1448 res
= child
->FindWindow( id
);
1451 return (wxWindow
*)res
;
1454 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1456 if ( name
== m_windowName
)
1457 return (wxWindow
*)this;
1459 wxWindowBase
*res
= (wxWindow
*)NULL
;
1460 wxWindowList::compatibility_iterator node
;
1461 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1463 wxWindow
*child
= node
->GetData();
1464 res
= child
->FindWindow(name
);
1467 return (wxWindow
*)res
;
1471 // find any window by id or name or label: If parent is non-NULL, look through
1472 // children for a label or title matching the specified string. If NULL, look
1473 // through all top-level windows.
1475 // to avoid duplicating code we reuse the same helper function but with
1476 // different comparators
1478 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1479 const wxString
& label
, long id
);
1482 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1485 return win
->GetLabel() == label
;
1489 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1492 return win
->GetName() == label
;
1496 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1499 return win
->GetId() == id
;
1502 // recursive helper for the FindWindowByXXX() functions
1504 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1505 const wxString
& label
,
1507 wxFindWindowCmp cmp
)
1511 // see if this is the one we're looking for
1512 if ( (*cmp
)(parent
, label
, id
) )
1513 return (wxWindow
*)parent
;
1515 // It wasn't, so check all its children
1516 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1518 node
= node
->GetNext() )
1520 // recursively check each child
1521 wxWindow
*win
= (wxWindow
*)node
->GetData();
1522 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1532 // helper for FindWindowByXXX()
1534 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1535 const wxString
& label
,
1537 wxFindWindowCmp cmp
)
1541 // just check parent and all its children
1542 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1545 // start at very top of wx's windows
1546 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1548 node
= node
->GetNext() )
1550 // recursively check each window & its children
1551 wxWindow
*win
= node
->GetData();
1552 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1562 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1564 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1569 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1571 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1575 // fall back to the label
1576 win
= FindWindowByLabel(title
, parent
);
1584 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1586 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1589 // ----------------------------------------------------------------------------
1590 // dialog oriented functions
1591 // ----------------------------------------------------------------------------
1593 void wxWindowBase::MakeModal(bool modal
)
1595 // Disable all other windows
1598 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1601 wxWindow
*win
= node
->GetData();
1603 win
->Enable(!modal
);
1605 node
= node
->GetNext();
1610 bool wxWindowBase::Validate()
1612 #if wxUSE_VALIDATORS
1613 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1615 wxWindowList::compatibility_iterator node
;
1616 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1618 wxWindowBase
*child
= node
->GetData();
1619 wxValidator
*validator
= child
->GetValidator();
1620 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1625 if ( recurse
&& !child
->Validate() )
1630 #endif // wxUSE_VALIDATORS
1635 bool wxWindowBase::TransferDataToWindow()
1637 #if wxUSE_VALIDATORS
1638 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1640 wxWindowList::compatibility_iterator node
;
1641 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1643 wxWindowBase
*child
= node
->GetData();
1644 wxValidator
*validator
= child
->GetValidator();
1645 if ( validator
&& !validator
->TransferToWindow() )
1647 wxLogWarning(_("Could not transfer data to window"));
1649 wxLog::FlushActive();
1657 if ( !child
->TransferDataToWindow() )
1659 // warning already given
1664 #endif // wxUSE_VALIDATORS
1669 bool wxWindowBase::TransferDataFromWindow()
1671 #if wxUSE_VALIDATORS
1672 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1674 wxWindowList::compatibility_iterator node
;
1675 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1677 wxWindow
*child
= node
->GetData();
1678 wxValidator
*validator
= child
->GetValidator();
1679 if ( validator
&& !validator
->TransferFromWindow() )
1681 // nop warning here because the application is supposed to give
1682 // one itself - we don't know here what might have gone wrongly
1689 if ( !child
->TransferDataFromWindow() )
1691 // warning already given
1696 #endif // wxUSE_VALIDATORS
1701 void wxWindowBase::InitDialog()
1703 wxInitDialogEvent
event(GetId());
1704 event
.SetEventObject( this );
1705 GetEventHandler()->ProcessEvent(event
);
1708 // ----------------------------------------------------------------------------
1709 // context-sensitive help support
1710 // ----------------------------------------------------------------------------
1714 // associate this help text with this window
1715 void wxWindowBase::SetHelpText(const wxString
& text
)
1717 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1720 helpProvider
->AddHelp(this, text
);
1724 #if WXWIN_COMPATIBILITY_2_8
1725 // associate this help text with all windows with the same id as this
1727 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1729 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1732 helpProvider
->AddHelp(GetId(), text
);
1735 #endif // WXWIN_COMPATIBILITY_2_8
1737 // get the help string associated with this window (may be empty)
1738 // default implementation forwards calls to the help provider
1740 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
1741 wxHelpEvent::Origin
WXUNUSED(origin
)) const
1744 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1747 text
= helpProvider
->GetHelp(this);
1753 // show help for this window
1754 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1756 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1759 wxPoint pos
= event
.GetPosition();
1760 const wxHelpEvent::Origin origin
= event
.GetOrigin();
1761 if ( origin
== wxHelpEvent::Origin_Keyboard
)
1763 // if the help event was generated from keyboard it shouldn't
1764 // appear at the mouse position (which is still the only position
1765 // associated with help event) if the mouse is far away, although
1766 // we still do use the mouse position if it's over the window
1767 // because we suppose the user looks approximately at the mouse
1768 // already and so it would be more convenient than showing tooltip
1769 // at some arbitrary position which can be quite far from it
1770 const wxRect rectClient
= GetClientRect();
1771 if ( !rectClient
.Contains(ScreenToClient(pos
)) )
1773 // position help slightly under and to the right of this window
1774 pos
= ClientToScreen(wxPoint(
1776 rectClient
.height
+ GetCharHeight()
1781 if ( helpProvider
->ShowHelpAtPoint(this, pos
, origin
) )
1783 // skip the event.Skip() below
1791 #endif // wxUSE_HELP
1793 // ----------------------------------------------------------------------------
1795 // ----------------------------------------------------------------------------
1799 void wxWindowBase::SetToolTip( const wxString
&tip
)
1801 // don't create the new tooltip if we already have one
1804 m_tooltip
->SetTip( tip
);
1808 SetToolTip( new wxToolTip( tip
) );
1811 // setting empty tooltip text does not remove the tooltip any more - use
1812 // SetToolTip((wxToolTip *)NULL) for this
1815 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1817 if ( m_tooltip
!= tooltip
)
1822 m_tooltip
= tooltip
;
1826 #endif // wxUSE_TOOLTIPS
1828 // ----------------------------------------------------------------------------
1829 // constraints and sizers
1830 // ----------------------------------------------------------------------------
1832 #if wxUSE_CONSTRAINTS
1834 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1836 if ( m_constraints
)
1838 UnsetConstraints(m_constraints
);
1839 delete m_constraints
;
1841 m_constraints
= constraints
;
1842 if ( m_constraints
)
1844 // Make sure other windows know they're part of a 'meaningful relationship'
1845 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1846 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1847 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1848 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1849 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1850 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1851 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1852 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1853 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1854 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1855 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1856 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1857 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1858 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1859 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1860 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1864 // This removes any dangling pointers to this window in other windows'
1865 // constraintsInvolvedIn lists.
1866 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1870 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1871 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1872 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1873 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1874 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1875 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1876 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1877 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1878 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1879 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1880 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1881 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1882 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1883 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1884 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1885 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1889 // Back-pointer to other windows we're involved with, so if we delete this
1890 // window, we must delete any constraints we're involved with.
1891 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1893 if ( !m_constraintsInvolvedIn
)
1894 m_constraintsInvolvedIn
= new wxWindowList
;
1895 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
1896 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
1899 // REMOVE back-pointer to other windows we're involved with.
1900 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1902 if ( m_constraintsInvolvedIn
)
1903 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
1906 // Reset any constraints that mention this window
1907 void wxWindowBase::DeleteRelatedConstraints()
1909 if ( m_constraintsInvolvedIn
)
1911 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
1914 wxWindow
*win
= node
->GetData();
1915 wxLayoutConstraints
*constr
= win
->GetConstraints();
1917 // Reset any constraints involving this window
1920 constr
->left
.ResetIfWin(this);
1921 constr
->top
.ResetIfWin(this);
1922 constr
->right
.ResetIfWin(this);
1923 constr
->bottom
.ResetIfWin(this);
1924 constr
->width
.ResetIfWin(this);
1925 constr
->height
.ResetIfWin(this);
1926 constr
->centreX
.ResetIfWin(this);
1927 constr
->centreY
.ResetIfWin(this);
1930 wxWindowList::compatibility_iterator next
= node
->GetNext();
1931 m_constraintsInvolvedIn
->Erase(node
);
1935 delete m_constraintsInvolvedIn
;
1936 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1940 #endif // wxUSE_CONSTRAINTS
1942 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1944 if ( sizer
== m_windowSizer
)
1947 if ( m_windowSizer
)
1949 m_windowSizer
->SetContainingWindow(NULL
);
1952 delete m_windowSizer
;
1955 m_windowSizer
= sizer
;
1956 if ( m_windowSizer
)
1958 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
1961 SetAutoLayout(m_windowSizer
!= NULL
);
1964 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1966 SetSizer( sizer
, deleteOld
);
1967 sizer
->SetSizeHints( (wxWindow
*) this );
1971 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
1973 // adding a window to a sizer twice is going to result in fatal and
1974 // hard to debug problems later because when deleting the second
1975 // associated wxSizerItem we're going to dereference a dangling
1976 // pointer; so try to detect this as early as possible
1977 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
1978 _T("Adding a window to the same sizer twice?") );
1980 m_containingSizer
= sizer
;
1983 #if wxUSE_CONSTRAINTS
1985 void wxWindowBase::SatisfyConstraints()
1987 wxLayoutConstraints
*constr
= GetConstraints();
1988 bool wasOk
= constr
&& constr
->AreSatisfied();
1990 ResetConstraints(); // Mark all constraints as unevaluated
1994 // if we're a top level panel (i.e. our parent is frame/dialog), our
1995 // own constraints will never be satisfied any more unless we do it
1999 while ( noChanges
> 0 )
2001 LayoutPhase1(&noChanges
);
2005 LayoutPhase2(&noChanges
);
2008 #endif // wxUSE_CONSTRAINTS
2010 bool wxWindowBase::Layout()
2012 // If there is a sizer, use it instead of the constraints
2016 GetVirtualSize(&w
, &h
);
2017 GetSizer()->SetDimension( 0, 0, w
, h
);
2019 #if wxUSE_CONSTRAINTS
2022 SatisfyConstraints(); // Find the right constraints values
2023 SetConstraintSizes(); // Recursively set the real window sizes
2030 #if wxUSE_CONSTRAINTS
2032 // first phase of the constraints evaluation: set our own constraints
2033 bool wxWindowBase::LayoutPhase1(int *noChanges
)
2035 wxLayoutConstraints
*constr
= GetConstraints();
2037 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
2040 // second phase: set the constraints for our children
2041 bool wxWindowBase::LayoutPhase2(int *noChanges
)
2048 // Layout grand children
2054 // Do a phase of evaluating child constraints
2055 bool wxWindowBase::DoPhase(int phase
)
2057 // the list containing the children for which the constraints are already
2059 wxWindowList succeeded
;
2061 // the max number of iterations we loop before concluding that we can't set
2063 static const int maxIterations
= 500;
2065 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
2069 // loop over all children setting their constraints
2070 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2072 node
= node
->GetNext() )
2074 wxWindow
*child
= node
->GetData();
2075 if ( child
->IsTopLevel() )
2077 // top level children are not inside our client area
2081 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
2083 // this one is either already ok or nothing we can do about it
2087 int tempNoChanges
= 0;
2088 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
2089 : child
->LayoutPhase2(&tempNoChanges
);
2090 noChanges
+= tempNoChanges
;
2094 succeeded
.Append(child
);
2100 // constraints are set
2108 void wxWindowBase::ResetConstraints()
2110 wxLayoutConstraints
*constr
= GetConstraints();
2113 constr
->left
.SetDone(false);
2114 constr
->top
.SetDone(false);
2115 constr
->right
.SetDone(false);
2116 constr
->bottom
.SetDone(false);
2117 constr
->width
.SetDone(false);
2118 constr
->height
.SetDone(false);
2119 constr
->centreX
.SetDone(false);
2120 constr
->centreY
.SetDone(false);
2123 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2126 wxWindow
*win
= node
->GetData();
2127 if ( !win
->IsTopLevel() )
2128 win
->ResetConstraints();
2129 node
= node
->GetNext();
2133 // Need to distinguish between setting the 'fake' size for windows and sizers,
2134 // and setting the real values.
2135 void wxWindowBase::SetConstraintSizes(bool recurse
)
2137 wxLayoutConstraints
*constr
= GetConstraints();
2138 if ( constr
&& constr
->AreSatisfied() )
2140 int x
= constr
->left
.GetValue();
2141 int y
= constr
->top
.GetValue();
2142 int w
= constr
->width
.GetValue();
2143 int h
= constr
->height
.GetValue();
2145 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2146 (constr
->height
.GetRelationship() != wxAsIs
) )
2148 SetSize(x
, y
, w
, h
);
2152 // If we don't want to resize this window, just move it...
2158 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2159 GetClassInfo()->GetClassName(),
2165 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2168 wxWindow
*win
= node
->GetData();
2169 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2170 win
->SetConstraintSizes();
2171 node
= node
->GetNext();
2176 // Only set the size/position of the constraint (if any)
2177 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2179 wxLayoutConstraints
*constr
= GetConstraints();
2182 if ( x
!= wxDefaultCoord
)
2184 constr
->left
.SetValue(x
);
2185 constr
->left
.SetDone(true);
2187 if ( y
!= wxDefaultCoord
)
2189 constr
->top
.SetValue(y
);
2190 constr
->top
.SetDone(true);
2192 if ( w
!= wxDefaultCoord
)
2194 constr
->width
.SetValue(w
);
2195 constr
->width
.SetDone(true);
2197 if ( h
!= wxDefaultCoord
)
2199 constr
->height
.SetValue(h
);
2200 constr
->height
.SetDone(true);
2205 void wxWindowBase::MoveConstraint(int x
, int y
)
2207 wxLayoutConstraints
*constr
= GetConstraints();
2210 if ( x
!= wxDefaultCoord
)
2212 constr
->left
.SetValue(x
);
2213 constr
->left
.SetDone(true);
2215 if ( y
!= wxDefaultCoord
)
2217 constr
->top
.SetValue(y
);
2218 constr
->top
.SetDone(true);
2223 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2225 wxLayoutConstraints
*constr
= GetConstraints();
2228 *w
= constr
->width
.GetValue();
2229 *h
= constr
->height
.GetValue();
2235 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2237 wxLayoutConstraints
*constr
= GetConstraints();
2240 *w
= constr
->width
.GetValue();
2241 *h
= constr
->height
.GetValue();
2244 GetClientSize(w
, h
);
2247 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2249 wxLayoutConstraints
*constr
= GetConstraints();
2252 *x
= constr
->left
.GetValue();
2253 *y
= constr
->top
.GetValue();
2259 #endif // wxUSE_CONSTRAINTS
2261 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2263 // don't do it for the dialogs/frames - they float independently of their
2265 if ( !IsTopLevel() )
2267 wxWindow
*parent
= GetParent();
2268 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2270 wxPoint
pt(parent
->GetClientAreaOrigin());
2277 // ----------------------------------------------------------------------------
2278 // Update UI processing
2279 // ----------------------------------------------------------------------------
2281 void wxWindowBase::UpdateWindowUI(long flags
)
2283 wxUpdateUIEvent
event(GetId());
2284 event
.SetEventObject(this);
2286 if ( GetEventHandler()->ProcessEvent(event
) )
2288 DoUpdateWindowUI(event
);
2291 if (flags
& wxUPDATE_UI_RECURSE
)
2293 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2296 wxWindow
* child
= (wxWindow
*) node
->GetData();
2297 child
->UpdateWindowUI(flags
);
2298 node
= node
->GetNext();
2303 // do the window-specific processing after processing the update event
2304 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2306 if ( event
.GetSetEnabled() )
2307 Enable(event
.GetEnabled());
2309 if ( event
.GetSetShown() )
2310 Show(event
.GetShown());
2313 // ----------------------------------------------------------------------------
2314 // dialog units translations
2315 // ----------------------------------------------------------------------------
2317 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
2319 int charWidth
= GetCharWidth();
2320 int charHeight
= GetCharHeight();
2321 wxPoint pt2
= wxDefaultPosition
;
2322 if (pt
.x
!= wxDefaultCoord
)
2323 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
);
2324 if (pt
.y
!= wxDefaultCoord
)
2325 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
);
2330 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
2332 int charWidth
= GetCharWidth();
2333 int charHeight
= GetCharHeight();
2334 wxPoint pt2
= wxDefaultPosition
;
2335 if (pt
.x
!= wxDefaultCoord
)
2336 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4);
2337 if (pt
.y
!= wxDefaultCoord
)
2338 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8);
2343 // ----------------------------------------------------------------------------
2345 // ----------------------------------------------------------------------------
2347 // propagate the colour change event to the subwindows
2348 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
2350 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2353 // Only propagate to non-top-level windows
2354 wxWindow
*win
= node
->GetData();
2355 if ( !win
->IsTopLevel() )
2357 wxSysColourChangedEvent event2
;
2358 event
.SetEventObject(win
);
2359 win
->GetEventHandler()->ProcessEvent(event2
);
2362 node
= node
->GetNext();
2368 // the default action is to populate dialog with data when it's created,
2369 // and nudge the UI into displaying itself correctly in case
2370 // we've turned the wxUpdateUIEvents frequency down low.
2371 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2373 TransferDataToWindow();
2375 // Update the UI at this point
2376 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2379 // ----------------------------------------------------------------------------
2380 // menu-related functions
2381 // ----------------------------------------------------------------------------
2385 bool wxWindowBase::PopupMenu(wxMenu
*menu
, int x
, int y
)
2387 wxCHECK_MSG( menu
, false, "can't popup NULL menu" );
2389 wxCurrentPopupMenu
= menu
;
2390 const bool rc
= DoPopupMenu(menu
, x
, y
);
2391 wxCurrentPopupMenu
= NULL
;
2396 // this is used to pass the id of the selected item from the menu event handler
2397 // to the main function itself
2399 // it's ok to use a global here as there can be at most one popup menu shown at
2401 static int gs_popupMenuSelection
= wxID_NONE
;
2403 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2405 // store the id in a global variable where we'll retrieve it from later
2406 gs_popupMenuSelection
= event
.GetId();
2410 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2412 gs_popupMenuSelection
= wxID_NONE
;
2414 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2415 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2419 PopupMenu(&menu
, x
, y
);
2421 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2422 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2426 return gs_popupMenuSelection
;
2429 #endif // wxUSE_MENUS
2431 // methods for drawing the sizers in a visible way
2434 static void DrawSizers(wxWindowBase
*win
);
2436 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
= false)
2438 wxClientDC
dc((wxWindow
*)win
);
2439 dc
.SetPen(*wxRED_PEN
);
2440 dc
.SetBrush(fill
? wxBrush(*wxRED
, wxBRUSHSTYLE_CROSSDIAG_HATCH
) : *wxTRANSPARENT_BRUSH
);
2441 dc
.DrawRectangle(rect
.Deflate(1, 1));
2444 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2446 const wxSizerItemList
& items
= sizer
->GetChildren();
2447 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2452 wxSizerItem
*item
= *i
;
2453 if ( item
->IsSizer() )
2455 DrawBorder(win
, item
->GetRect().Deflate(2));
2456 DrawSizer(win
, item
->GetSizer());
2458 else if ( item
->IsSpacer() )
2460 DrawBorder(win
, item
->GetRect().Deflate(2), true);
2462 else if ( item
->IsWindow() )
2464 DrawSizers(item
->GetWindow());
2469 static void DrawSizers(wxWindowBase
*win
)
2471 wxSizer
*sizer
= win
->GetSizer();
2474 DrawBorder(win
, win
->GetClientSize());
2475 DrawSizer(win
, sizer
);
2477 else // no sizer, still recurse into the children
2479 const wxWindowList
& children
= win
->GetChildren();
2480 for ( wxWindowList::const_iterator i
= children
.begin(),
2481 end
= children
.end();
2490 #endif // __WXDEBUG__
2492 // process special middle clicks
2493 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2495 if ( event
.ControlDown() && event
.AltDown() )
2498 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
2499 if ( event
.ShiftDown() )
2504 #endif // __WXDEBUG__
2505 ::wxInfoMessageBox((wxWindow
*)this);
2513 // ----------------------------------------------------------------------------
2515 // ----------------------------------------------------------------------------
2517 #if wxUSE_ACCESSIBILITY
2518 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
2520 if (m_accessible
&& (accessible
!= m_accessible
))
2521 delete m_accessible
;
2522 m_accessible
= accessible
;
2524 m_accessible
->SetWindow((wxWindow
*) this);
2527 // Returns the accessible object, creating if necessary.
2528 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
2531 m_accessible
= CreateAccessible();
2532 return m_accessible
;
2535 // Override to create a specific accessible object.
2536 wxAccessible
* wxWindowBase::CreateAccessible()
2538 return new wxWindowAccessible((wxWindow
*) this);
2543 // ----------------------------------------------------------------------------
2544 // list classes implementation
2545 // ----------------------------------------------------------------------------
2549 #include "wx/listimpl.cpp"
2550 WX_DEFINE_LIST(wxWindowList
)
2554 void wxWindowListNode::DeleteData()
2556 delete (wxWindow
*)GetData();
2559 #endif // wxUSE_STL/!wxUSE_STL
2561 // ----------------------------------------------------------------------------
2563 // ----------------------------------------------------------------------------
2565 wxBorder
wxWindowBase::GetBorder(long flags
) const
2567 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
2568 if ( border
== wxBORDER_DEFAULT
)
2570 border
= GetDefaultBorder();
2572 else if ( border
== wxBORDER_THEME
)
2574 border
= GetDefaultBorderForControl();
2580 wxBorder
wxWindowBase::GetDefaultBorder() const
2582 return wxBORDER_NONE
;
2585 // ----------------------------------------------------------------------------
2587 // ----------------------------------------------------------------------------
2589 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2591 // here we just check if the point is inside the window or not
2593 // check the top and left border first
2594 bool outside
= x
< 0 || y
< 0;
2597 // check the right and bottom borders too
2598 wxSize size
= GetSize();
2599 outside
= x
>= size
.x
|| y
>= size
.y
;
2602 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2605 // ----------------------------------------------------------------------------
2607 // ----------------------------------------------------------------------------
2609 struct WXDLLEXPORT wxWindowNext
2613 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2614 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
2615 bool wxWindowBase::ms_winCaptureChanging
= false;
2617 void wxWindowBase::CaptureMouse()
2619 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), wx_static_cast(void*, this));
2621 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive CaptureMouse call?") );
2623 ms_winCaptureChanging
= true;
2625 wxWindow
*winOld
= GetCapture();
2628 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2631 wxWindowNext
*item
= new wxWindowNext
;
2633 item
->next
= ms_winCaptureNext
;
2634 ms_winCaptureNext
= item
;
2636 //else: no mouse capture to save
2639 ms_winCaptureCurrent
= (wxWindow
*)this;
2641 ms_winCaptureChanging
= false;
2644 void wxWindowBase::ReleaseMouse()
2646 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), wx_static_cast(void*, this));
2648 wxASSERT_MSG( !ms_winCaptureChanging
, _T("recursive ReleaseMouse call?") );
2650 wxASSERT_MSG( GetCapture() == this,
2651 "attempt to release mouse, but this window hasn't captured it" );
2652 wxASSERT_MSG( ms_winCaptureCurrent
== this,
2653 "attempt to release mouse, but this window hasn't captured it" );
2655 ms_winCaptureChanging
= true;
2658 ms_winCaptureCurrent
= NULL
;
2660 if ( ms_winCaptureNext
)
2662 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2663 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
2665 wxWindowNext
*item
= ms_winCaptureNext
;
2666 ms_winCaptureNext
= item
->next
;
2669 //else: stack is empty, no previous capture
2671 ms_winCaptureChanging
= false;
2673 wxLogTrace(_T("mousecapture"),
2674 (const wxChar
*) _T("After ReleaseMouse() mouse is captured by %p"),
2675 wx_static_cast(void*, GetCapture()));
2678 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
2680 wxMouseCaptureLostEvent
event(win
->GetId());
2681 event
.SetEventObject(win
);
2682 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
2684 // windows must handle this event, otherwise the app wouldn't behave
2685 // correctly if it loses capture unexpectedly; see the discussion here:
2686 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
2687 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
2688 wxFAIL_MSG( _T("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
2693 void wxWindowBase::NotifyCaptureLost()
2695 // don't do anything if capture lost was expected, i.e. resulted from
2696 // a wx call to ReleaseMouse or CaptureMouse:
2697 if ( ms_winCaptureChanging
)
2700 // if the capture was lost unexpectedly, notify every window that has
2701 // capture (on stack or current) about it and clear the stack:
2703 if ( ms_winCaptureCurrent
)
2705 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
2706 ms_winCaptureCurrent
= NULL
;
2709 while ( ms_winCaptureNext
)
2711 wxWindowNext
*item
= ms_winCaptureNext
;
2712 ms_winCaptureNext
= item
->next
;
2714 DoNotifyWindowAboutCaptureLost(item
->win
);
2723 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
2724 int WXUNUSED(modifiers
),
2725 int WXUNUSED(keycode
))
2731 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
2737 #endif // wxUSE_HOTKEY
2739 // ----------------------------------------------------------------------------
2741 // ----------------------------------------------------------------------------
2743 bool wxWindowBase::TryValidator(wxEvent
& wxVALIDATOR_PARAM(event
))
2745 #if wxUSE_VALIDATORS
2746 // Can only use the validator of the window which
2747 // is receiving the event
2748 if ( event
.GetEventObject() == this )
2750 wxValidator
* const validator
= GetValidator();
2751 if ( validator
&& validator
->ProcessEventHere(event
) )
2756 #endif // wxUSE_VALIDATORS
2761 bool wxWindowBase::TryParent(wxEvent
& event
)
2763 // carry on up the parent-child hierarchy if the propagation count hasn't
2765 if ( event
.ShouldPropagate() )
2767 // honour the requests to stop propagation at this window: this is
2768 // used by the dialogs, for example, to prevent processing the events
2769 // from the dialog controls in the parent frame which rarely, if ever,
2771 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
2773 wxWindow
*parent
= GetParent();
2774 if ( parent
&& !parent
->IsBeingDeleted() )
2776 wxPropagateOnce
propagateOnce(event
);
2778 return parent
->GetEventHandler()->ProcessEvent(event
);
2783 return wxEvtHandler::TryParent(event
);
2786 // ----------------------------------------------------------------------------
2787 // window relationships
2788 // ----------------------------------------------------------------------------
2790 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
2792 wxCHECK_MSG( GetParent(), NULL
,
2793 _T("GetPrev/NextSibling() don't work for TLWs!") );
2795 wxWindowList
& siblings
= GetParent()->GetChildren();
2796 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
2797 wxCHECK_MSG( i
, NULL
, _T("window not a child of its parent?") );
2799 if ( order
== OrderBefore
)
2800 i
= i
->GetPrevious();
2804 return i
? i
->GetData() : NULL
;
2807 // ----------------------------------------------------------------------------
2808 // keyboard navigation
2809 // ----------------------------------------------------------------------------
2811 // Navigates in the specified direction inside this window
2812 bool wxWindowBase::DoNavigateIn(int flags
)
2814 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
2815 // native code doesn't process our wxNavigationKeyEvents anyhow
2818 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
2819 wxNavigationKeyEvent eventNav
;
2820 wxWindow
*focused
= FindFocus();
2821 eventNav
.SetCurrentFocus(focused
);
2822 eventNav
.SetEventObject(focused
);
2823 eventNav
.SetFlags(flags
);
2824 return GetEventHandler()->ProcessEvent(eventNav
);
2825 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
2828 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent
& event
)
2830 if ( event
.GetKeyCode() != WXK_TAB
)
2833 int flags
= wxNavigationKeyEvent::FromTab
;
2835 if ( event
.ShiftDown() )
2836 flags
|= wxNavigationKeyEvent::IsBackward
;
2838 flags
|= wxNavigationKeyEvent::IsForward
;
2840 if ( event
.ControlDown() )
2841 flags
|= wxNavigationKeyEvent::WinChange
;
2847 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
2849 // check that we're not a top level window
2850 wxCHECK_RET( GetParent(),
2851 _T("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
2853 // detect the special case when we have nothing to do anyhow and when the
2854 // code below wouldn't work
2858 // find the target window in the siblings list
2859 wxWindowList
& siblings
= GetParent()->GetChildren();
2860 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
2861 wxCHECK_RET( i
, _T("MoveBefore/AfterInTabOrder(): win is not a sibling") );
2863 // unfortunately, when wxUSE_STL == 1 DetachNode() is not implemented so we
2864 // can't just move the node around
2865 wxWindow
*self
= (wxWindow
*)this;
2866 siblings
.DeleteObject(self
);
2867 if ( move
== OrderAfter
)
2874 siblings
.Insert(i
, self
);
2876 else // OrderAfter and win was the last sibling
2878 siblings
.Append(self
);
2882 // ----------------------------------------------------------------------------
2884 // ----------------------------------------------------------------------------
2886 /*static*/ wxWindow
* wxWindowBase::FindFocus()
2888 wxWindowBase
*win
= DoFindFocus();
2889 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
2892 bool wxWindowBase::HasFocus() const
2894 wxWindowBase
*win
= DoFindFocus();
2895 return win
== this ||
2896 win
== wxConstCast(this, wxWindowBase
)->GetMainWindowOfCompositeControl();
2899 // ----------------------------------------------------------------------------
2901 // ----------------------------------------------------------------------------
2903 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2905 while ( win
&& !win
->IsTopLevel() )
2906 win
= win
->GetParent();
2911 #if wxUSE_ACCESSIBILITY
2912 // ----------------------------------------------------------------------------
2913 // accessible object for windows
2914 // ----------------------------------------------------------------------------
2916 // Can return either a child object, or an integer
2917 // representing the child element, starting from 1.
2918 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
2920 wxASSERT( GetWindow() != NULL
);
2924 return wxACC_NOT_IMPLEMENTED
;
2927 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2928 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2930 wxASSERT( GetWindow() != NULL
);
2934 wxWindow
* win
= NULL
;
2941 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2943 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
2950 rect
= win
->GetRect();
2951 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2952 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2956 return wxACC_NOT_IMPLEMENTED
;
2959 // Navigates from fromId to toId/toObject.
2960 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2961 int* WXUNUSED(toId
), wxAccessible
** toObject
)
2963 wxASSERT( GetWindow() != NULL
);
2969 case wxNAVDIR_FIRSTCHILD
:
2971 if (GetWindow()->GetChildren().GetCount() == 0)
2973 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2974 *toObject
= childWindow
->GetOrCreateAccessible();
2978 case wxNAVDIR_LASTCHILD
:
2980 if (GetWindow()->GetChildren().GetCount() == 0)
2982 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2983 *toObject
= childWindow
->GetOrCreateAccessible();
2987 case wxNAVDIR_RIGHT
:
2991 wxWindowList::compatibility_iterator node
=
2992 wxWindowList::compatibility_iterator();
2995 // Can't navigate to sibling of this window
2996 // if we're a top-level window.
2997 if (!GetWindow()->GetParent())
2998 return wxACC_NOT_IMPLEMENTED
;
3000 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3004 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3005 node
= GetWindow()->GetChildren().Item(fromId
-1);
3008 if (node
&& node
->GetNext())
3010 wxWindow
* nextWindow
= node
->GetNext()->GetData();
3011 *toObject
= nextWindow
->GetOrCreateAccessible();
3019 case wxNAVDIR_PREVIOUS
:
3021 wxWindowList::compatibility_iterator node
=
3022 wxWindowList::compatibility_iterator();
3025 // Can't navigate to sibling of this window
3026 // if we're a top-level window.
3027 if (!GetWindow()->GetParent())
3028 return wxACC_NOT_IMPLEMENTED
;
3030 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3034 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3035 node
= GetWindow()->GetChildren().Item(fromId
-1);
3038 if (node
&& node
->GetPrevious())
3040 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
3041 *toObject
= previousWindow
->GetOrCreateAccessible();
3049 return wxACC_NOT_IMPLEMENTED
;
3052 // Gets the name of the specified object.
3053 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
3055 wxASSERT( GetWindow() != NULL
);
3061 // If a child, leave wxWidgets to call the function on the actual
3064 return wxACC_NOT_IMPLEMENTED
;
3066 // This will eventually be replaced by specialised
3067 // accessible classes, one for each kind of wxWidgets
3068 // control or window.
3070 if (GetWindow()->IsKindOf(CLASSINFO(wxButton
)))
3071 title
= ((wxButton
*) GetWindow())->GetLabel();
3074 title
= GetWindow()->GetName();
3082 return wxACC_NOT_IMPLEMENTED
;
3085 // Gets the number of children.
3086 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
3088 wxASSERT( GetWindow() != NULL
);
3092 *childId
= (int) GetWindow()->GetChildren().GetCount();
3096 // Gets the specified child (starting from 1).
3097 // If *child is NULL and return value is wxACC_OK,
3098 // this means that the child is a simple element and
3099 // not an accessible object.
3100 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
3102 wxASSERT( GetWindow() != NULL
);
3112 if (childId
> (int) GetWindow()->GetChildren().GetCount())
3115 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
3116 *child
= childWindow
->GetOrCreateAccessible();
3123 // Gets the parent, or NULL.
3124 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
3126 wxASSERT( GetWindow() != NULL
);
3130 wxWindow
* parentWindow
= GetWindow()->GetParent();
3138 *parent
= parentWindow
->GetOrCreateAccessible();
3146 // Performs the default action. childId is 0 (the action for this object)
3147 // or > 0 (the action for a child).
3148 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3149 // window (e.g. an edit control).
3150 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
3152 wxASSERT( GetWindow() != NULL
);
3156 return wxACC_NOT_IMPLEMENTED
;
3159 // Gets the default action for this object (0) or > 0 (the action for a child).
3160 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3161 // string if there is no action.
3162 // The retrieved string describes the action that is performed on an object,
3163 // not what the object does as a result. For example, a toolbar button that prints
3164 // a document has a default action of "Press" rather than "Prints the current document."
3165 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
3167 wxASSERT( GetWindow() != NULL
);
3171 return wxACC_NOT_IMPLEMENTED
;
3174 // Returns the description for this object or a child.
3175 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3177 wxASSERT( GetWindow() != NULL
);
3181 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3187 return wxACC_NOT_IMPLEMENTED
;
3190 // Returns help text for this object or a child, similar to tooltip text.
3191 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3193 wxASSERT( GetWindow() != NULL
);
3197 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3203 return wxACC_NOT_IMPLEMENTED
;
3206 // Returns the keyboard shortcut for this object or child.
3207 // Return e.g. ALT+K
3208 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3210 wxASSERT( GetWindow() != NULL
);
3214 return wxACC_NOT_IMPLEMENTED
;
3217 // Returns a role constant.
3218 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3220 wxASSERT( GetWindow() != NULL
);
3224 // If a child, leave wxWidgets to call the function on the actual
3227 return wxACC_NOT_IMPLEMENTED
;
3229 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3230 return wxACC_NOT_IMPLEMENTED
;
3232 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3233 return wxACC_NOT_IMPLEMENTED
;
3236 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3237 return wxACC_NOT_IMPLEMENTED
;
3240 //*role = wxROLE_SYSTEM_CLIENT;
3241 *role
= wxROLE_SYSTEM_CLIENT
;
3245 return wxACC_NOT_IMPLEMENTED
;
3249 // Returns a state constant.
3250 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3252 wxASSERT( GetWindow() != NULL
);
3256 // If a child, leave wxWidgets to call the function on the actual
3259 return wxACC_NOT_IMPLEMENTED
;
3261 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3262 return wxACC_NOT_IMPLEMENTED
;
3265 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3266 return wxACC_NOT_IMPLEMENTED
;
3269 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3270 return wxACC_NOT_IMPLEMENTED
;
3277 return wxACC_NOT_IMPLEMENTED
;
3281 // Returns a localized string representing the value for the object
3283 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3285 wxASSERT( GetWindow() != NULL
);
3289 return wxACC_NOT_IMPLEMENTED
;
3292 // Selects the object or child.
3293 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3295 wxASSERT( GetWindow() != NULL
);
3299 return wxACC_NOT_IMPLEMENTED
;
3302 // Gets the window with the keyboard focus.
3303 // If childId is 0 and child is NULL, no object in
3304 // this subhierarchy has the focus.
3305 // If this object has the focus, child should be 'this'.
3306 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3308 wxASSERT( GetWindow() != NULL
);
3312 return wxACC_NOT_IMPLEMENTED
;
3316 // Gets a variant representing the selected children
3318 // Acceptable values:
3319 // - a null variant (IsNull() returns true)
3320 // - a list variant (GetType() == wxT("list")
3321 // - an integer representing the selected child element,
3322 // or 0 if this object is selected (GetType() == wxT("long")
3323 // - a "void*" pointer to a wxAccessible child object
3324 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3326 wxASSERT( GetWindow() != NULL
);
3330 return wxACC_NOT_IMPLEMENTED
;
3332 #endif // wxUSE_VARIANT
3334 #endif // wxUSE_ACCESSIBILITY
3336 // ----------------------------------------------------------------------------
3338 // ----------------------------------------------------------------------------
3341 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3343 wxCoord widthTotal
) const
3345 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3347 x
= widthTotal
- x
- width
;