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 if ( !GetChildren().empty() )
625 SetSize(GetBestSize());
627 //else: do nothing if we have no children
630 // fits virtual size (ie. scrolled area etc.) around children
631 void wxWindowBase::FitInside()
633 if ( GetChildren().GetCount() > 0 )
635 SetVirtualSize( GetBestVirtualSize() );
639 // On Mac, scrollbars are explicitly children.
640 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
641 static bool wxHasRealChildren(const wxWindowBase
* win
)
643 int realChildCount
= 0;
645 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
647 node
= node
->GetNext() )
649 wxWindow
*win
= node
->GetData();
650 if ( !win
->IsTopLevel() && win
->IsShown()
652 && !win
->IsKindOf(CLASSINFO(wxScrollBar
))
657 return (realChildCount
> 0);
661 void wxWindowBase::InvalidateBestSize()
663 m_bestSizeCache
= wxDefaultSize
;
665 // parent's best size calculation may depend on its children's
666 // as long as child window we are in is not top level window itself
667 // (because the TLW size is never resized automatically)
668 // so let's invalidate it as well to be safe:
669 if (m_parent
&& !IsTopLevel())
670 m_parent
->InvalidateBestSize();
673 // return the size best suited for the current window
674 wxSize
wxWindowBase::DoGetBestSize() const
680 best
= m_windowSizer
->GetMinSize();
682 #if wxUSE_CONSTRAINTS
683 else if ( m_constraints
)
685 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
687 // our minimal acceptable size is such that all our windows fit inside
691 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
693 node
= node
->GetNext() )
695 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
698 // it's not normal that we have an unconstrained child, but
699 // what can we do about it?
703 int x
= c
->right
.GetValue(),
704 y
= c
->bottom
.GetValue();
712 // TODO: we must calculate the overlaps somehow, otherwise we
713 // will never return a size bigger than the current one :-(
716 best
= wxSize(maxX
, maxY
);
718 #endif // wxUSE_CONSTRAINTS
719 else if ( !GetChildren().empty()
720 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
721 && wxHasRealChildren(this)
725 // our minimal acceptable size is such that all our visible child
726 // windows fit inside
730 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
732 node
= node
->GetNext() )
734 wxWindow
*win
= node
->GetData();
735 if ( win
->IsTopLevel()
738 || wxDynamicCast(win
, wxStatusBar
)
739 #endif // wxUSE_STATUSBAR
742 // dialogs and frames lie in different top level windows -
743 // don't deal with them here; as for the status bars, they
744 // don't lie in the client area at all
749 win
->GetPosition(&wx
, &wy
);
751 // if the window hadn't been positioned yet, assume that it is in
753 if ( wx
== wxDefaultCoord
)
755 if ( wy
== wxDefaultCoord
)
758 win
->GetSize(&ww
, &wh
);
759 if ( wx
+ ww
> maxX
)
761 if ( wy
+ wh
> maxY
)
765 best
= wxSize(maxX
, maxY
);
767 else // ! has children
769 wxSize size
= GetMinSize();
770 if ( !size
.IsFullySpecified() )
772 // if the window doesn't define its best size we assume that it can
773 // be arbitrarily small -- usually this is not the case, of course,
774 // but we have no way to know what the limit is, it should really
775 // override DoGetBestClientSize() itself to tell us
776 size
.SetDefaults(wxSize(1, 1));
779 // return as-is, unadjusted by the client size difference.
783 // Add any difference between size and client size
784 wxSize diff
= GetSize() - GetClientSize();
785 best
.x
+= wxMax(0, diff
.x
);
786 best
.y
+= wxMax(0, diff
.y
);
791 // helper of GetWindowBorderSize(): as many ports don't implement support for
792 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
793 // fallbacks in this case
794 static int wxGetMetricOrDefault(wxSystemMetric what
, const wxWindowBase
* win
)
796 int rc
= wxSystemSettings::GetMetric(
797 what
, static_cast<wxWindow
*>(const_cast<wxWindowBase
*>(win
)));
804 // 2D border is by default 1 pixel wide
810 // 3D borders are by default 2 pixels
815 wxFAIL_MSG( wxT("unexpected wxGetMetricOrDefault() argument") );
823 wxSize
wxWindowBase::GetWindowBorderSize() const
827 switch ( GetBorder() )
830 // nothing to do, size is already (0, 0)
833 case wxBORDER_SIMPLE
:
834 case wxBORDER_STATIC
:
835 size
.x
= wxGetMetricOrDefault(wxSYS_BORDER_X
, this);
836 size
.y
= wxGetMetricOrDefault(wxSYS_BORDER_Y
, this);
839 case wxBORDER_SUNKEN
:
840 case wxBORDER_RAISED
:
841 size
.x
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X
, this),
842 wxGetMetricOrDefault(wxSYS_BORDER_X
, this));
843 size
.y
= wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y
, this),
844 wxGetMetricOrDefault(wxSYS_BORDER_Y
, this));
847 case wxBORDER_DOUBLE
:
848 size
.x
= wxGetMetricOrDefault(wxSYS_EDGE_X
, this) +
849 wxGetMetricOrDefault(wxSYS_BORDER_X
, this);
850 size
.y
= wxGetMetricOrDefault(wxSYS_EDGE_Y
, this) +
851 wxGetMetricOrDefault(wxSYS_BORDER_Y
, this);
855 wxFAIL_MSG(wxT("Unknown border style."));
859 // we have borders on both sides
864 wxWindowBase::InformFirstDirection(int direction
,
866 int availableOtherDir
)
868 return GetSizer() && GetSizer()->InformFirstDirection(direction
,
873 wxSize
wxWindowBase::GetEffectiveMinSize() const
875 // merge the best size with the min size, giving priority to the min size
876 wxSize min
= GetMinSize();
878 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
880 wxSize best
= GetBestSize();
881 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
882 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
888 wxSize
wxWindowBase::DoGetBorderSize() const
890 // there is one case in which we can implement it for all ports easily
891 if ( GetBorder() == wxBORDER_NONE
)
894 // otherwise use the difference between the real size and the client size
895 // as a fallback: notice that this is incorrect in general as client size
896 // also doesn't take the scrollbars into account
897 return GetSize() - GetClientSize();
900 wxSize
wxWindowBase::GetBestSize() const
902 if ( !m_windowSizer
&& m_bestSizeCache
.IsFullySpecified() )
903 return m_bestSizeCache
;
905 // call DoGetBestClientSize() first, if a derived class overrides it wants
907 wxSize size
= DoGetBestClientSize();
908 if ( size
!= wxDefaultSize
)
910 size
+= DoGetBorderSize();
916 return DoGetBestSize();
919 int wxWindowBase::GetBestHeight(int width
) const
921 const int height
= DoGetBestClientHeight(width
);
923 return height
== wxDefaultCoord
925 : height
+ DoGetBorderSize().y
;
928 int wxWindowBase::GetBestWidth(int height
) const
930 const int width
= DoGetBestClientWidth(height
);
932 return width
== wxDefaultCoord
934 : width
+ DoGetBorderSize().x
;
937 void wxWindowBase::SetMinSize(const wxSize
& minSize
)
939 m_minWidth
= minSize
.x
;
940 m_minHeight
= minSize
.y
;
943 void wxWindowBase::SetMaxSize(const wxSize
& maxSize
)
945 m_maxWidth
= maxSize
.x
;
946 m_maxHeight
= maxSize
.y
;
949 void wxWindowBase::SetInitialSize(const wxSize
& size
)
951 // Set the min size to the size passed in. This will usually either be
952 // wxDefaultSize or the size passed to this window's ctor/Create function.
955 // Merge the size with the best size if needed
956 wxSize best
= GetEffectiveMinSize();
958 // If the current size doesn't match then change it
959 if (GetSize() != best
)
964 // by default the origin is not shifted
965 wxPoint
wxWindowBase::GetClientAreaOrigin() const
970 wxSize
wxWindowBase::ClientToWindowSize(const wxSize
& size
) const
972 const wxSize
diff(GetSize() - GetClientSize());
974 return wxSize(size
.x
== -1 ? -1 : size
.x
+ diff
.x
,
975 size
.y
== -1 ? -1 : size
.y
+ diff
.y
);
978 wxSize
wxWindowBase::WindowToClientSize(const wxSize
& size
) const
980 const wxSize
diff(GetSize() - GetClientSize());
982 return wxSize(size
.x
== -1 ? -1 : size
.x
- diff
.x
,
983 size
.y
== -1 ? -1 : size
.y
- diff
.y
);
986 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
988 if ( m_windowVariant
!= variant
)
990 m_windowVariant
= variant
;
992 DoSetWindowVariant(variant
);
996 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
998 // adjust the font height to correspond to our new variant (notice that
999 // we're only called if something really changed)
1000 wxFont font
= GetFont();
1001 int size
= font
.GetPointSize();
1004 case wxWINDOW_VARIANT_NORMAL
:
1007 case wxWINDOW_VARIANT_SMALL
:
1008 size
= wxRound(size
* 3.0 / 4.0);
1011 case wxWINDOW_VARIANT_MINI
:
1012 size
= wxRound(size
* 2.0 / 3.0);
1015 case wxWINDOW_VARIANT_LARGE
:
1016 size
= wxRound(size
* 5.0 / 4.0);
1020 wxFAIL_MSG(wxT("unexpected window variant"));
1024 font
.SetPointSize(size
);
1028 void wxWindowBase::DoSetSizeHints( int minW
, int minH
,
1030 int WXUNUSED(incW
), int WXUNUSED(incH
) )
1032 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
1033 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
1034 wxT("min width/height must be less than max width/height!") );
1043 #if WXWIN_COMPATIBILITY_2_8
1044 void wxWindowBase::SetVirtualSizeHints(int WXUNUSED(minW
), int WXUNUSED(minH
),
1045 int WXUNUSED(maxW
), int WXUNUSED(maxH
))
1049 void wxWindowBase::SetVirtualSizeHints(const wxSize
& WXUNUSED(minsize
),
1050 const wxSize
& WXUNUSED(maxsize
))
1053 #endif // WXWIN_COMPATIBILITY_2_8
1055 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
1057 m_virtualSize
= wxSize(x
, y
);
1060 wxSize
wxWindowBase::DoGetVirtualSize() const
1062 // we should use the entire client area so if it is greater than our
1063 // virtual size, expand it to fit (otherwise if the window is big enough we
1064 // wouldn't be using parts of it)
1065 wxSize size
= GetClientSize();
1066 if ( m_virtualSize
.x
> size
.x
)
1067 size
.x
= m_virtualSize
.x
;
1069 if ( m_virtualSize
.y
>= size
.y
)
1070 size
.y
= m_virtualSize
.y
;
1075 void wxWindowBase::DoGetScreenPosition(int *x
, int *y
) const
1077 // screen position is the same as (0, 0) in client coords for non TLWs (and
1078 // TLWs override this method)
1084 ClientToScreen(x
, y
);
1087 void wxWindowBase::SendSizeEvent(int flags
)
1089 wxSizeEvent
event(GetSize(), GetId());
1090 event
.SetEventObject(this);
1091 if ( flags
& wxSEND_EVENT_POST
)
1092 wxPostEvent(GetEventHandler(), event
);
1094 HandleWindowEvent(event
);
1097 void wxWindowBase::SendSizeEventToParent(int flags
)
1099 wxWindow
* const parent
= GetParent();
1100 if ( parent
&& !parent
->IsBeingDeleted() )
1101 parent
->SendSizeEvent(flags
);
1104 bool wxWindowBase::HasScrollbar(int orient
) const
1106 // if scrolling in the given direction is disabled, we can't have the
1107 // corresponding scrollbar no matter what
1108 if ( !CanScroll(orient
) )
1111 const wxSize sizeVirt
= GetVirtualSize();
1112 const wxSize sizeClient
= GetClientSize();
1114 return orient
== wxHORIZONTAL
? sizeVirt
.x
> sizeClient
.x
1115 : sizeVirt
.y
> sizeClient
.y
;
1118 // ----------------------------------------------------------------------------
1119 // show/hide/enable/disable the window
1120 // ----------------------------------------------------------------------------
1122 bool wxWindowBase::Show(bool show
)
1124 if ( show
!= m_isShown
)
1136 bool wxWindowBase::IsEnabled() const
1138 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
1141 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled
)
1143 // Under some platforms there is no need to update the window state
1144 // explicitly, it will become disabled when its parent is. On other ones we
1145 // do need to disable all windows recursively though.
1146 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
1148 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1152 // Disabling a top level window is typically done when showing a modal
1153 // dialog and we don't need to disable its children in this case, they will
1154 // be logically disabled anyhow (i.e. their IsEnabled() will return false)
1155 // and the TLW won't accept any input for them. Moreover, explicitly
1156 // disabling them would look ugly as the entire TLW would be greyed out
1157 // whenever a modal dialog is shown and no native applications under any
1158 // platform behave like this.
1159 if ( IsTopLevel() && !enabled
)
1162 // When disabling (or enabling back) a non-TLW window we need to
1163 // recursively propagate the change of the state to its children, otherwise
1164 // they would still show as enabled even though they wouldn't actually
1165 // accept any input (at least under MSW where children don't accept input
1166 // if any of the windows in their parent chain is enabled).
1168 // Notice that we must do this even for wxHAS_NATIVE_ENABLED_MANAGEMENT
1169 // platforms as we still need to call the children OnEnabled() recursively.
1170 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1172 node
= node
->GetNext() )
1174 wxWindowBase
* const child
= node
->GetData();
1175 if ( !child
->IsTopLevel() && child
->IsThisEnabled() )
1176 child
->NotifyWindowOnEnableChange(enabled
);
1180 bool wxWindowBase::Enable(bool enable
)
1182 if ( enable
== IsThisEnabled() )
1185 m_isEnabled
= enable
;
1187 // If we call DoEnable() from NotifyWindowOnEnableChange(), we don't need
1188 // to do it from here.
1189 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
1191 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1193 NotifyWindowOnEnableChange(enable
);
1198 bool wxWindowBase::IsShownOnScreen() const
1200 // A window is shown on screen if it itself is shown and so are all its
1201 // parents. But if a window is toplevel one, then its always visible on
1202 // screen if IsShown() returns true, even if it has a hidden parent.
1204 (IsTopLevel() || GetParent() == NULL
|| GetParent()->IsShownOnScreen());
1207 // ----------------------------------------------------------------------------
1209 // ----------------------------------------------------------------------------
1211 bool wxWindowBase::IsTopLevel() const
1216 // ----------------------------------------------------------------------------
1218 // ----------------------------------------------------------------------------
1220 void wxWindowBase::Freeze()
1222 if ( !m_freezeCount
++ )
1224 // physically freeze this window:
1227 // and recursively freeze all children:
1228 for ( wxWindowList::iterator i
= GetChildren().begin();
1229 i
!= GetChildren().end(); ++i
)
1231 wxWindow
*child
= *i
;
1232 if ( child
->IsTopLevel() )
1240 void wxWindowBase::Thaw()
1242 wxASSERT_MSG( m_freezeCount
, "Thaw() without matching Freeze()" );
1244 if ( !--m_freezeCount
)
1246 // recursively thaw all children:
1247 for ( wxWindowList::iterator i
= GetChildren().begin();
1248 i
!= GetChildren().end(); ++i
)
1250 wxWindow
*child
= *i
;
1251 if ( child
->IsTopLevel() )
1257 // physically thaw this window:
1262 // ----------------------------------------------------------------------------
1263 // Dealing with parents and children.
1264 // ----------------------------------------------------------------------------
1266 bool wxWindowBase::IsDescendant(wxWindowBase
* win
) const
1268 // Iterate until we find this window in the parent chain or exhaust it.
1271 wxWindow
* const parent
= win
->GetParent();
1272 if ( parent
== this )
1275 // Stop iterating on reaching the top level window boundary.
1276 if ( parent
->IsTopLevel() )
1285 void wxWindowBase::AddChild(wxWindowBase
*child
)
1287 wxCHECK_RET( child
, wxT("can't add a NULL child") );
1289 // this should never happen and it will lead to a crash later if it does
1290 // because RemoveChild() will remove only one node from the children list
1291 // and the other(s) one(s) will be left with dangling pointers in them
1292 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), wxT("AddChild() called twice") );
1294 GetChildren().Append((wxWindow
*)child
);
1295 child
->SetParent(this);
1297 // adding a child while frozen will assert when thawed, so freeze it as if
1298 // it had been already present when we were frozen
1299 if ( IsFrozen() && !child
->IsTopLevel() )
1303 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
1305 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
1307 // removing a child while frozen may result in permanently frozen window
1308 // if used e.g. from Reparent(), so thaw it
1310 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1311 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1312 if ( IsFrozen() && !child
->IsBeingDeleted() && !child
->IsTopLevel() )
1315 GetChildren().DeleteObject((wxWindow
*)child
);
1316 child
->SetParent(NULL
);
1319 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
1321 wxWindow
*oldParent
= GetParent();
1322 if ( newParent
== oldParent
)
1328 const bool oldEnabledState
= IsEnabled();
1330 // unlink this window from the existing parent.
1333 oldParent
->RemoveChild(this);
1337 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
1340 // add it to the new one
1343 newParent
->AddChild(this);
1347 wxTopLevelWindows
.Append((wxWindow
*)this);
1350 // We need to notify window (and its subwindows) if by changing the parent
1351 // we also change our enabled/disabled status.
1352 const bool newEnabledState
= IsEnabled();
1353 if ( newEnabledState
!= oldEnabledState
)
1355 NotifyWindowOnEnableChange(newEnabledState
);
1361 // ----------------------------------------------------------------------------
1362 // event handler stuff
1363 // ----------------------------------------------------------------------------
1365 void wxWindowBase::SetEventHandler(wxEvtHandler
*handler
)
1367 wxCHECK_RET(handler
!= NULL
, "SetEventHandler(NULL) called");
1369 m_eventHandler
= handler
;
1372 void wxWindowBase::SetNextHandler(wxEvtHandler
*WXUNUSED(handler
))
1374 // disable wxEvtHandler chain mechanism for wxWindows:
1375 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1377 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1379 void wxWindowBase::SetPreviousHandler(wxEvtHandler
*WXUNUSED(handler
))
1381 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1382 // handler of our stack when is destroyed will be Unlink()ed and thus
1383 // will call this function to update the pointer of this window...
1385 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1388 void wxWindowBase::PushEventHandler(wxEvtHandler
*handlerToPush
)
1390 wxCHECK_RET( handlerToPush
!= NULL
, "PushEventHandler(NULL) called" );
1392 // the new handler is going to be part of the wxWindow stack of event handlers:
1393 // it can't be part also of an event handler double-linked chain:
1394 wxASSERT_MSG(handlerToPush
->IsUnlinked(),
1395 "The handler being pushed in the wxWindow stack shouldn't be part of "
1396 "a wxEvtHandler chain; call Unlink() on it first");
1398 wxEvtHandler
*handlerOld
= GetEventHandler();
1399 wxCHECK_RET( handlerOld
, "an old event handler is NULL?" );
1401 // now use wxEvtHandler double-linked list to implement a stack:
1402 handlerToPush
->SetNextHandler(handlerOld
);
1404 if (handlerOld
!= this)
1405 handlerOld
->SetPreviousHandler(handlerToPush
);
1407 SetEventHandler(handlerToPush
);
1410 // final checks of the operations done above:
1411 wxASSERT_MSG( handlerToPush
->GetPreviousHandler() == NULL
,
1412 "the first handler of the wxWindow stack should "
1413 "have no previous handlers set" );
1414 wxASSERT_MSG( handlerToPush
->GetNextHandler() != NULL
,
1415 "the first handler of the wxWindow stack should "
1416 "have non-NULL next handler" );
1418 wxEvtHandler
* pLast
= handlerToPush
;
1419 while ( pLast
&& pLast
!= this )
1420 pLast
= pLast
->GetNextHandler();
1421 wxASSERT_MSG( pLast
->GetNextHandler() == NULL
,
1422 "the last handler of the wxWindow stack should "
1423 "have this window as next handler" );
1424 #endif // wxDEBUG_LEVEL
1427 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
1429 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
1431 wxEvtHandler
*firstHandler
= GetEventHandler();
1432 wxCHECK_MSG( firstHandler
!= NULL
, NULL
, "wxWindow cannot have a NULL event handler" );
1433 wxCHECK_MSG( firstHandler
!= this, NULL
, "cannot pop the wxWindow itself" );
1434 wxCHECK_MSG( firstHandler
->GetPreviousHandler() == NULL
, NULL
,
1435 "the first handler of the wxWindow stack should have no previous handlers set" );
1437 wxEvtHandler
*secondHandler
= firstHandler
->GetNextHandler();
1438 wxCHECK_MSG( secondHandler
!= NULL
, NULL
,
1439 "the first handler of the wxWindow stack should have non-NULL next handler" );
1441 firstHandler
->SetNextHandler(NULL
);
1442 secondHandler
->SetPreviousHandler(NULL
);
1444 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1445 SetEventHandler(secondHandler
);
1447 if ( deleteHandler
)
1449 wxDELETE(firstHandler
);
1452 return firstHandler
;
1455 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handlerToRemove
)
1457 wxCHECK_MSG( handlerToRemove
!= NULL
, false, "RemoveEventHandler(NULL) called" );
1458 wxCHECK_MSG( handlerToRemove
!= this, false, "Cannot remove the window itself" );
1460 if (handlerToRemove
== GetEventHandler())
1462 // removing the first event handler is equivalent to "popping" the stack
1463 PopEventHandler(false);
1467 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1468 wxEvtHandler
*handlerCur
= GetEventHandler()->GetNextHandler();
1469 while ( handlerCur
!= this && handlerCur
)
1471 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1473 if ( handlerCur
== handlerToRemove
)
1475 handlerCur
->Unlink();
1477 wxASSERT_MSG( handlerCur
!= GetEventHandler(),
1478 "the case Remove == Pop should was already handled" );
1482 handlerCur
= handlerNext
;
1485 wxFAIL_MSG( wxT("where has the event handler gone?") );
1490 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1492 // SafelyProcessEvent() will handle exceptions nicely
1493 return GetEventHandler()->SafelyProcessEvent(event
);
1496 // ----------------------------------------------------------------------------
1497 // colours, fonts &c
1498 // ----------------------------------------------------------------------------
1500 void wxWindowBase::InheritAttributes()
1502 const wxWindowBase
* const parent
= GetParent();
1506 // we only inherit attributes which had been explicitly set for the parent
1507 // which ensures that this only happens if the user really wants it and
1508 // not by default which wouldn't make any sense in modern GUIs where the
1509 // controls don't all use the same fonts (nor colours)
1510 if ( parent
->m_inheritFont
&& !m_hasFont
)
1511 SetFont(parent
->GetFont());
1513 // in addition, there is a possibility to explicitly forbid inheriting
1514 // colours at each class level by overriding ShouldInheritColours()
1515 if ( ShouldInheritColours() )
1517 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1518 SetForegroundColour(parent
->GetForegroundColour());
1520 // inheriting (solid) background colour is wrong as it totally breaks
1521 // any kind of themed backgrounds
1523 // instead, the controls should use the same background as their parent
1524 // (ideally by not drawing it at all)
1526 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1527 SetBackgroundColour(parent
->GetBackgroundColour());
1532 /* static */ wxVisualAttributes
1533 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1535 // it is important to return valid values for all attributes from here,
1536 // GetXXX() below rely on this
1537 wxVisualAttributes attrs
;
1538 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1539 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1541 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1542 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1543 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1544 // colour on other platforms.
1546 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1547 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1549 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1554 wxColour
wxWindowBase::GetBackgroundColour() const
1556 if ( !m_backgroundColour
.IsOk() )
1558 wxASSERT_MSG( !m_hasBgCol
, wxT("we have invalid explicit bg colour?") );
1560 // get our default background colour
1561 wxColour colBg
= GetDefaultAttributes().colBg
;
1563 // we must return some valid colour to avoid redoing this every time
1564 // and also to avoid surprising the applications written for older
1565 // wxWidgets versions where GetBackgroundColour() always returned
1566 // something -- so give them something even if it doesn't make sense
1567 // for this window (e.g. it has a themed background)
1568 if ( !colBg
.IsOk() )
1569 colBg
= GetClassDefaultAttributes().colBg
;
1574 return m_backgroundColour
;
1577 wxColour
wxWindowBase::GetForegroundColour() const
1579 // logic is the same as above
1580 if ( !m_hasFgCol
&& !m_foregroundColour
.IsOk() )
1582 wxColour colFg
= GetDefaultAttributes().colFg
;
1584 if ( !colFg
.IsOk() )
1585 colFg
= GetClassDefaultAttributes().colFg
;
1590 return m_foregroundColour
;
1593 bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style
)
1595 // The checks below shouldn't be triggered if we're not really changing the
1597 if ( style
== m_backgroundStyle
)
1600 // Transparent background style can be only set before creation because of
1601 // wxGTK limitation.
1602 wxCHECK_MSG( (style
!= wxBG_STYLE_TRANSPARENT
) || !GetHandle(),
1604 "wxBG_STYLE_TRANSPARENT style can only be set before "
1605 "Create()-ing the window." );
1607 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1608 wxCHECK_MSG( (m_backgroundStyle
!= wxBG_STYLE_TRANSPARENT
) ||
1609 (style
== wxBG_STYLE_TRANSPARENT
),
1611 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1613 m_backgroundStyle
= style
;
1618 bool wxWindowBase::IsTransparentBackgroundSupported(wxString
*reason
) const
1621 *reason
= _("This platform does not support background transparency.");
1626 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1628 if ( colour
== m_backgroundColour
)
1631 m_hasBgCol
= colour
.IsOk();
1633 m_inheritBgCol
= m_hasBgCol
;
1634 m_backgroundColour
= colour
;
1635 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.IsOk() );
1639 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1641 if (colour
== m_foregroundColour
)
1644 m_hasFgCol
= colour
.IsOk();
1645 m_inheritFgCol
= m_hasFgCol
;
1646 m_foregroundColour
= colour
;
1647 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.IsOk() );
1651 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1653 // setting an invalid cursor is ok, it means that we don't have any special
1655 if ( m_cursor
.IsSameAs(cursor
) )
1666 wxFont
wxWindowBase::GetFont() const
1668 // logic is the same as in GetBackgroundColour()
1669 if ( !m_font
.IsOk() )
1671 wxASSERT_MSG( !m_hasFont
, wxT("we have invalid explicit font?") );
1673 wxFont font
= GetDefaultAttributes().font
;
1675 font
= GetClassDefaultAttributes().font
;
1683 bool wxWindowBase::SetFont(const wxFont
& font
)
1685 if ( font
== m_font
)
1692 m_hasFont
= font
.IsOk();
1693 m_inheritFont
= m_hasFont
;
1695 InvalidateBestSize();
1702 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1704 m_hasCustomPalette
= true;
1707 // VZ: can anyone explain me what do we do here?
1708 wxWindowDC
d((wxWindow
*) this);
1712 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1714 wxWindow
*win
= (wxWindow
*)this;
1715 while ( win
&& !win
->HasCustomPalette() )
1717 win
= win
->GetParent();
1723 #endif // wxUSE_PALETTE
1726 void wxWindowBase::SetCaret(wxCaret
*caret
)
1737 wxASSERT_MSG( m_caret
->GetWindow() == this,
1738 wxT("caret should be created associated to this window") );
1741 #endif // wxUSE_CARET
1743 #if wxUSE_VALIDATORS
1744 // ----------------------------------------------------------------------------
1746 // ----------------------------------------------------------------------------
1748 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1750 if ( m_windowValidator
)
1751 delete m_windowValidator
;
1753 m_windowValidator
= (wxValidator
*)validator
.Clone();
1755 if ( m_windowValidator
)
1756 m_windowValidator
->SetWindow(this);
1758 #endif // wxUSE_VALIDATORS
1760 // ----------------------------------------------------------------------------
1761 // update region stuff
1762 // ----------------------------------------------------------------------------
1764 wxRect
wxWindowBase::GetUpdateClientRect() const
1766 wxRegion rgnUpdate
= GetUpdateRegion();
1767 rgnUpdate
.Intersect(GetClientRect());
1768 wxRect rectUpdate
= rgnUpdate
.GetBox();
1769 wxPoint ptOrigin
= GetClientAreaOrigin();
1770 rectUpdate
.x
-= ptOrigin
.x
;
1771 rectUpdate
.y
-= ptOrigin
.y
;
1776 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1778 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1781 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1783 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1786 void wxWindowBase::ClearBackground()
1788 // wxGTK uses its own version, no need to add never used code
1790 wxClientDC
dc((wxWindow
*)this);
1791 wxBrush
brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID
);
1792 dc
.SetBackground(brush
);
1797 // ----------------------------------------------------------------------------
1798 // find child window by id or name
1799 // ----------------------------------------------------------------------------
1801 wxWindow
*wxWindowBase::FindWindow(long id
) const
1803 if ( id
== m_windowId
)
1804 return (wxWindow
*)this;
1806 wxWindowBase
*res
= NULL
;
1807 wxWindowList::compatibility_iterator node
;
1808 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1810 wxWindowBase
*child
= node
->GetData();
1811 res
= child
->FindWindow( id
);
1814 return (wxWindow
*)res
;
1817 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1819 if ( name
== m_windowName
)
1820 return (wxWindow
*)this;
1822 wxWindowBase
*res
= NULL
;
1823 wxWindowList::compatibility_iterator node
;
1824 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1826 wxWindow
*child
= node
->GetData();
1827 res
= child
->FindWindow(name
);
1830 return (wxWindow
*)res
;
1834 // find any window by id or name or label: If parent is non-NULL, look through
1835 // children for a label or title matching the specified string. If NULL, look
1836 // through all top-level windows.
1838 // to avoid duplicating code we reuse the same helper function but with
1839 // different comparators
1841 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1842 const wxString
& label
, long id
);
1845 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1848 return win
->GetLabel() == label
;
1852 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1855 return win
->GetName() == label
;
1859 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1862 return win
->GetId() == id
;
1865 // recursive helper for the FindWindowByXXX() functions
1867 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1868 const wxString
& label
,
1870 wxFindWindowCmp cmp
)
1874 // see if this is the one we're looking for
1875 if ( (*cmp
)(parent
, label
, id
) )
1876 return (wxWindow
*)parent
;
1878 // It wasn't, so check all its children
1879 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1881 node
= node
->GetNext() )
1883 // recursively check each child
1884 wxWindow
*win
= (wxWindow
*)node
->GetData();
1885 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1895 // helper for FindWindowByXXX()
1897 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1898 const wxString
& label
,
1900 wxFindWindowCmp cmp
)
1904 // just check parent and all its children
1905 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1908 // start at very top of wx's windows
1909 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1911 node
= node
->GetNext() )
1913 // recursively check each window & its children
1914 wxWindow
*win
= node
->GetData();
1915 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1925 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1927 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1932 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1934 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1938 // fall back to the label
1939 win
= FindWindowByLabel(title
, parent
);
1947 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1949 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1952 // ----------------------------------------------------------------------------
1953 // dialog oriented functions
1954 // ----------------------------------------------------------------------------
1956 #if WXWIN_COMPATIBILITY_2_8
1957 void wxWindowBase::MakeModal(bool modal
)
1959 // Disable all other windows
1962 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1965 wxWindow
*win
= node
->GetData();
1967 win
->Enable(!modal
);
1969 node
= node
->GetNext();
1973 #endif // WXWIN_COMPATIBILITY_2_8
1975 bool wxWindowBase::Validate()
1977 #if wxUSE_VALIDATORS
1978 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1980 wxWindowList::compatibility_iterator node
;
1981 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1983 wxWindowBase
*child
= node
->GetData();
1984 wxValidator
*validator
= child
->GetValidator();
1985 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1990 if ( recurse
&& !child
->Validate() )
1995 #endif // wxUSE_VALIDATORS
2000 bool wxWindowBase::TransferDataToWindow()
2002 #if wxUSE_VALIDATORS
2003 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2005 wxWindowList::compatibility_iterator node
;
2006 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2008 wxWindowBase
*child
= node
->GetData();
2009 wxValidator
*validator
= child
->GetValidator();
2010 if ( validator
&& !validator
->TransferToWindow() )
2012 wxLogWarning(_("Could not transfer data to window"));
2014 wxLog::FlushActive();
2022 if ( !child
->TransferDataToWindow() )
2024 // warning already given
2029 #endif // wxUSE_VALIDATORS
2034 bool wxWindowBase::TransferDataFromWindow()
2036 #if wxUSE_VALIDATORS
2037 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2039 wxWindowList::compatibility_iterator node
;
2040 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2042 wxWindow
*child
= node
->GetData();
2043 wxValidator
*validator
= child
->GetValidator();
2044 if ( validator
&& !validator
->TransferFromWindow() )
2046 // nop warning here because the application is supposed to give
2047 // one itself - we don't know here what might have gone wrongly
2054 if ( !child
->TransferDataFromWindow() )
2056 // warning already given
2061 #endif // wxUSE_VALIDATORS
2066 void wxWindowBase::InitDialog()
2068 wxInitDialogEvent
event(GetId());
2069 event
.SetEventObject( this );
2070 GetEventHandler()->ProcessEvent(event
);
2073 // ----------------------------------------------------------------------------
2074 // context-sensitive help support
2075 // ----------------------------------------------------------------------------
2079 // associate this help text with this window
2080 void wxWindowBase::SetHelpText(const wxString
& text
)
2082 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2085 helpProvider
->AddHelp(this, text
);
2089 #if WXWIN_COMPATIBILITY_2_8
2090 // associate this help text with all windows with the same id as this
2092 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
2094 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2097 helpProvider
->AddHelp(GetId(), text
);
2100 #endif // WXWIN_COMPATIBILITY_2_8
2102 // get the help string associated with this window (may be empty)
2103 // default implementation forwards calls to the help provider
2105 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
2106 wxHelpEvent::Origin
WXUNUSED(origin
)) const
2109 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2112 text
= helpProvider
->GetHelp(this);
2118 // show help for this window
2119 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
2121 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2124 wxPoint pos
= event
.GetPosition();
2125 const wxHelpEvent::Origin origin
= event
.GetOrigin();
2126 if ( origin
== wxHelpEvent::Origin_Keyboard
)
2128 // if the help event was generated from keyboard it shouldn't
2129 // appear at the mouse position (which is still the only position
2130 // associated with help event) if the mouse is far away, although
2131 // we still do use the mouse position if it's over the window
2132 // because we suppose the user looks approximately at the mouse
2133 // already and so it would be more convenient than showing tooltip
2134 // at some arbitrary position which can be quite far from it
2135 const wxRect rectClient
= GetClientRect();
2136 if ( !rectClient
.Contains(ScreenToClient(pos
)) )
2138 // position help slightly under and to the right of this window
2139 pos
= ClientToScreen(wxPoint(
2141 rectClient
.height
+ GetCharHeight()
2146 if ( helpProvider
->ShowHelpAtPoint(this, pos
, origin
) )
2148 // skip the event.Skip() below
2156 #endif // wxUSE_HELP
2158 // ----------------------------------------------------------------------------
2160 // ----------------------------------------------------------------------------
2164 wxString
wxWindowBase::GetToolTipText() const
2166 return m_tooltip
? m_tooltip
->GetTip() : wxString();
2169 void wxWindowBase::SetToolTip( const wxString
&tip
)
2171 // don't create the new tooltip if we already have one
2174 m_tooltip
->SetTip( tip
);
2178 SetToolTip( new wxToolTip( tip
) );
2181 // setting empty tooltip text does not remove the tooltip any more - use
2182 // SetToolTip(NULL) for this
2185 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
2187 if ( m_tooltip
!= tooltip
)
2192 m_tooltip
= tooltip
;
2196 bool wxWindowBase::CopyToolTip(wxToolTip
*tip
)
2198 SetToolTip(tip
? new wxToolTip(tip
->GetTip()) : NULL
);
2203 #endif // wxUSE_TOOLTIPS
2205 // ----------------------------------------------------------------------------
2206 // constraints and sizers
2207 // ----------------------------------------------------------------------------
2209 #if wxUSE_CONSTRAINTS
2211 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
2213 if ( m_constraints
)
2215 UnsetConstraints(m_constraints
);
2216 delete m_constraints
;
2218 m_constraints
= constraints
;
2219 if ( m_constraints
)
2221 // Make sure other windows know they're part of a 'meaningful relationship'
2222 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
2223 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
2224 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
2225 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
2226 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
2227 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
2228 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
2229 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
2230 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
2231 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
2232 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
2233 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
2234 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
2235 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
2236 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
2237 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
2241 // This removes any dangling pointers to this window in other windows'
2242 // constraintsInvolvedIn lists.
2243 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
2247 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2248 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
2249 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2250 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
2251 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
2252 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
2253 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
2254 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
2255 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
2256 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
2257 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
2258 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
2259 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
2260 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
2261 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
2262 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
2266 // Back-pointer to other windows we're involved with, so if we delete this
2267 // window, we must delete any constraints we're involved with.
2268 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
2270 if ( !m_constraintsInvolvedIn
)
2271 m_constraintsInvolvedIn
= new wxWindowList
;
2272 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
2273 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
2276 // REMOVE back-pointer to other windows we're involved with.
2277 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
2279 if ( m_constraintsInvolvedIn
)
2280 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
2283 // Reset any constraints that mention this window
2284 void wxWindowBase::DeleteRelatedConstraints()
2286 if ( m_constraintsInvolvedIn
)
2288 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
2291 wxWindow
*win
= node
->GetData();
2292 wxLayoutConstraints
*constr
= win
->GetConstraints();
2294 // Reset any constraints involving this window
2297 constr
->left
.ResetIfWin(this);
2298 constr
->top
.ResetIfWin(this);
2299 constr
->right
.ResetIfWin(this);
2300 constr
->bottom
.ResetIfWin(this);
2301 constr
->width
.ResetIfWin(this);
2302 constr
->height
.ResetIfWin(this);
2303 constr
->centreX
.ResetIfWin(this);
2304 constr
->centreY
.ResetIfWin(this);
2307 wxWindowList::compatibility_iterator next
= node
->GetNext();
2308 m_constraintsInvolvedIn
->Erase(node
);
2312 wxDELETE(m_constraintsInvolvedIn
);
2316 #endif // wxUSE_CONSTRAINTS
2318 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
2320 if ( sizer
== m_windowSizer
)
2323 if ( m_windowSizer
)
2325 m_windowSizer
->SetContainingWindow(NULL
);
2328 delete m_windowSizer
;
2331 m_windowSizer
= sizer
;
2332 if ( m_windowSizer
)
2334 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
2337 SetAutoLayout(m_windowSizer
!= NULL
);
2340 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
2342 SetSizer( sizer
, deleteOld
);
2343 sizer
->SetSizeHints( (wxWindow
*) this );
2347 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
2349 // adding a window to a sizer twice is going to result in fatal and
2350 // hard to debug problems later because when deleting the second
2351 // associated wxSizerItem we're going to dereference a dangling
2352 // pointer; so try to detect this as early as possible
2353 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
2354 wxT("Adding a window to the same sizer twice?") );
2356 m_containingSizer
= sizer
;
2359 #if wxUSE_CONSTRAINTS
2361 void wxWindowBase::SatisfyConstraints()
2363 wxLayoutConstraints
*constr
= GetConstraints();
2364 bool wasOk
= constr
&& constr
->AreSatisfied();
2366 ResetConstraints(); // Mark all constraints as unevaluated
2370 // if we're a top level panel (i.e. our parent is frame/dialog), our
2371 // own constraints will never be satisfied any more unless we do it
2375 while ( noChanges
> 0 )
2377 LayoutPhase1(&noChanges
);
2381 LayoutPhase2(&noChanges
);
2384 #endif // wxUSE_CONSTRAINTS
2386 bool wxWindowBase::Layout()
2388 // If there is a sizer, use it instead of the constraints
2392 GetVirtualSize(&w
, &h
);
2393 GetSizer()->SetDimension( 0, 0, w
, h
);
2395 #if wxUSE_CONSTRAINTS
2398 SatisfyConstraints(); // Find the right constraints values
2399 SetConstraintSizes(); // Recursively set the real window sizes
2406 void wxWindowBase::InternalOnSize(wxSizeEvent
& event
)
2408 if ( GetAutoLayout() )
2414 #if wxUSE_CONSTRAINTS
2416 // first phase of the constraints evaluation: set our own constraints
2417 bool wxWindowBase::LayoutPhase1(int *noChanges
)
2419 wxLayoutConstraints
*constr
= GetConstraints();
2421 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
2424 // second phase: set the constraints for our children
2425 bool wxWindowBase::LayoutPhase2(int *noChanges
)
2432 // Layout grand children
2438 // Do a phase of evaluating child constraints
2439 bool wxWindowBase::DoPhase(int phase
)
2441 // the list containing the children for which the constraints are already
2443 wxWindowList succeeded
;
2445 // the max number of iterations we loop before concluding that we can't set
2447 static const int maxIterations
= 500;
2449 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
2453 // loop over all children setting their constraints
2454 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2456 node
= node
->GetNext() )
2458 wxWindow
*child
= node
->GetData();
2459 if ( child
->IsTopLevel() )
2461 // top level children are not inside our client area
2465 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
2467 // this one is either already ok or nothing we can do about it
2471 int tempNoChanges
= 0;
2472 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
2473 : child
->LayoutPhase2(&tempNoChanges
);
2474 noChanges
+= tempNoChanges
;
2478 succeeded
.Append(child
);
2484 // constraints are set
2492 void wxWindowBase::ResetConstraints()
2494 wxLayoutConstraints
*constr
= GetConstraints();
2497 constr
->left
.SetDone(false);
2498 constr
->top
.SetDone(false);
2499 constr
->right
.SetDone(false);
2500 constr
->bottom
.SetDone(false);
2501 constr
->width
.SetDone(false);
2502 constr
->height
.SetDone(false);
2503 constr
->centreX
.SetDone(false);
2504 constr
->centreY
.SetDone(false);
2507 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2510 wxWindow
*win
= node
->GetData();
2511 if ( !win
->IsTopLevel() )
2512 win
->ResetConstraints();
2513 node
= node
->GetNext();
2517 // Need to distinguish between setting the 'fake' size for windows and sizers,
2518 // and setting the real values.
2519 void wxWindowBase::SetConstraintSizes(bool recurse
)
2521 wxLayoutConstraints
*constr
= GetConstraints();
2522 if ( constr
&& constr
->AreSatisfied() )
2524 int x
= constr
->left
.GetValue();
2525 int y
= constr
->top
.GetValue();
2526 int w
= constr
->width
.GetValue();
2527 int h
= constr
->height
.GetValue();
2529 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2530 (constr
->height
.GetRelationship() != wxAsIs
) )
2532 // We really shouldn't set negative sizes for the windows so make
2533 // them at least of 1*1 size
2534 SetSize(x
, y
, w
> 0 ? w
: 1, h
> 0 ? h
: 1);
2538 // If we don't want to resize this window, just move it...
2544 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2545 GetClassInfo()->GetClassName(),
2551 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2554 wxWindow
*win
= node
->GetData();
2555 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2556 win
->SetConstraintSizes();
2557 node
= node
->GetNext();
2562 // Only set the size/position of the constraint (if any)
2563 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2565 wxLayoutConstraints
*constr
= GetConstraints();
2568 if ( x
!= wxDefaultCoord
)
2570 constr
->left
.SetValue(x
);
2571 constr
->left
.SetDone(true);
2573 if ( y
!= wxDefaultCoord
)
2575 constr
->top
.SetValue(y
);
2576 constr
->top
.SetDone(true);
2578 if ( w
!= wxDefaultCoord
)
2580 constr
->width
.SetValue(w
);
2581 constr
->width
.SetDone(true);
2583 if ( h
!= wxDefaultCoord
)
2585 constr
->height
.SetValue(h
);
2586 constr
->height
.SetDone(true);
2591 void wxWindowBase::MoveConstraint(int x
, int y
)
2593 wxLayoutConstraints
*constr
= GetConstraints();
2596 if ( x
!= wxDefaultCoord
)
2598 constr
->left
.SetValue(x
);
2599 constr
->left
.SetDone(true);
2601 if ( y
!= wxDefaultCoord
)
2603 constr
->top
.SetValue(y
);
2604 constr
->top
.SetDone(true);
2609 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2611 wxLayoutConstraints
*constr
= GetConstraints();
2614 *w
= constr
->width
.GetValue();
2615 *h
= constr
->height
.GetValue();
2621 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2623 wxLayoutConstraints
*constr
= GetConstraints();
2626 *w
= constr
->width
.GetValue();
2627 *h
= constr
->height
.GetValue();
2630 GetClientSize(w
, h
);
2633 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2635 wxLayoutConstraints
*constr
= GetConstraints();
2638 *x
= constr
->left
.GetValue();
2639 *y
= constr
->top
.GetValue();
2645 #endif // wxUSE_CONSTRAINTS
2647 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2649 wxWindow
*parent
= GetParent();
2650 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2652 wxPoint
pt(parent
->GetClientAreaOrigin());
2658 // ----------------------------------------------------------------------------
2659 // Update UI processing
2660 // ----------------------------------------------------------------------------
2662 void wxWindowBase::UpdateWindowUI(long flags
)
2664 wxUpdateUIEvent
event(GetId());
2665 event
.SetEventObject(this);
2667 if ( GetEventHandler()->ProcessEvent(event
) )
2669 DoUpdateWindowUI(event
);
2672 if (flags
& wxUPDATE_UI_RECURSE
)
2674 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2677 wxWindow
* child
= (wxWindow
*) node
->GetData();
2678 child
->UpdateWindowUI(flags
);
2679 node
= node
->GetNext();
2684 // do the window-specific processing after processing the update event
2685 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2687 if ( event
.GetSetEnabled() )
2688 Enable(event
.GetEnabled());
2690 if ( event
.GetSetShown() )
2691 Show(event
.GetShown());
2694 // ----------------------------------------------------------------------------
2696 // ----------------------------------------------------------------------------
2698 // Send idle event to window and all subwindows
2699 bool wxWindowBase::SendIdleEvents(wxIdleEvent
& event
)
2701 bool needMore
= false;
2705 // should we send idle event to this window?
2706 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL
||
2707 HasExtraStyle(wxWS_EX_PROCESS_IDLE
))
2709 event
.SetEventObject(this);
2710 HandleWindowEvent(event
);
2712 if (event
.MoreRequested())
2715 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2716 for (; node
; node
= node
->GetNext())
2718 wxWindow
* child
= node
->GetData();
2719 if (child
->SendIdleEvents(event
))
2726 void wxWindowBase::OnInternalIdle()
2728 if ( wxUpdateUIEvent::CanUpdate(this) )
2729 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
2732 // ----------------------------------------------------------------------------
2733 // dialog units translations
2734 // ----------------------------------------------------------------------------
2736 // Windows' computes dialog units using average character width over upper-
2737 // and lower-case ASCII alphabet and not using the average character width
2738 // metadata stored in the font; see
2739 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2740 // It's important that we perform the conversion in identical way, because
2741 // dialog units natively exist only on Windows and Windows HIG is expressed
2743 wxSize
wxWindowBase::GetDlgUnitBase() const
2745 const wxWindowBase
* const parent
= wxGetTopLevelParent((wxWindow
*)this);
2747 if ( !parent
->m_font
.IsOk() )
2749 // Default GUI font is used. This is the most common case, so
2750 // cache the results.
2751 static wxSize s_defFontSize
;
2752 if ( s_defFontSize
.x
== 0 )
2753 s_defFontSize
= wxPrivate::GetAverageASCIILetterSize(*parent
);
2754 return s_defFontSize
;
2758 // Custom font, we always need to compute the result
2759 return wxPrivate::GetAverageASCIILetterSize(*parent
);
2763 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
) const
2765 const wxSize base
= GetDlgUnitBase();
2767 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2769 wxPoint pt2
= wxDefaultPosition
;
2770 if (pt
.x
!= wxDefaultCoord
)
2771 pt2
.x
= wxMulDivInt32(pt
.x
, 4, base
.x
);
2772 if (pt
.y
!= wxDefaultCoord
)
2773 pt2
.y
= wxMulDivInt32(pt
.y
, 8, base
.y
);
2778 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
) const
2780 const wxSize base
= GetDlgUnitBase();
2782 wxPoint pt2
= wxDefaultPosition
;
2783 if (pt
.x
!= wxDefaultCoord
)
2784 pt2
.x
= wxMulDivInt32(pt
.x
, base
.x
, 4);
2785 if (pt
.y
!= wxDefaultCoord
)
2786 pt2
.y
= wxMulDivInt32(pt
.y
, base
.y
, 8);
2791 // ----------------------------------------------------------------------------
2793 // ----------------------------------------------------------------------------
2795 // propagate the colour change event to the subwindows
2796 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& WXUNUSED(event
))
2798 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2801 // Only propagate to non-top-level windows
2802 wxWindow
*win
= node
->GetData();
2803 if ( !win
->IsTopLevel() )
2805 wxSysColourChangedEvent event2
;
2806 event2
.SetEventObject(win
);
2807 win
->GetEventHandler()->ProcessEvent(event2
);
2810 node
= node
->GetNext();
2816 // the default action is to populate dialog with data when it's created,
2817 // and nudge the UI into displaying itself correctly in case
2818 // we've turned the wxUpdateUIEvents frequency down low.
2819 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2821 TransferDataToWindow();
2823 // Update the UI at this point
2824 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2827 // ----------------------------------------------------------------------------
2828 // menu-related functions
2829 // ----------------------------------------------------------------------------
2833 bool wxWindowBase::PopupMenu(wxMenu
*menu
, int x
, int y
)
2835 wxCHECK_MSG( menu
, false, "can't popup NULL menu" );
2837 wxMenuInvokingWindowSetter
2838 setInvokingWin(*menu
, static_cast<wxWindow
*>(this));
2840 wxCurrentPopupMenu
= menu
;
2841 const bool rc
= DoPopupMenu(menu
, x
, y
);
2842 wxCurrentPopupMenu
= NULL
;
2847 // this is used to pass the id of the selected item from the menu event handler
2848 // to the main function itself
2850 // it's ok to use a global here as there can be at most one popup menu shown at
2852 static int gs_popupMenuSelection
= wxID_NONE
;
2854 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2856 // store the id in a global variable where we'll retrieve it from later
2857 gs_popupMenuSelection
= event
.GetId();
2860 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent
& WXUNUSED(event
))
2862 // nothing to do but do not skip it
2866 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2868 gs_popupMenuSelection
= wxID_NONE
;
2870 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2871 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2875 // it is common to construct the menu passed to this function dynamically
2876 // using some fixed range of ids which could clash with the ids used
2877 // elsewhere in the program, which could result in some menu items being
2878 // unintentionally disabled or otherwise modified by update UI handlers
2879 // elsewhere in the program code and this is difficult to avoid in the
2880 // program itself, so instead we just temporarily suspend UI updating while
2881 // this menu is shown
2882 Connect(wxEVT_UPDATE_UI
,
2883 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2887 PopupMenu(&menu
, x
, y
);
2889 Disconnect(wxEVT_UPDATE_UI
,
2890 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2893 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2894 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2898 return gs_popupMenuSelection
;
2901 #endif // wxUSE_MENUS
2903 // methods for drawing the sizers in a visible way: this is currently only
2904 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2905 // that well and also because we don't want to leave it enabled in default
2906 // builds used for production
2907 #if wxDEBUG_LEVEL > 1
2909 static void DrawSizers(wxWindowBase
*win
);
2911 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
, const wxPen
* pen
)
2913 wxClientDC
dc((wxWindow
*)win
);
2915 dc
.SetBrush(fill
? wxBrush(pen
->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH
) :
2916 *wxTRANSPARENT_BRUSH
);
2917 dc
.DrawRectangle(rect
.Deflate(1, 1));
2920 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2922 const wxSizerItemList
& items
= sizer
->GetChildren();
2923 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2928 wxSizerItem
*item
= *i
;
2929 if ( item
->IsSizer() )
2931 DrawBorder(win
, item
->GetRect().Deflate(2), false, wxRED_PEN
);
2932 DrawSizer(win
, item
->GetSizer());
2934 else if ( item
->IsSpacer() )
2936 DrawBorder(win
, item
->GetRect().Deflate(2), true, wxBLUE_PEN
);
2938 else if ( item
->IsWindow() )
2940 DrawSizers(item
->GetWindow());
2943 wxFAIL_MSG("inconsistent wxSizerItem status!");
2947 static void DrawSizers(wxWindowBase
*win
)
2949 DrawBorder(win
, win
->GetClientSize(), false, wxGREEN_PEN
);
2951 wxSizer
*sizer
= win
->GetSizer();
2954 DrawSizer(win
, sizer
);
2956 else // no sizer, still recurse into the children
2958 const wxWindowList
& children
= win
->GetChildren();
2959 for ( wxWindowList::const_iterator i
= children
.begin(),
2960 end
= children
.end();
2967 // show all kind of sizes of this window; see the "window sizing" topic
2968 // overview for more info about the various differences:
2969 wxSize fullSz
= win
->GetSize();
2970 wxSize clientSz
= win
->GetClientSize();
2971 wxSize bestSz
= win
->GetBestSize();
2972 wxSize minSz
= win
->GetMinSize();
2973 wxSize maxSz
= win
->GetMaxSize();
2974 wxSize virtualSz
= win
->GetVirtualSize();
2976 wxMessageOutputDebug dbgout
;
2978 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
2981 clientSz
.x
, clientSz
.y
,
2985 virtualSz
.x
, virtualSz
.y
);
2989 #endif // wxDEBUG_LEVEL
2991 // process special middle clicks
2992 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2994 if ( event
.ControlDown() && event
.AltDown() )
2996 #if wxDEBUG_LEVEL > 1
2997 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
2998 if ( event
.ShiftDown() )
3003 #endif // __WXDEBUG__
3006 // just Ctrl-Alt-middle click shows information about wx version
3007 ::wxInfoMessageBox((wxWindow
*)this);
3008 #endif // wxUSE_MSGDLG
3017 // ----------------------------------------------------------------------------
3019 // ----------------------------------------------------------------------------
3021 #if wxUSE_ACCESSIBILITY
3022 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
3024 if (m_accessible
&& (accessible
!= m_accessible
))
3025 delete m_accessible
;
3026 m_accessible
= accessible
;
3028 m_accessible
->SetWindow((wxWindow
*) this);
3031 // Returns the accessible object, creating if necessary.
3032 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
3035 m_accessible
= CreateAccessible();
3036 return m_accessible
;
3039 // Override to create a specific accessible object.
3040 wxAccessible
* wxWindowBase::CreateAccessible()
3042 return new wxWindowAccessible((wxWindow
*) this);
3047 // ----------------------------------------------------------------------------
3048 // list classes implementation
3049 // ----------------------------------------------------------------------------
3051 #if wxUSE_STD_CONTAINERS
3053 #include "wx/listimpl.cpp"
3054 WX_DEFINE_LIST(wxWindowList
)
3056 #else // !wxUSE_STD_CONTAINERS
3058 void wxWindowListNode::DeleteData()
3060 delete (wxWindow
*)GetData();
3063 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3065 // ----------------------------------------------------------------------------
3067 // ----------------------------------------------------------------------------
3069 wxBorder
wxWindowBase::GetBorder(long flags
) const
3071 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
3072 if ( border
== wxBORDER_DEFAULT
)
3074 border
= GetDefaultBorder();
3076 else if ( border
== wxBORDER_THEME
)
3078 border
= GetDefaultBorderForControl();
3084 wxBorder
wxWindowBase::GetDefaultBorder() const
3086 return wxBORDER_NONE
;
3089 // ----------------------------------------------------------------------------
3091 // ----------------------------------------------------------------------------
3093 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
3095 // here we just check if the point is inside the window or not
3097 // check the top and left border first
3098 bool outside
= x
< 0 || y
< 0;
3101 // check the right and bottom borders too
3102 wxSize size
= GetSize();
3103 outside
= x
>= size
.x
|| y
>= size
.y
;
3106 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
3109 // ----------------------------------------------------------------------------
3111 // ----------------------------------------------------------------------------
3113 struct WXDLLEXPORT wxWindowNext
3117 } *wxWindowBase::ms_winCaptureNext
= NULL
;
3118 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
3119 bool wxWindowBase::ms_winCaptureChanging
= false;
3121 void wxWindowBase::CaptureMouse()
3123 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3125 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive CaptureMouse call?") );
3127 ms_winCaptureChanging
= true;
3129 wxWindow
*winOld
= GetCapture();
3132 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
3135 wxWindowNext
*item
= new wxWindowNext
;
3137 item
->next
= ms_winCaptureNext
;
3138 ms_winCaptureNext
= item
;
3140 //else: no mouse capture to save
3143 ms_winCaptureCurrent
= (wxWindow
*)this;
3145 ms_winCaptureChanging
= false;
3148 void wxWindowBase::ReleaseMouse()
3150 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3152 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive ReleaseMouse call?") );
3154 wxASSERT_MSG( GetCapture() == this,
3155 "attempt to release mouse, but this window hasn't captured it" );
3156 wxASSERT_MSG( ms_winCaptureCurrent
== this,
3157 "attempt to release mouse, but this window hasn't captured it" );
3159 ms_winCaptureChanging
= true;
3162 ms_winCaptureCurrent
= NULL
;
3164 if ( ms_winCaptureNext
)
3166 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
3167 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
3169 wxWindowNext
*item
= ms_winCaptureNext
;
3170 ms_winCaptureNext
= item
->next
;
3173 //else: stack is empty, no previous capture
3175 ms_winCaptureChanging
= false;
3177 wxLogTrace(wxT("mousecapture"),
3178 (const wxChar
*) wxT("After ReleaseMouse() mouse is captured by %p"),
3179 static_cast<void*>(GetCapture()));
3182 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
3184 wxMouseCaptureLostEvent
event(win
->GetId());
3185 event
.SetEventObject(win
);
3186 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
3188 // windows must handle this event, otherwise the app wouldn't behave
3189 // correctly if it loses capture unexpectedly; see the discussion here:
3190 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3191 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3192 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3197 void wxWindowBase::NotifyCaptureLost()
3199 // don't do anything if capture lost was expected, i.e. resulted from
3200 // a wx call to ReleaseMouse or CaptureMouse:
3201 if ( ms_winCaptureChanging
)
3204 // if the capture was lost unexpectedly, notify every window that has
3205 // capture (on stack or current) about it and clear the stack:
3207 if ( ms_winCaptureCurrent
)
3209 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
3210 ms_winCaptureCurrent
= NULL
;
3213 while ( ms_winCaptureNext
)
3215 wxWindowNext
*item
= ms_winCaptureNext
;
3216 ms_winCaptureNext
= item
->next
;
3218 DoNotifyWindowAboutCaptureLost(item
->win
);
3227 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
3228 int WXUNUSED(modifiers
),
3229 int WXUNUSED(keycode
))
3235 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
3241 #endif // wxUSE_HOTKEY
3243 // ----------------------------------------------------------------------------
3245 // ----------------------------------------------------------------------------
3247 bool wxWindowBase::TryBefore(wxEvent
& event
)
3249 #if wxUSE_VALIDATORS
3250 // Can only use the validator of the window which
3251 // is receiving the event
3252 if ( event
.GetEventObject() == this )
3254 wxValidator
* const validator
= GetValidator();
3255 if ( validator
&& validator
->ProcessEventLocally(event
) )
3260 #endif // wxUSE_VALIDATORS
3262 return wxEvtHandler::TryBefore(event
);
3265 bool wxWindowBase::TryAfter(wxEvent
& event
)
3267 // carry on up the parent-child hierarchy if the propagation count hasn't
3269 if ( event
.ShouldPropagate() )
3271 // honour the requests to stop propagation at this window: this is
3272 // used by the dialogs, for example, to prevent processing the events
3273 // from the dialog controls in the parent frame which rarely, if ever,
3275 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
3277 wxWindow
*parent
= GetParent();
3278 if ( parent
&& !parent
->IsBeingDeleted() )
3280 wxPropagateOnce
propagateOnce(event
);
3282 return parent
->GetEventHandler()->ProcessEvent(event
);
3287 return wxEvtHandler::TryAfter(event
);
3290 // ----------------------------------------------------------------------------
3291 // window relationships
3292 // ----------------------------------------------------------------------------
3294 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
3296 wxCHECK_MSG( GetParent(), NULL
,
3297 wxT("GetPrev/NextSibling() don't work for TLWs!") );
3299 wxWindowList
& siblings
= GetParent()->GetChildren();
3300 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
3301 wxCHECK_MSG( i
, NULL
, wxT("window not a child of its parent?") );
3303 if ( order
== OrderBefore
)
3304 i
= i
->GetPrevious();
3308 return i
? i
->GetData() : NULL
;
3311 // ----------------------------------------------------------------------------
3312 // keyboard navigation
3313 // ----------------------------------------------------------------------------
3315 // Navigates in the specified direction inside this window
3316 bool wxWindowBase::DoNavigateIn(int flags
)
3318 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3319 // native code doesn't process our wxNavigationKeyEvents anyhow
3322 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3323 wxNavigationKeyEvent eventNav
;
3324 wxWindow
*focused
= FindFocus();
3325 eventNav
.SetCurrentFocus(focused
);
3326 eventNav
.SetEventObject(focused
);
3327 eventNav
.SetFlags(flags
);
3328 return GetEventHandler()->ProcessEvent(eventNav
);
3329 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3332 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent
& event
)
3334 if ( event
.GetKeyCode() != WXK_TAB
)
3337 int flags
= wxNavigationKeyEvent::FromTab
;
3339 if ( event
.ShiftDown() )
3340 flags
|= wxNavigationKeyEvent::IsBackward
;
3342 flags
|= wxNavigationKeyEvent::IsForward
;
3344 if ( event
.ControlDown() )
3345 flags
|= wxNavigationKeyEvent::WinChange
;
3351 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
3353 // check that we're not a top level window
3354 wxCHECK_RET( GetParent(),
3355 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3357 // detect the special case when we have nothing to do anyhow and when the
3358 // code below wouldn't work
3362 // find the target window in the siblings list
3363 wxWindowList
& siblings
= GetParent()->GetChildren();
3364 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
3365 wxCHECK_RET( i
, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3367 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3368 // implemented so we can't just move the node around
3369 wxWindow
*self
= (wxWindow
*)this;
3370 siblings
.DeleteObject(self
);
3371 if ( move
== OrderAfter
)
3378 siblings
.Insert(i
, self
);
3380 else // OrderAfter and win was the last sibling
3382 siblings
.Append(self
);
3386 // ----------------------------------------------------------------------------
3388 // ----------------------------------------------------------------------------
3390 /*static*/ wxWindow
* wxWindowBase::FindFocus()
3392 wxWindowBase
*win
= DoFindFocus();
3393 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
3396 bool wxWindowBase::HasFocus() const
3398 wxWindowBase
* const win
= DoFindFocus();
3400 (this == win
|| this == win
->GetMainWindowOfCompositeControl());
3403 // ----------------------------------------------------------------------------
3405 // ----------------------------------------------------------------------------
3407 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3412 class DragAcceptFilesTarget
: public wxFileDropTarget
3415 DragAcceptFilesTarget(wxWindowBase
*win
) : m_win(win
) {}
3417 virtual bool OnDropFiles(wxCoord x
, wxCoord y
,
3418 const wxArrayString
& filenames
)
3420 wxDropFilesEvent
event(wxEVT_DROP_FILES
,
3422 wxCArrayString(filenames
).Release());
3423 event
.SetEventObject(m_win
);
3427 return m_win
->HandleWindowEvent(event
);
3431 wxWindowBase
* const m_win
;
3433 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget
);
3437 } // anonymous namespace
3439 // Generic version of DragAcceptFiles(). It works by installing a simple
3440 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3441 // together with explicit SetDropTarget() calls.
3442 void wxWindowBase::DragAcceptFiles(bool accept
)
3446 wxASSERT_MSG( !GetDropTarget(),
3447 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3448 SetDropTarget(new DragAcceptFilesTarget(this));
3452 SetDropTarget(NULL
);
3456 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3458 // ----------------------------------------------------------------------------
3460 // ----------------------------------------------------------------------------
3462 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
3464 while ( win
&& !win
->IsTopLevel() )
3465 win
= win
->GetParent();
3470 #if wxUSE_ACCESSIBILITY
3471 // ----------------------------------------------------------------------------
3472 // accessible object for windows
3473 // ----------------------------------------------------------------------------
3475 // Can return either a child object, or an integer
3476 // representing the child element, starting from 1.
3477 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
3479 wxASSERT( GetWindow() != NULL
);
3483 return wxACC_NOT_IMPLEMENTED
;
3486 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3487 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
3489 wxASSERT( GetWindow() != NULL
);
3493 wxWindow
* win
= NULL
;
3500 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
3502 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
3509 rect
= win
->GetRect();
3510 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
3511 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
3515 return wxACC_NOT_IMPLEMENTED
;
3518 // Navigates from fromId to toId/toObject.
3519 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
3520 int* WXUNUSED(toId
), wxAccessible
** toObject
)
3522 wxASSERT( GetWindow() != NULL
);
3528 case wxNAVDIR_FIRSTCHILD
:
3530 if (GetWindow()->GetChildren().GetCount() == 0)
3532 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
3533 *toObject
= childWindow
->GetOrCreateAccessible();
3537 case wxNAVDIR_LASTCHILD
:
3539 if (GetWindow()->GetChildren().GetCount() == 0)
3541 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
3542 *toObject
= childWindow
->GetOrCreateAccessible();
3546 case wxNAVDIR_RIGHT
:
3550 wxWindowList::compatibility_iterator node
=
3551 wxWindowList::compatibility_iterator();
3554 // Can't navigate to sibling of this window
3555 // if we're a top-level window.
3556 if (!GetWindow()->GetParent())
3557 return wxACC_NOT_IMPLEMENTED
;
3559 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3563 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3564 node
= GetWindow()->GetChildren().Item(fromId
-1);
3567 if (node
&& node
->GetNext())
3569 wxWindow
* nextWindow
= node
->GetNext()->GetData();
3570 *toObject
= nextWindow
->GetOrCreateAccessible();
3578 case wxNAVDIR_PREVIOUS
:
3580 wxWindowList::compatibility_iterator node
=
3581 wxWindowList::compatibility_iterator();
3584 // Can't navigate to sibling of this window
3585 // if we're a top-level window.
3586 if (!GetWindow()->GetParent())
3587 return wxACC_NOT_IMPLEMENTED
;
3589 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3593 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3594 node
= GetWindow()->GetChildren().Item(fromId
-1);
3597 if (node
&& node
->GetPrevious())
3599 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
3600 *toObject
= previousWindow
->GetOrCreateAccessible();
3608 return wxACC_NOT_IMPLEMENTED
;
3611 // Gets the name of the specified object.
3612 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
3614 wxASSERT( GetWindow() != NULL
);
3620 // If a child, leave wxWidgets to call the function on the actual
3623 return wxACC_NOT_IMPLEMENTED
;
3625 // This will eventually be replaced by specialised
3626 // accessible classes, one for each kind of wxWidgets
3627 // control or window.
3629 if (GetWindow()->IsKindOf(CLASSINFO(wxButton
)))
3630 title
= ((wxButton
*) GetWindow())->GetLabel();
3633 title
= GetWindow()->GetName();
3641 return wxACC_NOT_IMPLEMENTED
;
3644 // Gets the number of children.
3645 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
3647 wxASSERT( GetWindow() != NULL
);
3651 *childId
= (int) GetWindow()->GetChildren().GetCount();
3655 // Gets the specified child (starting from 1).
3656 // If *child is NULL and return value is wxACC_OK,
3657 // this means that the child is a simple element and
3658 // not an accessible object.
3659 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
3661 wxASSERT( GetWindow() != NULL
);
3671 if (childId
> (int) GetWindow()->GetChildren().GetCount())
3674 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
3675 *child
= childWindow
->GetOrCreateAccessible();
3682 // Gets the parent, or NULL.
3683 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
3685 wxASSERT( GetWindow() != NULL
);
3689 wxWindow
* parentWindow
= GetWindow()->GetParent();
3697 *parent
= parentWindow
->GetOrCreateAccessible();
3705 // Performs the default action. childId is 0 (the action for this object)
3706 // or > 0 (the action for a child).
3707 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3708 // window (e.g. an edit control).
3709 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
3711 wxASSERT( GetWindow() != NULL
);
3715 return wxACC_NOT_IMPLEMENTED
;
3718 // Gets the default action for this object (0) or > 0 (the action for a child).
3719 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3720 // string if there is no action.
3721 // The retrieved string describes the action that is performed on an object,
3722 // not what the object does as a result. For example, a toolbar button that prints
3723 // a document has a default action of "Press" rather than "Prints the current document."
3724 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
3726 wxASSERT( GetWindow() != NULL
);
3730 return wxACC_NOT_IMPLEMENTED
;
3733 // Returns the description for this object or a child.
3734 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3736 wxASSERT( GetWindow() != NULL
);
3740 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3746 return wxACC_NOT_IMPLEMENTED
;
3749 // Returns help text for this object or a child, similar to tooltip text.
3750 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3752 wxASSERT( GetWindow() != NULL
);
3756 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3762 return wxACC_NOT_IMPLEMENTED
;
3765 // Returns the keyboard shortcut for this object or child.
3766 // Return e.g. ALT+K
3767 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3769 wxASSERT( GetWindow() != NULL
);
3773 return wxACC_NOT_IMPLEMENTED
;
3776 // Returns a role constant.
3777 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3779 wxASSERT( GetWindow() != NULL
);
3783 // If a child, leave wxWidgets to call the function on the actual
3786 return wxACC_NOT_IMPLEMENTED
;
3788 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3789 return wxACC_NOT_IMPLEMENTED
;
3791 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3792 return wxACC_NOT_IMPLEMENTED
;
3795 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3796 return wxACC_NOT_IMPLEMENTED
;
3799 //*role = wxROLE_SYSTEM_CLIENT;
3800 *role
= wxROLE_SYSTEM_CLIENT
;
3804 return wxACC_NOT_IMPLEMENTED
;
3808 // Returns a state constant.
3809 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3811 wxASSERT( GetWindow() != NULL
);
3815 // If a child, leave wxWidgets to call the function on the actual
3818 return wxACC_NOT_IMPLEMENTED
;
3820 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
3821 return wxACC_NOT_IMPLEMENTED
;
3824 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
3825 return wxACC_NOT_IMPLEMENTED
;
3828 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
3829 return wxACC_NOT_IMPLEMENTED
;
3836 return wxACC_NOT_IMPLEMENTED
;
3840 // Returns a localized string representing the value for the object
3842 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3844 wxASSERT( GetWindow() != NULL
);
3848 return wxACC_NOT_IMPLEMENTED
;
3851 // Selects the object or child.
3852 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3854 wxASSERT( GetWindow() != NULL
);
3858 return wxACC_NOT_IMPLEMENTED
;
3861 // Gets the window with the keyboard focus.
3862 // If childId is 0 and child is NULL, no object in
3863 // this subhierarchy has the focus.
3864 // If this object has the focus, child should be 'this'.
3865 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3867 wxASSERT( GetWindow() != NULL
);
3871 return wxACC_NOT_IMPLEMENTED
;
3875 // Gets a variant representing the selected children
3877 // Acceptable values:
3878 // - a null variant (IsNull() returns true)
3879 // - a list variant (GetType() == wxT("list")
3880 // - an integer representing the selected child element,
3881 // or 0 if this object is selected (GetType() == wxT("long")
3882 // - a "void*" pointer to a wxAccessible child object
3883 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3885 wxASSERT( GetWindow() != NULL
);
3889 return wxACC_NOT_IMPLEMENTED
;
3891 #endif // wxUSE_VARIANT
3893 #endif // wxUSE_ACCESSIBILITY
3895 // ----------------------------------------------------------------------------
3897 // ----------------------------------------------------------------------------
3900 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3902 wxCoord widthTotal
) const
3904 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3906 x
= widthTotal
- x
- width
;