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
))
618 // setting min width greater than max width leads to infinite loops under
619 // X11 and generally doesn't make any sense, so don't allow it
620 wxCHECK_RET( (minW
== -1 || maxW
== -1 || minW
<= maxW
) &&
621 (minH
== -1 || maxH
== -1 || minH
< maxH
),
622 _T("min width/height must be less than max width/height!") );
630 void wxWindowBase::SetVirtualSizeHints( int minW
, int minH
,
633 m_minVirtualWidth
= minW
;
634 m_maxVirtualWidth
= maxW
;
635 m_minVirtualHeight
= minH
;
636 m_maxVirtualHeight
= maxH
;
639 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
641 if ( m_minVirtualWidth
!= -1 && m_minVirtualWidth
> x
)
642 x
= m_minVirtualWidth
;
643 if ( m_maxVirtualWidth
!= -1 && m_maxVirtualWidth
< x
)
644 x
= m_maxVirtualWidth
;
645 if ( m_minVirtualHeight
!= -1 && m_minVirtualHeight
> y
)
646 y
= m_minVirtualHeight
;
647 if ( m_maxVirtualHeight
!= -1 && m_maxVirtualHeight
< y
)
648 y
= m_maxVirtualHeight
;
650 m_virtualSize
= wxSize(x
, y
);
653 wxSize
wxWindowBase::DoGetVirtualSize() const
655 wxSize
s( GetClientSize() );
657 return wxSize( wxMax( m_virtualSize
.GetWidth(), s
.GetWidth() ),
658 wxMax( m_virtualSize
.GetHeight(), s
.GetHeight() ) );
661 // ----------------------------------------------------------------------------
662 // show/hide/enable/disable the window
663 // ----------------------------------------------------------------------------
665 bool wxWindowBase::Show(bool show
)
667 if ( show
!= m_isShown
)
679 bool wxWindowBase::Enable(bool enable
)
681 if ( enable
!= m_isEnabled
)
683 m_isEnabled
= enable
;
692 // ----------------------------------------------------------------------------
694 // ----------------------------------------------------------------------------
696 bool wxWindowBase::IsTopLevel() const
701 // ----------------------------------------------------------------------------
702 // reparenting the window
703 // ----------------------------------------------------------------------------
705 void wxWindowBase::AddChild(wxWindowBase
*child
)
707 wxCHECK_RET( child
, wxT("can't add a NULL child") );
709 // this should never happen and it will lead to a crash later if it does
710 // because RemoveChild() will remove only one node from the children list
711 // and the other(s) one(s) will be left with dangling pointers in them
712 wxASSERT_MSG( !GetChildren().Find(child
), _T("AddChild() called twice") );
714 GetChildren().Append(child
);
715 child
->SetParent(this);
718 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
720 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
722 GetChildren().DeleteObject(child
);
723 child
->SetParent((wxWindow
*)NULL
);
726 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
728 wxWindow
*oldParent
= GetParent();
729 if ( newParent
== oldParent
)
735 // unlink this window from the existing parent.
738 oldParent
->RemoveChild(this);
742 wxTopLevelWindows
.DeleteObject(this);
745 // add it to the new one
748 newParent
->AddChild(this);
752 wxTopLevelWindows
.Append(this);
758 // ----------------------------------------------------------------------------
759 // event handler stuff
760 // ----------------------------------------------------------------------------
762 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
764 wxEvtHandler
*handlerOld
= GetEventHandler();
766 handler
->SetNextHandler(handlerOld
);
769 GetEventHandler()->SetPreviousHandler(handler
);
771 SetEventHandler(handler
);
774 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
776 wxEvtHandler
*handlerA
= GetEventHandler();
779 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
780 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
783 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
784 SetEventHandler(handlerB
);
789 handlerA
= (wxEvtHandler
*)NULL
;
796 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
798 wxCHECK_MSG( handler
, FALSE
, _T("RemoveEventHandler(NULL) called") );
800 wxEvtHandler
*handlerPrev
= NULL
,
801 *handlerCur
= GetEventHandler();
804 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
806 if ( handlerCur
== handler
)
810 handlerPrev
->SetNextHandler(handlerNext
);
814 SetEventHandler(handlerNext
);
819 handlerNext
->SetPreviousHandler ( handlerPrev
);
821 handler
->SetNextHandler(NULL
);
826 handlerPrev
= handlerCur
;
827 handlerCur
= handlerNext
;
830 wxFAIL_MSG( _T("where has the event handler gone?") );
835 // ----------------------------------------------------------------------------
837 // ----------------------------------------------------------------------------
839 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
841 if ( !colour
.Ok() || (colour
== m_backgroundColour
) )
844 m_backgroundColour
= colour
;
851 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
853 if ( !colour
.Ok() || (colour
== m_foregroundColour
) )
856 m_foregroundColour
= colour
;
863 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
865 // setting an invalid cursor is ok, it means that we don't have any special
867 if ( m_cursor
== cursor
)
878 bool wxWindowBase::SetFont(const wxFont
& font
)
880 // don't try to set invalid font, always fall back to the default
881 const wxFont
& fontOk
= font
.Ok() ? font
: *wxSWISS_FONT
;
883 if ( fontOk
== m_font
)
898 void wxWindowBase::SetPalette(const wxPalette
& pal
)
900 m_hasCustomPalette
= TRUE
;
903 // VZ: can anyone explain me what do we do here?
904 wxWindowDC
d((wxWindow
*) this);
908 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
910 wxWindow
*win
= (wxWindow
*)this;
911 while ( win
&& !win
->HasCustomPalette() )
913 win
= win
->GetParent();
919 #endif // wxUSE_PALETTE
922 void wxWindowBase::SetCaret(wxCaret
*caret
)
933 wxASSERT_MSG( m_caret
->GetWindow() == this,
934 wxT("caret should be created associated to this window") );
937 #endif // wxUSE_CARET
940 // ----------------------------------------------------------------------------
942 // ----------------------------------------------------------------------------
944 void wxWindowBase::SetValidator(const wxValidator
& validator
)
946 if ( m_windowValidator
)
947 delete m_windowValidator
;
949 m_windowValidator
= (wxValidator
*)validator
.Clone();
951 if ( m_windowValidator
)
952 m_windowValidator
->SetWindow(this) ;
954 #endif // wxUSE_VALIDATORS
956 // ----------------------------------------------------------------------------
957 // update region stuff
958 // ----------------------------------------------------------------------------
960 wxRect
wxWindowBase::GetUpdateClientRect() const
962 wxRegion rgnUpdate
= GetUpdateRegion();
963 rgnUpdate
.Intersect(GetClientRect());
964 wxRect rectUpdate
= rgnUpdate
.GetBox();
965 wxPoint ptOrigin
= GetClientAreaOrigin();
966 rectUpdate
.x
-= ptOrigin
.x
;
967 rectUpdate
.y
-= ptOrigin
.y
;
972 bool wxWindowBase::IsExposed(int x
, int y
) const
974 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
977 bool wxWindowBase::IsExposed(int x
, int y
, int w
, int h
) const
979 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
982 // ----------------------------------------------------------------------------
983 // find child window by id or name
984 // ----------------------------------------------------------------------------
986 wxWindow
*wxWindowBase::FindWindow( long id
)
988 if ( id
== m_windowId
)
989 return (wxWindow
*)this;
991 wxWindowBase
*res
= (wxWindow
*)NULL
;
992 wxWindowList::Node
*node
;
993 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
995 wxWindowBase
*child
= node
->GetData();
996 res
= child
->FindWindow( id
);
999 return (wxWindow
*)res
;
1002 wxWindow
*wxWindowBase::FindWindow( const wxString
& name
)
1004 if ( name
== m_windowName
)
1005 return (wxWindow
*)this;
1007 wxWindowBase
*res
= (wxWindow
*)NULL
;
1008 wxWindowList::Node
*node
;
1009 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1011 wxWindow
*child
= node
->GetData();
1012 res
= child
->FindWindow(name
);
1015 return (wxWindow
*)res
;
1019 // find any window by id or name or label: If parent is non-NULL, look through
1020 // children for a label or title matching the specified string. If NULL, look
1021 // through all top-level windows.
1023 // to avoid duplicating code we reuse the same helper function but with
1024 // different comparators
1026 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1027 const wxString
& label
, long id
);
1030 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1033 return win
->GetLabel() == label
;
1037 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1040 return win
->GetName() == label
;
1044 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1047 return win
->GetId() == id
;
1050 // recursive helper for the FindWindowByXXX() functions
1052 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1053 const wxString
& label
,
1055 wxFindWindowCmp cmp
)
1059 // see if this is the one we're looking for
1060 if ( (*cmp
)(parent
, label
, id
) )
1061 return (wxWindow
*)parent
;
1063 // It wasn't, so check all its children
1064 for ( wxWindowList::Node
* node
= parent
->GetChildren().GetFirst();
1066 node
= node
->GetNext() )
1068 // recursively check each child
1069 wxWindow
*win
= (wxWindow
*)node
->GetData();
1070 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1080 // helper for FindWindowByXXX()
1082 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1083 const wxString
& label
,
1085 wxFindWindowCmp cmp
)
1089 // just check parent and all its children
1090 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1093 // start at very top of wx's windows
1094 for ( wxWindowList::Node
* node
= wxTopLevelWindows
.GetFirst();
1096 node
= node
->GetNext() )
1098 // recursively check each window & its children
1099 wxWindow
*win
= node
->GetData();
1100 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1110 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1112 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1117 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1119 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1123 // fall back to the label
1124 win
= FindWindowByLabel(title
, parent
);
1132 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1134 return wxFindWindowHelper(parent
, _T(""), id
, wxFindWindowCmpIds
);
1137 // ----------------------------------------------------------------------------
1138 // dialog oriented functions
1139 // ----------------------------------------------------------------------------
1141 void wxWindowBase::MakeModal(bool modal
)
1143 // Disable all other windows
1146 wxWindowList::Node
*node
= wxTopLevelWindows
.GetFirst();
1149 wxWindow
*win
= node
->GetData();
1151 win
->Enable(!modal
);
1153 node
= node
->GetNext();
1158 bool wxWindowBase::Validate()
1160 #if wxUSE_VALIDATORS
1161 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1163 wxWindowList::Node
*node
;
1164 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1166 wxWindowBase
*child
= node
->GetData();
1167 wxValidator
*validator
= child
->GetValidator();
1168 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1173 if ( recurse
&& !child
->Validate() )
1178 #endif // wxUSE_VALIDATORS
1183 bool wxWindowBase::TransferDataToWindow()
1185 #if wxUSE_VALIDATORS
1186 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1188 wxWindowList::Node
*node
;
1189 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1191 wxWindowBase
*child
= node
->GetData();
1192 wxValidator
*validator
= child
->GetValidator();
1193 if ( validator
&& !validator
->TransferToWindow() )
1195 wxLogWarning(_("Could not transfer data to window"));
1197 wxLog::FlushActive();
1205 if ( !child
->TransferDataToWindow() )
1207 // warning already given
1212 #endif // wxUSE_VALIDATORS
1217 bool wxWindowBase::TransferDataFromWindow()
1219 #if wxUSE_VALIDATORS
1220 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1222 wxWindowList::Node
*node
;
1223 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1225 wxWindow
*child
= node
->GetData();
1226 wxValidator
*validator
= child
->GetValidator();
1227 if ( validator
&& !validator
->TransferFromWindow() )
1229 // nop warning here because the application is supposed to give
1230 // one itself - we don't know here what might have gone wrongly
1237 if ( !child
->TransferDataFromWindow() )
1239 // warning already given
1244 #endif // wxUSE_VALIDATORS
1249 void wxWindowBase::InitDialog()
1251 wxInitDialogEvent
event(GetId());
1252 event
.SetEventObject( this );
1253 GetEventHandler()->ProcessEvent(event
);
1256 // ----------------------------------------------------------------------------
1257 // context-sensitive help support
1258 // ----------------------------------------------------------------------------
1262 // associate this help text with this window
1263 void wxWindowBase::SetHelpText(const wxString
& text
)
1265 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1268 helpProvider
->AddHelp(this, text
);
1272 // associate this help text with all windows with the same id as this
1274 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1276 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1279 helpProvider
->AddHelp(GetId(), text
);
1283 // get the help string associated with this window (may be empty)
1284 wxString
wxWindowBase::GetHelpText() const
1287 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1290 text
= helpProvider
->GetHelp(this);
1296 // show help for this window
1297 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1299 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1302 if ( helpProvider
->ShowHelp(this) )
1304 // skip the event.Skip() below
1312 #endif // wxUSE_HELP
1314 // ----------------------------------------------------------------------------
1315 // tooltipsroot.Replace("\\", "/");
1316 // ----------------------------------------------------------------------------
1320 void wxWindowBase::SetToolTip( const wxString
&tip
)
1322 // don't create the new tooltip if we already have one
1325 m_tooltip
->SetTip( tip
);
1329 SetToolTip( new wxToolTip( tip
) );
1332 // setting empty tooltip text does not remove the tooltip any more - use
1333 // SetToolTip((wxToolTip *)NULL) for this
1336 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1341 m_tooltip
= tooltip
;
1344 #endif // wxUSE_TOOLTIPS
1346 // ----------------------------------------------------------------------------
1347 // constraints and sizers
1348 // ----------------------------------------------------------------------------
1350 #if wxUSE_CONSTRAINTS
1352 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1354 if ( m_constraints
)
1356 UnsetConstraints(m_constraints
);
1357 delete m_constraints
;
1359 m_constraints
= constraints
;
1360 if ( m_constraints
)
1362 // Make sure other windows know they're part of a 'meaningful relationship'
1363 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1364 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1365 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1366 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1367 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1368 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1369 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1370 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1371 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1372 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1373 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1374 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1375 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1376 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1377 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1378 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1382 // This removes any dangling pointers to this window in other windows'
1383 // constraintsInvolvedIn lists.
1384 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1388 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1389 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1390 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1391 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1392 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1393 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1394 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1395 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1396 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1397 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1398 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1399 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1400 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1401 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1402 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1403 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1407 // Back-pointer to other windows we're involved with, so if we delete this
1408 // window, we must delete any constraints we're involved with.
1409 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1411 if ( !m_constraintsInvolvedIn
)
1412 m_constraintsInvolvedIn
= new wxWindowList
;
1413 if ( !m_constraintsInvolvedIn
->Find(otherWin
) )
1414 m_constraintsInvolvedIn
->Append(otherWin
);
1417 // REMOVE back-pointer to other windows we're involved with.
1418 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1420 if ( m_constraintsInvolvedIn
)
1421 m_constraintsInvolvedIn
->DeleteObject(otherWin
);
1424 // Reset any constraints that mention this window
1425 void wxWindowBase::DeleteRelatedConstraints()
1427 if ( m_constraintsInvolvedIn
)
1429 wxWindowList::Node
*node
= m_constraintsInvolvedIn
->GetFirst();
1432 wxWindow
*win
= node
->GetData();
1433 wxLayoutConstraints
*constr
= win
->GetConstraints();
1435 // Reset any constraints involving this window
1438 constr
->left
.ResetIfWin(this);
1439 constr
->top
.ResetIfWin(this);
1440 constr
->right
.ResetIfWin(this);
1441 constr
->bottom
.ResetIfWin(this);
1442 constr
->width
.ResetIfWin(this);
1443 constr
->height
.ResetIfWin(this);
1444 constr
->centreX
.ResetIfWin(this);
1445 constr
->centreY
.ResetIfWin(this);
1448 wxWindowList::Node
*next
= node
->GetNext();
1453 delete m_constraintsInvolvedIn
;
1454 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1458 #endif // wxUSE_CONSTRAINTS
1460 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1463 delete m_windowSizer
;
1465 m_windowSizer
= sizer
;
1467 SetAutoLayout( sizer
!= NULL
);
1470 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1472 SetSizer( sizer
, deleteOld
);
1473 sizer
->SetSizeHints( (wxWindow
*) this );
1476 #if wxUSE_CONSTRAINTS
1478 void wxWindowBase::SatisfyConstraints()
1480 wxLayoutConstraints
*constr
= GetConstraints();
1481 bool wasOk
= constr
&& constr
->AreSatisfied();
1483 ResetConstraints(); // Mark all constraints as unevaluated
1487 // if we're a top level panel (i.e. our parent is frame/dialog), our
1488 // own constraints will never be satisfied any more unless we do it
1492 while ( noChanges
> 0 )
1494 LayoutPhase1(&noChanges
);
1498 LayoutPhase2(&noChanges
);
1501 #endif // wxUSE_CONSTRAINTS
1503 bool wxWindowBase::Layout()
1505 // If there is a sizer, use it instead of the constraints
1509 GetVirtualSize(&w
, &h
);
1510 GetSizer()->SetDimension( 0, 0, w
, h
);
1512 #if wxUSE_CONSTRAINTS
1515 SatisfyConstraints(); // Find the right constraints values
1516 SetConstraintSizes(); // Recursively set the real window sizes
1523 #if wxUSE_CONSTRAINTS
1525 // first phase of the constraints evaluation: set our own constraints
1526 bool wxWindowBase::LayoutPhase1(int *noChanges
)
1528 wxLayoutConstraints
*constr
= GetConstraints();
1530 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
1533 // second phase: set the constraints for our children
1534 bool wxWindowBase::LayoutPhase2(int *noChanges
)
1541 // Layout grand children
1547 // Do a phase of evaluating child constraints
1548 bool wxWindowBase::DoPhase(int phase
)
1550 // the list containing the children for which the constraints are already
1552 wxWindowList succeeded
;
1554 // the max number of iterations we loop before concluding that we can't set
1556 static const int maxIterations
= 500;
1558 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
1562 // loop over all children setting their constraints
1563 for ( wxWindowList::Node
*node
= GetChildren().GetFirst();
1565 node
= node
->GetNext() )
1567 wxWindow
*child
= node
->GetData();
1568 if ( child
->IsTopLevel() )
1570 // top level children are not inside our client area
1574 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
1576 // this one is either already ok or nothing we can do about it
1580 int tempNoChanges
= 0;
1581 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
1582 : child
->LayoutPhase2(&tempNoChanges
);
1583 noChanges
+= tempNoChanges
;
1587 succeeded
.Append(child
);
1593 // constraints are set
1601 void wxWindowBase::ResetConstraints()
1603 wxLayoutConstraints
*constr
= GetConstraints();
1606 constr
->left
.SetDone(FALSE
);
1607 constr
->top
.SetDone(FALSE
);
1608 constr
->right
.SetDone(FALSE
);
1609 constr
->bottom
.SetDone(FALSE
);
1610 constr
->width
.SetDone(FALSE
);
1611 constr
->height
.SetDone(FALSE
);
1612 constr
->centreX
.SetDone(FALSE
);
1613 constr
->centreY
.SetDone(FALSE
);
1616 wxWindowList::Node
*node
= GetChildren().GetFirst();
1619 wxWindow
*win
= node
->GetData();
1620 if ( !win
->IsTopLevel() )
1621 win
->ResetConstraints();
1622 node
= node
->GetNext();
1626 // Need to distinguish between setting the 'fake' size for windows and sizers,
1627 // and setting the real values.
1628 void wxWindowBase::SetConstraintSizes(bool recurse
)
1630 wxLayoutConstraints
*constr
= GetConstraints();
1631 if ( constr
&& constr
->AreSatisfied() )
1633 int x
= constr
->left
.GetValue();
1634 int y
= constr
->top
.GetValue();
1635 int w
= constr
->width
.GetValue();
1636 int h
= constr
->height
.GetValue();
1638 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
1639 (constr
->height
.GetRelationship() != wxAsIs
) )
1641 SetSize(x
, y
, w
, h
);
1645 // If we don't want to resize this window, just move it...
1651 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
1652 GetClassInfo()->GetClassName(),
1658 wxWindowList::Node
*node
= GetChildren().GetFirst();
1661 wxWindow
*win
= node
->GetData();
1662 if ( !win
->IsTopLevel() && win
->GetConstraints() )
1663 win
->SetConstraintSizes();
1664 node
= node
->GetNext();
1669 // Only set the size/position of the constraint (if any)
1670 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
1672 wxLayoutConstraints
*constr
= GetConstraints();
1677 constr
->left
.SetValue(x
);
1678 constr
->left
.SetDone(TRUE
);
1682 constr
->top
.SetValue(y
);
1683 constr
->top
.SetDone(TRUE
);
1687 constr
->width
.SetValue(w
);
1688 constr
->width
.SetDone(TRUE
);
1692 constr
->height
.SetValue(h
);
1693 constr
->height
.SetDone(TRUE
);
1698 void wxWindowBase::MoveConstraint(int x
, int y
)
1700 wxLayoutConstraints
*constr
= GetConstraints();
1705 constr
->left
.SetValue(x
);
1706 constr
->left
.SetDone(TRUE
);
1710 constr
->top
.SetValue(y
);
1711 constr
->top
.SetDone(TRUE
);
1716 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
1718 wxLayoutConstraints
*constr
= GetConstraints();
1721 *w
= constr
->width
.GetValue();
1722 *h
= constr
->height
.GetValue();
1728 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
1730 wxLayoutConstraints
*constr
= GetConstraints();
1733 *w
= constr
->width
.GetValue();
1734 *h
= constr
->height
.GetValue();
1737 GetClientSize(w
, h
);
1740 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
1742 wxLayoutConstraints
*constr
= GetConstraints();
1745 *x
= constr
->left
.GetValue();
1746 *y
= constr
->top
.GetValue();
1752 #endif // wxUSE_CONSTRAINTS
1754 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
1756 // don't do it for the dialogs/frames - they float independently of their
1758 if ( !IsTopLevel() )
1760 wxWindow
*parent
= GetParent();
1761 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
1763 wxPoint
pt(parent
->GetClientAreaOrigin());
1770 // ----------------------------------------------------------------------------
1771 // do Update UI processing for child controls
1772 // ----------------------------------------------------------------------------
1774 // TODO: should this be implemented for the child window rather
1775 // than the parent? Then you can override it e.g. for wxCheckBox
1776 // to do the Right Thing rather than having to assume a fixed number
1777 // of control classes.
1778 void wxWindowBase::UpdateWindowUI()
1781 wxUpdateUIEvent
event(GetId());
1782 event
.m_eventObject
= this;
1784 if ( GetEventHandler()->ProcessEvent(event
) )
1786 if ( event
.GetSetEnabled() )
1787 Enable(event
.GetEnabled());
1789 if ( event
.GetSetText() )
1791 wxControl
*control
= wxDynamicCastThis(wxControl
);
1795 wxTextCtrl
*text
= wxDynamicCast(control
, wxTextCtrl
);
1798 if ( event
.GetText() != text
->GetValue() )
1799 text
->SetValue(event
.GetText());
1802 #endif // wxUSE_TEXTCTRL
1804 if ( event
.GetText() != control
->GetLabel() )
1805 control
->SetLabel(event
.GetText());
1811 wxCheckBox
*checkbox
= wxDynamicCastThis(wxCheckBox
);
1814 if ( event
.GetSetChecked() )
1815 checkbox
->SetValue(event
.GetChecked());
1817 #endif // wxUSE_CHECKBOX
1820 wxRadioButton
*radiobtn
= wxDynamicCastThis(wxRadioButton
);
1823 if ( event
.GetSetChecked() )
1824 radiobtn
->SetValue(event
.GetChecked());
1826 #endif // wxUSE_RADIOBTN
1828 #endif // wxUSE_CONTROLS
1831 // ----------------------------------------------------------------------------
1832 // dialog units translations
1833 // ----------------------------------------------------------------------------
1835 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
1837 int charWidth
= GetCharWidth();
1838 int charHeight
= GetCharHeight();
1839 wxPoint
pt2(-1, -1);
1841 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
) ;
1843 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
) ;
1848 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
1850 int charWidth
= GetCharWidth();
1851 int charHeight
= GetCharHeight();
1852 wxPoint
pt2(-1, -1);
1854 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4) ;
1856 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8) ;
1861 // ----------------------------------------------------------------------------
1863 // ----------------------------------------------------------------------------
1865 // propagate the colour change event to the subwindows
1866 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
1868 wxWindowList::Node
*node
= GetChildren().GetFirst();
1871 // Only propagate to non-top-level windows
1872 wxWindow
*win
= node
->GetData();
1873 if ( !win
->IsTopLevel() )
1875 wxSysColourChangedEvent event2
;
1876 event
.m_eventObject
= win
;
1877 win
->GetEventHandler()->ProcessEvent(event2
);
1880 node
= node
->GetNext();
1884 // the default action is to populate dialog with data when it's created
1885 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
1887 TransferDataToWindow();
1890 // process Ctrl-Alt-mclick
1891 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
1894 if ( event
.ControlDown() && event
.AltDown() )
1896 // don't translate these strings
1899 #ifdef __WXUNIVERSAL__
1901 #endif // __WXUNIVERSAL__
1903 switch ( wxGetOsVersion() )
1905 case wxMOTIF_X
: port
+= _T("Motif"); break;
1907 case wxMAC_DARWIN
: port
+= _T("Mac"); break;
1908 case wxBEOS
: port
+= _T("BeOS"); break;
1912 case wxGTK_BEOS
: port
+= _T("GTK"); break;
1918 case wxWIN386
: port
+= _T("MS Windows"); break;
1922 case wxMGL_OS2
: port
+= _T("MGL"); break;
1924 case wxOS2_PM
: port
+= _T("OS/2"); break;
1925 default: port
+= _T("unknown"); break;
1928 wxMessageBox(wxString::Format(
1930 " wxWindows Library (%s port)\nVersion %u.%u.%u%s, compiled at %s %s\n Copyright (c) 1995-2002 wxWindows team"
1944 _T("wxWindows information"),
1945 wxICON_INFORMATION
| wxOK
,
1949 #endif // wxUSE_MSGDLG
1955 // ----------------------------------------------------------------------------
1957 // ----------------------------------------------------------------------------
1959 #if wxUSE_ACCESSIBILITY
1960 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
1963 delete m_accessible
;
1964 m_accessible
= accessible
;
1966 m_accessible
->SetWindow((wxWindow
*) this);
1969 // Returns the accessible object, creating if necessary.
1970 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
1973 m_accessible
= CreateAccessible();
1974 return m_accessible
;
1977 // Override to create a specific accessible object.
1978 wxAccessible
* wxWindowBase::CreateAccessible()
1980 return new wxWindowAccessible((wxWindow
*) this);
1985 // ----------------------------------------------------------------------------
1986 // list classes implementation
1987 // ----------------------------------------------------------------------------
1989 void wxWindowListNode::DeleteData()
1991 delete (wxWindow
*)GetData();
1994 // ----------------------------------------------------------------------------
1996 // ----------------------------------------------------------------------------
1998 wxBorder
wxWindowBase::GetBorder() const
2000 wxBorder border
= (wxBorder
)(m_windowStyle
& wxBORDER_MASK
);
2001 if ( border
== wxBORDER_DEFAULT
)
2003 border
= GetDefaultBorder();
2009 wxBorder
wxWindowBase::GetDefaultBorder() const
2011 return wxBORDER_NONE
;
2014 // ----------------------------------------------------------------------------
2016 // ----------------------------------------------------------------------------
2018 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2020 // here we just check if the point is inside the window or not
2022 // check the top and left border first
2023 bool outside
= x
< 0 || y
< 0;
2026 // check the right and bottom borders too
2027 wxSize size
= GetSize();
2028 outside
= x
>= size
.x
|| y
>= size
.y
;
2031 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2034 // ----------------------------------------------------------------------------
2036 // ----------------------------------------------------------------------------
2038 struct WXDLLEXPORT wxWindowNext
2042 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2044 void wxWindowBase::CaptureMouse()
2046 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), this);
2048 wxWindow
*winOld
= GetCapture();
2051 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2054 wxWindowNext
*item
= new wxWindowNext
;
2056 item
->next
= ms_winCaptureNext
;
2057 ms_winCaptureNext
= item
;
2059 //else: no mouse capture to save
2064 void wxWindowBase::ReleaseMouse()
2066 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), this);
2068 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2072 if ( ms_winCaptureNext
)
2074 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2076 wxWindowNext
*item
= ms_winCaptureNext
;
2077 ms_winCaptureNext
= item
->next
;
2080 //else: stack is empty, no previous capture
2082 wxLogTrace(_T("mousecapture"),
2083 _T("After ReleaseMouse() mouse is captured by %p"),
2088 void wxWindowBase::SendDestroyEvent()
2090 wxWindowDestroyEvent event
;
2091 event
.SetEventObject(this);
2092 event
.SetId(GetId());
2093 GetEventHandler()->ProcessEvent(event
);
2096 // ----------------------------------------------------------------------------
2098 // ----------------------------------------------------------------------------
2100 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2102 while ( win
&& !win
->IsTopLevel() )
2103 win
= win
->GetParent();
2108 #if wxUSE_ACCESSIBILITY
2109 // ----------------------------------------------------------------------------
2110 // accessible object for windows
2111 // ----------------------------------------------------------------------------
2113 // Can return either a child object, or an integer
2114 // representing the child element, starting from 1.
2115 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& pt
, int* childId
, wxAccessible
** childObject
)
2117 wxASSERT( GetWindow() != NULL
);
2121 return wxACC_NOT_IMPLEMENTED
;
2124 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2125 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2127 wxASSERT( GetWindow() != NULL
);
2131 wxWindow
* win
= NULL
;
2138 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2140 win
= (wxWindow
*) GetWindow()->GetChildren().Nth(elementId
-1)->GetData();
2147 rect
= win
->GetRect();
2148 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2149 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2153 return wxACC_NOT_IMPLEMENTED
;
2156 // Navigates from fromId to toId/toObject.
2157 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2158 int* toId
, wxAccessible
** toObject
)
2160 wxASSERT( GetWindow() != NULL
);
2166 case wxNAVDIR_FIRSTCHILD
:
2168 if (GetWindow()->GetChildren().GetCount() == 0)
2170 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2171 *toObject
= childWindow
->GetOrCreateAccessible();
2175 case wxNAVDIR_LASTCHILD
:
2177 if (GetWindow()->GetChildren().GetCount() == 0)
2179 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2180 *toObject
= childWindow
->GetOrCreateAccessible();
2184 case wxNAVDIR_RIGHT
:
2188 wxWindowList::Node
*node
= NULL
;
2191 // Can't navigate to sibling of this window
2192 // if we're a top-level window.
2193 if (!GetWindow()->GetParent())
2194 return wxACC_NOT_IMPLEMENTED
;
2196 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2200 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2201 node
= (wxWindowList::Node
*) GetWindow()->GetChildren().Nth(fromId
-1);
2204 if (node
&& node
->GetNext())
2206 wxWindow
* nextWindow
= (wxWindow
*) node
->GetNext()->Data();
2207 *toObject
= nextWindow
->GetOrCreateAccessible();
2215 case wxNAVDIR_PREVIOUS
:
2217 wxWindowList::Node
*node
= NULL
;
2220 // Can't navigate to sibling of this window
2221 // if we're a top-level window.
2222 if (!GetWindow()->GetParent())
2223 return wxACC_NOT_IMPLEMENTED
;
2225 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2229 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2230 node
= (wxWindowList::Node
*) GetWindow()->GetChildren().Nth(fromId
-1);
2233 if (node
&& node
->GetPrevious())
2235 wxWindow
* previousWindow
= (wxWindow
*) node
->GetPrevious()->Data();
2236 *toObject
= previousWindow
->GetOrCreateAccessible();
2244 return wxACC_NOT_IMPLEMENTED
;
2247 // Gets the name of the specified object.
2248 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
2250 wxASSERT( GetWindow() != NULL
);
2254 wxString
title(GetWindow()->GetTitle());
2255 if (!title
.IsEmpty())
2261 return wxACC_NOT_IMPLEMENTED
;
2264 // Gets the number of children.
2265 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
2267 wxASSERT( GetWindow() != NULL
);
2271 *childId
= (int) GetWindow()->GetChildren().GetCount();
2275 // Gets the specified child (starting from 1).
2276 // If *child is NULL and return value is wxACC_OK,
2277 // this means that the child is a simple element and
2278 // not an accessible object.
2279 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
2281 wxASSERT( GetWindow() != NULL
);
2291 if (childId
> (int) GetWindow()->GetChildren().GetCount())
2294 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().Nth(childId
-1)->GetData();
2295 *child
= childWindow
->GetOrCreateAccessible();
2302 // Gets the parent, or NULL.
2303 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
2305 wxASSERT( GetWindow() != NULL
);
2309 wxWindow
* parentWindow
= GetWindow()->GetParent();
2317 *parent
= parentWindow
->GetOrCreateAccessible();
2325 // Performs the default action. childId is 0 (the action for this object)
2326 // or > 0 (the action for a child).
2327 // Return wxACC_NOT_SUPPORTED if there is no default action for this
2328 // window (e.g. an edit control).
2329 wxAccStatus
wxWindowAccessible::DoDefaultAction(int childId
)
2331 wxASSERT( GetWindow() != NULL
);
2335 return wxACC_NOT_IMPLEMENTED
;
2338 // Gets the default action for this object (0) or > 0 (the action for a child).
2339 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
2340 // string if there is no action.
2341 // The retrieved string describes the action that is performed on an object,
2342 // not what the object does as a result. For example, a toolbar button that prints
2343 // a document has a default action of "Press" rather than "Prints the current document."
2344 wxAccStatus
wxWindowAccessible::GetDefaultAction(int childId
, wxString
* actionName
)
2346 wxASSERT( GetWindow() != NULL
);
2350 return wxACC_NOT_IMPLEMENTED
;
2353 // Returns the description for this object or a child.
2354 wxAccStatus
wxWindowAccessible::GetDescription(int childId
, wxString
* description
)
2356 wxASSERT( GetWindow() != NULL
);
2360 return wxACC_NOT_IMPLEMENTED
;
2363 // Returns help text for this object or a child, similar to tooltip text.
2364 wxAccStatus
wxWindowAccessible::GetHelpText(int childId
, wxString
* helpText
)
2366 wxASSERT( GetWindow() != NULL
);
2370 wxString
ht(GetWindow()->GetHelpText());
2376 return wxACC_NOT_IMPLEMENTED
;
2379 // Returns the keyboard shortcut for this object or child.
2380 // Return e.g. ALT+K
2381 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int childId
, wxString
* shortcut
)
2383 wxASSERT( GetWindow() != NULL
);
2387 return wxACC_NOT_IMPLEMENTED
;
2390 // Returns a role constant.
2391 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
2393 wxASSERT( GetWindow() != NULL
);
2397 return wxACC_NOT_IMPLEMENTED
;
2400 // Returns a state constant.
2401 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
2403 wxASSERT( GetWindow() != NULL
);
2407 return wxACC_NOT_IMPLEMENTED
;
2410 // Returns a localized string representing the value for the object
2412 wxAccStatus
wxWindowAccessible::GetValue(int childId
, wxString
* strValue
)
2414 wxASSERT( GetWindow() != NULL
);
2418 return wxACC_NOT_IMPLEMENTED
;
2421 // Selects the object or child.
2422 wxAccStatus
wxWindowAccessible::Select(int childId
, wxAccSelectionFlags selectFlags
)
2424 wxASSERT( GetWindow() != NULL
);
2428 return wxACC_NOT_IMPLEMENTED
;
2431 // Gets the window with the keyboard focus.
2432 // If childId is 0 and child is NULL, no object in
2433 // this subhierarchy has the focus.
2434 // If this object has the focus, child should be 'this'.
2435 wxAccStatus
wxWindowAccessible::GetFocus(int* childId
, wxAccessible
** child
)
2437 wxASSERT( GetWindow() != NULL
);
2441 return wxACC_NOT_IMPLEMENTED
;
2444 // Gets a variant representing the selected children
2446 // Acceptable values:
2447 // - a null variant (IsNull() returns TRUE)
2448 // - a list variant (GetType() == wxT("list")
2449 // - an integer representing the selected child element,
2450 // or 0 if this object is selected (GetType() == wxT("long")
2451 // - a "void*" pointer to a wxAccessible child object
2452 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* selections
)
2454 wxASSERT( GetWindow() != NULL
);
2458 return wxACC_NOT_IMPLEMENTED
;
2461 #endif // wxUSE_ACCESSIBILITY