1 /////////////////////////////////////////////////////////////////////////////
2 // Name: common/window.cpp
3 // Purpose: common (to all ports) wxWindow functions
4 // Author: Julian Smart, Vadim Zeitlin
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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"
50 #if defined(__WXMAC__) && wxUSE_SCROLLBAR
51 #include "wx/scrolbar.h"
55 #include "wx/layout.h"
56 #endif // wxUSE_CONSTRAINTS
60 #if wxUSE_DRAG_AND_DROP
62 #endif // wxUSE_DRAG_AND_DROP
64 #if wxUSE_ACCESSIBILITY
65 #include "wx/access.h"
69 #include "wx/cshelp.h"
73 #include "wx/tooltip.h"
74 #endif // wxUSE_TOOLTIPS
81 #include "wx/display.h"
84 #if wxUSE_SYSTEM_OPTIONS
85 #include "wx/sysopt.h"
88 // ----------------------------------------------------------------------------
90 // ----------------------------------------------------------------------------
92 #if defined(__WXPALMOS__)
93 int wxWindowBase::ms_lastControlId
= 32767;
94 #elif defined(__WXPM__)
95 int wxWindowBase::ms_lastControlId
= 2000;
97 int wxWindowBase::ms_lastControlId
= -200;
100 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase
, wxEvtHandler
)
102 // ----------------------------------------------------------------------------
104 // ----------------------------------------------------------------------------
106 BEGIN_EVENT_TABLE(wxWindowBase
, wxEvtHandler
)
107 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged
)
108 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog
)
109 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick
)
112 EVT_HELP(wxID_ANY
, wxWindowBase::OnHelp
)
117 // ============================================================================
118 // implementation of the common functionality of the wxWindow class
119 // ============================================================================
121 // ----------------------------------------------------------------------------
123 // ----------------------------------------------------------------------------
125 // the default initialization
126 wxWindowBase::wxWindowBase()
128 // no window yet, no parent nor children
129 m_parent
= (wxWindow
*)NULL
;
130 m_windowId
= wxID_ANY
;
132 // no constraints on the minimal window size
134 m_maxWidth
= wxDefaultCoord
;
136 m_maxHeight
= wxDefaultCoord
;
138 // invalidiated cache value
139 m_bestSizeCache
= wxDefaultSize
;
141 // window are created enabled and visible by default
145 // the default event handler is just this window
146 m_eventHandler
= this;
150 m_windowValidator
= (wxValidator
*) NULL
;
151 #endif // wxUSE_VALIDATORS
153 // the colours/fonts are default for now, so leave m_font,
154 // m_backgroundColour and m_foregroundColour uninitialized and set those
160 m_inheritFont
= false;
166 m_backgroundStyle
= wxBG_STYLE_SYSTEM
;
168 #if wxUSE_CONSTRAINTS
169 // no constraints whatsoever
170 m_constraints
= (wxLayoutConstraints
*) NULL
;
171 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
172 #endif // wxUSE_CONSTRAINTS
174 m_windowSizer
= (wxSizer
*) NULL
;
175 m_containingSizer
= (wxSizer
*) NULL
;
176 m_autoLayout
= false;
178 #if wxUSE_DRAG_AND_DROP
179 m_dropTarget
= (wxDropTarget
*)NULL
;
180 #endif // wxUSE_DRAG_AND_DROP
183 m_tooltip
= (wxToolTip
*)NULL
;
184 #endif // wxUSE_TOOLTIPS
187 m_caret
= (wxCaret
*)NULL
;
188 #endif // wxUSE_CARET
191 m_hasCustomPalette
= false;
192 #endif // wxUSE_PALETTE
194 #if wxUSE_ACCESSIBILITY
198 m_virtualSize
= wxDefaultSize
;
201 m_maxVirtualWidth
= wxDefaultCoord
;
203 m_maxVirtualHeight
= wxDefaultCoord
;
205 m_windowVariant
= wxWINDOW_VARIANT_NORMAL
;
206 #if wxUSE_SYSTEM_OPTIONS
207 if ( wxSystemOptions::HasOption(wxWINDOW_DEFAULT_VARIANT
) )
209 m_windowVariant
= (wxWindowVariant
) wxSystemOptions::GetOptionInt( wxWINDOW_DEFAULT_VARIANT
) ;
213 // Whether we're using the current theme for this window (wxGTK only for now)
214 m_themeEnabled
= false;
216 // VZ: this one shouldn't exist...
217 m_isBeingDeleted
= false;
219 // Reserved for future use
220 m_windowReserved
= NULL
;
223 // common part of window creation process
224 bool wxWindowBase::CreateBase(wxWindowBase
*parent
,
226 const wxPoint
& WXUNUSED(pos
),
227 const wxSize
& WXUNUSED(size
),
229 const wxValidator
& wxVALIDATOR_PARAM(validator
),
230 const wxString
& name
)
233 // wxGTK doesn't allow to create controls with static box as the parent so
234 // this will result in a crash when the program is ported to wxGTK so warn
237 // if you get this assert, the correct solution is to create the controls
238 // as siblings of the static box
239 wxASSERT_MSG( !parent
|| !wxDynamicCast(parent
, wxStaticBox
),
240 _T("wxStaticBox can't be used as a window parent!") );
241 #endif // wxUSE_STATBOX
243 // ids are limited to 16 bits under MSW so if you care about portability,
244 // it's not a good idea to use ids out of this range (and negative ids are
245 // reserved for wxWidgets own usage)
246 wxASSERT_MSG( id
== wxID_ANY
|| (id
>= 0 && id
< 32767),
247 _T("invalid id value") );
249 // generate a new id if the user doesn't care about it
250 m_windowId
= id
== wxID_ANY
? NewControlId() : id
;
253 SetWindowStyleFlag(style
);
257 SetValidator(validator
);
258 #endif // wxUSE_VALIDATORS
260 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
261 // have it too - like this it's possible to set it only in the top level
262 // dialog/frame and all children will inherit it by defult
263 if ( parent
&& (parent
->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) )
265 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY
);
271 // ----------------------------------------------------------------------------
273 // ----------------------------------------------------------------------------
276 wxWindowBase::~wxWindowBase()
278 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
280 // FIXME if these 2 cases result from programming errors in the user code
281 // we should probably assert here instead of silently fixing them
283 // Just in case the window has been Closed, but we're then deleting
284 // immediately: don't leave dangling pointers.
285 wxPendingDelete
.DeleteObject(this);
287 // Just in case we've loaded a top-level window via LoadNativeDialog but
288 // we weren't a dialog class
289 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
291 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
293 // reset the dangling pointer our parent window may keep to us
296 if ( m_parent
->GetDefaultItem() == this )
298 m_parent
->SetDefaultItem(NULL
);
301 m_parent
->RemoveChild(this);
306 #endif // wxUSE_CARET
309 delete m_windowValidator
;
310 #endif // wxUSE_VALIDATORS
312 #if wxUSE_CONSTRAINTS
313 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
314 // at deleted windows as they delete themselves.
315 DeleteRelatedConstraints();
319 // This removes any dangling pointers to this window in other windows'
320 // constraintsInvolvedIn lists.
321 UnsetConstraints(m_constraints
);
322 delete m_constraints
;
323 m_constraints
= NULL
;
325 #endif // wxUSE_CONSTRAINTS
327 if ( m_containingSizer
)
328 m_containingSizer
->Detach( (wxWindow
*)this );
330 delete m_windowSizer
;
332 #if wxUSE_DRAG_AND_DROP
334 #endif // wxUSE_DRAG_AND_DROP
338 #endif // wxUSE_TOOLTIPS
340 #if wxUSE_ACCESSIBILITY
345 bool wxWindowBase::Destroy()
352 bool wxWindowBase::Close(bool force
)
354 wxCloseEvent
event(wxEVT_CLOSE_WINDOW
, m_windowId
);
355 event
.SetEventObject(this);
356 event
.SetCanVeto(!force
);
358 // return false if window wasn't closed because the application vetoed the
360 return GetEventHandler()->ProcessEvent(event
) && !event
.GetVeto();
363 bool wxWindowBase::DestroyChildren()
365 wxWindowList::compatibility_iterator node
;
368 // we iterate until the list becomes empty
369 node
= GetChildren().GetFirst();
373 wxWindow
*child
= node
->GetData();
375 // note that we really want to call delete and not ->Destroy() here
376 // because we want to delete the child immediately, before we are
377 // deleted, and delayed deletion would result in problems as our (top
378 // level) child could outlive its parent
381 wxASSERT_MSG( !GetChildren().Find(child
),
382 wxT("child didn't remove itself using RemoveChild()") );
388 // ----------------------------------------------------------------------------
389 // size/position related methods
390 // ----------------------------------------------------------------------------
392 // centre the window with respect to its parent in either (or both) directions
393 void wxWindowBase::Centre(int direction
)
395 // the position/size of the parent window or of the entire screen
397 int widthParent
, heightParent
;
399 wxWindow
*parent
= NULL
;
400 wxTopLevelWindow
*winTop
= NULL
;
402 if ( !(direction
& wxCENTRE_ON_SCREEN
) )
404 // find the parent to centre this window on: it should be the
405 // immediate parent for the controls but the top level parent for the
406 // top level windows (like dialogs)
407 parent
= GetParent();
410 while ( parent
&& !parent
->IsTopLevel() )
412 parent
= parent
->GetParent();
416 // there is no wxTopLevelWindow under wxMotif yet
418 // we shouldn't center the dialog on the iconized window: under
419 // Windows, for example, this places it completely off the screen
422 winTop
= wxDynamicCast(parent
, wxTopLevelWindow
);
423 if ( winTop
&& winTop
->IsIconized() )
429 #endif // __WXMOTIF__
431 // did we find the parent?
435 direction
|= wxCENTRE_ON_SCREEN
;
439 if ( direction
& wxCENTRE_ON_SCREEN
)
441 //RN: If we are using wxDisplay we get
442 //the dimensions of the monitor the window is on,
443 //otherwise we get the dimensions of the primary monitor
444 //FIXME: wxDisplay::GetFromWindow only implemented on MSW
445 #if wxUSE_DISPLAY && defined(__WXMSW__)
446 int nDisplay
= wxDisplay::GetFromWindow((wxWindow
*)this);
447 if(nDisplay
!= wxNOT_FOUND
)
449 wxDisplay
windowDisplay(nDisplay
);
450 wxRect displayRect
= windowDisplay
.GetGeometry();
451 widthParent
= displayRect
.width
;
452 heightParent
= displayRect
.height
;
456 // centre with respect to the whole screen
457 wxDisplaySize(&widthParent
, &heightParent
);
464 winTop
->GetRectForTopLevelChildren(&posParent
.x
, &posParent
.y
, &widthParent
, &heightParent
);
467 // centre on the parent
468 parent
->GetSize(&widthParent
, &heightParent
);
470 // adjust to the parents position
471 posParent
= parent
->GetPosition();
476 // centre inside the parents client rectangle
477 parent
->GetClientSize(&widthParent
, &heightParent
);
482 GetSize(&width
, &height
);
484 int xNew
= wxDefaultCoord
,
485 yNew
= wxDefaultCoord
;
487 if ( direction
& wxHORIZONTAL
)
488 xNew
= (widthParent
- width
)/2;
490 if ( direction
& wxVERTICAL
)
491 yNew
= (heightParent
- height
)/2;
496 // FIXME: This needs to get the client display rect of the display
497 // the window is (via wxDisplay::GetFromWindow).
499 // Base size of the visible dimensions of the display
500 // to take into account the taskbar. And the Mac menu bar at top.
501 wxRect clientrect
= wxGetClientDisplayRect();
503 // NB: in wxMSW, negative position may not neccessary mean "out of screen",
504 // but it may mean that the window is placed on other than the main
505 // display. Therefore we only make sure centered window is on the main display
506 // if the parent is at least partially present here.
507 if (posParent
.x
+ widthParent
>= 0) // if parent is (partially) on the main display
509 if (xNew
< clientrect
.GetLeft())
510 xNew
= clientrect
.GetLeft();
511 else if (xNew
+ width
> clientrect
.GetRight())
512 xNew
= clientrect
.GetRight() - width
;
514 if (posParent
.y
+ heightParent
>= 0) // if parent is (partially) on the main display
516 if (yNew
+ height
> clientrect
.GetBottom())
517 yNew
= clientrect
.GetBottom() - height
;
519 // Make certain that the title bar is initially visible
520 // always, even if this would push the bottom of the
521 // dialog off the visible area of the display
522 if (yNew
< clientrect
.GetTop())
523 yNew
= clientrect
.GetTop();
526 // move the window to this position (keeping the old size but using
527 // SetSize() and not Move() to allow xNew and/or yNew to be wxDefaultCoord)
528 SetSize(xNew
, yNew
, width
, height
, wxSIZE_ALLOW_MINUS_ONE
);
531 // fits the window around the children
532 void wxWindowBase::Fit()
534 if ( GetChildren().GetCount() > 0 )
536 SetSize(GetBestSize());
538 //else: do nothing if we have no children
541 // fits virtual size (ie. scrolled area etc.) around children
542 void wxWindowBase::FitInside()
544 if ( GetChildren().GetCount() > 0 )
546 SetVirtualSize( GetBestVirtualSize() );
550 // On Mac, scrollbars are explicitly children.
552 static bool wxHasRealChildren(const wxWindowBase
* win
)
554 int realChildCount
= 0;
556 for ( wxWindowList::compatibility_iterator node
= win
->GetChildren().GetFirst();
558 node
= node
->GetNext() )
560 wxWindow
*win
= node
->GetData();
561 if ( !win
->IsTopLevel() && win
->IsShown() && !win
->IsKindOf(CLASSINFO(wxScrollBar
)))
564 return (realChildCount
> 0);
568 void wxWindowBase::InvalidateBestSize()
570 m_bestSizeCache
= wxDefaultSize
;
572 // parent's best size calculation may depend on its children's
573 // best sizes, so let's invalidate it as well to be safe:
575 m_parent
->InvalidateBestSize();
578 // return the size best suited for the current window
579 wxSize
wxWindowBase::DoGetBestSize() const
585 best
= m_windowSizer
->GetMinSize();
587 #if wxUSE_CONSTRAINTS
588 else if ( m_constraints
)
590 wxConstCast(this, wxWindowBase
)->SatisfyConstraints();
592 // our minimal acceptable size is such that all our windows fit inside
596 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
598 node
= node
->GetNext() )
600 wxLayoutConstraints
*c
= node
->GetData()->GetConstraints();
603 // it's not normal that we have an unconstrained child, but
604 // what can we do about it?
608 int x
= c
->right
.GetValue(),
609 y
= c
->bottom
.GetValue();
617 // TODO: we must calculate the overlaps somehow, otherwise we
618 // will never return a size bigger than the current one :-(
621 best
= wxSize(maxX
, maxY
);
623 #endif // wxUSE_CONSTRAINTS
624 else if ( !GetChildren().empty()
626 && wxHasRealChildren(this)
630 // our minimal acceptable size is such that all our visible child windows fit inside
634 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
636 node
= node
->GetNext() )
638 wxWindow
*win
= node
->GetData();
639 if ( win
->IsTopLevel() || ( ! win
->IsShown() )
641 || wxDynamicCast(win
, wxStatusBar
)
642 #endif // wxUSE_STATUSBAR
645 // dialogs and frames lie in different top level windows -
646 // don't deal with them here; as for the status bars, they
647 // don't lie in the client area at all
652 win
->GetPosition(&wx
, &wy
);
654 // if the window hadn't been positioned yet, assume that it is in
656 if ( wx
== wxDefaultCoord
)
658 if ( wy
== wxDefaultCoord
)
661 win
->GetSize(&ww
, &wh
);
662 if ( wx
+ ww
> maxX
)
664 if ( wy
+ wh
> maxY
)
668 // for compatibility with the old versions and because it really looks
669 // slightly more pretty like this, add a pad
673 best
= wxSize(maxX
, maxY
);
675 else // ! has children
677 // For a generic window there is no natural best size - just use
678 // either the minimum size if there is one, or the current size.
679 // These are returned as-is, unadjusted by the client size difference.
680 if ( GetMinSize().IsFullySpecified() )
686 // Add any difference between size and client size
687 wxSize diff
= GetSize() - GetClientSize();
688 best
.x
+= wxMax(0, diff
.x
);
689 best
.y
+= wxMax(0, diff
.y
);
695 wxSize
wxWindowBase::GetBestFittingSize() const
697 // merge the best size with the min size, giving priority to the min size
698 wxSize min
= GetMinSize();
699 if (min
.x
== wxDefaultCoord
|| min
.y
== wxDefaultCoord
)
701 wxSize best
= GetBestSize();
702 if (min
.x
== wxDefaultCoord
) min
.x
= best
.x
;
703 if (min
.y
== wxDefaultCoord
) min
.y
= best
.y
;
709 void wxWindowBase::SetBestFittingSize(const wxSize
& size
)
711 // Set the min size to the size passed in. This will usually either be
712 // wxDefaultSize or the size passed to this window's ctor/Create function.
715 // Merge the size with the best size if needed
716 wxSize best
= GetBestFittingSize();
718 // If the current size doesn't match then change it
719 if (GetSize() != best
)
724 // by default the origin is not shifted
725 wxPoint
wxWindowBase::GetClientAreaOrigin() const
730 // set the min/max size of the window
731 void wxWindowBase::DoSetSizeHints(int minW
, int minH
,
733 int WXUNUSED(incW
), int WXUNUSED(incH
))
735 // setting min width greater than max width leads to infinite loops under
736 // X11 and generally doesn't make any sense, so don't allow it
737 wxCHECK_RET( (minW
== wxDefaultCoord
|| maxW
== wxDefaultCoord
|| minW
<= maxW
) &&
738 (minH
== wxDefaultCoord
|| maxH
== wxDefaultCoord
|| minH
<= maxH
),
739 _T("min width/height must be less than max width/height!") );
747 void wxWindowBase::SetWindowVariant( wxWindowVariant variant
)
749 if ( m_windowVariant
!= variant
)
751 m_windowVariant
= variant
;
753 DoSetWindowVariant(variant
);
757 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant
)
759 // adjust the font height to correspond to our new variant (notice that
760 // we're only called if something really changed)
761 wxFont font
= GetFont();
762 int size
= font
.GetPointSize();
765 case wxWINDOW_VARIANT_NORMAL
:
768 case wxWINDOW_VARIANT_SMALL
:
773 case wxWINDOW_VARIANT_MINI
:
778 case wxWINDOW_VARIANT_LARGE
:
784 wxFAIL_MSG(_T("unexpected window variant"));
788 font
.SetPointSize(size
);
792 void wxWindowBase::SetVirtualSizeHints( int minW
, int minH
,
795 m_minVirtualWidth
= minW
;
796 m_maxVirtualWidth
= maxW
;
797 m_minVirtualHeight
= minH
;
798 m_maxVirtualHeight
= maxH
;
801 void wxWindowBase::DoSetVirtualSize( int x
, int y
)
803 if ( m_minVirtualWidth
!= wxDefaultCoord
&& m_minVirtualWidth
> x
)
804 x
= m_minVirtualWidth
;
805 if ( m_maxVirtualWidth
!= wxDefaultCoord
&& m_maxVirtualWidth
< x
)
806 x
= m_maxVirtualWidth
;
807 if ( m_minVirtualHeight
!= wxDefaultCoord
&& m_minVirtualHeight
> y
)
808 y
= m_minVirtualHeight
;
809 if ( m_maxVirtualHeight
!= wxDefaultCoord
&& m_maxVirtualHeight
< y
)
810 y
= m_maxVirtualHeight
;
812 m_virtualSize
= wxSize(x
, y
);
815 wxSize
wxWindowBase::DoGetVirtualSize() const
817 if ( m_virtualSize
.IsFullySpecified() )
818 return m_virtualSize
;
820 wxSize size
= GetClientSize();
821 if ( m_virtualSize
.x
!= wxDefaultCoord
)
822 size
.x
= m_virtualSize
.x
;
824 if ( m_virtualSize
.y
!= wxDefaultCoord
)
825 size
.y
= m_virtualSize
.y
;
830 // ----------------------------------------------------------------------------
831 // show/hide/enable/disable the window
832 // ----------------------------------------------------------------------------
834 bool wxWindowBase::Show(bool show
)
836 if ( show
!= m_isShown
)
848 bool wxWindowBase::Enable(bool enable
)
850 if ( enable
!= m_isEnabled
)
852 m_isEnabled
= enable
;
861 // ----------------------------------------------------------------------------
863 // ----------------------------------------------------------------------------
865 bool wxWindowBase::IsTopLevel() const
870 // ----------------------------------------------------------------------------
871 // reparenting the window
872 // ----------------------------------------------------------------------------
874 void wxWindowBase::AddChild(wxWindowBase
*child
)
876 wxCHECK_RET( child
, wxT("can't add a NULL child") );
878 // this should never happen and it will lead to a crash later if it does
879 // because RemoveChild() will remove only one node from the children list
880 // and the other(s) one(s) will be left with dangling pointers in them
881 wxASSERT_MSG( !GetChildren().Find((wxWindow
*)child
), _T("AddChild() called twice") );
883 GetChildren().Append((wxWindow
*)child
);
884 child
->SetParent(this);
887 void wxWindowBase::RemoveChild(wxWindowBase
*child
)
889 wxCHECK_RET( child
, wxT("can't remove a NULL child") );
891 GetChildren().DeleteObject((wxWindow
*)child
);
892 child
->SetParent(NULL
);
895 bool wxWindowBase::Reparent(wxWindowBase
*newParent
)
897 wxWindow
*oldParent
= GetParent();
898 if ( newParent
== oldParent
)
904 // unlink this window from the existing parent.
907 oldParent
->RemoveChild(this);
911 wxTopLevelWindows
.DeleteObject((wxWindow
*)this);
914 // add it to the new one
917 newParent
->AddChild(this);
921 wxTopLevelWindows
.Append((wxWindow
*)this);
927 // ----------------------------------------------------------------------------
928 // event handler stuff
929 // ----------------------------------------------------------------------------
931 void wxWindowBase::PushEventHandler(wxEvtHandler
*handler
)
933 wxEvtHandler
*handlerOld
= GetEventHandler();
935 handler
->SetNextHandler(handlerOld
);
938 GetEventHandler()->SetPreviousHandler(handler
);
940 SetEventHandler(handler
);
943 wxEvtHandler
*wxWindowBase::PopEventHandler(bool deleteHandler
)
945 wxEvtHandler
*handlerA
= GetEventHandler();
948 wxEvtHandler
*handlerB
= handlerA
->GetNextHandler();
949 handlerA
->SetNextHandler((wxEvtHandler
*)NULL
);
952 handlerB
->SetPreviousHandler((wxEvtHandler
*)NULL
);
953 SetEventHandler(handlerB
);
958 handlerA
= (wxEvtHandler
*)NULL
;
965 bool wxWindowBase::RemoveEventHandler(wxEvtHandler
*handler
)
967 wxCHECK_MSG( handler
, false, _T("RemoveEventHandler(NULL) called") );
969 wxEvtHandler
*handlerPrev
= NULL
,
970 *handlerCur
= GetEventHandler();
973 wxEvtHandler
*handlerNext
= handlerCur
->GetNextHandler();
975 if ( handlerCur
== handler
)
979 handlerPrev
->SetNextHandler(handlerNext
);
983 SetEventHandler(handlerNext
);
988 handlerNext
->SetPreviousHandler ( handlerPrev
);
991 handler
->SetNextHandler(NULL
);
992 handler
->SetPreviousHandler(NULL
);
997 handlerPrev
= handlerCur
;
998 handlerCur
= handlerNext
;
1001 wxFAIL_MSG( _T("where has the event handler gone?") );
1006 // ----------------------------------------------------------------------------
1007 // colours, fonts &c
1008 // ----------------------------------------------------------------------------
1010 void wxWindowBase::InheritAttributes()
1012 const wxWindowBase
* const parent
= GetParent();
1016 // we only inherit attributes which had been explicitly set for the parent
1017 // which ensures that this only happens if the user really wants it and
1018 // not by default which wouldn't make any sense in modern GUIs where the
1019 // controls don't all use the same fonts (nor colours)
1020 if ( parent
->m_inheritFont
&& !m_hasFont
)
1021 SetFont(parent
->GetFont());
1023 // in addition, there is a possibility to explicitly forbid inheriting
1024 // colours at each class level by overriding ShouldInheritColours()
1025 if ( ShouldInheritColours() )
1027 if ( parent
->m_inheritFgCol
&& !m_hasFgCol
)
1028 SetForegroundColour(parent
->GetForegroundColour());
1030 // inheriting (solid) background colour is wrong as it totally breaks
1031 // any kind of themed backgrounds
1033 // instead, the controls should use the same background as their parent
1034 // (ideally by not drawing it at all)
1036 if ( parent
->m_inheritBgCol
&& !m_hasBgCol
)
1037 SetBackgroundColour(parent
->GetBackgroundColour());
1042 /* static */ wxVisualAttributes
1043 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1045 // it is important to return valid values for all attributes from here,
1046 // GetXXX() below rely on this
1047 wxVisualAttributes attrs
;
1048 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
1049 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
1051 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1052 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1053 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1054 // colour on other platforms.
1056 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1057 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
);
1059 attrs
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
);
1064 wxColour
wxWindowBase::GetBackgroundColour() const
1066 if ( !m_backgroundColour
.Ok() )
1068 wxASSERT_MSG( !m_hasBgCol
, _T("we have invalid explicit bg colour?") );
1070 // get our default background colour
1071 wxColour colBg
= GetDefaultAttributes().colBg
;
1073 // we must return some valid colour to avoid redoing this every time
1074 // and also to avoid surprizing the applications written for older
1075 // wxWidgets versions where GetBackgroundColour() always returned
1076 // something -- so give them something even if it doesn't make sense
1077 // for this window (e.g. it has a themed background)
1079 colBg
= GetClassDefaultAttributes().colBg
;
1084 return m_backgroundColour
;
1087 wxColour
wxWindowBase::GetForegroundColour() const
1089 // logic is the same as above
1090 if ( !m_hasFgCol
&& !m_foregroundColour
.Ok() )
1092 wxASSERT_MSG( !m_hasFgCol
, _T("we have invalid explicit fg colour?") );
1094 wxColour colFg
= GetDefaultAttributes().colFg
;
1097 colFg
= GetClassDefaultAttributes().colFg
;
1102 return m_foregroundColour
;
1105 bool wxWindowBase::SetBackgroundColour( const wxColour
&colour
)
1107 if ( colour
== m_backgroundColour
)
1110 m_hasBgCol
= colour
.Ok();
1111 if ( m_backgroundStyle
!= wxBG_STYLE_CUSTOM
)
1112 m_backgroundStyle
= m_hasBgCol
? wxBG_STYLE_COLOUR
: wxBG_STYLE_SYSTEM
;
1114 m_inheritBgCol
= m_hasBgCol
;
1115 m_backgroundColour
= colour
;
1116 SetThemeEnabled( !m_hasBgCol
&& !m_foregroundColour
.Ok() );
1120 bool wxWindowBase::SetForegroundColour( const wxColour
&colour
)
1122 if (colour
== m_foregroundColour
)
1125 m_hasFgCol
= colour
.Ok();
1126 m_inheritFgCol
= m_hasFgCol
;
1127 m_foregroundColour
= colour
;
1128 SetThemeEnabled( !m_hasFgCol
&& !m_backgroundColour
.Ok() );
1132 bool wxWindowBase::SetCursor(const wxCursor
& cursor
)
1134 // setting an invalid cursor is ok, it means that we don't have any special
1136 if ( m_cursor
== cursor
)
1147 wxFont
wxWindowBase::GetFont() const
1149 // logic is the same as in GetBackgroundColour()
1152 wxASSERT_MSG( !m_hasFont
, _T("we have invalid explicit font?") );
1154 wxFont font
= GetDefaultAttributes().font
;
1156 font
= GetClassDefaultAttributes().font
;
1164 bool wxWindowBase::SetFont(const wxFont
& font
)
1166 if ( font
== m_font
)
1173 m_hasFont
= font
.Ok();
1174 m_inheritFont
= m_hasFont
;
1176 InvalidateBestSize();
1183 void wxWindowBase::SetPalette(const wxPalette
& pal
)
1185 m_hasCustomPalette
= true;
1188 // VZ: can anyone explain me what do we do here?
1189 wxWindowDC
d((wxWindow
*) this);
1193 wxWindow
*wxWindowBase::GetAncestorWithCustomPalette() const
1195 wxWindow
*win
= (wxWindow
*)this;
1196 while ( win
&& !win
->HasCustomPalette() )
1198 win
= win
->GetParent();
1204 #endif // wxUSE_PALETTE
1207 void wxWindowBase::SetCaret(wxCaret
*caret
)
1218 wxASSERT_MSG( m_caret
->GetWindow() == this,
1219 wxT("caret should be created associated to this window") );
1222 #endif // wxUSE_CARET
1224 #if wxUSE_VALIDATORS
1225 // ----------------------------------------------------------------------------
1227 // ----------------------------------------------------------------------------
1229 void wxWindowBase::SetValidator(const wxValidator
& validator
)
1231 if ( m_windowValidator
)
1232 delete m_windowValidator
;
1234 m_windowValidator
= (wxValidator
*)validator
.Clone();
1236 if ( m_windowValidator
)
1237 m_windowValidator
->SetWindow(this);
1239 #endif // wxUSE_VALIDATORS
1241 // ----------------------------------------------------------------------------
1242 // update region stuff
1243 // ----------------------------------------------------------------------------
1245 wxRect
wxWindowBase::GetUpdateClientRect() const
1247 wxRegion rgnUpdate
= GetUpdateRegion();
1248 rgnUpdate
.Intersect(GetClientRect());
1249 wxRect rectUpdate
= rgnUpdate
.GetBox();
1250 wxPoint ptOrigin
= GetClientAreaOrigin();
1251 rectUpdate
.x
-= ptOrigin
.x
;
1252 rectUpdate
.y
-= ptOrigin
.y
;
1257 bool wxWindowBase::IsExposed(int x
, int y
) const
1259 return m_updateRegion
.Contains(x
, y
) != wxOutRegion
;
1262 bool wxWindowBase::IsExposed(int x
, int y
, int w
, int h
) const
1264 return m_updateRegion
.Contains(x
, y
, w
, h
) != wxOutRegion
;
1267 void wxWindowBase::ClearBackground()
1269 // wxGTK uses its own version, no need to add never used code
1271 wxClientDC
dc((wxWindow
*)this);
1272 wxBrush
brush(GetBackgroundColour(), wxSOLID
);
1273 dc
.SetBackground(brush
);
1278 // ----------------------------------------------------------------------------
1279 // find child window by id or name
1280 // ----------------------------------------------------------------------------
1282 wxWindow
*wxWindowBase::FindWindow(long id
) const
1284 if ( id
== m_windowId
)
1285 return (wxWindow
*)this;
1287 wxWindowBase
*res
= (wxWindow
*)NULL
;
1288 wxWindowList::compatibility_iterator node
;
1289 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1291 wxWindowBase
*child
= node
->GetData();
1292 res
= child
->FindWindow( id
);
1295 return (wxWindow
*)res
;
1298 wxWindow
*wxWindowBase::FindWindow(const wxString
& name
) const
1300 if ( name
== m_windowName
)
1301 return (wxWindow
*)this;
1303 wxWindowBase
*res
= (wxWindow
*)NULL
;
1304 wxWindowList::compatibility_iterator node
;
1305 for ( node
= m_children
.GetFirst(); node
&& !res
; node
= node
->GetNext() )
1307 wxWindow
*child
= node
->GetData();
1308 res
= child
->FindWindow(name
);
1311 return (wxWindow
*)res
;
1315 // find any window by id or name or label: If parent is non-NULL, look through
1316 // children for a label or title matching the specified string. If NULL, look
1317 // through all top-level windows.
1319 // to avoid duplicating code we reuse the same helper function but with
1320 // different comparators
1322 typedef bool (*wxFindWindowCmp
)(const wxWindow
*win
,
1323 const wxString
& label
, long id
);
1326 bool wxFindWindowCmpLabels(const wxWindow
*win
, const wxString
& label
,
1329 return win
->GetLabel() == label
;
1333 bool wxFindWindowCmpNames(const wxWindow
*win
, const wxString
& label
,
1336 return win
->GetName() == label
;
1340 bool wxFindWindowCmpIds(const wxWindow
*win
, const wxString
& WXUNUSED(label
),
1343 return win
->GetId() == id
;
1346 // recursive helper for the FindWindowByXXX() functions
1348 wxWindow
*wxFindWindowRecursively(const wxWindow
*parent
,
1349 const wxString
& label
,
1351 wxFindWindowCmp cmp
)
1355 // see if this is the one we're looking for
1356 if ( (*cmp
)(parent
, label
, id
) )
1357 return (wxWindow
*)parent
;
1359 // It wasn't, so check all its children
1360 for ( wxWindowList::compatibility_iterator node
= parent
->GetChildren().GetFirst();
1362 node
= node
->GetNext() )
1364 // recursively check each child
1365 wxWindow
*win
= (wxWindow
*)node
->GetData();
1366 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1376 // helper for FindWindowByXXX()
1378 wxWindow
*wxFindWindowHelper(const wxWindow
*parent
,
1379 const wxString
& label
,
1381 wxFindWindowCmp cmp
)
1385 // just check parent and all its children
1386 return wxFindWindowRecursively(parent
, label
, id
, cmp
);
1389 // start at very top of wx's windows
1390 for ( wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1392 node
= node
->GetNext() )
1394 // recursively check each window & its children
1395 wxWindow
*win
= node
->GetData();
1396 wxWindow
*retwin
= wxFindWindowRecursively(win
, label
, id
, cmp
);
1406 wxWindowBase::FindWindowByLabel(const wxString
& title
, const wxWindow
*parent
)
1408 return wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpLabels
);
1413 wxWindowBase::FindWindowByName(const wxString
& title
, const wxWindow
*parent
)
1415 wxWindow
*win
= wxFindWindowHelper(parent
, title
, 0, wxFindWindowCmpNames
);
1419 // fall back to the label
1420 win
= FindWindowByLabel(title
, parent
);
1428 wxWindowBase::FindWindowById( long id
, const wxWindow
* parent
)
1430 return wxFindWindowHelper(parent
, wxEmptyString
, id
, wxFindWindowCmpIds
);
1433 // ----------------------------------------------------------------------------
1434 // dialog oriented functions
1435 // ----------------------------------------------------------------------------
1437 void wxWindowBase::MakeModal(bool modal
)
1439 // Disable all other windows
1442 wxWindowList::compatibility_iterator node
= wxTopLevelWindows
.GetFirst();
1445 wxWindow
*win
= node
->GetData();
1447 win
->Enable(!modal
);
1449 node
= node
->GetNext();
1454 bool wxWindowBase::Validate()
1456 #if wxUSE_VALIDATORS
1457 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1459 wxWindowList::compatibility_iterator node
;
1460 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1462 wxWindowBase
*child
= node
->GetData();
1463 wxValidator
*validator
= child
->GetValidator();
1464 if ( validator
&& !validator
->Validate((wxWindow
*)this) )
1469 if ( recurse
&& !child
->Validate() )
1474 #endif // wxUSE_VALIDATORS
1479 bool wxWindowBase::TransferDataToWindow()
1481 #if wxUSE_VALIDATORS
1482 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1484 wxWindowList::compatibility_iterator node
;
1485 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1487 wxWindowBase
*child
= node
->GetData();
1488 wxValidator
*validator
= child
->GetValidator();
1489 if ( validator
&& !validator
->TransferToWindow() )
1491 wxLogWarning(_("Could not transfer data to window"));
1493 wxLog::FlushActive();
1501 if ( !child
->TransferDataToWindow() )
1503 // warning already given
1508 #endif // wxUSE_VALIDATORS
1513 bool wxWindowBase::TransferDataFromWindow()
1515 #if wxUSE_VALIDATORS
1516 bool recurse
= (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY
) != 0;
1518 wxWindowList::compatibility_iterator node
;
1519 for ( node
= m_children
.GetFirst(); node
; node
= node
->GetNext() )
1521 wxWindow
*child
= node
->GetData();
1522 wxValidator
*validator
= child
->GetValidator();
1523 if ( validator
&& !validator
->TransferFromWindow() )
1525 // nop warning here because the application is supposed to give
1526 // one itself - we don't know here what might have gone wrongly
1533 if ( !child
->TransferDataFromWindow() )
1535 // warning already given
1540 #endif // wxUSE_VALIDATORS
1545 void wxWindowBase::InitDialog()
1547 wxInitDialogEvent
event(GetId());
1548 event
.SetEventObject( this );
1549 GetEventHandler()->ProcessEvent(event
);
1552 // ----------------------------------------------------------------------------
1553 // context-sensitive help support
1554 // ----------------------------------------------------------------------------
1558 // associate this help text with this window
1559 void wxWindowBase::SetHelpText(const wxString
& text
)
1561 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1564 helpProvider
->AddHelp(this, text
);
1568 // associate this help text with all windows with the same id as this
1570 void wxWindowBase::SetHelpTextForId(const wxString
& text
)
1572 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1575 helpProvider
->AddHelp(GetId(), text
);
1579 // get the help string associated with this window (may be empty)
1580 wxString
wxWindowBase::GetHelpText() const
1583 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1586 text
= helpProvider
->GetHelp(this);
1592 // show help for this window
1593 void wxWindowBase::OnHelp(wxHelpEvent
& event
)
1595 wxHelpProvider
*helpProvider
= wxHelpProvider::Get();
1598 if ( helpProvider
->ShowHelp(this) )
1600 // skip the event.Skip() below
1608 #endif // wxUSE_HELP
1610 // ----------------------------------------------------------------------------
1611 // tooltipsroot.Replace("\\", "/");
1612 // ----------------------------------------------------------------------------
1616 void wxWindowBase::SetToolTip( const wxString
&tip
)
1618 // don't create the new tooltip if we already have one
1621 m_tooltip
->SetTip( tip
);
1625 SetToolTip( new wxToolTip( tip
) );
1628 // setting empty tooltip text does not remove the tooltip any more - use
1629 // SetToolTip((wxToolTip *)NULL) for this
1632 void wxWindowBase::DoSetToolTip(wxToolTip
*tooltip
)
1637 m_tooltip
= tooltip
;
1640 #endif // wxUSE_TOOLTIPS
1642 // ----------------------------------------------------------------------------
1643 // constraints and sizers
1644 // ----------------------------------------------------------------------------
1646 #if wxUSE_CONSTRAINTS
1648 void wxWindowBase::SetConstraints( wxLayoutConstraints
*constraints
)
1650 if ( m_constraints
)
1652 UnsetConstraints(m_constraints
);
1653 delete m_constraints
;
1655 m_constraints
= constraints
;
1656 if ( m_constraints
)
1658 // Make sure other windows know they're part of a 'meaningful relationship'
1659 if ( m_constraints
->left
.GetOtherWindow() && (m_constraints
->left
.GetOtherWindow() != this) )
1660 m_constraints
->left
.GetOtherWindow()->AddConstraintReference(this);
1661 if ( m_constraints
->top
.GetOtherWindow() && (m_constraints
->top
.GetOtherWindow() != this) )
1662 m_constraints
->top
.GetOtherWindow()->AddConstraintReference(this);
1663 if ( m_constraints
->right
.GetOtherWindow() && (m_constraints
->right
.GetOtherWindow() != this) )
1664 m_constraints
->right
.GetOtherWindow()->AddConstraintReference(this);
1665 if ( m_constraints
->bottom
.GetOtherWindow() && (m_constraints
->bottom
.GetOtherWindow() != this) )
1666 m_constraints
->bottom
.GetOtherWindow()->AddConstraintReference(this);
1667 if ( m_constraints
->width
.GetOtherWindow() && (m_constraints
->width
.GetOtherWindow() != this) )
1668 m_constraints
->width
.GetOtherWindow()->AddConstraintReference(this);
1669 if ( m_constraints
->height
.GetOtherWindow() && (m_constraints
->height
.GetOtherWindow() != this) )
1670 m_constraints
->height
.GetOtherWindow()->AddConstraintReference(this);
1671 if ( m_constraints
->centreX
.GetOtherWindow() && (m_constraints
->centreX
.GetOtherWindow() != this) )
1672 m_constraints
->centreX
.GetOtherWindow()->AddConstraintReference(this);
1673 if ( m_constraints
->centreY
.GetOtherWindow() && (m_constraints
->centreY
.GetOtherWindow() != this) )
1674 m_constraints
->centreY
.GetOtherWindow()->AddConstraintReference(this);
1678 // This removes any dangling pointers to this window in other windows'
1679 // constraintsInvolvedIn lists.
1680 void wxWindowBase::UnsetConstraints(wxLayoutConstraints
*c
)
1684 if ( c
->left
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1685 c
->left
.GetOtherWindow()->RemoveConstraintReference(this);
1686 if ( c
->top
.GetOtherWindow() && (c
->top
.GetOtherWindow() != this) )
1687 c
->top
.GetOtherWindow()->RemoveConstraintReference(this);
1688 if ( c
->right
.GetOtherWindow() && (c
->right
.GetOtherWindow() != this) )
1689 c
->right
.GetOtherWindow()->RemoveConstraintReference(this);
1690 if ( c
->bottom
.GetOtherWindow() && (c
->bottom
.GetOtherWindow() != this) )
1691 c
->bottom
.GetOtherWindow()->RemoveConstraintReference(this);
1692 if ( c
->width
.GetOtherWindow() && (c
->width
.GetOtherWindow() != this) )
1693 c
->width
.GetOtherWindow()->RemoveConstraintReference(this);
1694 if ( c
->height
.GetOtherWindow() && (c
->height
.GetOtherWindow() != this) )
1695 c
->height
.GetOtherWindow()->RemoveConstraintReference(this);
1696 if ( c
->centreX
.GetOtherWindow() && (c
->centreX
.GetOtherWindow() != this) )
1697 c
->centreX
.GetOtherWindow()->RemoveConstraintReference(this);
1698 if ( c
->centreY
.GetOtherWindow() && (c
->centreY
.GetOtherWindow() != this) )
1699 c
->centreY
.GetOtherWindow()->RemoveConstraintReference(this);
1703 // Back-pointer to other windows we're involved with, so if we delete this
1704 // window, we must delete any constraints we're involved with.
1705 void wxWindowBase::AddConstraintReference(wxWindowBase
*otherWin
)
1707 if ( !m_constraintsInvolvedIn
)
1708 m_constraintsInvolvedIn
= new wxWindowList
;
1709 if ( !m_constraintsInvolvedIn
->Find((wxWindow
*)otherWin
) )
1710 m_constraintsInvolvedIn
->Append((wxWindow
*)otherWin
);
1713 // REMOVE back-pointer to other windows we're involved with.
1714 void wxWindowBase::RemoveConstraintReference(wxWindowBase
*otherWin
)
1716 if ( m_constraintsInvolvedIn
)
1717 m_constraintsInvolvedIn
->DeleteObject((wxWindow
*)otherWin
);
1720 // Reset any constraints that mention this window
1721 void wxWindowBase::DeleteRelatedConstraints()
1723 if ( m_constraintsInvolvedIn
)
1725 wxWindowList::compatibility_iterator node
= m_constraintsInvolvedIn
->GetFirst();
1728 wxWindow
*win
= node
->GetData();
1729 wxLayoutConstraints
*constr
= win
->GetConstraints();
1731 // Reset any constraints involving this window
1734 constr
->left
.ResetIfWin(this);
1735 constr
->top
.ResetIfWin(this);
1736 constr
->right
.ResetIfWin(this);
1737 constr
->bottom
.ResetIfWin(this);
1738 constr
->width
.ResetIfWin(this);
1739 constr
->height
.ResetIfWin(this);
1740 constr
->centreX
.ResetIfWin(this);
1741 constr
->centreY
.ResetIfWin(this);
1744 wxWindowList::compatibility_iterator next
= node
->GetNext();
1745 m_constraintsInvolvedIn
->Erase(node
);
1749 delete m_constraintsInvolvedIn
;
1750 m_constraintsInvolvedIn
= (wxWindowList
*) NULL
;
1754 #endif // wxUSE_CONSTRAINTS
1756 void wxWindowBase::SetSizer(wxSizer
*sizer
, bool deleteOld
)
1758 if ( sizer
== m_windowSizer
)
1762 delete m_windowSizer
;
1764 m_windowSizer
= sizer
;
1766 SetAutoLayout( sizer
!= NULL
);
1769 void wxWindowBase::SetSizerAndFit(wxSizer
*sizer
, bool deleteOld
)
1771 SetSizer( sizer
, deleteOld
);
1772 sizer
->SetSizeHints( (wxWindow
*) this );
1776 void wxWindowBase::SetContainingSizer(wxSizer
* sizer
)
1778 // adding a window to a sizer twice is going to result in fatal and
1779 // hard to debug problems later because when deleting the second
1780 // associated wxSizerItem we're going to dereference a dangling
1781 // pointer; so try to detect this as early as possible
1782 wxASSERT_MSG( !sizer
|| m_containingSizer
!= sizer
,
1783 _T("Adding a window to the same sizer twice?") );
1785 m_containingSizer
= sizer
;
1788 #if wxUSE_CONSTRAINTS
1790 void wxWindowBase::SatisfyConstraints()
1792 wxLayoutConstraints
*constr
= GetConstraints();
1793 bool wasOk
= constr
&& constr
->AreSatisfied();
1795 ResetConstraints(); // Mark all constraints as unevaluated
1799 // if we're a top level panel (i.e. our parent is frame/dialog), our
1800 // own constraints will never be satisfied any more unless we do it
1804 while ( noChanges
> 0 )
1806 LayoutPhase1(&noChanges
);
1810 LayoutPhase2(&noChanges
);
1813 #endif // wxUSE_CONSTRAINTS
1815 bool wxWindowBase::Layout()
1817 // If there is a sizer, use it instead of the constraints
1821 GetVirtualSize(&w
, &h
);
1822 GetSizer()->SetDimension( 0, 0, w
, h
);
1824 #if wxUSE_CONSTRAINTS
1827 SatisfyConstraints(); // Find the right constraints values
1828 SetConstraintSizes(); // Recursively set the real window sizes
1835 #if wxUSE_CONSTRAINTS
1837 // first phase of the constraints evaluation: set our own constraints
1838 bool wxWindowBase::LayoutPhase1(int *noChanges
)
1840 wxLayoutConstraints
*constr
= GetConstraints();
1842 return !constr
|| constr
->SatisfyConstraints(this, noChanges
);
1845 // second phase: set the constraints for our children
1846 bool wxWindowBase::LayoutPhase2(int *noChanges
)
1853 // Layout grand children
1859 // Do a phase of evaluating child constraints
1860 bool wxWindowBase::DoPhase(int phase
)
1862 // the list containing the children for which the constraints are already
1864 wxWindowList succeeded
;
1866 // the max number of iterations we loop before concluding that we can't set
1868 static const int maxIterations
= 500;
1870 for ( int noIterations
= 0; noIterations
< maxIterations
; noIterations
++ )
1874 // loop over all children setting their constraints
1875 for ( wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1877 node
= node
->GetNext() )
1879 wxWindow
*child
= node
->GetData();
1880 if ( child
->IsTopLevel() )
1882 // top level children are not inside our client area
1886 if ( !child
->GetConstraints() || succeeded
.Find(child
) )
1888 // this one is either already ok or nothing we can do about it
1892 int tempNoChanges
= 0;
1893 bool success
= phase
== 1 ? child
->LayoutPhase1(&tempNoChanges
)
1894 : child
->LayoutPhase2(&tempNoChanges
);
1895 noChanges
+= tempNoChanges
;
1899 succeeded
.Append(child
);
1905 // constraints are set
1913 void wxWindowBase::ResetConstraints()
1915 wxLayoutConstraints
*constr
= GetConstraints();
1918 constr
->left
.SetDone(false);
1919 constr
->top
.SetDone(false);
1920 constr
->right
.SetDone(false);
1921 constr
->bottom
.SetDone(false);
1922 constr
->width
.SetDone(false);
1923 constr
->height
.SetDone(false);
1924 constr
->centreX
.SetDone(false);
1925 constr
->centreY
.SetDone(false);
1928 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1931 wxWindow
*win
= node
->GetData();
1932 if ( !win
->IsTopLevel() )
1933 win
->ResetConstraints();
1934 node
= node
->GetNext();
1938 // Need to distinguish between setting the 'fake' size for windows and sizers,
1939 // and setting the real values.
1940 void wxWindowBase::SetConstraintSizes(bool recurse
)
1942 wxLayoutConstraints
*constr
= GetConstraints();
1943 if ( constr
&& constr
->AreSatisfied() )
1945 int x
= constr
->left
.GetValue();
1946 int y
= constr
->top
.GetValue();
1947 int w
= constr
->width
.GetValue();
1948 int h
= constr
->height
.GetValue();
1950 if ( (constr
->width
.GetRelationship() != wxAsIs
) ||
1951 (constr
->height
.GetRelationship() != wxAsIs
) )
1953 SetSize(x
, y
, w
, h
);
1957 // If we don't want to resize this window, just move it...
1963 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
1964 GetClassInfo()->GetClassName(),
1970 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
1973 wxWindow
*win
= node
->GetData();
1974 if ( !win
->IsTopLevel() && win
->GetConstraints() )
1975 win
->SetConstraintSizes();
1976 node
= node
->GetNext();
1981 // Only set the size/position of the constraint (if any)
1982 void wxWindowBase::SetSizeConstraint(int x
, int y
, int w
, int h
)
1984 wxLayoutConstraints
*constr
= GetConstraints();
1987 if ( x
!= wxDefaultCoord
)
1989 constr
->left
.SetValue(x
);
1990 constr
->left
.SetDone(true);
1992 if ( y
!= wxDefaultCoord
)
1994 constr
->top
.SetValue(y
);
1995 constr
->top
.SetDone(true);
1997 if ( w
!= wxDefaultCoord
)
1999 constr
->width
.SetValue(w
);
2000 constr
->width
.SetDone(true);
2002 if ( h
!= wxDefaultCoord
)
2004 constr
->height
.SetValue(h
);
2005 constr
->height
.SetDone(true);
2010 void wxWindowBase::MoveConstraint(int x
, int y
)
2012 wxLayoutConstraints
*constr
= GetConstraints();
2015 if ( x
!= wxDefaultCoord
)
2017 constr
->left
.SetValue(x
);
2018 constr
->left
.SetDone(true);
2020 if ( y
!= wxDefaultCoord
)
2022 constr
->top
.SetValue(y
);
2023 constr
->top
.SetDone(true);
2028 void wxWindowBase::GetSizeConstraint(int *w
, int *h
) const
2030 wxLayoutConstraints
*constr
= GetConstraints();
2033 *w
= constr
->width
.GetValue();
2034 *h
= constr
->height
.GetValue();
2040 void wxWindowBase::GetClientSizeConstraint(int *w
, int *h
) const
2042 wxLayoutConstraints
*constr
= GetConstraints();
2045 *w
= constr
->width
.GetValue();
2046 *h
= constr
->height
.GetValue();
2049 GetClientSize(w
, h
);
2052 void wxWindowBase::GetPositionConstraint(int *x
, int *y
) const
2054 wxLayoutConstraints
*constr
= GetConstraints();
2057 *x
= constr
->left
.GetValue();
2058 *y
= constr
->top
.GetValue();
2064 #endif // wxUSE_CONSTRAINTS
2066 void wxWindowBase::AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
) const
2068 // don't do it for the dialogs/frames - they float independently of their
2070 if ( !IsTopLevel() )
2072 wxWindow
*parent
= GetParent();
2073 if ( !(sizeFlags
& wxSIZE_NO_ADJUSTMENTS
) && parent
)
2075 wxPoint
pt(parent
->GetClientAreaOrigin());
2082 // ----------------------------------------------------------------------------
2083 // do Update UI processing for child controls
2084 // ----------------------------------------------------------------------------
2086 void wxWindowBase::UpdateWindowUI(long flags
)
2088 wxUpdateUIEvent
event(GetId());
2089 event
.SetEventObject(this);
2091 if ( GetEventHandler()->ProcessEvent(event
) )
2093 DoUpdateWindowUI(event
);
2096 if (flags
& wxUPDATE_UI_RECURSE
)
2098 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2101 wxWindow
* child
= (wxWindow
*) node
->GetData();
2102 child
->UpdateWindowUI(flags
);
2103 node
= node
->GetNext();
2108 // do the window-specific processing after processing the update event
2109 // TODO: take specific knowledge out of this function and
2110 // put in each control's base class. Unfortunately we don't
2111 // yet have base implementation files for wxCheckBox and wxRadioButton.
2112 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
2114 if ( event
.GetSetEnabled() )
2115 Enable(event
.GetEnabled());
2118 if ( event
.GetSetText() )
2120 wxControl
*control
= wxDynamicCastThis(wxControl
);
2123 if ( event
.GetText() != control
->GetLabel() )
2124 control
->SetLabel(event
.GetText());
2127 #endif // wxUSE_CONTROLS
2129 if ( event
.GetSetChecked() )
2132 wxCheckBox
*checkbox
= wxDynamicCastThis(wxCheckBox
);
2135 checkbox
->SetValue(event
.GetChecked());
2137 #endif // wxUSE_CHECKBOX
2140 wxRadioButton
*radiobtn
= wxDynamicCastThis(wxRadioButton
);
2143 radiobtn
->SetValue(event
.GetChecked());
2145 #endif // wxUSE_RADIOBTN
2150 // call internal idle recursively
2151 // may be obsolete (wait until OnIdle scheme stabilises)
2152 void wxWindowBase::ProcessInternalIdle()
2156 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2159 wxWindow
*child
= node
->GetData();
2160 child
->ProcessInternalIdle();
2161 node
= node
->GetNext();
2166 // ----------------------------------------------------------------------------
2167 // dialog units translations
2168 // ----------------------------------------------------------------------------
2170 wxPoint
wxWindowBase::ConvertPixelsToDialog(const wxPoint
& pt
)
2172 int charWidth
= GetCharWidth();
2173 int charHeight
= GetCharHeight();
2174 wxPoint pt2
= wxDefaultPosition
;
2175 if (pt
.x
!= wxDefaultCoord
)
2176 pt2
.x
= (int) ((pt
.x
* 4) / charWidth
);
2177 if (pt
.y
!= wxDefaultCoord
)
2178 pt2
.y
= (int) ((pt
.y
* 8) / charHeight
);
2183 wxPoint
wxWindowBase::ConvertDialogToPixels(const wxPoint
& pt
)
2185 int charWidth
= GetCharWidth();
2186 int charHeight
= GetCharHeight();
2187 wxPoint pt2
= wxDefaultPosition
;
2188 if (pt
.x
!= wxDefaultCoord
)
2189 pt2
.x
= (int) ((pt
.x
* charWidth
) / 4);
2190 if (pt
.y
!= wxDefaultCoord
)
2191 pt2
.y
= (int) ((pt
.y
* charHeight
) / 8);
2196 // ----------------------------------------------------------------------------
2198 // ----------------------------------------------------------------------------
2200 // propagate the colour change event to the subwindows
2201 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent
& event
)
2203 wxWindowList::compatibility_iterator node
= GetChildren().GetFirst();
2206 // Only propagate to non-top-level windows
2207 wxWindow
*win
= node
->GetData();
2208 if ( !win
->IsTopLevel() )
2210 wxSysColourChangedEvent event2
;
2211 event
.SetEventObject(win
);
2212 win
->GetEventHandler()->ProcessEvent(event2
);
2215 node
= node
->GetNext();
2221 // the default action is to populate dialog with data when it's created,
2222 // and nudge the UI into displaying itself correctly in case
2223 // we've turned the wxUpdateUIEvents frequency down low.
2224 void wxWindowBase::OnInitDialog( wxInitDialogEvent
&WXUNUSED(event
) )
2226 TransferDataToWindow();
2228 // Update the UI at this point
2229 UpdateWindowUI(wxUPDATE_UI_RECURSE
);
2232 // process Ctrl-Alt-mclick
2233 void wxWindowBase::OnMiddleClick( wxMouseEvent
& event
)
2236 if ( event
.ControlDown() && event
.AltDown() )
2238 // don't translate these strings
2241 #ifdef __WXUNIVERSAL__
2243 #endif // __WXUNIVERSAL__
2245 switch ( wxGetOsVersion() )
2247 case wxMOTIF_X
: port
+= _T("Motif"); break;
2249 case wxMAC_DARWIN
: port
+= _T("Mac"); break;
2250 case wxBEOS
: port
+= _T("BeOS"); break;
2254 case wxGTK_BEOS
: port
+= _T("GTK"); break;
2260 case wxWIN386
: port
+= _T("MS Windows"); break;
2264 case wxMGL_OS2
: port
+= _T("MGL"); break;
2266 case wxOS2_PM
: port
+= _T("OS/2"); break;
2267 default: port
+= _T("unknown"); break;
2270 wxMessageBox(wxString::Format(
2272 " wxWidgets Library (%s port)\nVersion %u.%u.%u%s%s, compiled at %s %s\n Copyright (c) 1995-2005 wxWidgets team"
2291 _T("wxWidgets information"),
2292 wxICON_INFORMATION
| wxOK
,
2296 #endif // wxUSE_MSGDLG
2302 // ----------------------------------------------------------------------------
2304 // ----------------------------------------------------------------------------
2306 #if wxUSE_ACCESSIBILITY
2307 void wxWindowBase::SetAccessible(wxAccessible
* accessible
)
2309 if (m_accessible
&& (accessible
!= m_accessible
))
2310 delete m_accessible
;
2311 m_accessible
= accessible
;
2313 m_accessible
->SetWindow((wxWindow
*) this);
2316 // Returns the accessible object, creating if necessary.
2317 wxAccessible
* wxWindowBase::GetOrCreateAccessible()
2320 m_accessible
= CreateAccessible();
2321 return m_accessible
;
2324 // Override to create a specific accessible object.
2325 wxAccessible
* wxWindowBase::CreateAccessible()
2327 return new wxWindowAccessible((wxWindow
*) this);
2332 // ----------------------------------------------------------------------------
2333 // list classes implementation
2334 // ----------------------------------------------------------------------------
2338 #include <wx/listimpl.cpp>
2339 WX_DEFINE_LIST(wxWindowList
);
2343 void wxWindowListNode::DeleteData()
2345 delete (wxWindow
*)GetData();
2350 // ----------------------------------------------------------------------------
2352 // ----------------------------------------------------------------------------
2354 wxBorder
wxWindowBase::GetBorder(long flags
) const
2356 wxBorder border
= (wxBorder
)(flags
& wxBORDER_MASK
);
2357 if ( border
== wxBORDER_DEFAULT
)
2359 border
= GetDefaultBorder();
2365 wxBorder
wxWindowBase::GetDefaultBorder() const
2367 return wxBORDER_NONE
;
2370 // ----------------------------------------------------------------------------
2372 // ----------------------------------------------------------------------------
2374 wxHitTest
wxWindowBase::DoHitTest(wxCoord x
, wxCoord y
) const
2376 // here we just check if the point is inside the window or not
2378 // check the top and left border first
2379 bool outside
= x
< 0 || y
< 0;
2382 // check the right and bottom borders too
2383 wxSize size
= GetSize();
2384 outside
= x
>= size
.x
|| y
>= size
.y
;
2387 return outside
? wxHT_WINDOW_OUTSIDE
: wxHT_WINDOW_INSIDE
;
2390 // ----------------------------------------------------------------------------
2392 // ----------------------------------------------------------------------------
2394 struct WXDLLEXPORT wxWindowNext
2398 } *wxWindowBase::ms_winCaptureNext
= NULL
;
2400 void wxWindowBase::CaptureMouse()
2402 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), this);
2404 wxWindow
*winOld
= GetCapture();
2407 ((wxWindowBase
*) winOld
)->DoReleaseMouse();
2410 wxWindowNext
*item
= new wxWindowNext
;
2412 item
->next
= ms_winCaptureNext
;
2413 ms_winCaptureNext
= item
;
2415 //else: no mouse capture to save
2420 void wxWindowBase::ReleaseMouse()
2422 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), this);
2424 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2428 if ( ms_winCaptureNext
)
2430 ((wxWindowBase
*)ms_winCaptureNext
->win
)->DoCaptureMouse();
2432 wxWindowNext
*item
= ms_winCaptureNext
;
2433 ms_winCaptureNext
= item
->next
;
2436 //else: stack is empty, no previous capture
2438 wxLogTrace(_T("mousecapture"),
2439 (const wxChar
*) _T("After ReleaseMouse() mouse is captured by %p"),
2446 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId
),
2447 int WXUNUSED(modifiers
),
2448 int WXUNUSED(keycode
))
2454 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId
))
2460 #endif // wxUSE_HOTKEY
2462 void wxWindowBase::SendDestroyEvent()
2464 wxWindowDestroyEvent event
;
2465 event
.SetEventObject(this);
2466 event
.SetId(GetId());
2467 GetEventHandler()->ProcessEvent(event
);
2470 // ----------------------------------------------------------------------------
2472 // ----------------------------------------------------------------------------
2474 bool wxWindowBase::TryValidator(wxEvent
& wxVALIDATOR_PARAM(event
))
2476 #if wxUSE_VALIDATORS
2477 // Can only use the validator of the window which
2478 // is receiving the event
2479 if ( event
.GetEventObject() == this )
2481 wxValidator
*validator
= GetValidator();
2482 if ( validator
&& validator
->ProcessEvent(event
) )
2487 #endif // wxUSE_VALIDATORS
2492 bool wxWindowBase::TryParent(wxEvent
& event
)
2494 // carry on up the parent-child hierarchy if the propgation count hasn't
2496 if ( event
.ShouldPropagate() )
2498 // honour the requests to stop propagation at this window: this is
2499 // used by the dialogs, for example, to prevent processing the events
2500 // from the dialog controls in the parent frame which rarely, if ever,
2502 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
2504 wxWindow
*parent
= GetParent();
2505 if ( parent
&& !parent
->IsBeingDeleted() )
2507 wxPropagateOnce
propagateOnce(event
);
2509 return parent
->GetEventHandler()->ProcessEvent(event
);
2514 return wxEvtHandler::TryParent(event
);
2517 // ----------------------------------------------------------------------------
2518 // keyboard navigation
2519 // ----------------------------------------------------------------------------
2521 // Navigates in the specified direction.
2522 bool wxWindowBase::Navigate(int flags
)
2524 wxNavigationKeyEvent eventNav
;
2525 eventNav
.SetFlags(flags
);
2526 eventNav
.SetEventObject(this);
2527 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav
) )
2534 void wxWindowBase::DoMoveInTabOrder(wxWindow
*win
, MoveKind move
)
2536 // check that we're not a top level window
2537 wxCHECK_RET( GetParent(),
2538 _T("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
2540 // detect the special case when we have nothing to do anyhow and when the
2541 // code below wouldn't work
2545 // find the target window in the siblings list
2546 wxWindowList
& siblings
= GetParent()->GetChildren();
2547 wxWindowList::compatibility_iterator i
= siblings
.Find(win
);
2548 wxCHECK_RET( i
, _T("MoveBefore/AfterInTabOrder(): win is not a sibling") );
2550 // unfortunately, when wxUSE_STL == 1 DetachNode() is not implemented so we
2551 // can't just move the node around
2552 wxWindow
*self
= (wxWindow
*)this;
2553 siblings
.DeleteObject(self
);
2554 if ( move
== MoveAfter
)
2561 siblings
.Insert(i
, self
);
2563 else // MoveAfter and win was the last sibling
2565 siblings
.Append(self
);
2569 // ----------------------------------------------------------------------------
2571 // ----------------------------------------------------------------------------
2573 /*static*/ wxWindow
* wxWindowBase::FindFocus()
2575 wxWindowBase
*win
= DoFindFocus();
2576 return win
? win
->GetMainWindowOfCompositeControl() : NULL
;
2579 // ----------------------------------------------------------------------------
2581 // ----------------------------------------------------------------------------
2583 wxWindow
* wxGetTopLevelParent(wxWindow
*win
)
2585 while ( win
&& !win
->IsTopLevel() )
2586 win
= win
->GetParent();
2591 #if wxUSE_ACCESSIBILITY
2592 // ----------------------------------------------------------------------------
2593 // accessible object for windows
2594 // ----------------------------------------------------------------------------
2596 // Can return either a child object, or an integer
2597 // representing the child element, starting from 1.
2598 wxAccStatus
wxWindowAccessible::HitTest(const wxPoint
& WXUNUSED(pt
), int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(childObject
))
2600 wxASSERT( GetWindow() != NULL
);
2604 return wxACC_NOT_IMPLEMENTED
;
2607 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
2608 wxAccStatus
wxWindowAccessible::GetLocation(wxRect
& rect
, int elementId
)
2610 wxASSERT( GetWindow() != NULL
);
2614 wxWindow
* win
= NULL
;
2621 if (elementId
<= (int) GetWindow()->GetChildren().GetCount())
2623 win
= GetWindow()->GetChildren().Item(elementId
-1)->GetData();
2630 rect
= win
->GetRect();
2631 if (win
->GetParent() && !win
->IsKindOf(CLASSINFO(wxTopLevelWindow
)))
2632 rect
.SetPosition(win
->GetParent()->ClientToScreen(rect
.GetPosition()));
2636 return wxACC_NOT_IMPLEMENTED
;
2639 // Navigates from fromId to toId/toObject.
2640 wxAccStatus
wxWindowAccessible::Navigate(wxNavDir navDir
, int fromId
,
2641 int* WXUNUSED(toId
), wxAccessible
** toObject
)
2643 wxASSERT( GetWindow() != NULL
);
2649 case wxNAVDIR_FIRSTCHILD
:
2651 if (GetWindow()->GetChildren().GetCount() == 0)
2653 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetFirst()->GetData();
2654 *toObject
= childWindow
->GetOrCreateAccessible();
2658 case wxNAVDIR_LASTCHILD
:
2660 if (GetWindow()->GetChildren().GetCount() == 0)
2662 wxWindow
* childWindow
= (wxWindow
*) GetWindow()->GetChildren().GetLast()->GetData();
2663 *toObject
= childWindow
->GetOrCreateAccessible();
2667 case wxNAVDIR_RIGHT
:
2671 wxWindowList::compatibility_iterator node
=
2672 wxWindowList::compatibility_iterator();
2675 // Can't navigate to sibling of this window
2676 // if we're a top-level window.
2677 if (!GetWindow()->GetParent())
2678 return wxACC_NOT_IMPLEMENTED
;
2680 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2684 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2685 node
= GetWindow()->GetChildren().Item(fromId
-1);
2688 if (node
&& node
->GetNext())
2690 wxWindow
* nextWindow
= node
->GetNext()->GetData();
2691 *toObject
= nextWindow
->GetOrCreateAccessible();
2699 case wxNAVDIR_PREVIOUS
:
2701 wxWindowList::compatibility_iterator node
=
2702 wxWindowList::compatibility_iterator();
2705 // Can't navigate to sibling of this window
2706 // if we're a top-level window.
2707 if (!GetWindow()->GetParent())
2708 return wxACC_NOT_IMPLEMENTED
;
2710 node
= GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2714 if (fromId
<= (int) GetWindow()->GetChildren().GetCount())
2715 node
= GetWindow()->GetChildren().Item(fromId
-1);
2718 if (node
&& node
->GetPrevious())
2720 wxWindow
* previousWindow
= node
->GetPrevious()->GetData();
2721 *toObject
= previousWindow
->GetOrCreateAccessible();
2729 return wxACC_NOT_IMPLEMENTED
;
2732 // Gets the name of the specified object.
2733 wxAccStatus
wxWindowAccessible::GetName(int childId
, wxString
* name
)
2735 wxASSERT( GetWindow() != NULL
);
2741 // If a child, leave wxWidgets to call the function on the actual
2744 return wxACC_NOT_IMPLEMENTED
;
2746 // This will eventually be replaced by specialised
2747 // accessible classes, one for each kind of wxWidgets
2748 // control or window.
2750 if (GetWindow()->IsKindOf(CLASSINFO(wxButton
)))
2751 title
= ((wxButton
*) GetWindow())->GetLabel();
2754 title
= GetWindow()->GetName();
2762 return wxACC_NOT_IMPLEMENTED
;
2765 // Gets the number of children.
2766 wxAccStatus
wxWindowAccessible::GetChildCount(int* childId
)
2768 wxASSERT( GetWindow() != NULL
);
2772 *childId
= (int) GetWindow()->GetChildren().GetCount();
2776 // Gets the specified child (starting from 1).
2777 // If *child is NULL and return value is wxACC_OK,
2778 // this means that the child is a simple element and
2779 // not an accessible object.
2780 wxAccStatus
wxWindowAccessible::GetChild(int childId
, wxAccessible
** child
)
2782 wxASSERT( GetWindow() != NULL
);
2792 if (childId
> (int) GetWindow()->GetChildren().GetCount())
2795 wxWindow
* childWindow
= GetWindow()->GetChildren().Item(childId
-1)->GetData();
2796 *child
= childWindow
->GetOrCreateAccessible();
2803 // Gets the parent, or NULL.
2804 wxAccStatus
wxWindowAccessible::GetParent(wxAccessible
** parent
)
2806 wxASSERT( GetWindow() != NULL
);
2810 wxWindow
* parentWindow
= GetWindow()->GetParent();
2818 *parent
= parentWindow
->GetOrCreateAccessible();
2826 // Performs the default action. childId is 0 (the action for this object)
2827 // or > 0 (the action for a child).
2828 // Return wxACC_NOT_SUPPORTED if there is no default action for this
2829 // window (e.g. an edit control).
2830 wxAccStatus
wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId
))
2832 wxASSERT( GetWindow() != NULL
);
2836 return wxACC_NOT_IMPLEMENTED
;
2839 // Gets the default action for this object (0) or > 0 (the action for a child).
2840 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
2841 // string if there is no action.
2842 // The retrieved string describes the action that is performed on an object,
2843 // not what the object does as a result. For example, a toolbar button that prints
2844 // a document has a default action of "Press" rather than "Prints the current document."
2845 wxAccStatus
wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId
), wxString
* WXUNUSED(actionName
))
2847 wxASSERT( GetWindow() != NULL
);
2851 return wxACC_NOT_IMPLEMENTED
;
2854 // Returns the description for this object or a child.
2855 wxAccStatus
wxWindowAccessible::GetDescription(int WXUNUSED(childId
), wxString
* description
)
2857 wxASSERT( GetWindow() != NULL
);
2861 wxString
ht(GetWindow()->GetHelpText());
2867 return wxACC_NOT_IMPLEMENTED
;
2870 // Returns help text for this object or a child, similar to tooltip text.
2871 wxAccStatus
wxWindowAccessible::GetHelpText(int WXUNUSED(childId
), wxString
* helpText
)
2873 wxASSERT( GetWindow() != NULL
);
2877 wxString
ht(GetWindow()->GetHelpText());
2883 return wxACC_NOT_IMPLEMENTED
;
2886 // Returns the keyboard shortcut for this object or child.
2887 // Return e.g. ALT+K
2888 wxAccStatus
wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId
), wxString
* WXUNUSED(shortcut
))
2890 wxASSERT( GetWindow() != NULL
);
2894 return wxACC_NOT_IMPLEMENTED
;
2897 // Returns a role constant.
2898 wxAccStatus
wxWindowAccessible::GetRole(int childId
, wxAccRole
* role
)
2900 wxASSERT( GetWindow() != NULL
);
2904 // If a child, leave wxWidgets to call the function on the actual
2907 return wxACC_NOT_IMPLEMENTED
;
2909 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
2910 return wxACC_NOT_IMPLEMENTED
;
2912 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
2913 return wxACC_NOT_IMPLEMENTED
;
2916 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
2917 return wxACC_NOT_IMPLEMENTED
;
2920 //*role = wxROLE_SYSTEM_CLIENT;
2921 *role
= wxROLE_SYSTEM_CLIENT
;
2925 return wxACC_NOT_IMPLEMENTED
;
2929 // Returns a state constant.
2930 wxAccStatus
wxWindowAccessible::GetState(int childId
, long* state
)
2932 wxASSERT( GetWindow() != NULL
);
2936 // If a child, leave wxWidgets to call the function on the actual
2939 return wxACC_NOT_IMPLEMENTED
;
2941 if (GetWindow()->IsKindOf(CLASSINFO(wxControl
)))
2942 return wxACC_NOT_IMPLEMENTED
;
2945 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar
)))
2946 return wxACC_NOT_IMPLEMENTED
;
2949 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar
)))
2950 return wxACC_NOT_IMPLEMENTED
;
2957 return wxACC_NOT_IMPLEMENTED
;
2961 // Returns a localized string representing the value for the object
2963 wxAccStatus
wxWindowAccessible::GetValue(int WXUNUSED(childId
), wxString
* WXUNUSED(strValue
))
2965 wxASSERT( GetWindow() != NULL
);
2969 return wxACC_NOT_IMPLEMENTED
;
2972 // Selects the object or child.
2973 wxAccStatus
wxWindowAccessible::Select(int WXUNUSED(childId
), wxAccSelectionFlags
WXUNUSED(selectFlags
))
2975 wxASSERT( GetWindow() != NULL
);
2979 return wxACC_NOT_IMPLEMENTED
;
2982 // Gets the window with the keyboard focus.
2983 // If childId is 0 and child is NULL, no object in
2984 // this subhierarchy has the focus.
2985 // If this object has the focus, child should be 'this'.
2986 wxAccStatus
wxWindowAccessible::GetFocus(int* WXUNUSED(childId
), wxAccessible
** WXUNUSED(child
))
2988 wxASSERT( GetWindow() != NULL
);
2992 return wxACC_NOT_IMPLEMENTED
;
2995 // Gets a variant representing the selected children
2997 // Acceptable values:
2998 // - a null variant (IsNull() returns true)
2999 // - a list variant (GetType() == wxT("list")
3000 // - an integer representing the selected child element,
3001 // or 0 if this object is selected (GetType() == wxT("long")
3002 // - a "void*" pointer to a wxAccessible child object
3003 wxAccStatus
wxWindowAccessible::GetSelections(wxVariant
* WXUNUSED(selections
))
3005 wxASSERT( GetWindow() != NULL
);
3009 return wxACC_NOT_IMPLEMENTED
;
3012 #endif // wxUSE_ACCESSIBILITY