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 && !wxDynamicCast(win
, 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.
1274 // Stop iterating on reaching the top level window boundary.
1275 if ( win
->IsTopLevel() )
1278 win
= win
->GetParent();
1284 void wxWindowBase::AddChild(wxWindowBase
*child
)
1286 wxCHECK_RET( child
, wxT("can't add a NULL child") );
1288 // this should never happen and it will lead to a crash later if it does
1289 // because RemoveChild() will remove only one node from the children list
1290 // and the other(s) one(s) will be left with dangling pointers in them
1291 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), wxT("AddChild() called twice") );
1293 GetChildren().Append((wxWindow
*)child
);
1294 child
->SetParent(this);
1296 // adding a child while frozen will assert when thawed, so freeze it as if
1297 // it had been already present when we were frozen
1298 if ( IsFrozen() && !child
->IsTopLevel() )
1302 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
1304 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
1306 // removing a child while frozen may result in permanently frozen window
1307 // if used e.g. from Reparent(), so thaw it
1309 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1310 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1311 if ( IsFrozen() && !child
->IsBeingDeleted() && !child
->IsTopLevel() )
1314 GetChildren().DeleteObject((wxWindow
*)child
);
1315 child
->SetParent(NULL
);
1318 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
1320 wxWindow
*oldParent
= GetParent();
1321 if ( newParent
== oldParent
)
1327 const bool oldEnabledState
= IsEnabled();
1329 // unlink this window from the existing parent.
1332 oldParent
->RemoveChild(this);
1336 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
1339 // add it to the new one
1342 newParent
->AddChild(this);
1346 wxTopLevelWindows
.Append((wxWindow
*)this);
1349 // We need to notify window (and its subwindows) if by changing the parent
1350 // we also change our enabled/disabled status.
1351 const bool newEnabledState
= IsEnabled();
1352 if ( newEnabledState
!= oldEnabledState
)
1354 NotifyWindowOnEnableChange(newEnabledState
);
1360 // ----------------------------------------------------------------------------
1361 // event handler stuff
1362 // ----------------------------------------------------------------------------
1364 void wxWindowBase::SetEventHandler(wxEvtHandler
*handler
)
1366 wxCHECK_RET(handler
!= NULL
, "SetEventHandler(NULL) called");
1368 m_eventHandler
= handler
;
1371 void wxWindowBase::SetNextHandler(wxEvtHandler
*WXUNUSED(handler
))
1373 // disable wxEvtHandler chain mechanism for wxWindows:
1374 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1376 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1378 void wxWindowBase::SetPreviousHandler(wxEvtHandler
*WXUNUSED(handler
))
1380 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1381 // handler of our stack when is destroyed will be Unlink()ed and thus
1382 // will call this function to update the pointer of this window...
1384 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1387 void wxWindowBase::PushEventHandler(wxEvtHandler
*handlerToPush
)
1389 wxCHECK_RET( handlerToPush
!= NULL
, "PushEventHandler(NULL) called" );
1391 // the new handler is going to be part of the wxWindow stack of event handlers:
1392 // it can't be part also of an event handler double-linked chain:
1393 wxASSERT_MSG(handlerToPush
->IsUnlinked(),
1394 "The handler being pushed in the wxWindow stack shouldn't be part of "
1395 "a wxEvtHandler chain; call Unlink() on it first");
1397 wxEvtHandler
*handlerOld
= GetEventHandler();
1398 wxCHECK_RET( handlerOld
, "an old event handler is NULL?" );
1400 // now use wxEvtHandler double-linked list to implement a stack:
1401 handlerToPush
->SetNextHandler(handlerOld
);
1403 if (handlerOld
!= this)
1404 handlerOld
->SetPreviousHandler(handlerToPush
);
1406 SetEventHandler(handlerToPush
);
1409 // final checks of the operations done above:
1410 wxASSERT_MSG( handlerToPush
->GetPreviousHandler() == NULL
,
1411 "the first handler of the wxWindow stack should "
1412 "have no previous handlers set" );
1413 wxASSERT_MSG( handlerToPush
->GetNextHandler() != NULL
,
1414 "the first handler of the wxWindow stack should "
1415 "have non-NULL next handler" );
1417 wxEvtHandler
* pLast
= handlerToPush
;
1418 while ( pLast
&& pLast
!= this )
1419 pLast
= pLast
->GetNextHandler();
1420 wxASSERT_MSG( pLast
->GetNextHandler() == NULL
,
1421 "the last handler of the wxWindow stack should "
1422 "have this window as next handler" );
1423 #endif // wxDEBUG_LEVEL
1426 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
1428 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
1430 wxEvtHandler
*firstHandler
= GetEventHandler();
1431 wxCHECK_MSG( firstHandler
!= NULL
, NULL
, "wxWindow cannot have a NULL event handler" );
1432 wxCHECK_MSG( firstHandler
!= this, NULL
, "cannot pop the wxWindow itself" );
1433 wxCHECK_MSG( firstHandler
->GetPreviousHandler() == NULL
, NULL
,
1434 "the first handler of the wxWindow stack should have no previous handlers set" );
1436 wxEvtHandler
*secondHandler
= firstHandler
->GetNextHandler();
1437 wxCHECK_MSG( secondHandler
!= NULL
, NULL
,
1438 "the first handler of the wxWindow stack should have non-NULL next handler" );
1440 firstHandler
->SetNextHandler(NULL
);
1442 // It is harmless but useless to unset the previous handler of the window
1443 // itself as it's always NULL anyhow, so don't do this.
1444 if ( secondHandler
!= this )
1445 secondHandler
->SetPreviousHandler(NULL
);
1447 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1448 SetEventHandler(secondHandler
);
1450 if ( deleteHandler
)
1452 wxDELETE(firstHandler
);
1455 return firstHandler
;
1458 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handlerToRemove
)
1460 wxCHECK_MSG( handlerToRemove
!= NULL
, false, "RemoveEventHandler(NULL) called" );
1461 wxCHECK_MSG( handlerToRemove
!= this, false, "Cannot remove the window itself" );
1463 if (handlerToRemove
== GetEventHandler())
1465 // removing the first event handler is equivalent to "popping" the stack
1466 PopEventHandler(false);
1470 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1471 wxEvtHandler
*handlerCur
= GetEventHandler()->GetNextHandler();
1472 while ( handlerCur
!= this && handlerCur
)
1474 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
1476 if ( handlerCur
== handlerToRemove
)
1478 handlerCur
->Unlink();
1480 wxASSERT_MSG( handlerCur
!= GetEventHandler(),
1481 "the case Remove == Pop should was already handled" );
1485 handlerCur
= handlerNext
;
1488 wxFAIL_MSG( wxT("where has the event handler gone?") );
1493 bool wxWindowBase::HandleWindowEvent(wxEvent
& event
) const
1495 // SafelyProcessEvent() will handle exceptions nicely
1496 return GetEventHandler()->SafelyProcessEvent(event
);
1499 // ----------------------------------------------------------------------------
1500 // colours, fonts &c
1501 // ----------------------------------------------------------------------------
1503 void wxWindowBase::InheritAttributes()
1505 const wxWindowBase
* const parent
= GetParent();
1509 // we only inherit attributes which had been explicitly set for the parent
1510 // which ensures that this only happens if the user really wants it and
1511 // not by default which wouldn't make any sense in modern GUIs where the
1512 // controls don't all use the same fonts (nor colours)
1513 if ( parent
->m_inheritFont
&& !m_hasFont
)
1514 SetFont(parent
->GetFont());
1516 // in addition, there is a possibility to explicitly forbid inheriting
1517 // colours at each class level by overriding ShouldInheritColours()
1518 if ( ShouldInheritColours() )
1520 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1521 SetForegroundColour(parent
->GetForegroundColour());
1523 // inheriting (solid) background colour is wrong as it totally breaks
1524 // any kind of themed backgrounds
1526 // instead, the controls should use the same background as their parent
1527 // (ideally by not drawing it at all)
1529 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1530 SetBackgroundColour(parent
->GetBackgroundColour());
1535 /* static */ wxVisualAttributes
1536 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1538 // it is important to return valid values for all attributes from here,
1539 // GetXXX() below rely on this
1540 wxVisualAttributes attrs
;
1541 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1542 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1544 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1545 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1546 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1547 // colour on other platforms.
1549 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1550 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1552 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1557 wxColour
wxWindowBase::GetBackgroundColour() const
1559 if ( !m_backgroundColour
.IsOk() )
1561 wxASSERT_MSG( !m_hasBgCol
, wxT("we have invalid explicit bg colour?") );
1563 // get our default background colour
1564 wxColour colBg
= GetDefaultAttributes().colBg
;
1566 // we must return some valid colour to avoid redoing this every time
1567 // and also to avoid surprising the applications written for older
1568 // wxWidgets versions where GetBackgroundColour() always returned
1569 // something -- so give them something even if it doesn't make sense
1570 // for this window (e.g. it has a themed background)
1571 if ( !colBg
.IsOk() )
1572 colBg
= GetClassDefaultAttributes().colBg
;
1577 return m_backgroundColour
;
1580 wxColour
wxWindowBase::GetForegroundColour() const
1582 // logic is the same as above
1583 if ( !m_hasFgCol
&& !m_foregroundColour
.IsOk() )
1585 wxColour colFg
= GetDefaultAttributes().colFg
;
1587 if ( !colFg
.IsOk() )
1588 colFg
= GetClassDefaultAttributes().colFg
;
1593 return m_foregroundColour
;
1596 bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style
)
1598 // The checks below shouldn't be triggered if we're not really changing the
1600 if ( style
== m_backgroundStyle
)
1603 // Transparent background style can be only set before creation because of
1604 // wxGTK limitation.
1605 wxCHECK_MSG( (style
!= wxBG_STYLE_TRANSPARENT
) || !GetHandle(),
1607 "wxBG_STYLE_TRANSPARENT style can only be set before "
1608 "Create()-ing the window." );
1610 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1611 wxCHECK_MSG( (m_backgroundStyle
!= wxBG_STYLE_TRANSPARENT
) ||
1612 (style
== wxBG_STYLE_TRANSPARENT
),
1614 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1616 m_backgroundStyle
= style
;
1621 bool wxWindowBase::IsTransparentBackgroundSupported(wxString
*reason
) const
1624 *reason
= _("This platform does not support background transparency.");
1629 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1631 if ( colour
== m_backgroundColour
)
1634 m_hasBgCol
= colour
.IsOk();
1636 m_inheritBgCol
= m_hasBgCol
;
1637 m_backgroundColour
= colour
;
1638 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.IsOk() );
1642 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1644 if (colour
== m_foregroundColour
)
1647 m_hasFgCol
= colour
.IsOk();
1648 m_inheritFgCol
= m_hasFgCol
;
1649 m_foregroundColour
= colour
;
1650 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.IsOk() );
1654 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1656 // setting an invalid cursor is ok, it means that we don't have any special
1658 if ( m_cursor
.IsSameAs(cursor
) )
1669 wxFont
wxWindowBase::GetFont() const
1671 // logic is the same as in GetBackgroundColour()
1672 if ( !m_font
.IsOk() )
1674 wxASSERT_MSG( !m_hasFont
, wxT("we have invalid explicit font?") );
1676 wxFont font
= GetDefaultAttributes().font
;
1678 font
= GetClassDefaultAttributes().font
;
1686 bool wxWindowBase::SetFont(const wxFont
& font
)
1688 if ( font
== m_font
)
1695 m_hasFont
= font
.IsOk();
1696 m_inheritFont
= m_hasFont
;
1698 InvalidateBestSize();
1705 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1707 m_hasCustomPalette
= true;
1710 // VZ: can anyone explain me what do we do here?
1711 wxWindowDC
d((wxWindow
*) this);
1715 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1717 wxWindow
*win
= (wxWindow
*)this;
1718 while ( win
&& !win
->HasCustomPalette() )
1720 win
= win
->GetParent();
1726 #endif // wxUSE_PALETTE
1729 void wxWindowBase::SetCaret(wxCaret
*caret
)
1740 wxASSERT_MSG( m_caret
->GetWindow() == this,
1741 wxT("caret should be created associated to this window") );
1744 #endif // wxUSE_CARET
1746 #if wxUSE_VALIDATORS
1747 // ----------------------------------------------------------------------------
1749 // ----------------------------------------------------------------------------
1751 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1753 if ( m_windowValidator
)
1754 delete m_windowValidator
;
1756 m_windowValidator
= (wxValidator
*)validator
.Clone();
1758 if ( m_windowValidator
)
1759 m_windowValidator
->SetWindow(this);
1761 #endif // wxUSE_VALIDATORS
1763 // ----------------------------------------------------------------------------
1764 // update region stuff
1765 // ----------------------------------------------------------------------------
1767 wxRect
wxWindowBase::GetUpdateClientRect() const
1769 wxRegion rgnUpdate
= GetUpdateRegion();
1770 rgnUpdate
.Intersect(GetClientRect());
1771 wxRect rectUpdate
= rgnUpdate
.GetBox();
1772 wxPoint ptOrigin
= GetClientAreaOrigin();
1773 rectUpdate
.x
-= ptOrigin
.x
;
1774 rectUpdate
.y
-= ptOrigin
.y
;
1779 bool wxWindowBase::DoIsExposed(int x
, int y
) const
1781 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1784 bool wxWindowBase::DoIsExposed(int x
, int y
, int w
, int h
) const
1786 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1789 void wxWindowBase::ClearBackground()
1791 // wxGTK uses its own version, no need to add never used code
1793 wxClientDC
dc((wxWindow
*)this);
1794 wxBrush
brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID
);
1795 dc
.SetBackground(brush
);
1800 // ----------------------------------------------------------------------------
1801 // find child window by id or name
1802 // ----------------------------------------------------------------------------
1804 wxWindow
*wxWindowBase::FindWindow(long id
) const
1806 if ( id
== m_windowId
)
1807 return (wxWindow
*)this;
1809 wxWindowBase
*res
= NULL
;
1810 wxWindowList::compatibility_iterator node
;
1811 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1813 wxWindowBase
*child
= node
->GetData();
1814 res
= child
->FindWindow( id
);
1817 return (wxWindow
*)res
;
1820 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1822 if ( name
== m_windowName
)
1823 return (wxWindow
*)this;
1825 wxWindowBase
*res
= NULL
;
1826 wxWindowList::compatibility_iterator node
;
1827 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1829 wxWindow
*child
= node
->GetData();
1830 res
= child
->FindWindow(name
);
1833 return (wxWindow
*)res
;
1837 // find any window by id or name or label: If parent is non-NULL, look through
1838 // children for a label or title matching the specified string. If NULL, look
1839 // through all top-level windows.
1841 // to avoid duplicating code we reuse the same helper function but with
1842 // different comparators
1844 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1845 const wxString
& label
, long id
);
1848 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1851 return win
->GetLabel() == label
;
1855 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1858 return win
->GetName() == label
;
1862 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1865 return win
->GetId() == id
;
1868 // recursive helper for the FindWindowByXXX() functions
1870 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1871 const wxString
& label
,
1873 wxFindWindowCmp cmp
)
1877 // see if this is the one we're looking for
1878 if ( (*cmp
)(parent
, label
, id
) )
1879 return (wxWindow
*)parent
;
1881 // It wasn't, so check all its children
1882 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1884 node
= node
->GetNext() )
1886 // recursively check each child
1887 wxWindow
*win
= (wxWindow
*)node
->GetData();
1888 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1898 // helper for FindWindowByXXX()
1900 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1901 const wxString
& label
,
1903 wxFindWindowCmp cmp
)
1907 // just check parent and all its children
1908 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1911 // start at very top of wx's windows
1912 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1914 node
= node
->GetNext() )
1916 // recursively check each window & its children
1917 wxWindow
*win
= node
->GetData();
1918 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1928 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1930 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1935 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1937 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1941 // fall back to the label
1942 win
= FindWindowByLabel(title
, parent
);
1950 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1952 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1955 // ----------------------------------------------------------------------------
1956 // dialog oriented functions
1957 // ----------------------------------------------------------------------------
1959 #if WXWIN_COMPATIBILITY_2_8
1960 void wxWindowBase::MakeModal(bool modal
)
1962 // Disable all other windows
1965 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1968 wxWindow
*win
= node
->GetData();
1970 win
->Enable(!modal
);
1972 node
= node
->GetNext();
1976 #endif // WXWIN_COMPATIBILITY_2_8
1978 bool wxWindowBase::Validate()
1980 #if wxUSE_VALIDATORS
1981 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1983 wxWindowList::compatibility_iterator node
;
1984 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1986 wxWindowBase
*child
= node
->GetData();
1987 wxValidator
*validator
= child
->GetValidator();
1988 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1993 if ( recurse
&& !child
->Validate() )
1998 #endif // wxUSE_VALIDATORS
2003 bool wxWindowBase::TransferDataToWindow()
2005 #if wxUSE_VALIDATORS
2006 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2008 wxWindowList::compatibility_iterator node
;
2009 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2011 wxWindowBase
*child
= node
->GetData();
2012 wxValidator
*validator
= child
->GetValidator();
2013 if ( validator
&& !validator
->TransferToWindow() )
2015 wxLogWarning(_("Could not transfer data to window"));
2017 wxLog::FlushActive();
2025 if ( !child
->TransferDataToWindow() )
2027 // warning already given
2032 #endif // wxUSE_VALIDATORS
2037 bool wxWindowBase::TransferDataFromWindow()
2039 #if wxUSE_VALIDATORS
2040 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
2042 wxWindowList::compatibility_iterator node
;
2043 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
2045 wxWindow
*child
= node
->GetData();
2046 wxValidator
*validator
= child
->GetValidator();
2047 if ( validator
&& !validator
->TransferFromWindow() )
2049 // nop warning here because the application is supposed to give
2050 // one itself - we don't know here what might have gone wrongly
2057 if ( !child
->TransferDataFromWindow() )
2059 // warning already given
2064 #endif // wxUSE_VALIDATORS
2069 void wxWindowBase::InitDialog()
2071 wxInitDialogEvent
event(GetId());
2072 event
.SetEventObject( this );
2073 GetEventHandler()->ProcessEvent(event
);
2076 // ----------------------------------------------------------------------------
2077 // context-sensitive help support
2078 // ----------------------------------------------------------------------------
2082 // associate this help text with this window
2083 void wxWindowBase::SetHelpText(const wxString
& text
)
2085 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2088 helpProvider
->AddHelp(this, text
);
2092 #if WXWIN_COMPATIBILITY_2_8
2093 // associate this help text with all windows with the same id as this
2095 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
2097 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2100 helpProvider
->AddHelp(GetId(), text
);
2103 #endif // WXWIN_COMPATIBILITY_2_8
2105 // get the help string associated with this window (may be empty)
2106 // default implementation forwards calls to the help provider
2108 wxWindowBase::GetHelpTextAtPoint(const wxPoint
& WXUNUSED(pt
),
2109 wxHelpEvent::Origin
WXUNUSED(origin
)) const
2112 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2115 text
= helpProvider
->GetHelp(this);
2121 // show help for this window
2122 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
2124 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
2127 wxPoint pos
= event
.GetPosition();
2128 const wxHelpEvent::Origin origin
= event
.GetOrigin();
2129 if ( origin
== wxHelpEvent::Origin_Keyboard
)
2131 // if the help event was generated from keyboard it shouldn't
2132 // appear at the mouse position (which is still the only position
2133 // associated with help event) if the mouse is far away, although
2134 // we still do use the mouse position if it's over the window
2135 // because we suppose the user looks approximately at the mouse
2136 // already and so it would be more convenient than showing tooltip
2137 // at some arbitrary position which can be quite far from it
2138 const wxRect rectClient
= GetClientRect();
2139 if ( !rectClient
.Contains(ScreenToClient(pos
)) )
2141 // position help slightly under and to the right of this window
2142 pos
= ClientToScreen(wxPoint(
2144 rectClient
.height
+ GetCharHeight()
2149 if ( helpProvider
->ShowHelpAtPoint(this, pos
, origin
) )
2151 // skip the event.Skip() below
2159 #endif // wxUSE_HELP
2161 // ----------------------------------------------------------------------------
2163 // ----------------------------------------------------------------------------
2167 wxString
wxWindowBase::GetToolTipText() const
2169 return m_tooltip
? m_tooltip
->GetTip() : wxString();
2172 void wxWindowBase::SetToolTip( const wxString
&tip
)
2174 // don't create the new tooltip if we already have one
2177 m_tooltip
->SetTip( tip
);
2181 SetToolTip( new wxToolTip( tip
) );
2184 // setting empty tooltip text does not remove the tooltip any more - use
2185 // SetToolTip(NULL) for this
2188 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
2190 if ( m_tooltip
!= tooltip
)
2195 m_tooltip
= tooltip
;
2199 bool wxWindowBase::CopyToolTip(wxToolTip
*tip
)
2201 SetToolTip(tip
? new wxToolTip(tip
->GetTip()) : NULL
);
2206 #endif // wxUSE_TOOLTIPS
2208 // ----------------------------------------------------------------------------
2209 // constraints and sizers
2210 // ----------------------------------------------------------------------------
2212 #if wxUSE_CONSTRAINTS
2214 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
2216 if ( m_constraints
)
2218 UnsetConstraints(m_constraints
);
2219 delete m_constraints
;
2221 m_constraints
= constraints
;
2222 if ( m_constraints
)
2224 // Make sure other windows know they're part of a 'meaningful relationship'
2225 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
2226 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
2227 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
2228 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
2229 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
2230 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
2231 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
2232 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
2233 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
2234 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
2235 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
2236 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
2237 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
2238 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
2239 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
2240 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
2244 // This removes any dangling pointers to this window in other windows'
2245 // constraintsInvolvedIn lists.
2246 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
2250 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2251 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
2252 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
2253 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
2254 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
2255 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
2256 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
2257 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
2258 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
2259 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
2260 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
2261 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
2262 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
2263 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
2264 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
2265 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
2269 // Back-pointer to other windows we're involved with, so if we delete this
2270 // window, we must delete any constraints we're involved with.
2271 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
2273 if ( !m_constraintsInvolvedIn
)
2274 m_constraintsInvolvedIn
= new wxWindowList
;
2275 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
2276 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
2279 // REMOVE back-pointer to other windows we're involved with.
2280 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
2282 if ( m_constraintsInvolvedIn
)
2283 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
2286 // Reset any constraints that mention this window
2287 void wxWindowBase::DeleteRelatedConstraints()
2289 if ( m_constraintsInvolvedIn
)
2291 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
2294 wxWindow
*win
= node
->GetData();
2295 wxLayoutConstraints
*constr
= win
->GetConstraints();
2297 // Reset any constraints involving this window
2300 constr
->left
.ResetIfWin(this);
2301 constr
->top
.ResetIfWin(this);
2302 constr
->right
.ResetIfWin(this);
2303 constr
->bottom
.ResetIfWin(this);
2304 constr
->width
.ResetIfWin(this);
2305 constr
->height
.ResetIfWin(this);
2306 constr
->centreX
.ResetIfWin(this);
2307 constr
->centreY
.ResetIfWin(this);
2310 wxWindowList::compatibility_iterator next
= node
->GetNext();
2311 m_constraintsInvolvedIn
->Erase(node
);
2315 wxDELETE(m_constraintsInvolvedIn
);
2319 #endif // wxUSE_CONSTRAINTS
2321 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
2323 if ( sizer
== m_windowSizer
)
2326 if ( m_windowSizer
)
2328 m_windowSizer
->SetContainingWindow(NULL
);
2331 delete m_windowSizer
;
2334 m_windowSizer
= sizer
;
2335 if ( m_windowSizer
)
2337 m_windowSizer
->SetContainingWindow((wxWindow
*)this);
2340 SetAutoLayout(m_windowSizer
!= NULL
);
2343 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
2345 SetSizer( sizer
, deleteOld
);
2346 sizer
->SetSizeHints( (wxWindow
*) this );
2350 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
2352 // adding a window to a sizer twice is going to result in fatal and
2353 // hard to debug problems later because when deleting the second
2354 // associated wxSizerItem we're going to dereference a dangling
2355 // pointer; so try to detect this as early as possible
2356 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
2357 wxT("Adding a window to the same sizer twice?") );
2359 m_containingSizer
= sizer
;
2362 #if wxUSE_CONSTRAINTS
2364 void wxWindowBase::SatisfyConstraints()
2366 wxLayoutConstraints
*constr
= GetConstraints();
2367 bool wasOk
= constr
&& constr
->AreSatisfied();
2369 ResetConstraints(); // Mark all constraints as unevaluated
2373 // if we're a top level panel (i.e. our parent is frame/dialog), our
2374 // own constraints will never be satisfied any more unless we do it
2378 while ( noChanges
> 0 )
2380 LayoutPhase1(&noChanges
);
2384 LayoutPhase2(&noChanges
);
2387 #endif // wxUSE_CONSTRAINTS
2389 bool wxWindowBase::Layout()
2391 // If there is a sizer, use it instead of the constraints
2395 GetVirtualSize(&w
, &h
);
2396 GetSizer()->SetDimension( 0, 0, w
, h
);
2398 #if wxUSE_CONSTRAINTS
2401 SatisfyConstraints(); // Find the right constraints values
2402 SetConstraintSizes(); // Recursively set the real window sizes
2409 void wxWindowBase::InternalOnSize(wxSizeEvent
& event
)
2411 if ( GetAutoLayout() )
2417 #if wxUSE_CONSTRAINTS
2419 // first phase of the constraints evaluation: set our own constraints
2420 bool wxWindowBase::LayoutPhase1(int *noChanges
)
2422 wxLayoutConstraints
*constr
= GetConstraints();
2424 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
2427 // second phase: set the constraints for our children
2428 bool wxWindowBase::LayoutPhase2(int *noChanges
)
2435 // Layout grand children
2441 // Do a phase of evaluating child constraints
2442 bool wxWindowBase::DoPhase(int phase
)
2444 // the list containing the children for which the constraints are already
2446 wxWindowList succeeded
;
2448 // the max number of iterations we loop before concluding that we can't set
2450 static const int maxIterations
= 500;
2452 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
2456 // loop over all children setting their constraints
2457 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2459 node
= node
->GetNext() )
2461 wxWindow
*child
= node
->GetData();
2462 if ( child
->IsTopLevel() )
2464 // top level children are not inside our client area
2468 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
2470 // this one is either already ok or nothing we can do about it
2474 int tempNoChanges
= 0;
2475 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
2476 : child
->LayoutPhase2(&tempNoChanges
);
2477 noChanges
+= tempNoChanges
;
2481 succeeded
.Append(child
);
2487 // constraints are set
2495 void wxWindowBase::ResetConstraints()
2497 wxLayoutConstraints
*constr
= GetConstraints();
2500 constr
->left
.SetDone(false);
2501 constr
->top
.SetDone(false);
2502 constr
->right
.SetDone(false);
2503 constr
->bottom
.SetDone(false);
2504 constr
->width
.SetDone(false);
2505 constr
->height
.SetDone(false);
2506 constr
->centreX
.SetDone(false);
2507 constr
->centreY
.SetDone(false);
2510 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2513 wxWindow
*win
= node
->GetData();
2514 if ( !win
->IsTopLevel() )
2515 win
->ResetConstraints();
2516 node
= node
->GetNext();
2520 // Need to distinguish between setting the 'fake' size for windows and sizers,
2521 // and setting the real values.
2522 void wxWindowBase::SetConstraintSizes(bool recurse
)
2524 wxLayoutConstraints
*constr
= GetConstraints();
2525 if ( constr
&& constr
->AreSatisfied() )
2527 int x
= constr
->left
.GetValue();
2528 int y
= constr
->top
.GetValue();
2529 int w
= constr
->width
.GetValue();
2530 int h
= constr
->height
.GetValue();
2532 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
2533 (constr
->height
.GetRelationship() != wxAsIs
) )
2535 // We really shouldn't set negative sizes for the windows so make
2536 // them at least of 1*1 size
2537 SetSize(x
, y
, w
> 0 ? w
: 1, h
> 0 ? h
: 1);
2541 // If we don't want to resize this window, just move it...
2547 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2548 GetClassInfo()->GetClassName(),
2554 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2557 wxWindow
*win
= node
->GetData();
2558 if ( !win
->IsTopLevel() && win
->GetConstraints() )
2559 win
->SetConstraintSizes();
2560 node
= node
->GetNext();
2565 // Only set the size/position of the constraint (if any)
2566 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
2568 wxLayoutConstraints
*constr
= GetConstraints();
2571 if ( x
!= wxDefaultCoord
)
2573 constr
->left
.SetValue(x
);
2574 constr
->left
.SetDone(true);
2576 if ( y
!= wxDefaultCoord
)
2578 constr
->top
.SetValue(y
);
2579 constr
->top
.SetDone(true);
2581 if ( w
!= wxDefaultCoord
)
2583 constr
->width
.SetValue(w
);
2584 constr
->width
.SetDone(true);
2586 if ( h
!= wxDefaultCoord
)
2588 constr
->height
.SetValue(h
);
2589 constr
->height
.SetDone(true);
2594 void wxWindowBase::MoveConstraint(int x
, int y
)
2596 wxLayoutConstraints
*constr
= GetConstraints();
2599 if ( x
!= wxDefaultCoord
)
2601 constr
->left
.SetValue(x
);
2602 constr
->left
.SetDone(true);
2604 if ( y
!= wxDefaultCoord
)
2606 constr
->top
.SetValue(y
);
2607 constr
->top
.SetDone(true);
2612 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2614 wxLayoutConstraints
*constr
= GetConstraints();
2617 *w
= constr
->width
.GetValue();
2618 *h
= constr
->height
.GetValue();
2624 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2626 wxLayoutConstraints
*constr
= GetConstraints();
2629 *w
= constr
->width
.GetValue();
2630 *h
= constr
->height
.GetValue();
2633 GetClientSize(w
, h
);
2636 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2638 wxLayoutConstraints
*constr
= GetConstraints();
2641 *x
= constr
->left
.GetValue();
2642 *y
= constr
->top
.GetValue();
2648 #endif // wxUSE_CONSTRAINTS
2650 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2652 wxWindow
*parent
= GetParent();
2653 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2655 wxPoint
pt(parent
->GetClientAreaOrigin());
2661 // ----------------------------------------------------------------------------
2662 // Update UI processing
2663 // ----------------------------------------------------------------------------
2665 void wxWindowBase::UpdateWindowUI(long flags
)
2667 wxUpdateUIEvent
event(GetId());
2668 event
.SetEventObject(this);
2670 if ( GetEventHandler()->ProcessEvent(event
) )
2672 DoUpdateWindowUI(event
);
2675 if (flags
& wxUPDATE_UI_RECURSE
)
2677 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2680 wxWindow
* child
= (wxWindow
*) node
->GetData();
2681 child
->UpdateWindowUI(flags
);
2682 node
= node
->GetNext();
2687 // do the window-specific processing after processing the update event
2688 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2690 if ( event
.GetSetEnabled() )
2691 Enable(event
.GetEnabled());
2693 if ( event
.GetSetShown() )
2694 Show(event
.GetShown());
2697 // ----------------------------------------------------------------------------
2699 // ----------------------------------------------------------------------------
2701 // Send idle event to window and all subwindows
2702 bool wxWindowBase::SendIdleEvents(wxIdleEvent
& event
)
2704 bool needMore
= false;
2708 // should we send idle event to this window?
2709 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL
||
2710 HasExtraStyle(wxWS_EX_PROCESS_IDLE
))
2712 event
.SetEventObject(this);
2713 HandleWindowEvent(event
);
2715 if (event
.MoreRequested())
2718 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2719 for (; node
; node
= node
->GetNext())
2721 wxWindow
* child
= node
->GetData();
2722 if (child
->SendIdleEvents(event
))
2729 void wxWindowBase::OnInternalIdle()
2731 if ( wxUpdateUIEvent::CanUpdate(this) )
2732 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
2735 // ----------------------------------------------------------------------------
2736 // dialog units translations
2737 // ----------------------------------------------------------------------------
2739 // Windows' computes dialog units using average character width over upper-
2740 // and lower-case ASCII alphabet and not using the average character width
2741 // metadata stored in the font; see
2742 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2743 // It's important that we perform the conversion in identical way, because
2744 // dialog units natively exist only on Windows and Windows HIG is expressed
2746 wxSize
wxWindowBase::GetDlgUnitBase() const
2748 const wxWindowBase
* const parent
= wxGetTopLevelParent((wxWindow
*)this);
2750 wxCHECK_MSG( parent
, wxDefaultSize
, wxS("Must have TLW parent") );
2752 if ( !parent
->m_font
.IsOk() )
2754 // Default GUI font is used. This is the most common case, so
2755 // cache the results.
2756 static wxSize s_defFontSize
;
2757 if ( s_defFontSize
.x
== 0 )
2758 s_defFontSize
= wxPrivate::GetAverageASCIILetterSize(*parent
);
2759 return s_defFontSize
;
2763 // Custom font, we always need to compute the result
2764 return wxPrivate::GetAverageASCIILetterSize(*parent
);
2768 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
) const
2770 const wxSize base
= GetDlgUnitBase();
2772 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2774 wxPoint pt2
= wxDefaultPosition
;
2775 if (pt
.x
!= wxDefaultCoord
)
2776 pt2
.x
= wxMulDivInt32(pt
.x
, 4, base
.x
);
2777 if (pt
.y
!= wxDefaultCoord
)
2778 pt2
.y
= wxMulDivInt32(pt
.y
, 8, base
.y
);
2783 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
) const
2785 const wxSize base
= GetDlgUnitBase();
2787 wxPoint pt2
= wxDefaultPosition
;
2788 if (pt
.x
!= wxDefaultCoord
)
2789 pt2
.x
= wxMulDivInt32(pt
.x
, base
.x
, 4);
2790 if (pt
.y
!= wxDefaultCoord
)
2791 pt2
.y
= wxMulDivInt32(pt
.y
, base
.y
, 8);
2796 // ----------------------------------------------------------------------------
2798 // ----------------------------------------------------------------------------
2800 // propagate the colour change event to the subwindows
2801 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& WXUNUSED(event
))
2803 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2806 // Only propagate to non-top-level windows
2807 wxWindow
*win
= node
->GetData();
2808 if ( !win
->IsTopLevel() )
2810 wxSysColourChangedEvent event2
;
2811 event2
.SetEventObject(win
);
2812 win
->GetEventHandler()->ProcessEvent(event2
);
2815 node
= node
->GetNext();
2821 // the default action is to populate dialog with data when it's created,
2822 // and nudge the UI into displaying itself correctly in case
2823 // we've turned the wxUpdateUIEvents frequency down low.
2824 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2826 TransferDataToWindow();
2828 // Update the UI at this point
2829 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2832 // ----------------------------------------------------------------------------
2833 // menu-related functions
2834 // ----------------------------------------------------------------------------
2838 bool wxWindowBase::PopupMenu(wxMenu
*menu
, int x
, int y
)
2840 wxCHECK_MSG( menu
, false, "can't popup NULL menu" );
2842 wxMenuInvokingWindowSetter
2843 setInvokingWin(*menu
, static_cast<wxWindow
*>(this));
2845 wxCurrentPopupMenu
= menu
;
2846 const bool rc
= DoPopupMenu(menu
, x
, y
);
2847 wxCurrentPopupMenu
= NULL
;
2852 // this is used to pass the id of the selected item from the menu event handler
2853 // to the main function itself
2855 // it's ok to use a global here as there can be at most one popup menu shown at
2857 static int gs_popupMenuSelection
= wxID_NONE
;
2859 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent
& event
)
2861 // store the id in a global variable where we'll retrieve it from later
2862 gs_popupMenuSelection
= event
.GetId();
2865 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent
& WXUNUSED(event
))
2867 // nothing to do but do not skip it
2871 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu
& menu
, int x
, int y
)
2873 gs_popupMenuSelection
= wxID_NONE
;
2875 Connect(wxEVT_COMMAND_MENU_SELECTED
,
2876 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2880 // it is common to construct the menu passed to this function dynamically
2881 // using some fixed range of ids which could clash with the ids used
2882 // elsewhere in the program, which could result in some menu items being
2883 // unintentionally disabled or otherwise modified by update UI handlers
2884 // elsewhere in the program code and this is difficult to avoid in the
2885 // program itself, so instead we just temporarily suspend UI updating while
2886 // this menu is shown
2887 Connect(wxEVT_UPDATE_UI
,
2888 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2892 PopupMenu(&menu
, x
, y
);
2894 Disconnect(wxEVT_UPDATE_UI
,
2895 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate
),
2898 Disconnect(wxEVT_COMMAND_MENU_SELECTED
,
2899 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu
),
2903 return gs_popupMenuSelection
;
2906 #endif // wxUSE_MENUS
2908 // methods for drawing the sizers in a visible way: this is currently only
2909 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2910 // that well and also because we don't want to leave it enabled in default
2911 // builds used for production
2912 #if wxDEBUG_LEVEL > 1
2914 static void DrawSizers(wxWindowBase
*win
);
2916 static void DrawBorder(wxWindowBase
*win
, const wxRect
& rect
, bool fill
, const wxPen
* pen
)
2918 wxClientDC
dc((wxWindow
*)win
);
2920 dc
.SetBrush(fill
? wxBrush(pen
->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH
) :
2921 *wxTRANSPARENT_BRUSH
);
2922 dc
.DrawRectangle(rect
.Deflate(1, 1));
2925 static void DrawSizer(wxWindowBase
*win
, wxSizer
*sizer
)
2927 const wxSizerItemList
& items
= sizer
->GetChildren();
2928 for ( wxSizerItemList::const_iterator i
= items
.begin(),
2933 wxSizerItem
*item
= *i
;
2934 if ( item
->IsSizer() )
2936 DrawBorder(win
, item
->GetRect().Deflate(2), false, wxRED_PEN
);
2937 DrawSizer(win
, item
->GetSizer());
2939 else if ( item
->IsSpacer() )
2941 DrawBorder(win
, item
->GetRect().Deflate(2), true, wxBLUE_PEN
);
2943 else if ( item
->IsWindow() )
2945 DrawSizers(item
->GetWindow());
2948 wxFAIL_MSG("inconsistent wxSizerItem status!");
2952 static void DrawSizers(wxWindowBase
*win
)
2954 DrawBorder(win
, win
->GetClientSize(), false, wxGREEN_PEN
);
2956 wxSizer
*sizer
= win
->GetSizer();
2959 DrawSizer(win
, sizer
);
2961 else // no sizer, still recurse into the children
2963 const wxWindowList
& children
= win
->GetChildren();
2964 for ( wxWindowList::const_iterator i
= children
.begin(),
2965 end
= children
.end();
2972 // show all kind of sizes of this window; see the "window sizing" topic
2973 // overview for more info about the various differences:
2974 wxSize fullSz
= win
->GetSize();
2975 wxSize clientSz
= win
->GetClientSize();
2976 wxSize bestSz
= win
->GetBestSize();
2977 wxSize minSz
= win
->GetMinSize();
2978 wxSize maxSz
= win
->GetMaxSize();
2979 wxSize virtualSz
= win
->GetVirtualSize();
2981 wxMessageOutputDebug dbgout
;
2983 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
2986 clientSz
.x
, clientSz
.y
,
2990 virtualSz
.x
, virtualSz
.y
);
2994 #endif // wxDEBUG_LEVEL
2996 // process special middle clicks
2997 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2999 if ( event
.ControlDown() && event
.AltDown() )
3001 #if wxDEBUG_LEVEL > 1
3002 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3003 if ( event
.ShiftDown() )
3008 #endif // __WXDEBUG__
3011 // just Ctrl-Alt-middle click shows information about wx version
3012 ::wxInfoMessageBox((wxWindow
*)this);
3013 #endif // wxUSE_MSGDLG
3022 // ----------------------------------------------------------------------------
3024 // ----------------------------------------------------------------------------
3026 #if wxUSE_ACCESSIBILITY
3027 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
3029 if (m_accessible
&& (accessible
!= m_accessible
))
3030 delete m_accessible
;
3031 m_accessible
= accessible
;
3033 m_accessible
->SetWindow((wxWindow
*) this);
3036 // Returns the accessible object, creating if necessary.
3037 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
3040 m_accessible
= CreateAccessible();
3041 return m_accessible
;
3044 // Override to create a specific accessible object.
3045 wxAccessible
* wxWindowBase::CreateAccessible()
3047 return new wxWindowAccessible((wxWindow
*) this);
3052 // ----------------------------------------------------------------------------
3053 // list classes implementation
3054 // ----------------------------------------------------------------------------
3056 #if wxUSE_STD_CONTAINERS
3058 #include "wx/listimpl.cpp"
3059 WX_DEFINE_LIST(wxWindowList
)
3061 #else // !wxUSE_STD_CONTAINERS
3063 void wxWindowListNode::DeleteData()
3065 delete (wxWindow
*)GetData();
3068 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3070 // ----------------------------------------------------------------------------
3072 // ----------------------------------------------------------------------------
3074 wxBorder
wxWindowBase::GetBorder(long flags
) const
3076 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
3077 if ( border
== wxBORDER_DEFAULT
)
3079 border
= GetDefaultBorder();
3081 else if ( border
== wxBORDER_THEME
)
3083 border
= GetDefaultBorderForControl();
3089 wxBorder
wxWindowBase::GetDefaultBorder() const
3091 return wxBORDER_NONE
;
3094 // ----------------------------------------------------------------------------
3096 // ----------------------------------------------------------------------------
3098 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
3100 // here we just check if the point is inside the window or not
3102 // check the top and left border first
3103 bool outside
= x
< 0 || y
< 0;
3106 // check the right and bottom borders too
3107 wxSize size
= GetSize();
3108 outside
= x
>= size
.x
|| y
>= size
.y
;
3111 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
3114 // ----------------------------------------------------------------------------
3116 // ----------------------------------------------------------------------------
3118 struct WXDLLEXPORT wxWindowNext
3122 } *wxWindowBase::ms_winCaptureNext
= NULL
;
3123 wxWindow
*wxWindowBase::ms_winCaptureCurrent
= NULL
;
3124 bool wxWindowBase::ms_winCaptureChanging
= false;
3126 void wxWindowBase::CaptureMouse()
3128 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3130 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive CaptureMouse call?") );
3132 ms_winCaptureChanging
= true;
3134 wxWindow
*winOld
= GetCapture();
3137 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
3140 wxWindowNext
*item
= new wxWindowNext
;
3142 item
->next
= ms_winCaptureNext
;
3143 ms_winCaptureNext
= item
;
3145 //else: no mouse capture to save
3148 ms_winCaptureCurrent
= (wxWindow
*)this;
3150 ms_winCaptureChanging
= false;
3153 void wxWindowBase::ReleaseMouse()
3155 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3157 wxASSERT_MSG( !ms_winCaptureChanging
, wxT("recursive ReleaseMouse call?") );
3159 wxASSERT_MSG( GetCapture() == this,
3160 "attempt to release mouse, but this window hasn't captured it" );
3161 wxASSERT_MSG( ms_winCaptureCurrent
== this,
3162 "attempt to release mouse, but this window hasn't captured it" );
3164 ms_winCaptureChanging
= true;
3167 ms_winCaptureCurrent
= NULL
;
3169 if ( ms_winCaptureNext
)
3171 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
3172 ms_winCaptureCurrent
= ms_winCaptureNext
->win
;
3174 wxWindowNext
*item
= ms_winCaptureNext
;
3175 ms_winCaptureNext
= item
->next
;
3178 //else: stack is empty, no previous capture
3180 ms_winCaptureChanging
= false;
3182 wxLogTrace(wxT("mousecapture"),
3183 (const wxChar
*) wxT("After ReleaseMouse() mouse is captured by %p"),
3184 static_cast<void*>(GetCapture()));
3187 static void DoNotifyWindowAboutCaptureLost(wxWindow
*win
)
3189 wxMouseCaptureLostEvent
event(win
->GetId());
3190 event
.SetEventObject(win
);
3191 if ( !win
->GetEventHandler()->ProcessEvent(event
) )
3193 // windows must handle this event, otherwise the app wouldn't behave
3194 // correctly if it loses capture unexpectedly; see the discussion here:
3195 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3196 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3197 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3202 void wxWindowBase::NotifyCaptureLost()
3204 // don't do anything if capture lost was expected, i.e. resulted from
3205 // a wx call to ReleaseMouse or CaptureMouse:
3206 if ( ms_winCaptureChanging
)
3209 // if the capture was lost unexpectedly, notify every window that has
3210 // capture (on stack or current) about it and clear the stack:
3212 if ( ms_winCaptureCurrent
)
3214 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent
);
3215 ms_winCaptureCurrent
= NULL
;
3218 while ( ms_winCaptureNext
)
3220 wxWindowNext
*item
= ms_winCaptureNext
;
3221 ms_winCaptureNext
= item
->next
;
3223 DoNotifyWindowAboutCaptureLost(item
->win
);
3232 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
3233 int WXUNUSED(modifiers
),
3234 int WXUNUSED(keycode
))
3240 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
3246 #endif // wxUSE_HOTKEY
3248 // ----------------------------------------------------------------------------
3250 // ----------------------------------------------------------------------------
3252 bool wxWindowBase::TryBefore(wxEvent
& event
)
3254 #if wxUSE_VALIDATORS
3255 // Can only use the validator of the window which
3256 // is receiving the event
3257 if ( event
.GetEventObject() == this )
3259 wxValidator
* const validator
= GetValidator();
3260 if ( validator
&& validator
->ProcessEventLocally(event
) )
3265 #endif // wxUSE_VALIDATORS
3267 return wxEvtHandler::TryBefore(event
);
3270 bool wxWindowBase::TryAfter(wxEvent
& event
)
3272 // carry on up the parent-child hierarchy if the propagation count hasn't
3274 if ( event
.ShouldPropagate() )
3276 // honour the requests to stop propagation at this window: this is
3277 // used by the dialogs, for example, to prevent processing the events
3278 // from the dialog controls in the parent frame which rarely, if ever,
3280 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
3282 wxWindow
*parent
= GetParent();
3283 if ( parent
&& !parent
->IsBeingDeleted() )
3285 wxPropagateOnce
propagateOnce(event
);
3287 return parent
->GetEventHandler()->ProcessEvent(event
);
3292 return wxEvtHandler::TryAfter(event
);
3295 // ----------------------------------------------------------------------------
3296 // window relationships
3297 // ----------------------------------------------------------------------------
3299 wxWindow
*wxWindowBase::DoGetSibling(WindowOrder order
) const
3301 wxCHECK_MSG( GetParent(), NULL
,
3302 wxT("GetPrev/NextSibling() don't work for TLWs!") );
3304 wxWindowList
& siblings
= GetParent()->GetChildren();
3305 wxWindowList::compatibility_iterator i
= siblings
.Find((wxWindow
*)this);
3306 wxCHECK_MSG( i
, NULL
, wxT("window not a child of its parent?") );
3308 if ( order
== OrderBefore
)
3309 i
= i
->GetPrevious();
3313 return i
? i
->GetData() : NULL
;
3316 // ----------------------------------------------------------------------------
3317 // keyboard navigation
3318 // ----------------------------------------------------------------------------
3320 // Navigates in the specified direction inside this window
3321 bool wxWindowBase::DoNavigateIn(int flags
)
3323 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3324 // native code doesn't process our wxNavigationKeyEvents anyhow
3327 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3328 wxNavigationKeyEvent eventNav
;
3329 wxWindow
*focused
= FindFocus();
3330 eventNav
.SetCurrentFocus(focused
);
3331 eventNav
.SetEventObject(focused
);
3332 eventNav
.SetFlags(flags
);
3333 return GetEventHandler()->ProcessEvent(eventNav
);
3334 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3337 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent
& event
)
3339 if ( event
.GetKeyCode() != WXK_TAB
)
3342 int flags
= wxNavigationKeyEvent::FromTab
;
3344 if ( event
.ShiftDown() )
3345 flags
|= wxNavigationKeyEvent::IsBackward
;
3347 flags
|= wxNavigationKeyEvent::IsForward
;
3349 if ( event
.ControlDown() )
3350 flags
|= wxNavigationKeyEvent::WinChange
;
3356 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, WindowOrder move
)
3358 // check that we're not a top level window
3359 wxCHECK_RET( GetParent(),
3360 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3362 // detect the special case when we have nothing to do anyhow and when the
3363 // code below wouldn't work
3367 // find the target window in the siblings list
3368 wxWindowList
& siblings
= GetParent()->GetChildren();
3369 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
3370 wxCHECK_RET( i
, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3372 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3373 // implemented so we can't just move the node around
3374 wxWindow
*self
= (wxWindow
*)this;
3375 siblings
.DeleteObject(self
);
3376 if ( move
== OrderAfter
)
3383 siblings
.Insert(i
, self
);
3385 else // OrderAfter and win was the last sibling
3387 siblings
.Append(self
);
3391 // ----------------------------------------------------------------------------
3393 // ----------------------------------------------------------------------------
3395 /*static*/ wxWindow
* wxWindowBase::FindFocus()
3397 wxWindowBase
*win
= DoFindFocus();
3398 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
3401 bool wxWindowBase::HasFocus() const
3403 wxWindowBase
* const win
= DoFindFocus();
3405 (this == win
|| this == win
->GetMainWindowOfCompositeControl());
3408 // ----------------------------------------------------------------------------
3410 // ----------------------------------------------------------------------------
3412 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3417 class DragAcceptFilesTarget
: public wxFileDropTarget
3420 DragAcceptFilesTarget(wxWindowBase
*win
) : m_win(win
) {}
3422 virtual bool OnDropFiles(wxCoord x
, wxCoord y
,
3423 const wxArrayString
& filenames
)
3425 wxDropFilesEvent
event(wxEVT_DROP_FILES
,
3427 wxCArrayString(filenames
).Release());
3428 event
.SetEventObject(m_win
);
3432 return m_win
->HandleWindowEvent(event
);
3436 wxWindowBase
* const m_win
;
3438 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget
);
3442 } // anonymous namespace
3444 // Generic version of DragAcceptFiles(). It works by installing a simple
3445 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3446 // together with explicit SetDropTarget() calls.
3447 void wxWindowBase::DragAcceptFiles(bool accept
)
3451 wxASSERT_MSG( !GetDropTarget(),
3452 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3453 SetDropTarget(new DragAcceptFilesTarget(this));
3457 SetDropTarget(NULL
);
3461 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3463 // ----------------------------------------------------------------------------
3465 // ----------------------------------------------------------------------------
3467 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
3469 while ( win
&& !win
->IsTopLevel() )
3470 win
= win
->GetParent();
3475 #if wxUSE_ACCESSIBILITY
3476 // ----------------------------------------------------------------------------
3477 // accessible object for windows
3478 // ----------------------------------------------------------------------------
3480 // Can return either a child object, or an integer
3481 // representing the child element, starting from 1.
3482 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
3484 wxASSERT( GetWindow() != NULL
);
3488 return wxACC_NOT_IMPLEMENTED
;
3491 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3492 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
3494 wxASSERT( GetWindow() != NULL
);
3498 wxWindow
* win
= NULL
;
3505 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
3507 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
3514 rect
= win
->GetRect();
3515 if (win
->GetParent() && !wxDynamicCast(win
, wxTopLevelWindow
))
3516 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
3520 return wxACC_NOT_IMPLEMENTED
;
3523 // Navigates from fromId to toId/toObject.
3524 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
3525 int* WXUNUSED(toId
), wxAccessible
** toObject
)
3527 wxASSERT( GetWindow() != NULL
);
3533 case wxNAVDIR_FIRSTCHILD
:
3535 if (GetWindow()->GetChildren().GetCount() == 0)
3537 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
3538 *toObject
= childWindow
->GetOrCreateAccessible();
3542 case wxNAVDIR_LASTCHILD
:
3544 if (GetWindow()->GetChildren().GetCount() == 0)
3546 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
3547 *toObject
= childWindow
->GetOrCreateAccessible();
3551 case wxNAVDIR_RIGHT
:
3555 wxWindowList::compatibility_iterator node
=
3556 wxWindowList::compatibility_iterator();
3559 // Can't navigate to sibling of this window
3560 // if we're a top-level window.
3561 if (!GetWindow()->GetParent())
3562 return wxACC_NOT_IMPLEMENTED
;
3564 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3568 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3569 node
= GetWindow()->GetChildren().Item(fromId
-1);
3572 if (node
&& node
->GetNext())
3574 wxWindow
* nextWindow
= node
->GetNext()->GetData();
3575 *toObject
= nextWindow
->GetOrCreateAccessible();
3583 case wxNAVDIR_PREVIOUS
:
3585 wxWindowList::compatibility_iterator node
=
3586 wxWindowList::compatibility_iterator();
3589 // Can't navigate to sibling of this window
3590 // if we're a top-level window.
3591 if (!GetWindow()->GetParent())
3592 return wxACC_NOT_IMPLEMENTED
;
3594 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3598 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
3599 node
= GetWindow()->GetChildren().Item(fromId
-1);
3602 if (node
&& node
->GetPrevious())
3604 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
3605 *toObject
= previousWindow
->GetOrCreateAccessible();
3613 return wxACC_NOT_IMPLEMENTED
;
3616 // Gets the name of the specified object.
3617 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
3619 wxASSERT( GetWindow() != NULL
);
3625 // If a child, leave wxWidgets to call the function on the actual
3628 return wxACC_NOT_IMPLEMENTED
;
3630 // This will eventually be replaced by specialised
3631 // accessible classes, one for each kind of wxWidgets
3632 // control or window.
3634 if (wxDynamicCast(GetWindow(), wxButton
))
3635 title
= ((wxButton
*) GetWindow())->GetLabel();
3638 title
= GetWindow()->GetName();
3646 return wxACC_NOT_IMPLEMENTED
;
3649 // Gets the number of children.
3650 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
3652 wxASSERT( GetWindow() != NULL
);
3656 *childId
= (int) GetWindow()->GetChildren().GetCount();
3660 // Gets the specified child (starting from 1).
3661 // If *child is NULL and return value is wxACC_OK,
3662 // this means that the child is a simple element and
3663 // not an accessible object.
3664 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
3666 wxASSERT( GetWindow() != NULL
);
3676 if (childId
> (int) GetWindow()->GetChildren().GetCount())
3679 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
3680 *child
= childWindow
->GetOrCreateAccessible();
3687 // Gets the parent, or NULL.
3688 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
3690 wxASSERT( GetWindow() != NULL
);
3694 wxWindow
* parentWindow
= GetWindow()->GetParent();
3702 *parent
= parentWindow
->GetOrCreateAccessible();
3710 // Performs the default action. childId is 0 (the action for this object)
3711 // or > 0 (the action for a child).
3712 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3713 // window (e.g. an edit control).
3714 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
3716 wxASSERT( GetWindow() != NULL
);
3720 return wxACC_NOT_IMPLEMENTED
;
3723 // Gets the default action for this object (0) or > 0 (the action for a child).
3724 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3725 // string if there is no action.
3726 // The retrieved string describes the action that is performed on an object,
3727 // not what the object does as a result. For example, a toolbar button that prints
3728 // a document has a default action of "Press" rather than "Prints the current document."
3729 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
3731 wxASSERT( GetWindow() != NULL
);
3735 return wxACC_NOT_IMPLEMENTED
;
3738 // Returns the description for this object or a child.
3739 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
3741 wxASSERT( GetWindow() != NULL
);
3745 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3751 return wxACC_NOT_IMPLEMENTED
;
3754 // Returns help text for this object or a child, similar to tooltip text.
3755 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
3757 wxASSERT( GetWindow() != NULL
);
3761 wxString
ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition
, wxHelpEvent::Origin_Keyboard
));
3767 return wxACC_NOT_IMPLEMENTED
;
3770 // Returns the keyboard shortcut for this object or child.
3771 // Return e.g. ALT+K
3772 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
3774 wxASSERT( GetWindow() != NULL
);
3778 return wxACC_NOT_IMPLEMENTED
;
3781 // Returns a role constant.
3782 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
3784 wxASSERT( GetWindow() != NULL
);
3788 // If a child, leave wxWidgets to call the function on the actual
3791 return wxACC_NOT_IMPLEMENTED
;
3793 if (wxDynamicCast(GetWindow(), wxControl
))
3794 return wxACC_NOT_IMPLEMENTED
;
3796 if (wxDynamicCast(GetWindow(), wxStatusBar
))
3797 return wxACC_NOT_IMPLEMENTED
;
3800 if (wxDynamicCast(GetWindow(), wxToolBar
))
3801 return wxACC_NOT_IMPLEMENTED
;
3804 //*role = wxROLE_SYSTEM_CLIENT;
3805 *role
= wxROLE_SYSTEM_CLIENT
;
3809 return wxACC_NOT_IMPLEMENTED
;
3813 // Returns a state constant.
3814 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
3816 wxASSERT( GetWindow() != NULL
);
3820 // If a child, leave wxWidgets to call the function on the actual
3823 return wxACC_NOT_IMPLEMENTED
;
3825 if (wxDynamicCast(GetWindow(), wxControl
))
3826 return wxACC_NOT_IMPLEMENTED
;
3829 if (wxDynamicCast(GetWindow(), wxStatusBar
))
3830 return wxACC_NOT_IMPLEMENTED
;
3833 if (wxDynamicCast(GetWindow(), wxToolBar
))
3834 return wxACC_NOT_IMPLEMENTED
;
3841 return wxACC_NOT_IMPLEMENTED
;
3845 // Returns a localized string representing the value for the object
3847 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
3849 wxASSERT( GetWindow() != NULL
);
3853 return wxACC_NOT_IMPLEMENTED
;
3856 // Selects the object or child.
3857 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
3859 wxASSERT( GetWindow() != NULL
);
3863 return wxACC_NOT_IMPLEMENTED
;
3866 // Gets the window with the keyboard focus.
3867 // If childId is 0 and child is NULL, no object in
3868 // this subhierarchy has the focus.
3869 // If this object has the focus, child should be 'this'.
3870 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
3872 wxASSERT( GetWindow() != NULL
);
3876 return wxACC_NOT_IMPLEMENTED
;
3880 // Gets a variant representing the selected children
3882 // Acceptable values:
3883 // - a null variant (IsNull() returns true)
3884 // - a list variant (GetType() == wxT("list")
3885 // - an integer representing the selected child element,
3886 // or 0 if this object is selected (GetType() == wxT("long")
3887 // - a "void*" pointer to a wxAccessible child object
3888 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3890 wxASSERT( GetWindow() != NULL
);
3894 return wxACC_NOT_IMPLEMENTED
;
3896 #endif // wxUSE_VARIANT
3898 #endif // wxUSE_ACCESSIBILITY
3900 // ----------------------------------------------------------------------------
3902 // ----------------------------------------------------------------------------
3905 wxWindowBase::AdjustForLayoutDirection(wxCoord x
,
3907 wxCoord widthTotal
) const
3909 if ( GetLayoutDirection() == wxLayout_RightToLeft
)
3911 x
= widthTotal
- x
- width
;