1 /////////////////////////////////////////////////////////////////////////////
2 // Name: common/window.cpp
3 // Purpose: common (to all ports) wxWindow functions
4 // Author: Julian Smart, Vadim Zeitlin
8 // Copyright: (c) wxWindows team
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "windowbase.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
32 #include "wx/string.h"
37 #include "wx/window.h"
38 #include "wx/control.h"
39 #include "wx/checkbox.h"
40 #include "wx/radiobut.h"
41 #include "wx/statbox.h"
42 #include "wx/textctrl.h"
43 #include "wx/settings.h"
44 #include "wx/dialog.h"
45 #include "wx/msgdlg.h"
46 #include "wx/statusbr.h"
47 #include "wx/dcclient.h"
51 #include "wx/layout.h"
52 #endif // wxUSE_CONSTRAINTS
56 #if wxUSE_DRAG_AND_DROP
58 #endif // wxUSE_DRAG_AND_DROP
60 #if wxUSE_ACCESSIBILITY
61 #include "wx/access.h"
65 #include "wx/cshelp.h"
69 #include "wx/tooltip.h"
70 #endif // wxUSE_TOOLTIPS
76 // ----------------------------------------------------------------------------
78 // ----------------------------------------------------------------------------
81 int wxWindowBase::ms_lastControlId
= 2000;
83 int wxWindowBase::ms_lastControlId
= -200;
86 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase
, wxEvtHandler
)
88 // ----------------------------------------------------------------------------
90 // ----------------------------------------------------------------------------
92 BEGIN_EVENT_TABLE(wxWindowBase
, wxEvtHandler
)
93 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged
)
94 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog
)
95 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick
)
98 EVT_HELP(-1, wxWindowBase::OnHelp
)
103 // ============================================================================
104 // implementation of the common functionality of the wxWindow class
105 // ============================================================================
107 // ----------------------------------------------------------------------------
109 // ----------------------------------------------------------------------------
111 // the default initialization
112 void wxWindowBase::InitBase()
114 // no window yet, no parent nor children
115 m_parent
= (wxWindow
*)NULL
;
117 m_children
.DeleteContents( FALSE
); // don't auto delete node data
119 // no constraints on the minimal window size
125 // window is created enabled but it's not visible yet
129 // the default event handler is just this window
130 m_eventHandler
= this;
134 m_windowValidator
= (wxValidator
*) NULL
;
135 #endif // wxUSE_VALIDATORS
137 // use the system default colours
138 m_backgroundColour
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
139 m_foregroundColour
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
141 // don't set the font here for wxMSW as we don't call WM_SETFONT here and
142 // so the font is *not* really set - but calls to SetFont() later won't do
143 // anything because m_font appears to be already set!
145 m_font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
148 // the colours/fonts are default for now
157 // an optimization for the event processing: checking this flag is much
158 // faster than using IsKindOf(CLASSINFO(wxWindow))
161 #if wxUSE_CONSTRAINTS
162 // no constraints whatsoever
163 m_constraints
= (wxLayoutConstraints
*) NULL
;
164 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
165 #endif // wxUSE_CONSTRAINTS
167 m_windowSizer
= (wxSizer
*) NULL
;
168 m_containingSizer
= (wxSizer
*) NULL
;
169 m_autoLayout
= FALSE
;
171 #if wxUSE_DRAG_AND_DROP
172 m_dropTarget
= (wxDropTarget
*)NULL
;
173 #endif // wxUSE_DRAG_AND_DROP
176 m_tooltip
= (wxToolTip
*)NULL
;
177 #endif // wxUSE_TOOLTIPS
180 m_caret
= (wxCaret
*)NULL
;
181 #endif // wxUSE_CARET
184 m_hasCustomPalette
= FALSE
;
185 #endif // wxUSE_PALETTE
187 #if wxUSE_ACCESSIBILITY
191 m_virtualSize
= wxDefaultSize
;
196 m_maxVirtualHeight
= -1;
198 // Whether we're using the current theme for this window (wxGTK only for now)
199 m_themeEnabled
= FALSE
;
202 // common part of window creation process
203 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
205 const wxPoint
& WXUNUSED(pos
),
206 const wxSize
& WXUNUSED(size
),
208 const wxValidator
& validator
,
209 const wxString
& name
)
211 // m_isWindow is set to TRUE in wxWindowBase::Init() as well as many other
212 // member variables - check that it has been called (will catch the case
213 // when a new ctor is added which doesn't call InitWindow)
214 wxASSERT_MSG( m_isWindow
, wxT("Init() must have been called before!") );
217 // wxGTK doesn't allow to create controls with static box as the parent so
218 // this will result in a crash when the program is ported to wxGTK so warn
221 // if you get this assert, the correct solution is to create the controls
222 // as siblings of the static box
223 wxASSERT_MSG( !parent
|| !wxDynamicCast(parent
, wxStaticBox
),
224 _T("wxStaticBox can't be used as a window parent!") );
225 #endif // wxUSE_STATBOX
227 // generate a new id if the user doesn't care about it
228 m_windowId
= id
== -1 ? NewControlId() : id
;
231 SetWindowStyleFlag(style
);
235 SetValidator(validator
);
236 #endif // wxUSE_VALIDATORS
238 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
239 // have it too - like this it's possible to set it only in the top level
240 // dialog/frame and all children will inherit it by defult
241 if ( parent
&& (parent
->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) )
243 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY
);
249 // ----------------------------------------------------------------------------
251 // ----------------------------------------------------------------------------
254 wxWindowBase::~wxWindowBase()
256 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
258 // FIXME if these 2 cases result from programming errors in the user code
259 // we should probably assert here instead of silently fixing them
261 // Just in case the window has been Closed, but we're then deleting
262 // immediately: don't leave dangling pointers.
263 wxPendingDelete
.DeleteObject(this);
265 // Just in case we've loaded a top-level window via LoadNativeDialog but
266 // we weren't a dialog class
267 wxTopLevelWindows
.DeleteObject(this);
269 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
274 #endif // wxUSE_CARET
277 if ( m_windowValidator
)
278 delete m_windowValidator
;
279 #endif // wxUSE_VALIDATORS
281 #if wxUSE_CONSTRAINTS
282 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
283 // at deleted windows as they delete themselves.
284 DeleteRelatedConstraints();
288 // This removes any dangling pointers to this window in other windows'
289 // constraintsInvolvedIn lists.
290 UnsetConstraints(m_constraints
);
291 delete m_constraints
;
292 m_constraints
= NULL
;
295 #endif // wxUSE_CONSTRAINTS
297 if ( m_containingSizer
)
298 m_containingSizer
->Detach( (wxWindow
*)this );
301 delete m_windowSizer
;
303 #if wxUSE_DRAG_AND_DROP
306 #endif // wxUSE_DRAG_AND_DROP
311 #endif // wxUSE_TOOLTIPS
313 #if wxUSE_ACCESSIBILITY
318 // reset the dangling pointer our parent window may keep to us
319 if ( m_parent
&& m_parent
->GetDefaultItem() == this )
321 m_parent
->SetDefaultItem(NULL
);
325 bool wxWindowBase::Destroy()
332 bool wxWindowBase::Close(bool force
)
334 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
335 event
.SetEventObject(this);
336 #if WXWIN_COMPATIBILITY
337 event
.SetForce(force
);
338 #endif // WXWIN_COMPATIBILITY
339 event
.SetCanVeto(!force
);
341 // return FALSE if window wasn't closed because the application vetoed the
343 return GetEventHandler()->ProcessEvent(event
) && !event
.GetVeto();
346 bool wxWindowBase::DestroyChildren()
348 wxWindowList::Node
*node
;
351 // we iterate until the list becomes empty
352 node
= GetChildren().GetFirst();
356 wxWindow
*child
= node
->GetData();
358 wxASSERT_MSG( child
, wxT("children list contains empty nodes") );
363 wxASSERT_MSG( !GetChildren().Find(child
),
364 wxT("child didn't remove itself using RemoveChild()") );
370 // ----------------------------------------------------------------------------
371 // size/position related methods
372 // ----------------------------------------------------------------------------
374 // centre the window with respect to its parent in either (or both) directions
375 void wxWindowBase::Centre(int direction
)
377 // the position/size of the parent window or of the entire screen
379 int widthParent
, heightParent
;
381 wxWindow
*parent
= NULL
;
383 if ( !(direction
& wxCENTRE_ON_SCREEN
) )
385 // find the parent to centre this window on: it should be the
386 // immediate parent for the controls but the top level parent for the
387 // top level windows (like dialogs)
388 parent
= GetParent();
391 while ( parent
&& !parent
->IsTopLevel() )
393 parent
= parent
->GetParent();
397 // there is no wxTopLevelWindow under wxMotif yet
399 // we shouldn't center the dialog on the iconized window: under
400 // Windows, for example, this places it completely off the screen
403 wxTopLevelWindow
*winTop
= wxDynamicCast(parent
, wxTopLevelWindow
);
404 if ( winTop
&& winTop
->IsIconized() )
409 #endif // __WXMOTIF__
411 // did we find the parent?
415 direction
|= wxCENTRE_ON_SCREEN
;
419 if ( direction
& wxCENTRE_ON_SCREEN
)
421 // centre with respect to the whole screen
422 wxDisplaySize(&widthParent
, &heightParent
);
428 // centre on the parent
429 parent
->GetSize(&widthParent
, &heightParent
);
431 // adjust to the parents position
432 posParent
= parent
->GetPosition();
436 // centre inside the parents client rectangle
437 parent
->GetClientSize(&widthParent
, &heightParent
);
442 GetSize(&width
, &height
);
447 if ( direction
& wxHORIZONTAL
)
448 xNew
= (widthParent
- width
)/2;
450 if ( direction
& wxVERTICAL
)
451 yNew
= (heightParent
- height
)/2;
456 // Base size of the visible dimensions of the display
457 // to take into account the taskbar
458 wxRect rect
= wxGetClientDisplayRect();
459 wxSize
size (rect
.width
,rect
.height
);
461 // NB: in wxMSW, negative position may not neccessary mean "out of screen",
462 // but it may mean that the window is placed on other than the main
463 // display. Therefore we only make sure centered window is on the main display
464 // if the parent is at least partially present here.
465 if (posParent
.x
+ widthParent
>= 0) // if parent is (partially) on the main display
469 else if (xNew
+width
> size
.x
)
470 xNew
= size
.x
-width
-1;
472 if (posParent
.y
+ heightParent
>= 0) // if parent is (partially) on the main display
474 if (yNew
+height
> size
.y
)
475 yNew
= size
.y
-height
-1;
477 // Make certain that the title bar is initially visible
478 // always, even if this would push the bottom of the
479 // dialog of the visible area of the display
484 // move the window to this position (keeping the old size but using
485 // SetSize() and not Move() to allow xNew and/or yNew to be -1)
486 SetSize(xNew
, yNew
, width
, height
, wxSIZE_ALLOW_MINUS_ONE
);
489 // fits the window around the children
490 void wxWindowBase::Fit()
492 if ( GetChildren().GetCount() > 0 )
494 SetClientSize(DoGetBestSize());
496 //else: do nothing if we have no children
499 // fits virtual size (ie. scrolled area etc.) around children
500 void wxWindowBase::FitInside()
502 if ( GetChildren().GetCount() > 0 )
504 SetVirtualSize( GetBestVirtualSize() );
508 // return the size best suited for the current window
509 wxSize
wxWindowBase::DoGetBestSize() const
513 return m_windowSizer
->GetMinSize();
515 #if wxUSE_CONSTRAINTS
516 else if ( m_constraints
)
518 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
520 // our minimal acceptable size is such that all our windows fit inside
524 for ( wxWindowList::Node
*node
= GetChildren().GetFirst();
526 node
= node
->GetNext() )
528 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
531 // it's not normal that we have an unconstrained child, but
532 // what can we do about it?
536 int x
= c
->right
.GetValue(),
537 y
= c
->bottom
.GetValue();
545 // TODO: we must calculate the overlaps somehow, otherwise we
546 // will never return a size bigger than the current one :-(
549 return wxSize(maxX
, maxY
);
551 #endif // wxUSE_CONSTRAINTS
552 else if ( GetChildren().GetCount() > 0 )
554 // our minimal acceptable size is such that all our windows fit inside
558 for ( wxWindowList::Node
*node
= GetChildren().GetFirst();
560 node
= node
->GetNext() )
562 wxWindow
*win
= node
->GetData();
563 if ( win
->IsTopLevel()
565 || wxDynamicCast(win
, wxStatusBar
)
566 #endif // wxUSE_STATUSBAR
569 // dialogs and frames lie in different top level windows -
570 // don't deal with them here; as for the status bars, they
571 // don't lie in the client area at all
576 win
->GetPosition(&wx
, &wy
);
578 // if the window hadn't been positioned yet, assume that it is in
585 win
->GetSize(&ww
, &wh
);
586 if ( wx
+ ww
> maxX
)
588 if ( wy
+ wh
> maxY
)
592 // for compatibility with the old versions and because it really looks
593 // slightly more pretty like this, add a pad
597 return wxSize(maxX
, maxY
);
601 // for a generic window there is no natural best size - just use the
607 // by default the origin is not shifted
608 wxPoint
wxWindowBase::GetClientAreaOrigin() const
610 return wxPoint(0, 0);
613 // set the min/max size of the window
614 void wxWindowBase::SetSizeHints(int minW
, int minH
,
616 int WXUNUSED(incW
), int WXUNUSED(incH
))
624 void wxWindowBase::SetVirtualSizeHints( int minW
, int minH
,
627 m_minVirtualWidth
= minW
;
628 m_maxVirtualWidth
= maxW
;
629 m_minVirtualHeight
= minH
;
630 m_maxVirtualHeight
= maxH
;
633 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
635 if ( m_minVirtualWidth
!= -1 && m_minVirtualWidth
> x
)
636 x
= m_minVirtualWidth
;
637 if ( m_maxVirtualWidth
!= -1 && m_maxVirtualWidth
< x
)
638 x
= m_maxVirtualWidth
;
639 if ( m_minVirtualHeight
!= -1 && m_minVirtualHeight
> y
)
640 y
= m_minVirtualHeight
;
641 if ( m_maxVirtualHeight
!= -1 && m_maxVirtualHeight
< y
)
642 y
= m_maxVirtualHeight
;
644 m_virtualSize
= wxSize(x
, y
);
647 wxSize
wxWindowBase::DoGetVirtualSize() const
649 wxSize
s( GetClientSize() );
651 return wxSize( wxMax( m_virtualSize
.GetWidth(), s
.GetWidth() ),
652 wxMax( m_virtualSize
.GetHeight(), s
.GetHeight() ) );
655 // ----------------------------------------------------------------------------
656 // show/hide/enable/disable the window
657 // ----------------------------------------------------------------------------
659 bool wxWindowBase::Show(bool show
)
661 if ( show
!= m_isShown
)
673 bool wxWindowBase::Enable(bool enable
)
675 if ( enable
!= m_isEnabled
)
677 m_isEnabled
= enable
;
686 // ----------------------------------------------------------------------------
688 // ----------------------------------------------------------------------------
690 bool wxWindowBase::IsTopLevel() const
695 // ----------------------------------------------------------------------------
696 // reparenting the window
697 // ----------------------------------------------------------------------------
699 void wxWindowBase::AddChild(wxWindowBase
*child
)
701 wxCHECK_RET( child
, wxT("can't add a NULL child") );
703 // this should never happen and it will lead to a crash later if it does
704 // because RemoveChild() will remove only one node from the children list
705 // and the other(s) one(s) will be left with dangling pointers in them
706 wxASSERT_MSG( !GetChildren().Find(child
), _T("AddChild() called twice") );
708 GetChildren().Append(child
);
709 child
->SetParent(this);
712 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
714 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
716 GetChildren().DeleteObject(child
);
717 child
->SetParent((wxWindow
*)NULL
);
720 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
722 wxWindow
*oldParent
= GetParent();
723 if ( newParent
== oldParent
)
729 // unlink this window from the existing parent.
732 oldParent
->RemoveChild(this);
736 wxTopLevelWindows
.DeleteObject(this);
739 // add it to the new one
742 newParent
->AddChild(this);
746 wxTopLevelWindows
.Append(this);
752 // ----------------------------------------------------------------------------
753 // event handler stuff
754 // ----------------------------------------------------------------------------
756 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
758 wxEvtHandler
*handlerOld
= GetEventHandler();
760 handler
->SetNextHandler(handlerOld
);
763 GetEventHandler()->SetPreviousHandler(handler
);
765 SetEventHandler(handler
);
768 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
770 wxEvtHandler
*handlerA
= GetEventHandler();
773 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
774 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
777 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
778 SetEventHandler(handlerB
);
783 handlerA
= (wxEvtHandler
*)NULL
;
790 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
792 wxCHECK_MSG( handler
, FALSE
, _T("RemoveEventHandler(NULL) called") );
794 wxEvtHandler
*handlerPrev
= NULL
,
795 *handlerCur
= GetEventHandler();
798 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
800 if ( handlerCur
== handler
)
804 handlerPrev
->SetNextHandler(handlerNext
);
808 SetEventHandler(handlerNext
);
813 handlerNext
->SetPreviousHandler ( handlerPrev
);
815 handler
->SetNextHandler(NULL
);
820 handlerPrev
= handlerCur
;
821 handlerCur
= handlerNext
;
824 wxFAIL_MSG( _T("where has the event handler gone?") );
829 // ----------------------------------------------------------------------------
831 // ----------------------------------------------------------------------------
833 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
835 if ( !colour
.Ok() || (colour
== m_backgroundColour
) )
838 m_backgroundColour
= colour
;
845 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
847 if ( !colour
.Ok() || (colour
== m_foregroundColour
) )
850 m_foregroundColour
= colour
;
857 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
859 // setting an invalid cursor is ok, it means that we don't have any special
861 if ( m_cursor
== cursor
)
872 bool wxWindowBase::SetFont(const wxFont
& font
)
874 // don't try to set invalid font, always fall back to the default
875 const wxFont
& fontOk
= font
.Ok() ? font
: *wxSWISS_FONT
;
877 if ( fontOk
== m_font
)
892 void wxWindowBase::SetPalette(const wxPalette
& pal
)
894 m_hasCustomPalette
= TRUE
;
897 // VZ: can anyone explain me what do we do here?
898 wxWindowDC
d((wxWindow
*) this);
902 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
904 wxWindow
*win
= (wxWindow
*)this;
905 while ( win
&& !win
->HasCustomPalette() )
907 win
= win
->GetParent();
913 #endif // wxUSE_PALETTE
916 void wxWindowBase::SetCaret(wxCaret
*caret
)
927 wxASSERT_MSG( m_caret
->GetWindow() == this,
928 wxT("caret should be created associated to this window") );
931 #endif // wxUSE_CARET
934 // ----------------------------------------------------------------------------
936 // ----------------------------------------------------------------------------
938 void wxWindowBase::SetValidator(const wxValidator
& validator
)
940 if ( m_windowValidator
)
941 delete m_windowValidator
;
943 m_windowValidator
= (wxValidator
*)validator
.Clone();
945 if ( m_windowValidator
)
946 m_windowValidator
->SetWindow(this) ;
948 #endif // wxUSE_VALIDATORS
950 // ----------------------------------------------------------------------------
951 // update region stuff
952 // ----------------------------------------------------------------------------
954 wxRect
wxWindowBase::GetUpdateClientRect() const
956 wxRegion rgnUpdate
= GetUpdateRegion();
957 rgnUpdate
.Intersect(GetClientRect());
958 wxRect rectUpdate
= rgnUpdate
.GetBox();
959 wxPoint ptOrigin
= GetClientAreaOrigin();
960 rectUpdate
.x
-= ptOrigin
.x
;
961 rectUpdate
.y
-= ptOrigin
.y
;
966 bool wxWindowBase::IsExposed(int x
, int y
) const
968 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
971 bool wxWindowBase::IsExposed(int x
, int y
, int w
, int h
) const
973 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
976 // ----------------------------------------------------------------------------
977 // find child window by id or name
978 // ----------------------------------------------------------------------------
980 wxWindow
*wxWindowBase::FindWindow( long id
)
982 if ( id
== m_windowId
)
983 return (wxWindow
*)this;
985 wxWindowBase
*res
= (wxWindow
*)NULL
;
986 wxWindowList::Node
*node
;
987 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
989 wxWindowBase
*child
= node
->GetData();
990 res
= child
->FindWindow( id
);
993 return (wxWindow
*)res
;
996 wxWindow
*wxWindowBase::FindWindow( const wxString
& name
)
998 if ( name
== m_windowName
)
999 return (wxWindow
*)this;
1001 wxWindowBase
*res
= (wxWindow
*)NULL
;
1002 wxWindowList::Node
*node
;
1003 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1005 wxWindow
*child
= node
->GetData();
1006 res
= child
->FindWindow(name
);
1009 return (wxWindow
*)res
;
1013 // find any window by id or name or label: If parent is non-NULL, look through
1014 // children for a label or title matching the specified string. If NULL, look
1015 // through all top-level windows.
1017 // to avoid duplicating code we reuse the same helper function but with
1018 // different comparators
1020 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1021 const wxString
& label
, long id
);
1024 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1027 return win
->GetLabel() == label
;
1031 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1034 return win
->GetName() == label
;
1038 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1041 return win
->GetId() == id
;
1044 // recursive helper for the FindWindowByXXX() functions
1046 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1047 const wxString
& label
,
1049 wxFindWindowCmp cmp
)
1053 // see if this is the one we're looking for
1054 if ( (*cmp
)(parent
, label
, id
) )
1055 return (wxWindow
*)parent
;
1057 // It wasn't, so check all its children
1058 for ( wxWindowList::Node
* node
= parent
->GetChildren().GetFirst();
1060 node
= node
->GetNext() )
1062 // recursively check each child
1063 wxWindow
*win
= (wxWindow
*)node
->GetData();
1064 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1074 // helper for FindWindowByXXX()
1076 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1077 const wxString
& label
,
1079 wxFindWindowCmp cmp
)
1083 // just check parent and all its children
1084 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1087 // start at very top of wx's windows
1088 for ( wxWindowList::Node
* node
= wxTopLevelWindows
.GetFirst();
1090 node
= node
->GetNext() )
1092 // recursively check each window & its children
1093 wxWindow
*win
= node
->GetData();
1094 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1104 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1106 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1111 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1113 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1117 // fall back to the label
1118 win
= FindWindowByLabel(title
, parent
);
1126 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1128 return wxFindWindowHelper(parent
, _T(""), id
, wxFindWindowCmpIds
);
1131 // ----------------------------------------------------------------------------
1132 // dialog oriented functions
1133 // ----------------------------------------------------------------------------
1135 void wxWindowBase::MakeModal(bool modal
)
1137 // Disable all other windows
1140 wxWindowList::Node
*node
= wxTopLevelWindows
.GetFirst();
1143 wxWindow
*win
= node
->GetData();
1145 win
->Enable(!modal
);
1147 node
= node
->GetNext();
1152 bool wxWindowBase::Validate()
1154 #if wxUSE_VALIDATORS
1155 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1157 wxWindowList::Node
*node
;
1158 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1160 wxWindowBase
*child
= node
->GetData();
1161 wxValidator
*validator
= child
->GetValidator();
1162 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1167 if ( recurse
&& !child
->Validate() )
1172 #endif // wxUSE_VALIDATORS
1177 bool wxWindowBase::TransferDataToWindow()
1179 #if wxUSE_VALIDATORS
1180 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1182 wxWindowList::Node
*node
;
1183 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1185 wxWindowBase
*child
= node
->GetData();
1186 wxValidator
*validator
= child
->GetValidator();
1187 if ( validator
&& !validator
->TransferToWindow() )
1189 wxLogWarning(_("Could not transfer data to window"));
1191 wxLog::FlushActive();
1199 if ( !child
->TransferDataToWindow() )
1201 // warning already given
1206 #endif // wxUSE_VALIDATORS
1211 bool wxWindowBase::TransferDataFromWindow()
1213 #if wxUSE_VALIDATORS
1214 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1216 wxWindowList::Node
*node
;
1217 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1219 wxWindow
*child
= node
->GetData();
1220 wxValidator
*validator
= child
->GetValidator();
1221 if ( validator
&& !validator
->TransferFromWindow() )
1223 // nop warning here because the application is supposed to give
1224 // one itself - we don't know here what might have gone wrongly
1231 if ( !child
->TransferDataFromWindow() )
1233 // warning already given
1238 #endif // wxUSE_VALIDATORS
1243 void wxWindowBase::InitDialog()
1245 wxInitDialogEvent
event(GetId());
1246 event
.SetEventObject( this );
1247 GetEventHandler()->ProcessEvent(event
);
1250 // ----------------------------------------------------------------------------
1251 // context-sensitive help support
1252 // ----------------------------------------------------------------------------
1256 // associate this help text with this window
1257 void wxWindowBase::SetHelpText(const wxString
& text
)
1259 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1262 helpProvider
->AddHelp(this, text
);
1266 // associate this help text with all windows with the same id as this
1268 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1270 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1273 helpProvider
->AddHelp(GetId(), text
);
1277 // get the help string associated with this window (may be empty)
1278 wxString
wxWindowBase::GetHelpText() const
1281 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1284 text
= helpProvider
->GetHelp(this);
1290 // show help for this window
1291 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1293 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1296 if ( helpProvider
->ShowHelp(this) )
1298 // skip the event.Skip() below
1306 #endif // wxUSE_HELP
1308 // ----------------------------------------------------------------------------
1309 // tooltipsroot.Replace("\\", "/");
1310 // ----------------------------------------------------------------------------
1314 void wxWindowBase::SetToolTip( const wxString
&tip
)
1316 // don't create the new tooltip if we already have one
1319 m_tooltip
->SetTip( tip
);
1323 SetToolTip( new wxToolTip( tip
) );
1326 // setting empty tooltip text does not remove the tooltip any more - use
1327 // SetToolTip((wxToolTip *)NULL) for this
1330 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1335 m_tooltip
= tooltip
;
1338 #endif // wxUSE_TOOLTIPS
1340 // ----------------------------------------------------------------------------
1341 // constraints and sizers
1342 // ----------------------------------------------------------------------------
1344 #if wxUSE_CONSTRAINTS
1346 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1348 if ( m_constraints
)
1350 UnsetConstraints(m_constraints
);
1351 delete m_constraints
;
1353 m_constraints
= constraints
;
1354 if ( m_constraints
)
1356 // Make sure other windows know they're part of a 'meaningful relationship'
1357 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1358 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1359 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1360 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1361 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1362 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1363 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1364 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1365 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1366 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1367 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1368 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1369 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1370 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1371 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1372 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1376 // This removes any dangling pointers to this window in other windows'
1377 // constraintsInvolvedIn lists.
1378 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1382 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1383 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1384 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1385 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1386 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1387 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1388 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1389 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1390 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1391 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1392 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1393 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1394 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1395 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1396 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1397 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1401 // Back-pointer to other windows we're involved with, so if we delete this
1402 // window, we must delete any constraints we're involved with.
1403 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1405 if ( !m_constraintsInvolvedIn
)
1406 m_constraintsInvolvedIn
= new wxWindowList
;
1407 if ( !m_constraintsInvolvedIn
->Find(otherWin
) )
1408 m_constraintsInvolvedIn
->Append(otherWin
);
1411 // REMOVE back-pointer to other windows we're involved with.
1412 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1414 if ( m_constraintsInvolvedIn
)
1415 m_constraintsInvolvedIn
->DeleteObject(otherWin
);
1418 // Reset any constraints that mention this window
1419 void wxWindowBase::DeleteRelatedConstraints()
1421 if ( m_constraintsInvolvedIn
)
1423 wxWindowList::Node
*node
= m_constraintsInvolvedIn
->GetFirst();
1426 wxWindow
*win
= node
->GetData();
1427 wxLayoutConstraints
*constr
= win
->GetConstraints();
1429 // Reset any constraints involving this window
1432 constr
->left
.ResetIfWin(this);
1433 constr
->top
.ResetIfWin(this);
1434 constr
->right
.ResetIfWin(this);
1435 constr
->bottom
.ResetIfWin(this);
1436 constr
->width
.ResetIfWin(this);
1437 constr
->height
.ResetIfWin(this);
1438 constr
->centreX
.ResetIfWin(this);
1439 constr
->centreY
.ResetIfWin(this);
1442 wxWindowList::Node
*next
= node
->GetNext();
1447 delete m_constraintsInvolvedIn
;
1448 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1452 #endif // wxUSE_CONSTRAINTS
1454 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1457 delete m_windowSizer
;
1459 m_windowSizer
= sizer
;
1461 SetAutoLayout( sizer
!= NULL
);
1464 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1466 SetSizer( sizer
, deleteOld
);
1467 sizer
->SetSizeHints( (wxWindow
*) this );
1470 #if wxUSE_CONSTRAINTS
1472 void wxWindowBase::SatisfyConstraints()
1474 wxLayoutConstraints
*constr
= GetConstraints();
1475 bool wasOk
= constr
&& constr
->AreSatisfied();
1477 ResetConstraints(); // Mark all constraints as unevaluated
1481 // if we're a top level panel (i.e. our parent is frame/dialog), our
1482 // own constraints will never be satisfied any more unless we do it
1486 while ( noChanges
> 0 )
1488 LayoutPhase1(&noChanges
);
1492 LayoutPhase2(&noChanges
);
1495 #endif // wxUSE_CONSTRAINTS
1497 bool wxWindowBase::Layout()
1499 // If there is a sizer, use it instead of the constraints
1503 GetVirtualSize(&w
, &h
);
1504 GetSizer()->SetDimension( 0, 0, w
, h
);
1506 #if wxUSE_CONSTRAINTS
1509 SatisfyConstraints(); // Find the right constraints values
1510 SetConstraintSizes(); // Recursively set the real window sizes
1517 #if wxUSE_CONSTRAINTS
1519 // first phase of the constraints evaluation: set our own constraints
1520 bool wxWindowBase::LayoutPhase1(int *noChanges
)
1522 wxLayoutConstraints
*constr
= GetConstraints();
1524 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
1527 // second phase: set the constraints for our children
1528 bool wxWindowBase::LayoutPhase2(int *noChanges
)
1535 // Layout grand children
1541 // Do a phase of evaluating child constraints
1542 bool wxWindowBase::DoPhase(int phase
)
1544 // the list containing the children for which the constraints are already
1546 wxWindowList succeeded
;
1548 // the max number of iterations we loop before concluding that we can't set
1550 static const int maxIterations
= 500;
1552 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
1556 // loop over all children setting their constraints
1557 for ( wxWindowList::Node
*node
= GetChildren().GetFirst();
1559 node
= node
->GetNext() )
1561 wxWindow
*child
= node
->GetData();
1562 if ( child
->IsTopLevel() )
1564 // top level children are not inside our client area
1568 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
1570 // this one is either already ok or nothing we can do about it
1574 int tempNoChanges
= 0;
1575 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
1576 : child
->LayoutPhase2(&tempNoChanges
);
1577 noChanges
+= tempNoChanges
;
1581 succeeded
.Append(child
);
1587 // constraints are set
1595 void wxWindowBase::ResetConstraints()
1597 wxLayoutConstraints
*constr
= GetConstraints();
1600 constr
->left
.SetDone(FALSE
);
1601 constr
->top
.SetDone(FALSE
);
1602 constr
->right
.SetDone(FALSE
);
1603 constr
->bottom
.SetDone(FALSE
);
1604 constr
->width
.SetDone(FALSE
);
1605 constr
->height
.SetDone(FALSE
);
1606 constr
->centreX
.SetDone(FALSE
);
1607 constr
->centreY
.SetDone(FALSE
);
1610 wxWindowList::Node
*node
= GetChildren().GetFirst();
1613 wxWindow
*win
= node
->GetData();
1614 if ( !win
->IsTopLevel() )
1615 win
->ResetConstraints();
1616 node
= node
->GetNext();
1620 // Need to distinguish between setting the 'fake' size for windows and sizers,
1621 // and setting the real values.
1622 void wxWindowBase::SetConstraintSizes(bool recurse
)
1624 wxLayoutConstraints
*constr
= GetConstraints();
1625 if ( constr
&& constr
->AreSatisfied() )
1627 int x
= constr
->left
.GetValue();
1628 int y
= constr
->top
.GetValue();
1629 int w
= constr
->width
.GetValue();
1630 int h
= constr
->height
.GetValue();
1632 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
1633 (constr
->height
.GetRelationship() != wxAsIs
) )
1635 SetSize(x
, y
, w
, h
);
1639 // If we don't want to resize this window, just move it...
1645 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
1646 GetClassInfo()->GetClassName(),
1652 wxWindowList::Node
*node
= GetChildren().GetFirst();
1655 wxWindow
*win
= node
->GetData();
1656 if ( !win
->IsTopLevel() && win
->GetConstraints() )
1657 win
->SetConstraintSizes();
1658 node
= node
->GetNext();
1663 // Only set the size/position of the constraint (if any)
1664 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
1666 wxLayoutConstraints
*constr
= GetConstraints();
1671 constr
->left
.SetValue(x
);
1672 constr
->left
.SetDone(TRUE
);
1676 constr
->top
.SetValue(y
);
1677 constr
->top
.SetDone(TRUE
);
1681 constr
->width
.SetValue(w
);
1682 constr
->width
.SetDone(TRUE
);
1686 constr
->height
.SetValue(h
);
1687 constr
->height
.SetDone(TRUE
);
1692 void wxWindowBase::MoveConstraint(int x
, int y
)
1694 wxLayoutConstraints
*constr
= GetConstraints();
1699 constr
->left
.SetValue(x
);
1700 constr
->left
.SetDone(TRUE
);
1704 constr
->top
.SetValue(y
);
1705 constr
->top
.SetDone(TRUE
);
1710 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
1712 wxLayoutConstraints
*constr
= GetConstraints();
1715 *w
= constr
->width
.GetValue();
1716 *h
= constr
->height
.GetValue();
1722 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
1724 wxLayoutConstraints
*constr
= GetConstraints();
1727 *w
= constr
->width
.GetValue();
1728 *h
= constr
->height
.GetValue();
1731 GetClientSize(w
, h
);
1734 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
1736 wxLayoutConstraints
*constr
= GetConstraints();
1739 *x
= constr
->left
.GetValue();
1740 *y
= constr
->top
.GetValue();
1746 #endif // wxUSE_CONSTRAINTS
1748 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
1750 // don't do it for the dialogs/frames - they float independently of their
1752 if ( !IsTopLevel() )
1754 wxWindow
*parent
= GetParent();
1755 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
1757 wxPoint
pt(parent
->GetClientAreaOrigin());
1764 // ----------------------------------------------------------------------------
1765 // do Update UI processing for child controls
1766 // ----------------------------------------------------------------------------
1768 // TODO: should this be implemented for the child window rather
1769 // than the parent? Then you can override it e.g. for wxCheckBox
1770 // to do the Right Thing rather than having to assume a fixed number
1771 // of control classes.
1772 void wxWindowBase::UpdateWindowUI()
1775 wxUpdateUIEvent
event(GetId());
1776 event
.m_eventObject
= this;
1778 if ( GetEventHandler()->ProcessEvent(event
) )
1780 if ( event
.GetSetEnabled() )
1781 Enable(event
.GetEnabled());
1783 if ( event
.GetSetText() )
1785 wxControl
*control
= wxDynamicCastThis(wxControl
);
1789 wxTextCtrl
*text
= wxDynamicCast(control
, wxTextCtrl
);
1792 if ( event
.GetText() != text
->GetValue() )
1793 text
->SetValue(event
.GetText());
1796 #endif // wxUSE_TEXTCTRL
1798 if ( event
.GetText() != control
->GetLabel() )
1799 control
->SetLabel(event
.GetText());
1805 wxCheckBox
*checkbox
= wxDynamicCastThis(wxCheckBox
);
1808 if ( event
.GetSetChecked() )
1809 checkbox
->SetValue(event
.GetChecked());
1811 #endif // wxUSE_CHECKBOX
1814 wxRadioButton
*radiobtn
= wxDynamicCastThis(wxRadioButton
);
1817 if ( event
.GetSetChecked() )
1818 radiobtn
->SetValue(event
.GetChecked());
1820 #endif // wxUSE_RADIOBTN
1822 #endif // wxUSE_CONTROLS
1825 // ----------------------------------------------------------------------------
1826 // dialog units translations
1827 // ----------------------------------------------------------------------------
1829 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
1831 int charWidth
= GetCharWidth();
1832 int charHeight
= GetCharHeight();
1833 wxPoint
pt2(-1, -1);
1835 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
) ;
1837 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
) ;
1842 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
1844 int charWidth
= GetCharWidth();
1845 int charHeight
= GetCharHeight();
1846 wxPoint
pt2(-1, -1);
1848 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4) ;
1850 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8) ;
1855 // ----------------------------------------------------------------------------
1857 // ----------------------------------------------------------------------------
1859 // propagate the colour change event to the subwindows
1860 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
1862 wxWindowList::Node
*node
= GetChildren().GetFirst();
1865 // Only propagate to non-top-level windows
1866 wxWindow
*win
= node
->GetData();
1867 if ( !win
->IsTopLevel() )
1869 wxSysColourChangedEvent event2
;
1870 event
.m_eventObject
= win
;
1871 win
->GetEventHandler()->ProcessEvent(event2
);
1874 node
= node
->GetNext();
1878 // the default action is to populate dialog with data when it's created
1879 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
1881 TransferDataToWindow();
1884 // process Ctrl-Alt-mclick
1885 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
1888 if ( event
.ControlDown() && event
.AltDown() )
1890 // don't translate these strings
1893 #ifdef __WXUNIVERSAL__
1895 #endif // __WXUNIVERSAL__
1897 switch ( wxGetOsVersion() )
1899 case wxMOTIF_X
: port
+= _T("Motif"); break;
1901 case wxMAC_DARWIN
: port
+= _T("Mac"); break;
1902 case wxBEOS
: port
+= _T("BeOS"); break;
1906 case wxGTK_BEOS
: port
+= _T("GTK"); break;
1912 case wxWIN386
: port
+= _T("MS Windows"); break;
1916 case wxMGL_OS2
: port
+= _T("MGL"); break;
1918 case wxOS2_PM
: port
+= _T("OS/2"); break;
1919 default: port
+= _T("unknown"); break;
1922 wxMessageBox(wxString::Format(
1924 " wxWindows Library (%s port)\nVersion %u.%u.%u%s, compiled at %s %s\n Copyright (c) 1995-2002 wxWindows team"
1938 _T("wxWindows information"),
1939 wxICON_INFORMATION
| wxOK
,
1943 #endif // wxUSE_MSGDLG
1949 // ----------------------------------------------------------------------------
1951 // ----------------------------------------------------------------------------
1953 #if wxUSE_ACCESSIBILITY
1954 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
1957 delete m_accessible
;
1958 m_accessible
= accessible
;
1960 m_accessible
->SetWindow((wxWindow
*) this);
1963 // Returns the accessible object, creating if necessary.
1964 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
1967 m_accessible
= CreateAccessible();
1968 return m_accessible
;
1971 // Override to create a specific accessible object.
1972 wxAccessible
* wxWindowBase::CreateAccessible()
1974 return new wxWindowAccessible((wxWindow
*) this);
1979 // ----------------------------------------------------------------------------
1980 // list classes implementation
1981 // ----------------------------------------------------------------------------
1983 void wxWindowListNode::DeleteData()
1985 delete (wxWindow
*)GetData();
1988 // ----------------------------------------------------------------------------
1990 // ----------------------------------------------------------------------------
1992 wxBorder
wxWindowBase::GetBorder() const
1994 wxBorder border
= (wxBorder
)(m_windowStyle
& wxBORDER_MASK
);
1995 if ( border
== wxBORDER_DEFAULT
)
1997 border
= GetDefaultBorder();
2003 wxBorder
wxWindowBase::GetDefaultBorder() const
2005 return wxBORDER_NONE
;
2008 // ----------------------------------------------------------------------------
2010 // ----------------------------------------------------------------------------
2012 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2014 // here we just check if the point is inside the window or not
2016 // check the top and left border first
2017 bool outside
= x
< 0 || y
< 0;
2020 // check the right and bottom borders too
2021 wxSize size
= GetSize();
2022 outside
= x
>= size
.x
|| y
>= size
.y
;
2025 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2028 // ----------------------------------------------------------------------------
2030 // ----------------------------------------------------------------------------
2032 struct WXDLLEXPORT wxWindowNext
2036 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2038 void wxWindowBase::CaptureMouse()
2040 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), this);
2042 wxWindow
*winOld
= GetCapture();
2045 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2048 wxWindowNext
*item
= new wxWindowNext
;
2050 item
->next
= ms_winCaptureNext
;
2051 ms_winCaptureNext
= item
;
2053 //else: no mouse capture to save
2058 void wxWindowBase::ReleaseMouse()
2060 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), this);
2062 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2066 if ( ms_winCaptureNext
)
2068 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2070 wxWindowNext
*item
= ms_winCaptureNext
;
2071 ms_winCaptureNext
= item
->next
;
2074 //else: stack is empty, no previous capture
2076 wxLogTrace(_T("mousecapture"),
2077 _T("After ReleaseMouse() mouse is captured by %p"),
2081 // ----------------------------------------------------------------------------
2083 // ----------------------------------------------------------------------------
2085 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2087 while ( win
&& !win
->IsTopLevel() )
2088 win
= win
->GetParent();
2093 #if wxUSE_ACCESSIBILITY
2094 // ----------------------------------------------------------------------------
2095 // accessible object for windows
2096 // ----------------------------------------------------------------------------
2098 // Can return either a child object, or an integer
2099 // representing the child element, starting from 1.
2100 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
)
2102 wxASSERT( GetWindow() != NULL
);
2106 return wxACC_NOT_IMPLEMENTED
;
2109 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2110 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2112 wxASSERT( GetWindow() != NULL
);
2116 wxWindow
* win
= NULL
;
2123 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2125 win
= (wxWindow
*) GetWindow()->GetChildren().Nth(elementId
-1)->GetData();
2132 rect
= win
->GetRect();
2133 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2134 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2138 return wxACC_NOT_IMPLEMENTED
;
2141 // Navigates from fromId to toId/toObject.
2142 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2143 int* toId
, wxAccessible
** toObject
)
2145 wxASSERT( GetWindow() != NULL
);
2151 case wxNAVDIR_FIRSTCHILD
:
2153 if (GetWindow()->GetChildren().GetCount() == 0)
2155 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2156 *toObject
= childWindow
->GetOrCreateAccessible();
2160 case wxNAVDIR_LASTCHILD
:
2162 if (GetWindow()->GetChildren().GetCount() == 0)
2164 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2165 *toObject
= childWindow
->GetOrCreateAccessible();
2169 case wxNAVDIR_RIGHT
:
2173 wxWindowList::Node
*node
= NULL
;
2176 // Can't navigate to sibling of this window
2177 // if we're a top-level window.
2178 if (!GetWindow()->GetParent())
2179 return wxACC_NOT_IMPLEMENTED
;
2181 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2185 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2186 node
= (wxWindowList::Node
*) GetWindow()->GetChildren().Nth(fromId
-1);
2189 if (node
&& node
->GetNext())
2191 wxWindow
* nextWindow
= (wxWindow
*) node
->GetNext()->Data();
2192 *toObject
= nextWindow
->GetOrCreateAccessible();
2200 case wxNAVDIR_PREVIOUS
:
2202 wxWindowList::Node
*node
= NULL
;
2205 // Can't navigate to sibling of this window
2206 // if we're a top-level window.
2207 if (!GetWindow()->GetParent())
2208 return wxACC_NOT_IMPLEMENTED
;
2210 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2214 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2215 node
= (wxWindowList::Node
*) GetWindow()->GetChildren().Nth(fromId
-1);
2218 if (node
&& node
->GetPrevious())
2220 wxWindow
* previousWindow
= (wxWindow
*) node
->GetPrevious()->Data();
2221 *toObject
= previousWindow
->GetOrCreateAccessible();
2229 return wxACC_NOT_IMPLEMENTED
;
2232 // Gets the name of the specified object.
2233 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
2235 wxASSERT( GetWindow() != NULL
);
2239 wxString
title(GetWindow()->GetTitle());
2240 if (!title
.IsEmpty())
2246 return wxACC_NOT_IMPLEMENTED
;
2249 // Gets the number of children.
2250 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
2252 wxASSERT( GetWindow() != NULL
);
2256 *childId
= (int) GetWindow()->GetChildren().GetCount();
2260 // Gets the specified child (starting from 1).
2261 // If *child is NULL and return value is wxACC_OK,
2262 // this means that the child is a simple element and
2263 // not an accessible object.
2264 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
2266 wxASSERT( GetWindow() != NULL
);
2276 if (childId
> (int) GetWindow()->GetChildren().GetCount())
2279 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().Nth(childId
-1)->GetData();
2280 *child
= childWindow
->GetOrCreateAccessible();
2287 // Gets the parent, or NULL.
2288 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
2290 wxASSERT( GetWindow() != NULL
);
2294 wxWindow
* parentWindow
= GetWindow()->GetParent();
2302 *parent
= parentWindow
->GetOrCreateAccessible();
2310 // Performs the default action. childId is 0 (the action for this object)
2311 // or > 0 (the action for a child).
2312 // Return wxACC_NOT_SUPPORTED if there is no default action for this
2313 // window (e.g. an edit control).
2314 wxAccStatus
wxWindowAccessible::DoDefaultAction(int childId
)
2316 wxASSERT( GetWindow() != NULL
);
2320 return wxACC_NOT_IMPLEMENTED
;
2323 // Gets the default action for this object (0) or > 0 (the action for a child).
2324 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
2325 // string if there is no action.
2326 // The retrieved string describes the action that is performed on an object,
2327 // not what the object does as a result. For example, a toolbar button that prints
2328 // a document has a default action of "Press" rather than "Prints the current document."
2329 wxAccStatus
wxWindowAccessible::GetDefaultAction(int childId
, wxString
* actionName
)
2331 wxASSERT( GetWindow() != NULL
);
2335 return wxACC_NOT_IMPLEMENTED
;
2338 // Returns the description for this object or a child.
2339 wxAccStatus
wxWindowAccessible::GetDescription(int childId
, wxString
* description
)
2341 wxASSERT( GetWindow() != NULL
);
2345 return wxACC_NOT_IMPLEMENTED
;
2348 // Returns help text for this object or a child, similar to tooltip text.
2349 wxAccStatus
wxWindowAccessible::GetHelpText(int childId
, wxString
* helpText
)
2351 wxASSERT( GetWindow() != NULL
);
2355 wxString
ht(GetWindow()->GetHelpText());
2361 return wxACC_NOT_IMPLEMENTED
;
2364 // Returns the keyboard shortcut for this object or child.
2365 // Return e.g. ALT+K
2366 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int childId
, wxString
* shortcut
)
2368 wxASSERT( GetWindow() != NULL
);
2372 return wxACC_NOT_IMPLEMENTED
;
2375 // Returns a role constant.
2376 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
2378 wxASSERT( GetWindow() != NULL
);
2382 return wxACC_NOT_IMPLEMENTED
;
2385 // Returns a state constant.
2386 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
2388 wxASSERT( GetWindow() != NULL
);
2392 return wxACC_NOT_IMPLEMENTED
;
2395 // Returns a localized string representing the value for the object
2397 wxAccStatus
wxWindowAccessible::GetValue(int childId
, wxString
* strValue
)
2399 wxASSERT( GetWindow() != NULL
);
2403 return wxACC_NOT_IMPLEMENTED
;
2406 // Selects the object or child.
2407 wxAccStatus
wxWindowAccessible::Select(int childId
, wxAccSelectionFlags selectFlags
)
2409 wxASSERT( GetWindow() != NULL
);
2413 return wxACC_NOT_IMPLEMENTED
;
2416 // Gets the window with the keyboard focus.
2417 // If childId is 0 and child is NULL, no object in
2418 // this subhierarchy has the focus.
2419 // If this object has the focus, child should be 'this'.
2420 wxAccStatus
wxWindowAccessible::GetFocus(int* childId
, wxAccessible
** child
)
2422 wxASSERT( GetWindow() != NULL
);
2426 return wxACC_NOT_IMPLEMENTED
;
2429 // Gets a variant representing the selected children
2431 // Acceptable values:
2432 // - a null variant (IsNull() returns TRUE)
2433 // - a list variant (GetType() == wxT("list")
2434 // - an integer representing the selected child element,
2435 // or 0 if this object is selected (GetType() == wxT("long")
2436 // - a "void*" pointer to a wxAccessible child object
2437 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* selections
)
2439 wxASSERT( GetWindow() != NULL
);
2443 return wxACC_NOT_IMPLEMENTED
;
2446 #endif // wxUSE_ACCESSIBILITY