1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/wincmn.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/msgout.h"
42 #include "wx/statusbr.h"
43 #include "wx/toolbar.h"
44 #include "wx/dcclient.h"
45 #include "wx/scrolbar.h"
46 #include "wx/layout.h"
51 #if wxUSE_DRAG_AND_DROP
53 #endif // wxUSE_DRAG_AND_DROP
55 #if wxUSE_ACCESSIBILITY
56 #include "wx/access.h"
60 #include "wx/cshelp.h"
64 #include "wx/tooltip.h"
65 #endif // wxUSE_TOOLTIPS
71 #if wxUSE_SYSTEM_OPTIONS
72 #include "wx/sysopt.h"
75 #include "wx/platinfo.h"
76 #include "wx/private/window.h"
79 #include "wx/msw/wrapwin.h"
83 WXDLLIMPEXP_DATA_CORE(wxWindowList
) wxTopLevelWindows
;
87 wxMenu
*wxCurrentPopupMenu
= NULL
;
90 extern WXDLLEXPORT_DATA(const char) wxPanelNameStr
[] = "panel";
92 // ----------------------------------------------------------------------------
94 // ----------------------------------------------------------------------------
97 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase
, wxEvtHandler
)
99 // ----------------------------------------------------------------------------
101 // ----------------------------------------------------------------------------
103 BEGIN_EVENT_TABLE(wxWindowBase
, wxEvtHandler
)
104 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged
)
105 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog
)
106 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick
)
109 EVT_HELP(wxID_ANY
, wxWindowBase::OnHelp
)
112 EVT_SIZE(wxWindowBase::InternalOnSize
)
115 // ============================================================================
116 // implementation of the common functionality of the wxWindow class
117 // ============================================================================
119 // ----------------------------------------------------------------------------
121 // ----------------------------------------------------------------------------
123 #if wxUSE_EXTENDED_RTTI
125 // windows that are created from a parent window during its Create method,
126 // eg. spin controls in a calendar controls must never been streamed out
127 // separately otherwise chaos occurs. Right now easiest is to test for negative ids,
128 // as windows with negative ids never can be recreated anyway
131 bool wxWindowStreamingCallback( const wxObject
*object
, wxObjectWriter
*,
132 wxObjectWriterCallback
*, const wxStringToAnyHashMap
& )
134 const wxWindow
* win
= wx_dynamic_cast(const wxWindow
*, object
);
135 if ( win
&& win
->GetId() < 0 )
140 wxIMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxWindow
, wxWindowBase
, "wx/window.h", \
141 wxWindowStreamingCallback
)
143 // make wxWindowList known before the property is used
145 wxCOLLECTION_TYPE_INFO( wxWindow
*, wxWindowList
);
147 template<> void wxCollectionToVariantArray( wxWindowList
const &theList
,
150 wxListCollectionToAnyList
<wxWindowList::compatibility_iterator
>( theList
, value
);
153 wxDEFINE_FLAGS( wxWindowStyle
)
155 wxBEGIN_FLAGS( wxWindowStyle
)
156 // new style border flags, we put them first to
157 // use them for streaming out
159 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
160 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
161 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
162 wxFLAGS_MEMBER(wxBORDER_RAISED
)
163 wxFLAGS_MEMBER(wxBORDER_STATIC
)
164 wxFLAGS_MEMBER(wxBORDER_NONE
)
166 // old style border flags
167 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
168 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
169 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
170 wxFLAGS_MEMBER(wxRAISED_BORDER
)
171 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
172 wxFLAGS_MEMBER(wxBORDER
)
174 // standard window styles
175 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
176 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
177 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
178 wxFLAGS_MEMBER(wxWANTS_CHARS
)
179 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
180 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
181 wxFLAGS_MEMBER(wxVSCROLL
)
182 wxFLAGS_MEMBER(wxHSCROLL
)
184 wxEND_FLAGS( wxWindowStyle
)
186 wxBEGIN_PROPERTIES_TABLE(wxWindow
)
187 wxEVENT_PROPERTY( Close
, wxEVT_CLOSE_WINDOW
, wxCloseEvent
)
188 wxEVENT_PROPERTY( Create
, wxEVT_CREATE
, wxWindowCreateEvent
)
189 wxEVENT_PROPERTY( Destroy
, wxEVT_DESTROY
, wxWindowDestroyEvent
)
190 // Always constructor Properties first
192 wxREADONLY_PROPERTY( Parent
,wxWindow
*, GetParent
, wxEMPTY_PARAMETER_VALUE
, \
193 0 /*flags*/, wxT("Helpstring"), wxT("group"))
194 wxPROPERTY( Id
,wxWindowID
, SetId
, GetId
, -1 /*wxID_ANY*/, 0 /*flags*/, \
195 wxT("Helpstring"), wxT("group") )
196 wxPROPERTY( Position
,wxPoint
, SetPosition
, GetPosition
, wxDefaultPosition
, \
197 0 /*flags*/, wxT("Helpstring"), wxT("group")) // pos
198 wxPROPERTY( Size
,wxSize
, SetSize
, GetSize
, wxDefaultSize
, 0 /*flags*/, \
199 wxT("Helpstring"), wxT("group")) // size
200 wxPROPERTY( WindowStyle
, long, SetWindowStyleFlag
, GetWindowStyleFlag
, \
201 wxEMPTY_PARAMETER_VALUE
, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // style
202 wxPROPERTY( Name
,wxString
, SetName
, GetName
, wxEmptyString
, 0 /*flags*/, \
203 wxT("Helpstring"), wxT("group") )
205 // Then all relations of the object graph
207 wxREADONLY_PROPERTY_COLLECTION( Children
, wxWindowList
, wxWindowBase
*, \
208 GetWindowChildren
, wxPROP_OBJECT_GRAPH
/*flags*/, \
209 wxT("Helpstring"), wxT("group"))
211 // and finally all other properties
213 wxPROPERTY( ExtraStyle
, long, SetExtraStyle
, GetExtraStyle
, wxEMPTY_PARAMETER_VALUE
, \
214 0 /*flags*/, wxT("Helpstring"), wxT("group")) // extstyle
215 wxPROPERTY( BackgroundColour
, wxColour
, SetBackgroundColour
, GetBackgroundColour
, \
216 wxEMPTY_PARAMETER_VALUE
, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // bg
217 wxPROPERTY( ForegroundColour
, wxColour
, SetForegroundColour
, GetForegroundColour
, \
218 wxEMPTY_PARAMETER_VALUE
, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // fg
219 wxPROPERTY( Enabled
, bool, Enable
, IsEnabled
, wxAny((bool)true), 0 /*flags*/, \
220 wxT("Helpstring"), wxT("group"))
221 wxPROPERTY( Shown
, bool, Show
, IsShown
, wxAny((bool)true), 0 /*flags*/, \
222 wxT("Helpstring"), wxT("group"))
225 // possible property candidates (not in xrc) or not valid in all subclasses
226 wxPROPERTY( Title
,wxString
, SetTitle
, GetTitle
, wxEmptyString
)
227 wxPROPERTY( Font
, wxFont
, SetFont
, GetWindowFont
, )
228 wxPROPERTY( Label
,wxString
, SetLabel
, GetLabel
, wxEmptyString
)
229 // MaxHeight, Width, MinHeight, Width
230 // TODO switch label to control and title to toplevels
232 wxPROPERTY( ThemeEnabled
, bool, SetThemeEnabled
, GetThemeEnabled
, )
233 //wxPROPERTY( Cursor, wxCursor, SetCursor, GetCursor, )
234 // wxPROPERTY( ToolTip, wxString, SetToolTip, GetToolTipText, )
235 wxPROPERTY( AutoLayout
, bool, SetAutoLayout
, GetAutoLayout
, )
237 wxEND_PROPERTIES_TABLE()
239 wxEMPTY_HANDLERS_TABLE(wxWindow
)
241 wxCONSTRUCTOR_DUMMY(wxWindow
)
245 #ifndef __WXUNIVERSAL__
246 IMPLEMENT_DYNAMIC_CLASS(wxWindow
, wxWindowBase
)
251 // ----------------------------------------------------------------------------
253 // ----------------------------------------------------------------------------
255 // the default initialization
256 wxWindowBase::wxWindowBase()
258 // no window yet, no parent nor children
260 m_windowId
= wxID_ANY
;
262 // no constraints on the minimal window size
264 m_maxWidth
= wxDefaultCoord
;
266 m_maxHeight
= wxDefaultCoord
;
268 // invalidiated cache value
269 m_bestSizeCache
= wxDefaultSize
;
271 // window are created enabled and visible by default
275 // the default event handler is just this window
276 m_eventHandler
= this;
280 m_windowValidator
= NULL
;
281 #endif // wxUSE_VALIDATORS
283 // the colours/fonts are default for now, so leave m_font,
284 // m_backgroundColour and m_foregroundColour uninitialized and set those
290 m_inheritFont
= false;
296 m_backgroundStyle
= wxBG_STYLE_ERASE
;
298 #if wxUSE_CONSTRAINTS
299 // no constraints whatsoever
300 m_constraints
= NULL
;
301 m_constraintsInvolvedIn
= NULL
;
302 #endif // wxUSE_CONSTRAINTS
304 m_windowSizer
= NULL
;
305 m_containingSizer
= NULL
;
306 m_autoLayout
= false;
308 #if wxUSE_DRAG_AND_DROP
310 #endif // wxUSE_DRAG_AND_DROP
314 #endif // wxUSE_TOOLTIPS
318 #endif // wxUSE_CARET
321 m_hasCustomPalette
= false;
322 #endif // wxUSE_PALETTE
324 #if wxUSE_ACCESSIBILITY
328 m_virtualSize
= wxDefaultSize
;
330 m_scrollHelper
= NULL
;
332 m_windowVariant
= wxWINDOW_VARIANT_NORMAL
;
333 #if wxUSE_SYSTEM_OPTIONS
334 if ( wxSystemOptions::HasOption(wxWINDOW_DEFAULT_VARIANT
) )
336 m_windowVariant
= (wxWindowVariant
) wxSystemOptions::GetOptionInt( wxWINDOW_DEFAULT_VARIANT
) ;
340 // Whether we're using the current theme for this window (wxGTK only for now)
341 m_themeEnabled
= false;
343 // This is set to true by SendDestroyEvent() which should be called by the
344 // most derived class to ensure that the destruction event is sent as soon
345 // as possible to allow its handlers to still see the undestroyed window
346 m_isBeingDeleted
= false;
351 // common part of window creation process
352 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
354 const wxPoint
& WXUNUSED(pos
),
357 const wxString
& name
)
359 // ids are limited to 16 bits under MSW so if you care about portability,
360 // it's not a good idea to use ids out of this range (and negative ids are
361 // reserved for wxWidgets own usage)
362 wxASSERT_MSG( id
== wxID_ANY
|| (id
>= 0 && id
< 32767) ||
363 (id
>= wxID_AUTO_LOWEST
&& id
<= wxID_AUTO_HIGHEST
),
364 wxT("invalid id value") );
366 // generate a new id if the user doesn't care about it
367 if ( id
== wxID_ANY
)
369 m_windowId
= NewControlId();
371 else // valid id specified
376 // don't use SetWindowStyleFlag() here, this function should only be called
377 // to change the flag after creation as it tries to reflect the changes in
378 // flags by updating the window dynamically and we don't need this here
379 m_windowStyle
= style
;
381 // assume the user doesn't want this window to shrink beneath its initial
382 // size, this worked like this in wxWidgets 2.8 and before and generally
383 // often makes sense for child windows (for top level ones it definitely
384 // does not as the user should be able to resize the window)
386 // note that we can't use IsTopLevel() from ctor
387 if ( size
!= wxDefaultSize
&& !wxTopLevelWindows
.Find((wxWindow
*)this) )
396 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
401 const wxValidator
& wxVALIDATOR_PARAM(validator
),
402 const wxString
& name
)
404 if ( !CreateBase(parent
, id
, pos
, size
, style
, name
) )
408 SetValidator(validator
);
409 #endif // wxUSE_VALIDATORS
411 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
412 // have it too - like this it's possible to set it only in the top level
413 // dialog/frame and all children will inherit it by defult
414 if ( parent
&& (parent
->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) )
416 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY
);
422 bool wxWindowBase::ToggleWindowStyle(int flag
)
424 wxASSERT_MSG( flag
, wxT("flags with 0 value can't be toggled") );
427 long style
= GetWindowStyleFlag();
433 else // currently off
439 SetWindowStyleFlag(style
);
444 // ----------------------------------------------------------------------------
446 // ----------------------------------------------------------------------------
449 wxWindowBase::~wxWindowBase()
451 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
453 // FIXME if these 2 cases result from programming errors in the user code
454 // we should probably assert here instead of silently fixing them
456 // Just in case the window has been Closed, but we're then deleting
457 // immediately: don't leave dangling pointers.
458 wxPendingDelete
.DeleteObject(this);
460 // Just in case we've loaded a top-level window via LoadNativeDialog but
461 // we weren't a dialog class
462 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
464 // Any additional event handlers should be popped before the window is
465 // deleted as otherwise the last handler will be left with a dangling
466 // pointer to this window result in a difficult to diagnose crash later on.
467 wxASSERT_MSG( GetEventHandler() == this,
468 wxT("any pushed event handlers must have been removed") );
471 // The associated popup menu can still be alive, disassociate from it in
473 if ( wxCurrentPopupMenu
&& wxCurrentPopupMenu
->GetInvokingWindow() == this )
474 wxCurrentPopupMenu
->SetInvokingWindow(NULL
);
475 #endif // wxUSE_MENUS
477 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
479 // notify the parent about this window destruction
481 m_parent
->RemoveChild(this);
485 #endif // wxUSE_CARET
488 delete m_windowValidator
;
489 #endif // wxUSE_VALIDATORS
491 #if wxUSE_CONSTRAINTS
492 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
493 // at deleted windows as they delete themselves.
494 DeleteRelatedConstraints();
498 // This removes any dangling pointers to this window in other windows'
499 // constraintsInvolvedIn lists.
500 UnsetConstraints(m_constraints
);
501 wxDELETE(m_constraints
);
503 #endif // wxUSE_CONSTRAINTS
505 if ( m_containingSizer
)
506 m_containingSizer
->Detach( (wxWindow
*)this );
508 delete m_windowSizer
;
510 #if wxUSE_DRAG_AND_DROP
512 #endif // wxUSE_DRAG_AND_DROP
516 #endif // wxUSE_TOOLTIPS
518 #if wxUSE_ACCESSIBILITY
523 // NB: this has to be called unconditionally, because we don't know
524 // whether this window has associated help text or not
525 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
527 helpProvider
->RemoveHelp(this);
531 bool wxWindowBase::IsBeingDeleted() const
533 return m_isBeingDeleted
||
534 (!IsTopLevel() && m_parent
&& m_parent
->IsBeingDeleted());
537 void wxWindowBase::SendDestroyEvent()
539 if ( m_isBeingDeleted
)
541 // we could have been already called from a more derived class dtor,
542 // e.g. ~wxTLW calls us and so does ~wxWindow and the latter call
543 // should be simply ignored
547 m_isBeingDeleted
= true;
549 wxWindowDestroyEvent event
;
550 event
.SetEventObject(this);
551 event
.SetId(GetId());
552 GetEventHandler()->ProcessEvent(event
);
555 bool wxWindowBase::Destroy()
557 // If our handle is invalid, it means that this window has never been
558 // created, either because creating it failed or, more typically, because
559 // this wxWindow object was default-constructed and its Create() method had
560 // never been called. As we didn't send wxWindowCreateEvent in this case
561 // (which is sent after successful creation), don't send the matching
562 // wxWindowDestroyEvent neither.
571 bool wxWindowBase::Close(bool force
)
573 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
574 event
.SetEventObject(this);
575 event
.SetCanVeto(!force
);
577 // return false if window wasn't closed because the application vetoed the
579 return HandleWindowEvent(event
) && !event
.GetVeto();
582 bool wxWindowBase::DestroyChildren()
584 wxWindowList::compatibility_iterator node
;
587 // we iterate until the list becomes empty
588 node
= GetChildren().GetFirst();
592 wxWindow
*child
= node
->GetData();
594 // note that we really want to delete it immediately so don't call the
595 // possible overridden Destroy() version which might not delete the
596 // child immediately resulting in problems with our (top level) child
597 // outliving its parent
598 child
->wxWindowBase::Destroy();
600 wxASSERT_MSG( !GetChildren().Find(child
),
601 wxT("child didn't remove itself using RemoveChild()") );
607 // ----------------------------------------------------------------------------
608 // size/position related methods
609 // ----------------------------------------------------------------------------
611 // centre the window with respect to its parent in either (or both) directions
612 void wxWindowBase::DoCentre(int dir
)
614 wxCHECK_RET( !(dir
& wxCENTRE_ON_SCREEN
) && GetParent(),
615 wxT("this method only implements centering child windows") );
617 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir
));
620 // fits the window around the children
621 void wxWindowBase::Fit()
623 SetSize(GetBestSize());
626 // fits virtual size (ie. scrolled area etc.) around children
627 void wxWindowBase::FitInside()
629 SetVirtualSize( GetBestVirtualSize() );
632 // On Mac, scrollbars are explicitly children.
633 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
634 static bool wxHasRealChildren(const wxWindowBase
* win
)
636 int realChildCount
= 0;
638 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
640 node
= node
->GetNext() )
642 wxWindow
*win
= node
->GetData();
643 if ( !win
->IsTopLevel() && win
->IsShown()
645 && !wxDynamicCast(win
, wxScrollBar
)
650 return (realChildCount
> 0);
654 void wxWindowBase::InvalidateBestSize()
656 m_bestSizeCache
= wxDefaultSize
;
658 // parent's best size calculation may depend on its children's
659 // as long as child window we are in is not top level window itself
660 // (because the TLW size is never resized automatically)
661 // so let's invalidate it as well to be safe:
662 if (m_parent
&& !IsTopLevel())
663 m_parent
->InvalidateBestSize();
666 // return the size best suited for the current window
667 wxSize
wxWindowBase::DoGetBestSize() const
673 best
= m_windowSizer
->GetMinSize();
675 #if wxUSE_CONSTRAINTS
676 else if ( m_constraints
)
678 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
680 // our minimal acceptable size is such that all our windows fit inside
684 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
686 node
= node
->GetNext() )
688 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
691 // it's not normal that we have an unconstrained child, but
692 // what can we do about it?
696 int x
= c
->right
.GetValue(),
697 y
= c
->bottom
.GetValue();
705 // TODO: we must calculate the overlaps somehow, otherwise we
706 // will never return a size bigger than the current one :-(
709 best
= wxSize(maxX
, maxY
);
711 #endif // wxUSE_CONSTRAINTS
712 else if ( !GetChildren().empty()
713 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
714 && wxHasRealChildren(this)
718 // our minimal acceptable size is such that all our visible child
719 // windows fit inside
723 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
725 node
= node
->GetNext() )
727 wxWindow
*win
= node
->GetData();
728 if ( win
->IsTopLevel()
731 || wxDynamicCast(win
, wxStatusBar
)
732 #endif // wxUSE_STATUSBAR
735 // dialogs and frames lie in different top level windows -
736 // don't deal with them here; as for the status bars, they
737 // don't lie in the client area at all
742 win
->GetPosition(&wx
, &wy
);
744 // if the window hadn't been positioned yet, assume that it is in
746 if ( wx
== wxDefaultCoord
)
748 if ( wy
== wxDefaultCoord
)
751 win
->GetSize(&ww
, &wh
);
752 if ( wx
+ ww
> maxX
)
754 if ( wy
+ wh
> maxY
)
758 best
= wxSize(maxX
, maxY
);
760 else // ! has children
762 wxSize size
= GetMinSize();
763 if ( !size
.IsFullySpecified() )
765 // if the window doesn't define its best size we assume that it can
766 // be arbitrarily small -- usually this is not the case, of course,
767 // but we have no way to know what the limit is, it should really
768 // override DoGetBestClientSize() itself to tell us
769 size
.SetDefaults(wxSize(1, 1));
772 // return as-is, unadjusted by the client size difference.
776 // Add any difference between size and client size
777 wxSize diff
= GetSize() - GetClientSize();
778 best
.x
+= wxMax(0, diff
.x
);
779 best
.y
+= wxMax(0, diff
.y
);
784 // helper of GetWindowBorderSize(): as many ports don't implement support for
785 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
786 // fallbacks in this case
787 static int wxGetMetricOrDefault(wxSystemMetric what
, const wxWindowBase
* win
)
789 int rc
= wxSystemSettings::GetMetric(
790 what
, static_cast<wxWindow
*>(const_cast<wxWindowBase
*>(win
)));
797 // 2D border is by default 1 pixel wide
803 // 3D borders are by default 2 pixels
808 wxFAIL_MSG( wxT("unexpected wxGetMetricOrDefault() argument") );
816 wxSize
wxWindowBase::GetWindowBorderSize() const
820 switch ( GetBorder() )
823 // nothing to do, size is already (0, 0)
826 case wxBORDER_SIMPLE
:
827 case wxBORDER_STATIC
:
828 size
.x
= wxGetMetricOrDefault(wxSYS_BORDER_X
, this);
829 size
.y
= wxGetMetricOrDefault(wxSYS_BORDER_Y
, this);
832 case wxBORDER_SUNKEN
:
833 case wxBORDER_RAISED
:
834 size
.x
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X
, this),
835 wxGetMetricOrDefault(wxSYS_BORDER_X
, this));
836 size
.y
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y
, this),
837 wxGetMetricOrDefault(wxSYS_BORDER_Y
, this));
840 case wxBORDER_DOUBLE
:
841 size
.x
= wxGetMetricOrDefault(wxSYS_EDGE_X
, this) +
842 wxGetMetricOrDefault(wxSYS_BORDER_X
, this);
843 size
.y
= wxGetMetricOrDefault(wxSYS_EDGE_Y
, this) +
844 wxGetMetricOrDefault(wxSYS_BORDER_Y
, this);
848 wxFAIL_MSG(wxT("Unknown border style."));
852 // we have borders on both sides
857 wxWindowBase::InformFirstDirection(int direction
,
859 int availableOtherDir
)
861 return GetSizer() && GetSizer()->InformFirstDirection(direction
,
866 wxSize
wxWindowBase::GetEffectiveMinSize() const
868 // merge the best size with the min size, giving priority to the min size
869 wxSize min
= GetMinSize();
871 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
873 wxSize best
= GetBestSize();
874 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
875 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
881 wxSize
wxWindowBase::DoGetBorderSize() const
883 // there is one case in which we can implement it for all ports easily
884 if ( GetBorder() == wxBORDER_NONE
)
887 // otherwise use the difference between the real size and the client size
888 // as a fallback: notice that this is incorrect in general as client size
889 // also doesn't take the scrollbars into account
890 return GetSize() - GetClientSize();
893 wxSize
wxWindowBase::GetBestSize() const
895 if ( !m_windowSizer
&& m_bestSizeCache
.IsFullySpecified() )
896 return m_bestSizeCache
;
898 // call DoGetBestClientSize() first, if a derived class overrides it wants
900 wxSize size
= DoGetBestClientSize();
901 if ( size
!= wxDefaultSize
)
902 size
+= DoGetBorderSize();
904 size
= DoGetBestSize();
906 // Ensure that the best size is at least as large as min size.
907 size
.IncTo(GetMinSize());
909 // And not larger than max size.
910 size
.DecToIfSpecified(GetMaxSize());
912 // Finally cache result and return.
917 int wxWindowBase::GetBestHeight(int width
) const
919 const int height
= DoGetBestClientHeight(width
);
921 return height
== wxDefaultCoord
923 : height
+ DoGetBorderSize().y
;
926 int wxWindowBase::GetBestWidth(int height
) const
928 const int width
= DoGetBestClientWidth(height
);
930 return width
== wxDefaultCoord
932 : width
+ DoGetBorderSize().x
;
935 void wxWindowBase::SetMinSize(const wxSize
& minSize
)
937 m_minWidth
= minSize
.x
;
938 m_minHeight
= minSize
.y
;
940 InvalidateBestSize();
943 void wxWindowBase::SetMaxSize(const wxSize
& maxSize
)
945 m_maxWidth
= maxSize
.x
;
946 m_maxHeight
= maxSize
.y
;
948 InvalidateBestSize();
951 void wxWindowBase::SetInitialSize(const wxSize
& size
)
953 // Set the min size to the size passed in. This will usually either be
954 // wxDefaultSize or the size passed to this window's ctor/Create function.
957 // Merge the size with the best size if needed
958 wxSize best
= GetEffectiveMinSize();
960 // If the current size doesn't match then change it
961 if (GetSize() != best
)
966 // by default the origin is not shifted
967 wxPoint
wxWindowBase::GetClientAreaOrigin() const
972 wxSize
wxWindowBase::ClientToWindowSize(const wxSize
& size
) const
974 const wxSize
diff(GetSize() - GetClientSize());
976 return wxSize(size
.x
== -1 ? -1 : size
.x
+ diff
.x
,
977 size
.y
== -1 ? -1 : size
.y
+ diff
.y
);
980 wxSize
wxWindowBase::WindowToClientSize(const wxSize
& size
) const
982 const wxSize
diff(GetSize() - GetClientSize());
984 return wxSize(size
.x
== -1 ? -1 : size
.x
- diff
.x
,
985 size
.y
== -1 ? -1 : size
.y
- diff
.y
);
988 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
990 if ( m_windowVariant
!= variant
)
992 m_windowVariant
= variant
;
994 DoSetWindowVariant(variant
);
998 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
1000 // adjust the font height to correspond to our new variant (notice that
1001 // we're only called if something really changed)
1002 wxFont font
= GetFont();
1003 int size
= font
.GetPointSize();
1006 case wxWINDOW_VARIANT_NORMAL
:
1009 case wxWINDOW_VARIANT_SMALL
:
1010 size
= wxRound(size
* 3.0 / 4.0);
1013 case wxWINDOW_VARIANT_MINI
:
1014 size
= wxRound(size
* 2.0 / 3.0);
1017 case wxWINDOW_VARIANT_LARGE
:
1018 size
= wxRound(size
* 5.0 / 4.0);
1022 wxFAIL_MSG(wxT("unexpected window variant"));
1026 font
.SetPointSize(size
);
1030 void wxWindowBase::DoSetSizeHints( int minW
, int minH
,
1032 int WXUNUSED(incW
), int WXUNUSED(incH
) )
1034 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
1035 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
1036 wxT("min width/height must be less than max width/height!") );
1045 #if WXWIN_COMPATIBILITY_2_8
1046 void wxWindowBase::SetVirtualSizeHints(int WXUNUSED(minW
), int WXUNUSED(minH
),
1047 int WXUNUSED(maxW
), int WXUNUSED(maxH
))
1051 void wxWindowBase::SetVirtualSizeHints(const wxSize
& WXUNUSED(minsize
),
1052 const wxSize
& WXUNUSED(maxsize
))
1055 #endif // WXWIN_COMPATIBILITY_2_8
1057 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
1059 m_virtualSize
= wxSize(x
, y
);
1062 wxSize
wxWindowBase::DoGetVirtualSize() const
1064 // we should use the entire client area so if it is greater than our
1065 // virtual size, expand it to fit (otherwise if the window is big enough we
1066 // wouldn't be using parts of it)
1067 wxSize size
= GetClientSize();
1068 if ( m_virtualSize
.x
> size
.x
)
1069 size
.x
= m_virtualSize
.x
;
1071 if ( m_virtualSize
.y
>= size
.y
)
1072 size
.y
= m_virtualSize
.y
;
1077 void wxWindowBase::DoGetScreenPosition(int *x
, int *y
) const
1079 // screen position is the same as (0, 0) in client coords for non TLWs (and
1080 // TLWs override this method)
1086 ClientToScreen(x
, y
);
1089 void wxWindowBase::SendSizeEvent(int flags
)
1091 wxSizeEvent
event(GetSize(), GetId());
1092 event
.SetEventObject(this);
1093 if ( flags
& wxSEND_EVENT_POST
)
1094 wxPostEvent(GetEventHandler(), event
);
1096 HandleWindowEvent(event
);
1099 void wxWindowBase::SendSizeEventToParent(int flags
)
1101 wxWindow
* const parent
= GetParent();
1102 if ( parent
&& !parent
->IsBeingDeleted() )
1103 parent
->SendSizeEvent(flags
);
1106 bool wxWindowBase::HasScrollbar(int orient
) const
1108 // if scrolling in the given direction is disabled, we can't have the
1109 // corresponding scrollbar no matter what
1110 if ( !CanScroll(orient
) )
1113 const wxSize sizeVirt
= GetVirtualSize();
1114 const wxSize sizeClient
= GetClientSize();
1116 return orient
== wxHORIZONTAL
? sizeVirt
.x
> sizeClient
.x
1117 : sizeVirt
.y
> sizeClient
.y
;
1120 // ----------------------------------------------------------------------------
1121 // show/hide/enable/disable the window
1122 // ----------------------------------------------------------------------------
1124 bool wxWindowBase::Show(bool show
)
1126 if ( show
!= m_isShown
)
1138 bool wxWindowBase::IsEnabled() const
1140 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
1143 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled
)
1145 // Under some platforms there is no need to update the window state
1146 // explicitly, it will become disabled when its parent is. On other ones we
1147 // do need to disable all windows recursively though.
1148 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
1150 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1154 // Disabling a top level window is typically done when showing a modal
1155 // dialog and we don't need to disable its children in this case, they will
1156 // be logically disabled anyhow (i.e. their IsEnabled() will return false)
1157 // and the TLW won't accept any input for them. Moreover, explicitly
1158 // disabling them would look ugly as the entire TLW would be greyed out
1159 // whenever a modal dialog is shown and no native applications under any
1160 // platform behave like this.
1161 if ( IsTopLevel() && !enabled
)
1164 // When disabling (or enabling back) a non-TLW window we need to
1165 // recursively propagate the change of the state to its children, otherwise
1166 // they would still show as enabled even though they wouldn't actually
1167 // accept any input (at least under MSW where children don't accept input
1168 // if any of the windows in their parent chain is enabled).
1170 // Notice that we must do this even for wxHAS_NATIVE_ENABLED_MANAGEMENT
1171 // platforms as we still need to call the children OnEnabled() recursively.
1172 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1174 node
= node
->GetNext() )
1176 wxWindowBase
* const child
= node
->GetData();
1177 if ( !child
->IsTopLevel() && child
->IsThisEnabled() )
1178 child
->NotifyWindowOnEnableChange(enabled
);
1182 bool wxWindowBase::Enable(bool enable
)
1184 if ( enable
== IsThisEnabled() )
1187 m_isEnabled
= enable
;
1189 // If we call DoEnable() from NotifyWindowOnEnableChange(), we don't need
1190 // to do it from here.
1191 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
1193 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1195 NotifyWindowOnEnableChange(enable
);
1200 bool wxWindowBase::IsShownOnScreen() const
1202 // A window is shown on screen if it itself is shown and so are all its
1203 // parents. But if a window is toplevel one, then its always visible on
1204 // screen if IsShown() returns true, even if it has a hidden parent.
1206 (IsTopLevel() || GetParent() == NULL
|| GetParent()->IsShownOnScreen());
1209 // ----------------------------------------------------------------------------
1211 // ----------------------------------------------------------------------------
1213 bool wxWindowBase::IsTopLevel() const
1218 // ----------------------------------------------------------------------------
1220 // ----------------------------------------------------------------------------
1222 void wxWindowBase::Freeze()
1224 if ( !m_freezeCount
++ )
1226 // physically freeze this window:
1229 // and recursively freeze all children:
1230 for ( wxWindowList::iterator i
= GetChildren().begin();
1231 i
!= GetChildren().end(); ++i
)
1233 wxWindow
*child
= *i
;
1234 if ( child
->IsTopLevel() )
1242 void wxWindowBase::Thaw()
1244 wxASSERT_MSG( m_freezeCount
, "Thaw() without matching Freeze()" );
1246 if ( !--m_freezeCount
)
1248 // recursively thaw all children:
1249 for ( wxWindowList::iterator i
= GetChildren().begin();
1250 i
!= GetChildren().end(); ++i
)
1252 wxWindow
*child
= *i
;
1253 if ( child
->IsTopLevel() )
1259 // physically thaw this window:
1264 // ----------------------------------------------------------------------------
1265 // Dealing with parents and children.
1266 // ----------------------------------------------------------------------------
1268 bool wxWindowBase::IsDescendant(wxWindowBase
* win
) const
1270 // Iterate until we find this window in the parent chain or exhaust it.
1276 // Stop iterating on reaching the top level window boundary.
1277 if ( win
->IsTopLevel() )
1280 win
= win
->GetParent();
1286 void wxWindowBase::AddChild(wxWindowBase
*child
)
1288 wxCHECK_RET( child
, wxT("can't add a NULL child") );
1290 // this should never happen and it will lead to a crash later if it does
1291 // because RemoveChild() will remove only one node from the children list
1292 // and the other(s) one(s) will be left with dangling pointers in them
1293 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), wxT("AddChild() called twice") );
1295 GetChildren().Append((wxWindow
*)child
);
1296 child
->SetParent(this);
1298 // adding a child while frozen will assert when thawed, so freeze it as if
1299 // it had been already present when we were frozen
1300 if ( IsFrozen() && !child
->IsTopLevel() )
1304 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
1306 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
1308 // removing a child while frozen may result in permanently frozen window
1309 // if used e.g. from Reparent(), so thaw it
1311 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1312 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1313 if ( IsFrozen() && !child
->IsBeingDeleted() && !child
->IsTopLevel() )
1316 GetChildren().DeleteObject((wxWindow
*)child
);
1317 child
->SetParent(NULL
);
1320 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
1322 wxWindow
*oldParent
= GetParent();
1323 if ( newParent
== oldParent
)
1329 const bool oldEnabledState
= IsEnabled();
1331 // unlink this window from the existing parent.
1334 oldParent
->RemoveChild(this);
1338 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
1341 // add it to the new one
1344 newParent
->AddChild(this);
1348 wxTopLevelWindows
.Append((wxWindow
*)this);
1351 // We need to notify window (and its subwindows) if by changing the parent
1352 // we also change our enabled/disabled status.
1353 const bool newEnabledState
= IsEnabled();
1354 if ( newEnabledState
!= oldEnabledState
)
1356 NotifyWindowOnEnableChange(newEnabledState
);
1362 // ----------------------------------------------------------------------------
1363 // event handler stuff
1364 // ----------------------------------------------------------------------------
1366 void wxWindowBase::SetEventHandler(wxEvtHandler
*handler
)
1368 wxCHECK_RET(handler
!= NULL
, "SetEventHandler(NULL) called");
1370 m_eventHandler
= handler
;
1373 void wxWindowBase::SetNextHandler(wxEvtHandler
*WXUNUSED(handler
))
1375 // disable wxEvtHandler chain mechanism for wxWindows:
1376 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1378 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1380 void wxWindowBase::SetPreviousHandler(wxEvtHandler
*WXUNUSED(handler
))
1382 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1383 // handler of our stack when is destroyed will be Unlink()ed and thus
1384 // will call this function to update the pointer of this window...
1386 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1389 void wxWindowBase::PushEventHandler(wxEvtHandler
*handlerToPush
)
1391 wxCHECK_RET( handlerToPush
!= NULL
, "PushEventHandler(NULL) called" );
1393 // the new handler is going to be part of the wxWindow stack of event handlers:
1394 // it can't be part also of an event handler double-linked chain:
1395 wxASSERT_MSG(handlerToPush
->IsUnlinked(),
1396 "The handler being pushed in the wxWindow stack shouldn't be part of "
1397 "a wxEvtHandler chain; call Unlink() on it first");
1399 wxEvtHandler
*handlerOld
= GetEventHandler();
1400 wxCHECK_RET( handlerOld
, "an old event handler is NULL?" );
1402 // now use wxEvtHandler double-linked list to implement a stack:
1403 handlerToPush
->SetNextHandler(handlerOld
);
1405 if (handlerOld
!= this)
1406 handlerOld
->SetPreviousHandler(handlerToPush
);
1408 SetEventHandler(handlerToPush
);
1411 // final checks of the operations done above:
1412 wxASSERT_MSG( handlerToPush
->GetPreviousHandler() == NULL
,
1413 "the first handler of the wxWindow stack should "
1414 "have no previous handlers set" );
1415 wxASSERT_MSG( handlerToPush
->GetNextHandler() != NULL
,
1416 "the first handler of the wxWindow stack should "
1417 "have non-NULL next handler" );
1419 wxEvtHandler
* pLast
= handlerToPush
;
1420 while ( pLast
&& pLast
!= this )
1421 pLast
= pLast
->GetNextHandler();
1422 wxASSERT_MSG( pLast
->GetNextHandler() == NULL
,
1423 "the last handler of the wxWindow stack should "
1424 "have this window as next handler" );
1425 #endif // wxDEBUG_LEVEL
1428 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
1430 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
1432 wxEvtHandler
*firstHandler
= GetEventHandler();
1433 wxCHECK_MSG( firstHandler
!= NULL
, NULL
, "wxWindow cannot have a NULL event handler" );
1434 wxCHECK_MSG( firstHandler
!= this, NULL
, "cannot pop the wxWindow itself" );
1435 wxCHECK_MSG( firstHandler
->GetPreviousHandler() == NULL
, NULL
,
1436 "the first handler of the wxWindow stack should have no previous handlers set" );
1438 wxEvtHandler
*secondHandler
= firstHandler
->GetNextHandler();
1439 wxCHECK_MSG( secondHandler
!= NULL
, NULL
,
1440 "the first handler of the wxWindow stack should have non-NULL next handler" );
1442 firstHandler
->SetNextHandler(NULL
);
1444 // It is harmless but useless to unset the previous handler of the window
1445 // itself as it's always NULL anyhow, so don't do this.
1446 if ( secondHandler
!= this )
1447 secondHandler
->SetPreviousHandler(NULL
);
1449 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1450 SetEventHandler(secondHandler
);
1452 if ( deleteHandler
)
1454 wxDELETE(firstHandler
);
1457 return firstHandler
;
1460 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handlerToRemove
)
1462 wxCHECK_MSG( handlerToRemove
!= NULL
, false, "RemoveEventHandler(NULL) called" );
1463 wxCHECK_MSG( handlerToRemove
!= this, false, "Cannot remove the window itself" );
1465 if (handlerToRemove
== GetEventHandler())
1467 // removing the first event handler is equivalent to "popping" the stack
1468 PopEventHandler(false);
1472 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1473 wxEvtHandler
*handlerCur
= GetEventHandler()->GetNextHandler();
1474 while ( handlerCur
!= this && handlerCur
)
1476 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1478 if ( handlerCur
== handlerToRemove
)
1480 handlerCur
->Unlink();
1482 wxASSERT_MSG( handlerCur
!= GetEventHandler(),
1483 "the case Remove == Pop should was already handled" );
1487 handlerCur
= handlerNext
;
1490 wxFAIL_MSG( wxT("where has the event handler gone?") );
1495 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1497 // SafelyProcessEvent() will handle exceptions nicely
1498 return GetEventHandler()->SafelyProcessEvent(event
);
1501 // ----------------------------------------------------------------------------
1502 // colours, fonts &c
1503 // ----------------------------------------------------------------------------
1505 void wxWindowBase::InheritAttributes()
1507 const wxWindowBase
* const parent
= GetParent();
1511 // we only inherit attributes which had been explicitly set for the parent
1512 // which ensures that this only happens if the user really wants it and
1513 // not by default which wouldn't make any sense in modern GUIs where the
1514 // controls don't all use the same fonts (nor colours)
1515 if ( parent
->m_inheritFont
&& !m_hasFont
)
1516 SetFont(parent
->GetFont());
1518 // in addition, there is a possibility to explicitly forbid inheriting
1519 // colours at each class level by overriding ShouldInheritColours()
1520 if ( ShouldInheritColours() )
1522 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1523 SetForegroundColour(parent
->GetForegroundColour());
1525 // inheriting (solid) background colour is wrong as it totally breaks
1526 // any kind of themed backgrounds
1528 // instead, the controls should use the same background as their parent
1529 // (ideally by not drawing it at all)
1531 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1532 SetBackgroundColour(parent
->GetBackgroundColour());
1537 /* static */ wxVisualAttributes
1538 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1540 // it is important to return valid values for all attributes from here,
1541 // GetXXX() below rely on this
1542 wxVisualAttributes attrs
;
1543 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1544 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1546 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1547 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1548 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1549 // colour on other platforms.
1551 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1552 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1554 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1559 wxColour
wxWindowBase::GetBackgroundColour() const
1561 if ( !m_backgroundColour
.IsOk() )
1563 wxASSERT_MSG( !m_hasBgCol
, wxT("we have invalid explicit bg colour?") );
1565 // get our default background colour
1566 wxColour colBg
= GetDefaultAttributes().colBg
;
1568 // we must return some valid colour to avoid redoing this every time
1569 // and also to avoid surprising the applications written for older
1570 // wxWidgets versions where GetBackgroundColour() always returned
1571 // something -- so give them something even if it doesn't make sense
1572 // for this window (e.g. it has a themed background)
1573 if ( !colBg
.IsOk() )
1574 colBg
= GetClassDefaultAttributes().colBg
;
1579 return m_backgroundColour
;
1582 wxColour
wxWindowBase::GetForegroundColour() const
1584 // logic is the same as above
1585 if ( !m_hasFgCol
&& !m_foregroundColour
.IsOk() )
1587 wxColour colFg
= GetDefaultAttributes().colFg
;
1589 if ( !colFg
.IsOk() )
1590 colFg
= GetClassDefaultAttributes().colFg
;
1595 return m_foregroundColour
;
1598 bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style
)
1600 // The checks below shouldn't be triggered if we're not really changing the
1602 if ( style
== m_backgroundStyle
)
1605 // Transparent background style can be only set before creation because of
1606 // wxGTK limitation.
1607 wxCHECK_MSG( (style
!= wxBG_STYLE_TRANSPARENT
) || !GetHandle(),
1609 "wxBG_STYLE_TRANSPARENT style can only be set before "
1610 "Create()-ing the window." );
1612 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1613 wxCHECK_MSG( (m_backgroundStyle
!= wxBG_STYLE_TRANSPARENT
) ||
1614 (style
== wxBG_STYLE_TRANSPARENT
),
1616 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1618 m_backgroundStyle
= style
;
1623 bool wxWindowBase::IsTransparentBackgroundSupported(wxString
*reason
) const
1626 *reason
= _("This platform does not support background transparency.");
1631 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1633 if ( colour
== m_backgroundColour
)
1636 m_hasBgCol
= colour
.IsOk();
1638 m_inheritBgCol
= m_hasBgCol
;
1639 m_backgroundColour
= colour
;
1640 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.IsOk() );
1644 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1646 if (colour
== m_foregroundColour
)
1649 m_hasFgCol
= colour
.IsOk();
1650 m_inheritFgCol
= m_hasFgCol
;
1651 m_foregroundColour
= colour
;
1652 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.IsOk() );
1656 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1658 // setting an invalid cursor is ok, it means that we don't have any special
1660 if ( m_cursor
.IsSameAs(cursor
) )
1671 wxFont
wxWindowBase::GetFont() const
1673 // logic is the same as in GetBackgroundColour()
1674 if ( !m_font
.IsOk() )
1676 wxASSERT_MSG( !m_hasFont
, wxT("we have invalid explicit font?") );
1678 wxFont font
= GetDefaultAttributes().font
;
1680 font
= GetClassDefaultAttributes().font
;
1688 bool wxWindowBase::SetFont(const wxFont
& font
)
1690 if ( font
== m_font
)
1697 m_hasFont
= font
.IsOk();
1698 m_inheritFont
= m_hasFont
;
1700 InvalidateBestSize();
1707 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1709 m_hasCustomPalette
= true;
1712 // VZ: can anyone explain me what do we do here?
1713 wxWindowDC
d((wxWindow
*) this);
1717 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1719 wxWindow
*win
= (wxWindow
*)this;
1720 while ( win
&& !win
->HasCustomPalette() )
1722 win
= win
->GetParent();
1728 #endif // wxUSE_PALETTE
1731 void wxWindowBase::SetCaret(wxCaret
*caret
)
1742 wxASSERT_MSG( m_caret
->GetWindow() == this,
1743 wxT("caret should be created associated to this window") );
1746 #endif // wxUSE_CARET
1748 #if wxUSE_VALIDATORS
1749 // ----------------------------------------------------------------------------
1751 // ----------------------------------------------------------------------------
1753 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1755 if ( m_windowValidator
)
1756 delete m_windowValidator
;
1758 m_windowValidator
= (wxValidator
*)validator
.Clone();
1760 if ( m_windowValidator
)
1761 m_windowValidator
->SetWindow(this);
1763 #endif // wxUSE_VALIDATORS
1765 // ----------------------------------------------------------------------------
1766 // update region stuff
1767 // ----------------------------------------------------------------------------
1769 wxRect
wxWindowBase::GetUpdateClientRect() const
1771 wxRegion rgnUpdate
= GetUpdateRegion();
1772 rgnUpdate
.Intersect(GetClientRect());
1773 wxRect rectUpdate
= rgnUpdate
.GetBox();
1774 wxPoint ptOrigin
= GetClientAreaOrigin();
1775 rectUpdate
.x
-= ptOrigin
.x
;
1776 rectUpdate
.y
-= ptOrigin
.y
;
1781 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1783 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1786 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1788 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1791 void wxWindowBase::ClearBackground()
1793 // wxGTK uses its own version, no need to add never used code
1795 wxClientDC
dc((wxWindow
*)this);
1796 wxBrush
brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID
);
1797 dc
.SetBackground(brush
);
1802 // ----------------------------------------------------------------------------
1803 // find child window by id or name
1804 // ----------------------------------------------------------------------------
1806 wxWindow
*wxWindowBase::FindWindow(long id
) const
1808 if ( id
== m_windowId
)
1809 return (wxWindow
*)this;
1811 wxWindowBase
*res
= NULL
;
1812 wxWindowList::compatibility_iterator node
;
1813 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1815 wxWindowBase
*child
= node
->GetData();
1816 res
= child
->FindWindow( id
);
1819 return (wxWindow
*)res
;
1822 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1824 if ( name
== m_windowName
)
1825 return (wxWindow
*)this;
1827 wxWindowBase
*res
= NULL
;
1828 wxWindowList::compatibility_iterator node
;
1829 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1831 wxWindow
*child
= node
->GetData();
1832 res
= child
->FindWindow(name
);
1835 return (wxWindow
*)res
;
1839 // find any window by id or name or label: If parent is non-NULL, look through
1840 // children for a label or title matching the specified string. If NULL, look
1841 // through all top-level windows.
1843 // to avoid duplicating code we reuse the same helper function but with
1844 // different comparators
1846 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1847 const wxString
& label
, long id
);
1850 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1853 return win
->GetLabel() == label
;
1857 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1860 return win
->GetName() == label
;
1864 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1867 return win
->GetId() == id
;
1870 // recursive helper for the FindWindowByXXX() functions
1872 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1873 const wxString
& label
,
1875 wxFindWindowCmp cmp
)
1879 // see if this is the one we're looking for
1880 if ( (*cmp
)(parent
, label
, id
) )
1881 return (wxWindow
*)parent
;
1883 // It wasn't, so check all its children
1884 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1886 node
= node
->GetNext() )
1888 // recursively check each child
1889 wxWindow
*win
= (wxWindow
*)node
->GetData();
1890 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1900 // helper for FindWindowByXXX()
1902 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1903 const wxString
& label
,
1905 wxFindWindowCmp cmp
)
1909 // just check parent and all its children
1910 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1913 // start at very top of wx's windows
1914 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1916 node
= node
->GetNext() )
1918 // recursively check each window & its children
1919 wxWindow
*win
= node
->GetData();
1920 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1930 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1932 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1937 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1939 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1943 // fall back to the label
1944 win
= FindWindowByLabel(title
, parent
);
1952 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1954 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1957 // ----------------------------------------------------------------------------
1958 // dialog oriented functions
1959 // ----------------------------------------------------------------------------
1961 #if WXWIN_COMPATIBILITY_2_8
1962 void wxWindowBase::MakeModal(bool modal
)
1964 // Disable all other windows
1967 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1970 wxWindow
*win
= node
->GetData();
1972 win
->Enable(!modal
);
1974 node
= node
->GetNext();
1978 #endif // WXWIN_COMPATIBILITY_2_8
1980 bool wxWindowBase::Validate()
1982 #if wxUSE_VALIDATORS
1983 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1985 wxWindowList::compatibility_iterator node
;
1986 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1988 wxWindowBase
*child
= node
->GetData();
1989 wxValidator
*validator
= child
->GetValidator();
1990 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1995 if ( recurse
&& !child
->Validate() )
2000 #endif // wxUSE_VALIDATORS
2005 bool wxWindowBase::TransferDataToWindow()
2007 #if wxUSE_VALIDATORS
2008 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2010 wxWindowList::compatibility_iterator node
;
2011 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2013 wxWindowBase
*child
= node
->GetData();
2014 wxValidator
*validator
= child
->GetValidator();
2015 if ( validator
&& !validator
->TransferToWindow() )
2017 wxLogWarning(_("Could not transfer data to window"));
2019 wxLog::FlushActive();
2027 if ( !child
->TransferDataToWindow() )
2029 // warning already given
2034 #endif // wxUSE_VALIDATORS
2039 bool wxWindowBase::TransferDataFromWindow()
2041 #if wxUSE_VALIDATORS
2042 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2044 wxWindowList::compatibility_iterator node
;
2045 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2047 wxWindow
*child
= node
->GetData();
2048 wxValidator
*validator
= child
->GetValidator();
2049 if ( validator
&& !validator
->TransferFromWindow() )
2051 // nop warning here because the application is supposed to give
2052 // one itself - we don't know here what might have gone wrongly
2059 if ( !child
->TransferDataFromWindow() )
2061 // warning already given
2066 #endif // wxUSE_VALIDATORS
2071 void wxWindowBase::InitDialog()
2073 wxInitDialogEvent
event(GetId());
2074 event
.SetEventObject( this );
2075 GetEventHandler()->ProcessEvent(event
);
2078 // ----------------------------------------------------------------------------
2079 // context-sensitive help support
2080 // ----------------------------------------------------------------------------
2084 // associate this help text with this window
2085 void wxWindowBase::SetHelpText(const wxString
& text
)
2087 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2090 helpProvider
->AddHelp(this, text
);
2094 #if WXWIN_COMPATIBILITY_2_8
2095 // associate this help text with all windows with the same id as this
2097 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
2099 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2102 helpProvider
->AddHelp(GetId(), text
);
2105 #endif // WXWIN_COMPATIBILITY_2_8
2107 // get the help string associated with this window (may be empty)
2108 // default implementation forwards calls to the help provider
2110 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
2111 wxHelpEvent::Origin
WXUNUSED(origin
)) const
2114 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2117 text
= helpProvider
->GetHelp(this);
2123 // show help for this window
2124 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
2126 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2129 wxPoint pos
= event
.GetPosition();
2130 const wxHelpEvent::Origin origin
= event
.GetOrigin();
2131 if ( origin
== wxHelpEvent::Origin_Keyboard
)
2133 // if the help event was generated from keyboard it shouldn't
2134 // appear at the mouse position (which is still the only position
2135 // associated with help event) if the mouse is far away, although
2136 // we still do use the mouse position if it's over the window
2137 // because we suppose the user looks approximately at the mouse
2138 // already and so it would be more convenient than showing tooltip
2139 // at some arbitrary position which can be quite far from it
2140 const wxRect rectClient
= GetClientRect();
2141 if ( !rectClient
.Contains(ScreenToClient(pos
)) )
2143 // position help slightly under and to the right of this window
2144 pos
= ClientToScreen(wxPoint(
2146 rectClient
.height
+ GetCharHeight()
2151 if ( helpProvider
->ShowHelpAtPoint(this, pos
, origin
) )
2153 // skip the event.Skip() below
2161 #endif // wxUSE_HELP
2163 // ----------------------------------------------------------------------------
2165 // ----------------------------------------------------------------------------
2169 wxString
wxWindowBase::GetToolTipText() const
2171 return m_tooltip
? m_tooltip
->GetTip() : wxString();
2174 void wxWindowBase::SetToolTip( const wxString
&tip
)
2176 // don't create the new tooltip if we already have one
2179 m_tooltip
->SetTip( tip
);
2183 SetToolTip( new wxToolTip( tip
) );
2186 // setting empty tooltip text does not remove the tooltip any more - use
2187 // SetToolTip(NULL) for this
2190 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
2192 if ( m_tooltip
!= tooltip
)
2197 m_tooltip
= tooltip
;
2201 bool wxWindowBase::CopyToolTip(wxToolTip
*tip
)
2203 SetToolTip(tip
? new wxToolTip(tip
->GetTip()) : NULL
);
2208 #endif // wxUSE_TOOLTIPS
2210 // ----------------------------------------------------------------------------
2211 // constraints and sizers
2212 // ----------------------------------------------------------------------------
2214 #if wxUSE_CONSTRAINTS
2216 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
2218 if ( m_constraints
)
2220 UnsetConstraints(m_constraints
);
2221 delete m_constraints
;
2223 m_constraints
= constraints
;
2224 if ( m_constraints
)
2226 // Make sure other windows know they're part of a 'meaningful relationship'
2227 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
2228 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
2229 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
2230 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
2231 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
2232 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
2233 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
2234 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
2235 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
2236 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
2237 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
2238 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
2239 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
2240 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
2241 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
2242 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
2246 // This removes any dangling pointers to this window in other windows'
2247 // constraintsInvolvedIn lists.
2248 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
2252 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2253 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
2254 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2255 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
2256 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
2257 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
2258 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
2259 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
2260 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
2261 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
2262 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
2263 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
2264 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
2265 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
2266 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
2267 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
2271 // Back-pointer to other windows we're involved with, so if we delete this
2272 // window, we must delete any constraints we're involved with.
2273 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
2275 if ( !m_constraintsInvolvedIn
)
2276 m_constraintsInvolvedIn
= new wxWindowList
;
2277 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
2278 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
2281 // REMOVE back-pointer to other windows we're involved with.
2282 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
2284 if ( m_constraintsInvolvedIn
)
2285 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
2288 // Reset any constraints that mention this window
2289 void wxWindowBase::DeleteRelatedConstraints()
2291 if ( m_constraintsInvolvedIn
)
2293 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
2296 wxWindow
*win
= node
->GetData();
2297 wxLayoutConstraints
*constr
= win
->GetConstraints();
2299 // Reset any constraints involving this window
2302 constr
->left
.ResetIfWin(this);
2303 constr
->top
.ResetIfWin(this);
2304 constr
->right
.ResetIfWin(this);
2305 constr
->bottom
.ResetIfWin(this);
2306 constr
->width
.ResetIfWin(this);
2307 constr
->height
.ResetIfWin(this);
2308 constr
->centreX
.ResetIfWin(this);
2309 constr
->centreY
.ResetIfWin(this);
2312 wxWindowList::compatibility_iterator next
= node
->GetNext();
2313 m_constraintsInvolvedIn
->Erase(node
);
2317 wxDELETE(m_constraintsInvolvedIn
);
2321 #endif // wxUSE_CONSTRAINTS
2323 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
2325 if ( sizer
== m_windowSizer
)
2328 if ( m_windowSizer
)
2330 m_windowSizer
->SetContainingWindow(NULL
);
2333 delete m_windowSizer
;
2336 m_windowSizer
= sizer
;
2337 if ( m_windowSizer
)
2339 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
2342 SetAutoLayout(m_windowSizer
!= NULL
);
2345 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
2347 SetSizer( sizer
, deleteOld
);
2348 sizer
->SetSizeHints( (wxWindow
*) this );
2352 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
2354 // adding a window to a sizer twice is going to result in fatal and
2355 // hard to debug problems later because when deleting the second
2356 // associated wxSizerItem we're going to dereference a dangling
2357 // pointer; so try to detect this as early as possible
2358 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
2359 wxT("Adding a window to the same sizer twice?") );
2361 m_containingSizer
= sizer
;
2364 #if wxUSE_CONSTRAINTS
2366 void wxWindowBase::SatisfyConstraints()
2368 wxLayoutConstraints
*constr
= GetConstraints();
2369 bool wasOk
= constr
&& constr
->AreSatisfied();
2371 ResetConstraints(); // Mark all constraints as unevaluated
2375 // if we're a top level panel (i.e. our parent is frame/dialog), our
2376 // own constraints will never be satisfied any more unless we do it
2380 while ( noChanges
> 0 )
2382 LayoutPhase1(&noChanges
);
2386 LayoutPhase2(&noChanges
);
2389 #endif // wxUSE_CONSTRAINTS
2391 bool wxWindowBase::Layout()
2393 // If there is a sizer, use it instead of the constraints
2397 GetVirtualSize(&w
, &h
);
2398 GetSizer()->SetDimension( 0, 0, w
, h
);
2400 #if wxUSE_CONSTRAINTS
2403 SatisfyConstraints(); // Find the right constraints values
2404 SetConstraintSizes(); // Recursively set the real window sizes
2411 void wxWindowBase::InternalOnSize(wxSizeEvent
& event
)
2413 if ( GetAutoLayout() )
2419 #if wxUSE_CONSTRAINTS
2421 // first phase of the constraints evaluation: set our own constraints
2422 bool wxWindowBase::LayoutPhase1(int *noChanges
)
2424 wxLayoutConstraints
*constr
= GetConstraints();
2426 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
2429 // second phase: set the constraints for our children
2430 bool wxWindowBase::LayoutPhase2(int *noChanges
)
2437 // Layout grand children
2443 // Do a phase of evaluating child constraints
2444 bool wxWindowBase::DoPhase(int phase
)
2446 // the list containing the children for which the constraints are already
2448 wxWindowList succeeded
;
2450 // the max number of iterations we loop before concluding that we can't set
2452 static const int maxIterations
= 500;
2454 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
2458 // loop over all children setting their constraints
2459 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2461 node
= node
->GetNext() )
2463 wxWindow
*child
= node
->GetData();
2464 if ( child
->IsTopLevel() )
2466 // top level children are not inside our client area
2470 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
2472 // this one is either already ok or nothing we can do about it
2476 int tempNoChanges
= 0;
2477 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
2478 : child
->LayoutPhase2(&tempNoChanges
);
2479 noChanges
+= tempNoChanges
;
2483 succeeded
.Append(child
);
2489 // constraints are set
2497 void wxWindowBase::ResetConstraints()
2499 wxLayoutConstraints
*constr
= GetConstraints();
2502 constr
->left
.SetDone(false);
2503 constr
->top
.SetDone(false);
2504 constr
->right
.SetDone(false);
2505 constr
->bottom
.SetDone(false);
2506 constr
->width
.SetDone(false);
2507 constr
->height
.SetDone(false);
2508 constr
->centreX
.SetDone(false);
2509 constr
->centreY
.SetDone(false);
2512 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2515 wxWindow
*win
= node
->GetData();
2516 if ( !win
->IsTopLevel() )
2517 win
->ResetConstraints();
2518 node
= node
->GetNext();
2522 // Need to distinguish between setting the 'fake' size for windows and sizers,
2523 // and setting the real values.
2524 void wxWindowBase::SetConstraintSizes(bool recurse
)
2526 wxLayoutConstraints
*constr
= GetConstraints();
2527 if ( constr
&& constr
->AreSatisfied() )
2529 int x
= constr
->left
.GetValue();
2530 int y
= constr
->top
.GetValue();
2531 int w
= constr
->width
.GetValue();
2532 int h
= constr
->height
.GetValue();
2534 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2535 (constr
->height
.GetRelationship() != wxAsIs
) )
2537 // We really shouldn't set negative sizes for the windows so make
2538 // them at least of 1*1 size
2539 SetSize(x
, y
, w
> 0 ? w
: 1, h
> 0 ? h
: 1);
2543 // If we don't want to resize this window, just move it...
2549 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2550 GetClassInfo()->GetClassName(),
2556 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2559 wxWindow
*win
= node
->GetData();
2560 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2561 win
->SetConstraintSizes();
2562 node
= node
->GetNext();
2567 // Only set the size/position of the constraint (if any)
2568 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2570 wxLayoutConstraints
*constr
= GetConstraints();
2573 if ( x
!= wxDefaultCoord
)
2575 constr
->left
.SetValue(x
);
2576 constr
->left
.SetDone(true);
2578 if ( y
!= wxDefaultCoord
)
2580 constr
->top
.SetValue(y
);
2581 constr
->top
.SetDone(true);
2583 if ( w
!= wxDefaultCoord
)
2585 constr
->width
.SetValue(w
);
2586 constr
->width
.SetDone(true);
2588 if ( h
!= wxDefaultCoord
)
2590 constr
->height
.SetValue(h
);
2591 constr
->height
.SetDone(true);
2596 void wxWindowBase::MoveConstraint(int x
, int y
)
2598 wxLayoutConstraints
*constr
= GetConstraints();
2601 if ( x
!= wxDefaultCoord
)
2603 constr
->left
.SetValue(x
);
2604 constr
->left
.SetDone(true);
2606 if ( y
!= wxDefaultCoord
)
2608 constr
->top
.SetValue(y
);
2609 constr
->top
.SetDone(true);
2614 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2616 wxLayoutConstraints
*constr
= GetConstraints();
2619 *w
= constr
->width
.GetValue();
2620 *h
= constr
->height
.GetValue();
2626 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2628 wxLayoutConstraints
*constr
= GetConstraints();
2631 *w
= constr
->width
.GetValue();
2632 *h
= constr
->height
.GetValue();
2635 GetClientSize(w
, h
);
2638 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2640 wxLayoutConstraints
*constr
= GetConstraints();
2643 *x
= constr
->left
.GetValue();
2644 *y
= constr
->top
.GetValue();
2650 #endif // wxUSE_CONSTRAINTS
2652 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2654 wxWindow
*parent
= GetParent();
2655 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2657 wxPoint
pt(parent
->GetClientAreaOrigin());
2663 // ----------------------------------------------------------------------------
2664 // Update UI processing
2665 // ----------------------------------------------------------------------------
2667 void wxWindowBase::UpdateWindowUI(long flags
)
2669 wxUpdateUIEvent
event(GetId());
2670 event
.SetEventObject(this);
2672 if ( GetEventHandler()->ProcessEvent(event
) )
2674 DoUpdateWindowUI(event
);
2677 if (flags
& wxUPDATE_UI_RECURSE
)
2679 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2682 wxWindow
* child
= (wxWindow
*) node
->GetData();
2683 child
->UpdateWindowUI(flags
);
2684 node
= node
->GetNext();
2689 // do the window-specific processing after processing the update event
2690 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2692 if ( event
.GetSetEnabled() )
2693 Enable(event
.GetEnabled());
2695 if ( event
.GetSetShown() )
2696 Show(event
.GetShown());
2699 // ----------------------------------------------------------------------------
2701 // ----------------------------------------------------------------------------
2703 // Send idle event to window and all subwindows
2704 bool wxWindowBase::SendIdleEvents(wxIdleEvent
& event
)
2706 bool needMore
= false;
2710 // should we send idle event to this window?
2711 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL
||
2712 HasExtraStyle(wxWS_EX_PROCESS_IDLE
))
2714 event
.SetEventObject(this);
2715 HandleWindowEvent(event
);
2717 if (event
.MoreRequested())
2720 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2721 for (; node
; node
= node
->GetNext())
2723 wxWindow
* child
= node
->GetData();
2724 if (child
->SendIdleEvents(event
))
2731 void wxWindowBase::OnInternalIdle()
2733 if ( wxUpdateUIEvent::CanUpdate(this) )
2734 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
2737 // ----------------------------------------------------------------------------
2738 // dialog units translations
2739 // ----------------------------------------------------------------------------
2741 // Windows' computes dialog units using average character width over upper-
2742 // and lower-case ASCII alphabet and not using the average character width
2743 // metadata stored in the font; see
2744 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2745 // It's important that we perform the conversion in identical way, because
2746 // dialog units natively exist only on Windows and Windows HIG is expressed
2748 wxSize
wxWindowBase::GetDlgUnitBase() const
2750 const wxWindowBase
* const parent
= wxGetTopLevelParent((wxWindow
*)this);
2752 wxCHECK_MSG( parent
, wxDefaultSize
, wxS("Must have TLW parent") );
2754 if ( !parent
->m_font
.IsOk() )
2756 // Default GUI font is used. This is the most common case, so
2757 // cache the results.
2758 static wxSize s_defFontSize
;
2759 if ( s_defFontSize
.x
== 0 )
2760 s_defFontSize
= wxPrivate::GetAverageASCIILetterSize(*parent
);
2761 return s_defFontSize
;
2765 // Custom font, we always need to compute the result
2766 return wxPrivate::GetAverageASCIILetterSize(*parent
);
2770 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
) const
2772 const wxSize base
= GetDlgUnitBase();
2774 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2776 wxPoint pt2
= wxDefaultPosition
;
2777 if (pt
.x
!= wxDefaultCoord
)
2778 pt2
.x
= wxMulDivInt32(pt
.x
, 4, base
.x
);
2779 if (pt
.y
!= wxDefaultCoord
)
2780 pt2
.y
= wxMulDivInt32(pt
.y
, 8, base
.y
);
2785 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
) const
2787 const wxSize base
= GetDlgUnitBase();
2789 wxPoint pt2
= wxDefaultPosition
;
2790 if (pt
.x
!= wxDefaultCoord
)
2791 pt2
.x
= wxMulDivInt32(pt
.x
, base
.x
, 4);
2792 if (pt
.y
!= wxDefaultCoord
)
2793 pt2
.y
= wxMulDivInt32(pt
.y
, base
.y
, 8);
2798 // ----------------------------------------------------------------------------
2800 // ----------------------------------------------------------------------------
2802 // propagate the colour change event to the subwindows
2803 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& WXUNUSED(event
))
2805 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2808 // Only propagate to non-top-level windows
2809 wxWindow
*win
= node
->GetData();
2810 if ( !win
->IsTopLevel() )
2812 wxSysColourChangedEvent event2
;
2813 event2
.SetEventObject(win
);
2814 win
->GetEventHandler()->ProcessEvent(event2
);
2817 node
= node
->GetNext();
2823 // the default action is to populate dialog with data when it's created,
2824 // and nudge the UI into displaying itself correctly in case
2825 // we've turned the wxUpdateUIEvents frequency down low.
2826 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2828 TransferDataToWindow();
2830 // Update the UI at this point
2831 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2834 // ----------------------------------------------------------------------------
2835 // menu-related functions
2836 // ----------------------------------------------------------------------------
2840 bool wxWindowBase::PopupMenu(wxMenu
*menu
, int x
, int y
)
2842 wxCHECK_MSG( menu
, false, "can't popup NULL menu" );
2844 wxMenuInvokingWindowSetter
2845 setInvokingWin(*menu
, static_cast<wxWindow
*>(this));
2847 wxCurrentPopupMenu
= menu
;
2848 const bool rc
= DoPopupMenu(menu
, x
, y
);
2849 wxCurrentPopupMenu
= NULL
;
2854 // this is used to pass the id of the selected item from the menu event handler
2855 // to the main function itself
2857 // it's ok to use a global here as there can be at most one popup menu shown at
2859 static int gs_popupMenuSelection
= wxID_NONE
;
2861 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2863 // store the id in a global variable where we'll retrieve it from later
2864 gs_popupMenuSelection
= event
.GetId();
2867 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent
& WXUNUSED(event
))
2869 // nothing to do but do not skip it
2873 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2875 gs_popupMenuSelection
= wxID_NONE
;
2877 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2878 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2882 // it is common to construct the menu passed to this function dynamically
2883 // using some fixed range of ids which could clash with the ids used
2884 // elsewhere in the program, which could result in some menu items being
2885 // unintentionally disabled or otherwise modified by update UI handlers
2886 // elsewhere in the program code and this is difficult to avoid in the
2887 // program itself, so instead we just temporarily suspend UI updating while
2888 // this menu is shown
2889 Connect(wxEVT_UPDATE_UI
,
2890 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2894 PopupMenu(&menu
, x
, y
);
2896 Disconnect(wxEVT_UPDATE_UI
,
2897 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2900 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2901 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2905 return gs_popupMenuSelection
;
2908 #endif // wxUSE_MENUS
2910 // methods for drawing the sizers in a visible way: this is currently only
2911 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2912 // that well and also because we don't want to leave it enabled in default
2913 // builds used for production
2914 #if wxDEBUG_LEVEL > 1
2916 static void DrawSizers(wxWindowBase
*win
);
2918 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
, const wxPen
* pen
)
2920 wxClientDC
dc((wxWindow
*)win
);
2922 dc
.SetBrush(fill
? wxBrush(pen
->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH
) :
2923 *wxTRANSPARENT_BRUSH
);
2924 dc
.DrawRectangle(rect
.Deflate(1, 1));
2927 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2929 const wxSizerItemList
& items
= sizer
->GetChildren();
2930 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2935 wxSizerItem
*item
= *i
;
2936 if ( item
->IsSizer() )
2938 DrawBorder(win
, item
->GetRect().Deflate(2), false, wxRED_PEN
);
2939 DrawSizer(win
, item
->GetSizer());
2941 else if ( item
->IsSpacer() )
2943 DrawBorder(win
, item
->GetRect().Deflate(2), true, wxBLUE_PEN
);
2945 else if ( item
->IsWindow() )
2947 DrawSizers(item
->GetWindow());
2950 wxFAIL_MSG("inconsistent wxSizerItem status!");
2954 static void DrawSizers(wxWindowBase
*win
)
2956 DrawBorder(win
, win
->GetClientSize(), false, wxGREEN_PEN
);
2958 wxSizer
*sizer
= win
->GetSizer();
2961 DrawSizer(win
, sizer
);
2963 else // no sizer, still recurse into the children
2965 const wxWindowList
& children
= win
->GetChildren();
2966 for ( wxWindowList::const_iterator i
= children
.begin(),
2967 end
= children
.end();
2974 // show all kind of sizes of this window; see the "window sizing" topic
2975 // overview for more info about the various differences:
2976 wxSize fullSz
= win
->GetSize();
2977 wxSize clientSz
= win
->GetClientSize();
2978 wxSize bestSz
= win
->GetBestSize();
2979 wxSize minSz
= win
->GetMinSize();
2980 wxSize maxSz
= win
->GetMaxSize();
2981 wxSize virtualSz
= win
->GetVirtualSize();
2983 wxMessageOutputDebug dbgout
;
2985 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
2988 clientSz
.x
, clientSz
.y
,
2992 virtualSz
.x
, virtualSz
.y
);
2996 #endif // wxDEBUG_LEVEL
2998 // process special middle clicks
2999 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
3001 if ( event
.ControlDown() && event
.AltDown() )
3003 #if wxDEBUG_LEVEL > 1
3004 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3005 if ( event
.ShiftDown() )
3010 #endif // __WXDEBUG__
3013 // just Ctrl-Alt-middle click shows information about wx version
3014 ::wxInfoMessageBox((wxWindow
*)this);
3015 #endif // wxUSE_MSGDLG
3024 // ----------------------------------------------------------------------------
3026 // ----------------------------------------------------------------------------
3028 #if wxUSE_ACCESSIBILITY
3029 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
3031 if (m_accessible
&& (accessible
!= m_accessible
))
3032 delete m_accessible
;
3033 m_accessible
= accessible
;
3035 m_accessible
->SetWindow((wxWindow
*) this);
3038 // Returns the accessible object, creating if necessary.
3039 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
3042 m_accessible
= CreateAccessible();
3043 return m_accessible
;
3046 // Override to create a specific accessible object.
3047 wxAccessible
* wxWindowBase::CreateAccessible()
3049 return new wxWindowAccessible((wxWindow
*) this);
3054 // ----------------------------------------------------------------------------
3055 // list classes implementation
3056 // ----------------------------------------------------------------------------
3058 #if wxUSE_STD_CONTAINERS
3060 #include "wx/listimpl.cpp"
3061 WX_DEFINE_LIST(wxWindowList
)
3063 #else // !wxUSE_STD_CONTAINERS
3065 void wxWindowListNode::DeleteData()
3067 delete (wxWindow
*)GetData();
3070 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3072 // ----------------------------------------------------------------------------
3074 // ----------------------------------------------------------------------------
3076 wxBorder
wxWindowBase::GetBorder(long flags
) const
3078 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
3079 if ( border
== wxBORDER_DEFAULT
)
3081 border
= GetDefaultBorder();
3083 else if ( border
== wxBORDER_THEME
)
3085 border
= GetDefaultBorderForControl();
3091 wxBorder
wxWindowBase::GetDefaultBorder() const
3093 return wxBORDER_NONE
;
3096 // ----------------------------------------------------------------------------
3098 // ----------------------------------------------------------------------------
3100 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
3102 // here we just check if the point is inside the window or not
3104 // check the top and left border first
3105 bool outside
= x
< 0 || y
< 0;
3108 // check the right and bottom borders too
3109 wxSize size
= GetSize();
3110 outside
= x
>= size
.x
|| y
>= size
.y
;
3113 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
3116 // ----------------------------------------------------------------------------
3118 // ----------------------------------------------------------------------------
3120 struct WXDLLEXPORT wxWindowNext
3124 } *wxWindowBase::ms_winCaptureNext
= NULL
;
3125 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
3126 bool wxWindowBase::ms_winCaptureChanging
= false;
3128 void wxWindowBase::CaptureMouse()
3130 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3132 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive CaptureMouse call?") );
3134 ms_winCaptureChanging
= true;
3136 wxWindow
*winOld
= GetCapture();
3139 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
3142 wxWindowNext
*item
= new wxWindowNext
;
3144 item
->next
= ms_winCaptureNext
;
3145 ms_winCaptureNext
= item
;
3147 //else: no mouse capture to save
3150 ms_winCaptureCurrent
= (wxWindow
*)this;
3152 ms_winCaptureChanging
= false;
3155 void wxWindowBase::ReleaseMouse()
3157 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3159 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive ReleaseMouse call?") );
3161 wxASSERT_MSG( GetCapture() == this,
3162 "attempt to release mouse, but this window hasn't captured it" );
3163 wxASSERT_MSG( ms_winCaptureCurrent
== this,
3164 "attempt to release mouse, but this window hasn't captured it" );
3166 ms_winCaptureChanging
= true;
3169 ms_winCaptureCurrent
= NULL
;
3171 if ( ms_winCaptureNext
)
3173 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
3174 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
3176 wxWindowNext
*item
= ms_winCaptureNext
;
3177 ms_winCaptureNext
= item
->next
;
3180 //else: stack is empty, no previous capture
3182 ms_winCaptureChanging
= false;
3184 wxLogTrace(wxT("mousecapture"),
3185 (const wxChar
*) wxT("After ReleaseMouse() mouse is captured by %p"),
3186 static_cast<void*>(GetCapture()));
3189 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
3191 wxMouseCaptureLostEvent
event(win
->GetId());
3192 event
.SetEventObject(win
);
3193 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
3195 // windows must handle this event, otherwise the app wouldn't behave
3196 // correctly if it loses capture unexpectedly; see the discussion here:
3197 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3198 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3199 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3204 void wxWindowBase::NotifyCaptureLost()
3206 // don't do anything if capture lost was expected, i.e. resulted from
3207 // a wx call to ReleaseMouse or CaptureMouse:
3208 if ( ms_winCaptureChanging
)
3211 // if the capture was lost unexpectedly, notify every window that has
3212 // capture (on stack or current) about it and clear the stack:
3214 if ( ms_winCaptureCurrent
)
3216 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
3217 ms_winCaptureCurrent
= NULL
;
3220 while ( ms_winCaptureNext
)
3222 wxWindowNext
*item
= ms_winCaptureNext
;
3223 ms_winCaptureNext
= item
->next
;
3225 DoNotifyWindowAboutCaptureLost(item
->win
);
3234 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
3235 int WXUNUSED(modifiers
),
3236 int WXUNUSED(keycode
))
3242 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
3248 #endif // wxUSE_HOTKEY
3250 // ----------------------------------------------------------------------------
3252 // ----------------------------------------------------------------------------
3254 bool wxWindowBase::TryBefore(wxEvent
& event
)
3256 #if wxUSE_VALIDATORS
3257 // Can only use the validator of the window which
3258 // is receiving the event
3259 if ( event
.GetEventObject() == this )
3261 wxValidator
* const validator
= GetValidator();
3262 if ( validator
&& validator
->ProcessEventLocally(event
) )
3267 #endif // wxUSE_VALIDATORS
3269 return wxEvtHandler::TryBefore(event
);
3272 bool wxWindowBase::TryAfter(wxEvent
& event
)
3274 // carry on up the parent-child hierarchy if the propagation count hasn't
3276 if ( event
.ShouldPropagate() )
3278 // honour the requests to stop propagation at this window: this is
3279 // used by the dialogs, for example, to prevent processing the events
3280 // from the dialog controls in the parent frame which rarely, if ever,
3282 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
3284 wxWindow
*parent
= GetParent();
3285 if ( parent
&& !parent
->IsBeingDeleted() )
3287 wxPropagateOnce
propagateOnce(event
);
3289 return parent
->GetEventHandler()->ProcessEvent(event
);
3294 return wxEvtHandler::TryAfter(event
);
3297 // ----------------------------------------------------------------------------
3298 // window relationships
3299 // ----------------------------------------------------------------------------
3301 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
3303 wxCHECK_MSG( GetParent(), NULL
,
3304 wxT("GetPrev/NextSibling() don't work for TLWs!") );
3306 wxWindowList
& siblings
= GetParent()->GetChildren();
3307 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
3308 wxCHECK_MSG( i
, NULL
, wxT("window not a child of its parent?") );
3310 if ( order
== OrderBefore
)
3311 i
= i
->GetPrevious();
3315 return i
? i
->GetData() : NULL
;
3318 // ----------------------------------------------------------------------------
3319 // keyboard navigation
3320 // ----------------------------------------------------------------------------
3322 // Navigates in the specified direction inside this window
3323 bool wxWindowBase::DoNavigateIn(int flags
)
3325 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3326 // native code doesn't process our wxNavigationKeyEvents anyhow
3329 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3330 wxNavigationKeyEvent eventNav
;
3331 wxWindow
*focused
= FindFocus();
3332 eventNav
.SetCurrentFocus(focused
);
3333 eventNav
.SetEventObject(focused
);
3334 eventNav
.SetFlags(flags
);
3335 return GetEventHandler()->ProcessEvent(eventNav
);
3336 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3339 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent
& event
)
3341 if ( event
.GetKeyCode() != WXK_TAB
)
3344 int flags
= wxNavigationKeyEvent::FromTab
;
3346 if ( event
.ShiftDown() )
3347 flags
|= wxNavigationKeyEvent::IsBackward
;
3349 flags
|= wxNavigationKeyEvent::IsForward
;
3351 if ( event
.ControlDown() )
3352 flags
|= wxNavigationKeyEvent::WinChange
;
3358 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
3360 // check that we're not a top level window
3361 wxCHECK_RET( GetParent(),
3362 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3364 // detect the special case when we have nothing to do anyhow and when the
3365 // code below wouldn't work
3369 // find the target window in the siblings list
3370 wxWindowList
& siblings
= GetParent()->GetChildren();
3371 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
3372 wxCHECK_RET( i
, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3374 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3375 // implemented so we can't just move the node around
3376 wxWindow
*self
= (wxWindow
*)this;
3377 siblings
.DeleteObject(self
);
3378 if ( move
== OrderAfter
)
3385 siblings
.Insert(i
, self
);
3387 else // OrderAfter and win was the last sibling
3389 siblings
.Append(self
);
3393 // ----------------------------------------------------------------------------
3395 // ----------------------------------------------------------------------------
3397 /*static*/ wxWindow
* wxWindowBase::FindFocus()
3399 wxWindowBase
*win
= DoFindFocus();
3400 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
3403 bool wxWindowBase::HasFocus() const
3405 wxWindowBase
* const win
= DoFindFocus();
3407 (this == win
|| this == win
->GetMainWindowOfCompositeControl());
3410 // ----------------------------------------------------------------------------
3412 // ----------------------------------------------------------------------------
3414 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3419 class DragAcceptFilesTarget
: public wxFileDropTarget
3422 DragAcceptFilesTarget(wxWindowBase
*win
) : m_win(win
) {}
3424 virtual bool OnDropFiles(wxCoord x
, wxCoord y
,
3425 const wxArrayString
& filenames
)
3427 wxDropFilesEvent
event(wxEVT_DROP_FILES
,
3429 wxCArrayString(filenames
).Release());
3430 event
.SetEventObject(m_win
);
3434 return m_win
->HandleWindowEvent(event
);
3438 wxWindowBase
* const m_win
;
3440 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget
);
3444 } // anonymous namespace
3446 // Generic version of DragAcceptFiles(). It works by installing a simple
3447 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3448 // together with explicit SetDropTarget() calls.
3449 void wxWindowBase::DragAcceptFiles(bool accept
)
3453 wxASSERT_MSG( !GetDropTarget(),
3454 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3455 SetDropTarget(new DragAcceptFilesTarget(this));
3459 SetDropTarget(NULL
);
3463 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3465 // ----------------------------------------------------------------------------
3467 // ----------------------------------------------------------------------------
3469 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
3471 while ( win
&& !win
->IsTopLevel() )
3472 win
= win
->GetParent();
3477 #if wxUSE_ACCESSIBILITY
3478 // ----------------------------------------------------------------------------
3479 // accessible object for windows
3480 // ----------------------------------------------------------------------------
3482 // Can return either a child object, or an integer
3483 // representing the child element, starting from 1.
3484 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
3486 wxASSERT( GetWindow() != NULL
);
3490 return wxACC_NOT_IMPLEMENTED
;
3493 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3494 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
3496 wxASSERT( GetWindow() != NULL
);
3500 wxWindow
* win
= NULL
;
3507 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
3509 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
3516 rect
= win
->GetRect();
3517 if (win
->GetParent() && !wxDynamicCast(win
, wxTopLevelWindow
))
3518 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
3522 return wxACC_NOT_IMPLEMENTED
;
3525 // Navigates from fromId to toId/toObject.
3526 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
3527 int* WXUNUSED(toId
), wxAccessible
** toObject
)
3529 wxASSERT( GetWindow() != NULL
);
3535 case wxNAVDIR_FIRSTCHILD
:
3537 if (GetWindow()->GetChildren().GetCount() == 0)
3539 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
3540 *toObject
= childWindow
->GetOrCreateAccessible();
3544 case wxNAVDIR_LASTCHILD
:
3546 if (GetWindow()->GetChildren().GetCount() == 0)
3548 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
3549 *toObject
= childWindow
->GetOrCreateAccessible();
3553 case wxNAVDIR_RIGHT
:
3557 wxWindowList::compatibility_iterator node
=
3558 wxWindowList::compatibility_iterator();
3561 // Can't navigate to sibling of this window
3562 // if we're a top-level window.
3563 if (!GetWindow()->GetParent())
3564 return wxACC_NOT_IMPLEMENTED
;
3566 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3570 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3571 node
= GetWindow()->GetChildren().Item(fromId
-1);
3574 if (node
&& node
->GetNext())
3576 wxWindow
* nextWindow
= node
->GetNext()->GetData();
3577 *toObject
= nextWindow
->GetOrCreateAccessible();
3585 case wxNAVDIR_PREVIOUS
:
3587 wxWindowList::compatibility_iterator node
=
3588 wxWindowList::compatibility_iterator();
3591 // Can't navigate to sibling of this window
3592 // if we're a top-level window.
3593 if (!GetWindow()->GetParent())
3594 return wxACC_NOT_IMPLEMENTED
;
3596 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3600 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3601 node
= GetWindow()->GetChildren().Item(fromId
-1);
3604 if (node
&& node
->GetPrevious())
3606 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
3607 *toObject
= previousWindow
->GetOrCreateAccessible();
3615 return wxACC_NOT_IMPLEMENTED
;
3618 // Gets the name of the specified object.
3619 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
3621 wxASSERT( GetWindow() != NULL
);
3627 // If a child, leave wxWidgets to call the function on the actual
3630 return wxACC_NOT_IMPLEMENTED
;
3632 // This will eventually be replaced by specialised
3633 // accessible classes, one for each kind of wxWidgets
3634 // control or window.
3636 if (wxDynamicCast(GetWindow(), wxButton
))
3637 title
= ((wxButton
*) GetWindow())->GetLabel();
3640 title
= GetWindow()->GetName();
3648 return wxACC_NOT_IMPLEMENTED
;
3651 // Gets the number of children.
3652 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
3654 wxASSERT( GetWindow() != NULL
);
3658 *childId
= (int) GetWindow()->GetChildren().GetCount();
3662 // Gets the specified child (starting from 1).
3663 // If *child is NULL and return value is wxACC_OK,
3664 // this means that the child is a simple element and
3665 // not an accessible object.
3666 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
3668 wxASSERT( GetWindow() != NULL
);
3678 if (childId
> (int) GetWindow()->GetChildren().GetCount())
3681 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
3682 *child
= childWindow
->GetOrCreateAccessible();
3689 // Gets the parent, or NULL.
3690 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
3692 wxASSERT( GetWindow() != NULL
);
3696 wxWindow
* parentWindow
= GetWindow()->GetParent();
3704 *parent
= parentWindow
->GetOrCreateAccessible();
3712 // Performs the default action. childId is 0 (the action for this object)
3713 // or > 0 (the action for a child).
3714 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3715 // window (e.g. an edit control).
3716 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
3718 wxASSERT( GetWindow() != NULL
);
3722 return wxACC_NOT_IMPLEMENTED
;
3725 // Gets the default action for this object (0) or > 0 (the action for a child).
3726 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3727 // string if there is no action.
3728 // The retrieved string describes the action that is performed on an object,
3729 // not what the object does as a result. For example, a toolbar button that prints
3730 // a document has a default action of "Press" rather than "Prints the current document."
3731 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
3733 wxASSERT( GetWindow() != NULL
);
3737 return wxACC_NOT_IMPLEMENTED
;
3740 // Returns the description for this object or a child.
3741 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3743 wxASSERT( GetWindow() != NULL
);
3747 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3753 return wxACC_NOT_IMPLEMENTED
;
3756 // Returns help text for this object or a child, similar to tooltip text.
3757 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3759 wxASSERT( GetWindow() != NULL
);
3763 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3769 return wxACC_NOT_IMPLEMENTED
;
3772 // Returns the keyboard shortcut for this object or child.
3773 // Return e.g. ALT+K
3774 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3776 wxASSERT( GetWindow() != NULL
);
3780 return wxACC_NOT_IMPLEMENTED
;
3783 // Returns a role constant.
3784 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3786 wxASSERT( GetWindow() != NULL
);
3790 // If a child, leave wxWidgets to call the function on the actual
3793 return wxACC_NOT_IMPLEMENTED
;
3795 if (wxDynamicCast(GetWindow(), wxControl
))
3796 return wxACC_NOT_IMPLEMENTED
;
3798 if (wxDynamicCast(GetWindow(), wxStatusBar
))
3799 return wxACC_NOT_IMPLEMENTED
;
3802 if (wxDynamicCast(GetWindow(), wxToolBar
))
3803 return wxACC_NOT_IMPLEMENTED
;
3806 //*role = wxROLE_SYSTEM_CLIENT;
3807 *role
= wxROLE_SYSTEM_CLIENT
;
3811 return wxACC_NOT_IMPLEMENTED
;
3815 // Returns a state constant.
3816 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3818 wxASSERT( GetWindow() != NULL
);
3822 // If a child, leave wxWidgets to call the function on the actual
3825 return wxACC_NOT_IMPLEMENTED
;
3827 if (wxDynamicCast(GetWindow(), wxControl
))
3828 return wxACC_NOT_IMPLEMENTED
;
3831 if (wxDynamicCast(GetWindow(), wxStatusBar
))
3832 return wxACC_NOT_IMPLEMENTED
;
3835 if (wxDynamicCast(GetWindow(), wxToolBar
))
3836 return wxACC_NOT_IMPLEMENTED
;
3843 return wxACC_NOT_IMPLEMENTED
;
3847 // Returns a localized string representing the value for the object
3849 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3851 wxASSERT( GetWindow() != NULL
);
3855 return wxACC_NOT_IMPLEMENTED
;
3858 // Selects the object or child.
3859 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3861 wxASSERT( GetWindow() != NULL
);
3865 return wxACC_NOT_IMPLEMENTED
;
3868 // Gets the window with the keyboard focus.
3869 // If childId is 0 and child is NULL, no object in
3870 // this subhierarchy has the focus.
3871 // If this object has the focus, child should be 'this'.
3872 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3874 wxASSERT( GetWindow() != NULL
);
3878 return wxACC_NOT_IMPLEMENTED
;
3882 // Gets a variant representing the selected children
3884 // Acceptable values:
3885 // - a null variant (IsNull() returns true)
3886 // - a list variant (GetType() == wxT("list")
3887 // - an integer representing the selected child element,
3888 // or 0 if this object is selected (GetType() == wxT("long")
3889 // - a "void*" pointer to a wxAccessible child object
3890 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3892 wxASSERT( GetWindow() != NULL
);
3896 return wxACC_NOT_IMPLEMENTED
;
3898 #endif // wxUSE_VARIANT
3900 #endif // wxUSE_ACCESSIBILITY
3902 // ----------------------------------------------------------------------------
3904 // ----------------------------------------------------------------------------
3907 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3909 wxCoord widthTotal
) const
3911 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3913 x
= widthTotal
- x
- width
;