Don't reset previous window event handler in PopEventHandler().
[wxWidgets.git] / src / common / wincmn.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/wincmn.cpp
3 // Purpose: common (to all ports) wxWindow functions
4 // Author: Julian Smart, Vadim Zeitlin
5 // Modified by:
6 // Created: 13/07/98
7 // RCS-ID: $Id$
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/string.h"
29 #include "wx/log.h"
30 #include "wx/intl.h"
31 #include "wx/frame.h"
32 #include "wx/window.h"
33 #include "wx/control.h"
34 #include "wx/checkbox.h"
35 #include "wx/radiobut.h"
36 #include "wx/statbox.h"
37 #include "wx/textctrl.h"
38 #include "wx/settings.h"
39 #include "wx/dialog.h"
40 #include "wx/msgdlg.h"
41 #include "wx/msgout.h"
42 #include "wx/statusbr.h"
43 #include "wx/toolbar.h"
44 #include "wx/dcclient.h"
45 #include "wx/scrolbar.h"
46 #include "wx/layout.h"
47 #include "wx/sizer.h"
48 #include "wx/menu.h"
49 #endif //WX_PRECOMP
50
51 #if wxUSE_DRAG_AND_DROP
52 #include "wx/dnd.h"
53 #endif // wxUSE_DRAG_AND_DROP
54
55 #if wxUSE_ACCESSIBILITY
56 #include "wx/access.h"
57 #endif
58
59 #if wxUSE_HELP
60 #include "wx/cshelp.h"
61 #endif // wxUSE_HELP
62
63 #if wxUSE_TOOLTIPS
64 #include "wx/tooltip.h"
65 #endif // wxUSE_TOOLTIPS
66
67 #if wxUSE_CARET
68 #include "wx/caret.h"
69 #endif // wxUSE_CARET
70
71 #if wxUSE_SYSTEM_OPTIONS
72 #include "wx/sysopt.h"
73 #endif
74
75 #include "wx/platinfo.h"
76 #include "wx/private/window.h"
77
78 #ifdef __WINDOWS__
79 #include "wx/msw/wrapwin.h"
80 #endif
81
82 // Windows List
83 WXDLLIMPEXP_DATA_CORE(wxWindowList) wxTopLevelWindows;
84
85 // globals
86 #if wxUSE_MENUS
87 wxMenu *wxCurrentPopupMenu = NULL;
88 #endif // wxUSE_MENUS
89
90 extern WXDLLEXPORT_DATA(const char) wxPanelNameStr[] = "panel";
91
92 // ----------------------------------------------------------------------------
93 // static data
94 // ----------------------------------------------------------------------------
95
96
97 IMPLEMENT_ABSTRACT_CLASS(wxWindowBase, wxEvtHandler)
98
99 // ----------------------------------------------------------------------------
100 // event table
101 // ----------------------------------------------------------------------------
102
103 BEGIN_EVENT_TABLE(wxWindowBase, wxEvtHandler)
104 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged)
105 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog)
106 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick)
107
108 #if wxUSE_HELP
109 EVT_HELP(wxID_ANY, wxWindowBase::OnHelp)
110 #endif // wxUSE_HELP
111
112 EVT_SIZE(wxWindowBase::InternalOnSize)
113 END_EVENT_TABLE()
114
115 // ============================================================================
116 // implementation of the common functionality of the wxWindow class
117 // ============================================================================
118
119 // ----------------------------------------------------------------------------
120 // XTI
121 // ----------------------------------------------------------------------------
122
123 #if wxUSE_EXTENDED_RTTI
124
125 // windows that are created from a parent window during its Create method,
126 // eg. spin controls in a calendar controls must never been streamed out
127 // separately otherwise chaos occurs. Right now easiest is to test for negative ids,
128 // as windows with negative ids never can be recreated anyway
129
130
131 bool wxWindowStreamingCallback( const wxObject *object, wxObjectWriter *,
132 wxObjectWriterCallback *, const wxStringToAnyHashMap & )
133 {
134 const wxWindow * win = wx_dynamic_cast(const wxWindow*, object);
135 if ( win && win->GetId() < 0 )
136 return false;
137 return true;
138 }
139
140 wxIMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxWindow, wxWindowBase, "wx/window.h", \
141 wxWindowStreamingCallback)
142
143 // make wxWindowList known before the property is used
144
145 wxCOLLECTION_TYPE_INFO( wxWindow*, wxWindowList );
146
147 template<> void wxCollectionToVariantArray( wxWindowList const &theList,
148 wxAnyList &value)
149 {
150 wxListCollectionToAnyList<wxWindowList::compatibility_iterator>( theList, value );
151 }
152
153 wxDEFINE_FLAGS( wxWindowStyle )
154
155 wxBEGIN_FLAGS( wxWindowStyle )
156 // new style border flags, we put them first to
157 // use them for streaming out
158
159 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
160 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
161 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
162 wxFLAGS_MEMBER(wxBORDER_RAISED)
163 wxFLAGS_MEMBER(wxBORDER_STATIC)
164 wxFLAGS_MEMBER(wxBORDER_NONE)
165
166 // old style border flags
167 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
168 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
169 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
170 wxFLAGS_MEMBER(wxRAISED_BORDER)
171 wxFLAGS_MEMBER(wxSTATIC_BORDER)
172 wxFLAGS_MEMBER(wxBORDER)
173
174 // standard window styles
175 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
176 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
177 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
178 wxFLAGS_MEMBER(wxWANTS_CHARS)
179 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
180 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
181 wxFLAGS_MEMBER(wxVSCROLL)
182 wxFLAGS_MEMBER(wxHSCROLL)
183
184 wxEND_FLAGS( wxWindowStyle )
185
186 wxBEGIN_PROPERTIES_TABLE(wxWindow)
187 wxEVENT_PROPERTY( Close, wxEVT_CLOSE_WINDOW, wxCloseEvent)
188 wxEVENT_PROPERTY( Create, wxEVT_CREATE, wxWindowCreateEvent )
189 wxEVENT_PROPERTY( Destroy, wxEVT_DESTROY, wxWindowDestroyEvent )
190 // Always constructor Properties first
191
192 wxREADONLY_PROPERTY( Parent,wxWindow*, GetParent, wxEMPTY_PARAMETER_VALUE, \
193 0 /*flags*/, wxT("Helpstring"), wxT("group"))
194 wxPROPERTY( Id,wxWindowID, SetId, GetId, -1 /*wxID_ANY*/, 0 /*flags*/, \
195 wxT("Helpstring"), wxT("group") )
196 wxPROPERTY( Position,wxPoint, SetPosition, GetPosition, wxDefaultPosition, \
197 0 /*flags*/, wxT("Helpstring"), wxT("group")) // pos
198 wxPROPERTY( Size,wxSize, SetSize, GetSize, wxDefaultSize, 0 /*flags*/, \
199 wxT("Helpstring"), wxT("group")) // size
200 wxPROPERTY( WindowStyle, long, SetWindowStyleFlag, GetWindowStyleFlag, \
201 wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // style
202 wxPROPERTY( Name,wxString, SetName, GetName, wxEmptyString, 0 /*flags*/, \
203 wxT("Helpstring"), wxT("group") )
204
205 // Then all relations of the object graph
206
207 wxREADONLY_PROPERTY_COLLECTION( Children, wxWindowList, wxWindowBase*, \
208 GetWindowChildren, wxPROP_OBJECT_GRAPH /*flags*/, \
209 wxT("Helpstring"), wxT("group"))
210
211 // and finally all other properties
212
213 wxPROPERTY( ExtraStyle, long, SetExtraStyle, GetExtraStyle, wxEMPTY_PARAMETER_VALUE, \
214 0 /*flags*/, wxT("Helpstring"), wxT("group")) // extstyle
215 wxPROPERTY( BackgroundColour, wxColour, SetBackgroundColour, GetBackgroundColour, \
216 wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // bg
217 wxPROPERTY( ForegroundColour, wxColour, SetForegroundColour, GetForegroundColour, \
218 wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, wxT("Helpstring"), wxT("group")) // fg
219 wxPROPERTY( Enabled, bool, Enable, IsEnabled, wxAny((bool)true), 0 /*flags*/, \
220 wxT("Helpstring"), wxT("group"))
221 wxPROPERTY( Shown, bool, Show, IsShown, wxAny((bool)true), 0 /*flags*/, \
222 wxT("Helpstring"), wxT("group"))
223
224 #if 0
225 // possible property candidates (not in xrc) or not valid in all subclasses
226 wxPROPERTY( Title,wxString, SetTitle, GetTitle, wxEmptyString )
227 wxPROPERTY( Font, wxFont, SetFont, GetWindowFont , )
228 wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxEmptyString )
229 // MaxHeight, Width, MinHeight, Width
230 // TODO switch label to control and title to toplevels
231
232 wxPROPERTY( ThemeEnabled, bool, SetThemeEnabled, GetThemeEnabled, )
233 //wxPROPERTY( Cursor, wxCursor, SetCursor, GetCursor, )
234 // wxPROPERTY( ToolTip, wxString, SetToolTip, GetToolTipText, )
235 wxPROPERTY( AutoLayout, bool, SetAutoLayout, GetAutoLayout, )
236 #endif
237 wxEND_PROPERTIES_TABLE()
238
239 wxEMPTY_HANDLERS_TABLE(wxWindow)
240
241 wxCONSTRUCTOR_DUMMY(wxWindow)
242
243 #else
244
245 #ifndef __WXUNIVERSAL__
246 IMPLEMENT_DYNAMIC_CLASS(wxWindow, wxWindowBase)
247 #endif
248
249 #endif
250
251 // ----------------------------------------------------------------------------
252 // initialization
253 // ----------------------------------------------------------------------------
254
255 // the default initialization
256 wxWindowBase::wxWindowBase()
257 {
258 // no window yet, no parent nor children
259 m_parent = NULL;
260 m_windowId = wxID_ANY;
261
262 // no constraints on the minimal window size
263 m_minWidth =
264 m_maxWidth = wxDefaultCoord;
265 m_minHeight =
266 m_maxHeight = wxDefaultCoord;
267
268 // invalidiated cache value
269 m_bestSizeCache = wxDefaultSize;
270
271 // window are created enabled and visible by default
272 m_isShown =
273 m_isEnabled = true;
274
275 // the default event handler is just this window
276 m_eventHandler = this;
277
278 #if wxUSE_VALIDATORS
279 // no validator
280 m_windowValidator = NULL;
281 #endif // wxUSE_VALIDATORS
282
283 // the colours/fonts are default for now, so leave m_font,
284 // m_backgroundColour and m_foregroundColour uninitialized and set those
285 m_hasBgCol =
286 m_hasFgCol =
287 m_hasFont = false;
288 m_inheritBgCol =
289 m_inheritFgCol =
290 m_inheritFont = false;
291
292 // no style bits
293 m_exStyle =
294 m_windowStyle = 0;
295
296 m_backgroundStyle = wxBG_STYLE_ERASE;
297
298 #if wxUSE_CONSTRAINTS
299 // no constraints whatsoever
300 m_constraints = NULL;
301 m_constraintsInvolvedIn = NULL;
302 #endif // wxUSE_CONSTRAINTS
303
304 m_windowSizer = NULL;
305 m_containingSizer = NULL;
306 m_autoLayout = false;
307
308 #if wxUSE_DRAG_AND_DROP
309 m_dropTarget = NULL;
310 #endif // wxUSE_DRAG_AND_DROP
311
312 #if wxUSE_TOOLTIPS
313 m_tooltip = NULL;
314 #endif // wxUSE_TOOLTIPS
315
316 #if wxUSE_CARET
317 m_caret = NULL;
318 #endif // wxUSE_CARET
319
320 #if wxUSE_PALETTE
321 m_hasCustomPalette = false;
322 #endif // wxUSE_PALETTE
323
324 #if wxUSE_ACCESSIBILITY
325 m_accessible = NULL;
326 #endif
327
328 m_virtualSize = wxDefaultSize;
329
330 m_scrollHelper = NULL;
331
332 m_windowVariant = wxWINDOW_VARIANT_NORMAL;
333 #if wxUSE_SYSTEM_OPTIONS
334 if ( wxSystemOptions::HasOption(wxWINDOW_DEFAULT_VARIANT) )
335 {
336 m_windowVariant = (wxWindowVariant) wxSystemOptions::GetOptionInt( wxWINDOW_DEFAULT_VARIANT ) ;
337 }
338 #endif
339
340 // Whether we're using the current theme for this window (wxGTK only for now)
341 m_themeEnabled = false;
342
343 // This is set to true by SendDestroyEvent() which should be called by the
344 // most derived class to ensure that the destruction event is sent as soon
345 // as possible to allow its handlers to still see the undestroyed window
346 m_isBeingDeleted = false;
347
348 m_freezeCount = 0;
349 }
350
351 // common part of window creation process
352 bool wxWindowBase::CreateBase(wxWindowBase *parent,
353 wxWindowID id,
354 const wxPoint& WXUNUSED(pos),
355 const wxSize& size,
356 long style,
357 const wxString& name)
358 {
359 // ids are limited to 16 bits under MSW so if you care about portability,
360 // it's not a good idea to use ids out of this range (and negative ids are
361 // reserved for wxWidgets own usage)
362 wxASSERT_MSG( id == wxID_ANY || (id >= 0 && id < 32767) ||
363 (id >= wxID_AUTO_LOWEST && id <= wxID_AUTO_HIGHEST),
364 wxT("invalid id value") );
365
366 // generate a new id if the user doesn't care about it
367 if ( id == wxID_ANY )
368 {
369 m_windowId = NewControlId();
370 }
371 else // valid id specified
372 {
373 m_windowId = id;
374 }
375
376 // don't use SetWindowStyleFlag() here, this function should only be called
377 // to change the flag after creation as it tries to reflect the changes in
378 // flags by updating the window dynamically and we don't need this here
379 m_windowStyle = style;
380
381 // assume the user doesn't want this window to shrink beneath its initial
382 // size, this worked like this in wxWidgets 2.8 and before and generally
383 // often makes sense for child windows (for top level ones it definitely
384 // does not as the user should be able to resize the window)
385 //
386 // note that we can't use IsTopLevel() from ctor
387 if ( size != wxDefaultSize && !wxTopLevelWindows.Find((wxWindow *)this) )
388 SetMinSize(size);
389
390 SetName(name);
391 SetParent(parent);
392
393 return true;
394 }
395
396 bool wxWindowBase::CreateBase(wxWindowBase *parent,
397 wxWindowID id,
398 const wxPoint& pos,
399 const wxSize& size,
400 long style,
401 const wxValidator& wxVALIDATOR_PARAM(validator),
402 const wxString& name)
403 {
404 if ( !CreateBase(parent, id, pos, size, style, name) )
405 return false;
406
407 #if wxUSE_VALIDATORS
408 SetValidator(validator);
409 #endif // wxUSE_VALIDATORS
410
411 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
412 // have it too - like this it's possible to set it only in the top level
413 // dialog/frame and all children will inherit it by defult
414 if ( parent && (parent->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) )
415 {
416 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY);
417 }
418
419 return true;
420 }
421
422 bool wxWindowBase::ToggleWindowStyle(int flag)
423 {
424 wxASSERT_MSG( flag, wxT("flags with 0 value can't be toggled") );
425
426 bool rc;
427 long style = GetWindowStyleFlag();
428 if ( style & flag )
429 {
430 style &= ~flag;
431 rc = false;
432 }
433 else // currently off
434 {
435 style |= flag;
436 rc = true;
437 }
438
439 SetWindowStyleFlag(style);
440
441 return rc;
442 }
443
444 // ----------------------------------------------------------------------------
445 // destruction
446 // ----------------------------------------------------------------------------
447
448 // common clean up
449 wxWindowBase::~wxWindowBase()
450 {
451 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
452
453 // FIXME if these 2 cases result from programming errors in the user code
454 // we should probably assert here instead of silently fixing them
455
456 // Just in case the window has been Closed, but we're then deleting
457 // immediately: don't leave dangling pointers.
458 wxPendingDelete.DeleteObject(this);
459
460 // Just in case we've loaded a top-level window via LoadNativeDialog but
461 // we weren't a dialog class
462 wxTopLevelWindows.DeleteObject((wxWindow*)this);
463
464 // Any additional event handlers should be popped before the window is
465 // deleted as otherwise the last handler will be left with a dangling
466 // pointer to this window result in a difficult to diagnose crash later on.
467 wxASSERT_MSG( GetEventHandler() == this,
468 wxT("any pushed event handlers must have been removed") );
469
470 #if wxUSE_MENUS
471 // The associated popup menu can still be alive, disassociate from it in
472 // this case
473 if ( wxCurrentPopupMenu && wxCurrentPopupMenu->GetInvokingWindow() == this )
474 wxCurrentPopupMenu->SetInvokingWindow(NULL);
475 #endif // wxUSE_MENUS
476
477 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
478
479 // notify the parent about this window destruction
480 if ( m_parent )
481 m_parent->RemoveChild(this);
482
483 #if wxUSE_CARET
484 delete m_caret;
485 #endif // wxUSE_CARET
486
487 #if wxUSE_VALIDATORS
488 delete m_windowValidator;
489 #endif // wxUSE_VALIDATORS
490
491 #if wxUSE_CONSTRAINTS
492 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
493 // at deleted windows as they delete themselves.
494 DeleteRelatedConstraints();
495
496 if ( m_constraints )
497 {
498 // This removes any dangling pointers to this window in other windows'
499 // constraintsInvolvedIn lists.
500 UnsetConstraints(m_constraints);
501 wxDELETE(m_constraints);
502 }
503 #endif // wxUSE_CONSTRAINTS
504
505 if ( m_containingSizer )
506 m_containingSizer->Detach( (wxWindow*)this );
507
508 delete m_windowSizer;
509
510 #if wxUSE_DRAG_AND_DROP
511 delete m_dropTarget;
512 #endif // wxUSE_DRAG_AND_DROP
513
514 #if wxUSE_TOOLTIPS
515 delete m_tooltip;
516 #endif // wxUSE_TOOLTIPS
517
518 #if wxUSE_ACCESSIBILITY
519 delete m_accessible;
520 #endif
521
522 #if wxUSE_HELP
523 // NB: this has to be called unconditionally, because we don't know
524 // whether this window has associated help text or not
525 wxHelpProvider *helpProvider = wxHelpProvider::Get();
526 if ( helpProvider )
527 helpProvider->RemoveHelp(this);
528 #endif
529 }
530
531 bool wxWindowBase::IsBeingDeleted() const
532 {
533 return m_isBeingDeleted ||
534 (!IsTopLevel() && m_parent && m_parent->IsBeingDeleted());
535 }
536
537 void wxWindowBase::SendDestroyEvent()
538 {
539 if ( m_isBeingDeleted )
540 {
541 // we could have been already called from a more derived class dtor,
542 // e.g. ~wxTLW calls us and so does ~wxWindow and the latter call
543 // should be simply ignored
544 return;
545 }
546
547 m_isBeingDeleted = true;
548
549 wxWindowDestroyEvent event;
550 event.SetEventObject(this);
551 event.SetId(GetId());
552 GetEventHandler()->ProcessEvent(event);
553 }
554
555 bool wxWindowBase::Destroy()
556 {
557 // If our handle is invalid, it means that this window has never been
558 // created, either because creating it failed or, more typically, because
559 // this wxWindow object was default-constructed and its Create() method had
560 // never been called. As we didn't send wxWindowCreateEvent in this case
561 // (which is sent after successful creation), don't send the matching
562 // wxWindowDestroyEvent neither.
563 if ( GetHandle() )
564 SendDestroyEvent();
565
566 delete this;
567
568 return true;
569 }
570
571 bool wxWindowBase::Close(bool force)
572 {
573 wxCloseEvent event(wxEVT_CLOSE_WINDOW, m_windowId);
574 event.SetEventObject(this);
575 event.SetCanVeto(!force);
576
577 // return false if window wasn't closed because the application vetoed the
578 // close event
579 return HandleWindowEvent(event) && !event.GetVeto();
580 }
581
582 bool wxWindowBase::DestroyChildren()
583 {
584 wxWindowList::compatibility_iterator node;
585 for ( ;; )
586 {
587 // we iterate until the list becomes empty
588 node = GetChildren().GetFirst();
589 if ( !node )
590 break;
591
592 wxWindow *child = node->GetData();
593
594 // note that we really want to delete it immediately so don't call the
595 // possible overridden Destroy() version which might not delete the
596 // child immediately resulting in problems with our (top level) child
597 // outliving its parent
598 child->wxWindowBase::Destroy();
599
600 wxASSERT_MSG( !GetChildren().Find(child),
601 wxT("child didn't remove itself using RemoveChild()") );
602 }
603
604 return true;
605 }
606
607 // ----------------------------------------------------------------------------
608 // size/position related methods
609 // ----------------------------------------------------------------------------
610
611 // centre the window with respect to its parent in either (or both) directions
612 void wxWindowBase::DoCentre(int dir)
613 {
614 wxCHECK_RET( !(dir & wxCENTRE_ON_SCREEN) && GetParent(),
615 wxT("this method only implements centering child windows") );
616
617 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir));
618 }
619
620 // fits the window around the children
621 void wxWindowBase::Fit()
622 {
623 if ( !GetChildren().empty() )
624 {
625 SetSize(GetBestSize());
626 }
627 //else: do nothing if we have no children
628 }
629
630 // fits virtual size (ie. scrolled area etc.) around children
631 void wxWindowBase::FitInside()
632 {
633 if ( GetChildren().GetCount() > 0 )
634 {
635 SetVirtualSize( GetBestVirtualSize() );
636 }
637 }
638
639 // On Mac, scrollbars are explicitly children.
640 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
641 static bool wxHasRealChildren(const wxWindowBase* win)
642 {
643 int realChildCount = 0;
644
645 for ( wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
646 node;
647 node = node->GetNext() )
648 {
649 wxWindow *win = node->GetData();
650 if ( !win->IsTopLevel() && win->IsShown()
651 #if wxUSE_SCROLLBAR
652 && !win->IsKindOf(CLASSINFO(wxScrollBar))
653 #endif
654 )
655 realChildCount ++;
656 }
657 return (realChildCount > 0);
658 }
659 #endif
660
661 void wxWindowBase::InvalidateBestSize()
662 {
663 m_bestSizeCache = wxDefaultSize;
664
665 // parent's best size calculation may depend on its children's
666 // as long as child window we are in is not top level window itself
667 // (because the TLW size is never resized automatically)
668 // so let's invalidate it as well to be safe:
669 if (m_parent && !IsTopLevel())
670 m_parent->InvalidateBestSize();
671 }
672
673 // return the size best suited for the current window
674 wxSize wxWindowBase::DoGetBestSize() const
675 {
676 wxSize best;
677
678 if ( m_windowSizer )
679 {
680 best = m_windowSizer->GetMinSize();
681 }
682 #if wxUSE_CONSTRAINTS
683 else if ( m_constraints )
684 {
685 wxConstCast(this, wxWindowBase)->SatisfyConstraints();
686
687 // our minimal acceptable size is such that all our windows fit inside
688 int maxX = 0,
689 maxY = 0;
690
691 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
692 node;
693 node = node->GetNext() )
694 {
695 wxLayoutConstraints *c = node->GetData()->GetConstraints();
696 if ( !c )
697 {
698 // it's not normal that we have an unconstrained child, but
699 // what can we do about it?
700 continue;
701 }
702
703 int x = c->right.GetValue(),
704 y = c->bottom.GetValue();
705
706 if ( x > maxX )
707 maxX = x;
708
709 if ( y > maxY )
710 maxY = y;
711
712 // TODO: we must calculate the overlaps somehow, otherwise we
713 // will never return a size bigger than the current one :-(
714 }
715
716 best = wxSize(maxX, maxY);
717 }
718 #endif // wxUSE_CONSTRAINTS
719 else if ( !GetChildren().empty()
720 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
721 && wxHasRealChildren(this)
722 #endif
723 )
724 {
725 // our minimal acceptable size is such that all our visible child
726 // windows fit inside
727 int maxX = 0,
728 maxY = 0;
729
730 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
731 node;
732 node = node->GetNext() )
733 {
734 wxWindow *win = node->GetData();
735 if ( win->IsTopLevel()
736 || !win->IsShown()
737 #if wxUSE_STATUSBAR
738 || wxDynamicCast(win, wxStatusBar)
739 #endif // wxUSE_STATUSBAR
740 )
741 {
742 // dialogs and frames lie in different top level windows -
743 // don't deal with them here; as for the status bars, they
744 // don't lie in the client area at all
745 continue;
746 }
747
748 int wx, wy, ww, wh;
749 win->GetPosition(&wx, &wy);
750
751 // if the window hadn't been positioned yet, assume that it is in
752 // the origin
753 if ( wx == wxDefaultCoord )
754 wx = 0;
755 if ( wy == wxDefaultCoord )
756 wy = 0;
757
758 win->GetSize(&ww, &wh);
759 if ( wx + ww > maxX )
760 maxX = wx + ww;
761 if ( wy + wh > maxY )
762 maxY = wy + wh;
763 }
764
765 best = wxSize(maxX, maxY);
766 }
767 else // ! has children
768 {
769 wxSize size = GetMinSize();
770 if ( !size.IsFullySpecified() )
771 {
772 // if the window doesn't define its best size we assume that it can
773 // be arbitrarily small -- usually this is not the case, of course,
774 // but we have no way to know what the limit is, it should really
775 // override DoGetBestClientSize() itself to tell us
776 size.SetDefaults(wxSize(1, 1));
777 }
778
779 // return as-is, unadjusted by the client size difference.
780 return size;
781 }
782
783 // Add any difference between size and client size
784 wxSize diff = GetSize() - GetClientSize();
785 best.x += wxMax(0, diff.x);
786 best.y += wxMax(0, diff.y);
787
788 return best;
789 }
790
791 // helper of GetWindowBorderSize(): as many ports don't implement support for
792 // wxSYS_BORDER/EDGE_X/Y metrics in their wxSystemSettings, use hard coded
793 // fallbacks in this case
794 static int wxGetMetricOrDefault(wxSystemMetric what, const wxWindowBase* win)
795 {
796 int rc = wxSystemSettings::GetMetric(
797 what, static_cast<wxWindow*>(const_cast<wxWindowBase*>(win)));
798 if ( rc == -1 )
799 {
800 switch ( what )
801 {
802 case wxSYS_BORDER_X:
803 case wxSYS_BORDER_Y:
804 // 2D border is by default 1 pixel wide
805 rc = 1;
806 break;
807
808 case wxSYS_EDGE_X:
809 case wxSYS_EDGE_Y:
810 // 3D borders are by default 2 pixels
811 rc = 2;
812 break;
813
814 default:
815 wxFAIL_MSG( wxT("unexpected wxGetMetricOrDefault() argument") );
816 rc = 0;
817 }
818 }
819
820 return rc;
821 }
822
823 wxSize wxWindowBase::GetWindowBorderSize() const
824 {
825 wxSize size;
826
827 switch ( GetBorder() )
828 {
829 case wxBORDER_NONE:
830 // nothing to do, size is already (0, 0)
831 break;
832
833 case wxBORDER_SIMPLE:
834 case wxBORDER_STATIC:
835 size.x = wxGetMetricOrDefault(wxSYS_BORDER_X, this);
836 size.y = wxGetMetricOrDefault(wxSYS_BORDER_Y, this);
837 break;
838
839 case wxBORDER_SUNKEN:
840 case wxBORDER_RAISED:
841 size.x = wxMax(wxGetMetricOrDefault(wxSYS_EDGE_X, this),
842 wxGetMetricOrDefault(wxSYS_BORDER_X, this));
843 size.y = wxMax(wxGetMetricOrDefault(wxSYS_EDGE_Y, this),
844 wxGetMetricOrDefault(wxSYS_BORDER_Y, this));
845 break;
846
847 case wxBORDER_DOUBLE:
848 size.x = wxGetMetricOrDefault(wxSYS_EDGE_X, this) +
849 wxGetMetricOrDefault(wxSYS_BORDER_X, this);
850 size.y = wxGetMetricOrDefault(wxSYS_EDGE_Y, this) +
851 wxGetMetricOrDefault(wxSYS_BORDER_Y, this);
852 break;
853
854 default:
855 wxFAIL_MSG(wxT("Unknown border style."));
856 break;
857 }
858
859 // we have borders on both sides
860 return size*2;
861 }
862
863 bool
864 wxWindowBase::InformFirstDirection(int direction,
865 int size,
866 int availableOtherDir)
867 {
868 return GetSizer() && GetSizer()->InformFirstDirection(direction,
869 size,
870 availableOtherDir);
871 }
872
873 wxSize wxWindowBase::GetEffectiveMinSize() const
874 {
875 // merge the best size with the min size, giving priority to the min size
876 wxSize min = GetMinSize();
877
878 if (min.x == wxDefaultCoord || min.y == wxDefaultCoord)
879 {
880 wxSize best = GetBestSize();
881 if (min.x == wxDefaultCoord) min.x = best.x;
882 if (min.y == wxDefaultCoord) min.y = best.y;
883 }
884
885 return min;
886 }
887
888 wxSize wxWindowBase::DoGetBorderSize() const
889 {
890 // there is one case in which we can implement it for all ports easily
891 if ( GetBorder() == wxBORDER_NONE )
892 return wxSize(0, 0);
893
894 // otherwise use the difference between the real size and the client size
895 // as a fallback: notice that this is incorrect in general as client size
896 // also doesn't take the scrollbars into account
897 return GetSize() - GetClientSize();
898 }
899
900 wxSize wxWindowBase::GetBestSize() const
901 {
902 if ( !m_windowSizer && m_bestSizeCache.IsFullySpecified() )
903 return m_bestSizeCache;
904
905 // call DoGetBestClientSize() first, if a derived class overrides it wants
906 // it to be used
907 wxSize size = DoGetBestClientSize();
908 if ( size != wxDefaultSize )
909 {
910 size += DoGetBorderSize();
911
912 CacheBestSize(size);
913 return size;
914 }
915
916 return DoGetBestSize();
917 }
918
919 int wxWindowBase::GetBestHeight(int width) const
920 {
921 const int height = DoGetBestClientHeight(width);
922
923 return height == wxDefaultCoord
924 ? GetBestSize().y
925 : height + DoGetBorderSize().y;
926 }
927
928 int wxWindowBase::GetBestWidth(int height) const
929 {
930 const int width = DoGetBestClientWidth(height);
931
932 return width == wxDefaultCoord
933 ? GetBestSize().x
934 : width + DoGetBorderSize().x;
935 }
936
937 void wxWindowBase::SetMinSize(const wxSize& minSize)
938 {
939 m_minWidth = minSize.x;
940 m_minHeight = minSize.y;
941 }
942
943 void wxWindowBase::SetMaxSize(const wxSize& maxSize)
944 {
945 m_maxWidth = maxSize.x;
946 m_maxHeight = maxSize.y;
947 }
948
949 void wxWindowBase::SetInitialSize(const wxSize& size)
950 {
951 // Set the min size to the size passed in. This will usually either be
952 // wxDefaultSize or the size passed to this window's ctor/Create function.
953 SetMinSize(size);
954
955 // Merge the size with the best size if needed
956 wxSize best = GetEffectiveMinSize();
957
958 // If the current size doesn't match then change it
959 if (GetSize() != best)
960 SetSize(best);
961 }
962
963
964 // by default the origin is not shifted
965 wxPoint wxWindowBase::GetClientAreaOrigin() const
966 {
967 return wxPoint(0,0);
968 }
969
970 wxSize wxWindowBase::ClientToWindowSize(const wxSize& size) const
971 {
972 const wxSize diff(GetSize() - GetClientSize());
973
974 return wxSize(size.x == -1 ? -1 : size.x + diff.x,
975 size.y == -1 ? -1 : size.y + diff.y);
976 }
977
978 wxSize wxWindowBase::WindowToClientSize(const wxSize& size) const
979 {
980 const wxSize diff(GetSize() - GetClientSize());
981
982 return wxSize(size.x == -1 ? -1 : size.x - diff.x,
983 size.y == -1 ? -1 : size.y - diff.y);
984 }
985
986 void wxWindowBase::SetWindowVariant( wxWindowVariant variant )
987 {
988 if ( m_windowVariant != variant )
989 {
990 m_windowVariant = variant;
991
992 DoSetWindowVariant(variant);
993 }
994 }
995
996 void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant )
997 {
998 // adjust the font height to correspond to our new variant (notice that
999 // we're only called if something really changed)
1000 wxFont font = GetFont();
1001 int size = font.GetPointSize();
1002 switch ( variant )
1003 {
1004 case wxWINDOW_VARIANT_NORMAL:
1005 break;
1006
1007 case wxWINDOW_VARIANT_SMALL:
1008 size = wxRound(size * 3.0 / 4.0);
1009 break;
1010
1011 case wxWINDOW_VARIANT_MINI:
1012 size = wxRound(size * 2.0 / 3.0);
1013 break;
1014
1015 case wxWINDOW_VARIANT_LARGE:
1016 size = wxRound(size * 5.0 / 4.0);
1017 break;
1018
1019 default:
1020 wxFAIL_MSG(wxT("unexpected window variant"));
1021 break;
1022 }
1023
1024 font.SetPointSize(size);
1025 SetFont(font);
1026 }
1027
1028 void wxWindowBase::DoSetSizeHints( int minW, int minH,
1029 int maxW, int maxH,
1030 int WXUNUSED(incW), int WXUNUSED(incH) )
1031 {
1032 wxCHECK_RET( (minW == wxDefaultCoord || maxW == wxDefaultCoord || minW <= maxW) &&
1033 (minH == wxDefaultCoord || maxH == wxDefaultCoord || minH <= maxH),
1034 wxT("min width/height must be less than max width/height!") );
1035
1036 m_minWidth = minW;
1037 m_maxWidth = maxW;
1038 m_minHeight = minH;
1039 m_maxHeight = maxH;
1040 }
1041
1042
1043 #if WXWIN_COMPATIBILITY_2_8
1044 void wxWindowBase::SetVirtualSizeHints(int WXUNUSED(minW), int WXUNUSED(minH),
1045 int WXUNUSED(maxW), int WXUNUSED(maxH))
1046 {
1047 }
1048
1049 void wxWindowBase::SetVirtualSizeHints(const wxSize& WXUNUSED(minsize),
1050 const wxSize& WXUNUSED(maxsize))
1051 {
1052 }
1053 #endif // WXWIN_COMPATIBILITY_2_8
1054
1055 void wxWindowBase::DoSetVirtualSize( int x, int y )
1056 {
1057 m_virtualSize = wxSize(x, y);
1058 }
1059
1060 wxSize wxWindowBase::DoGetVirtualSize() const
1061 {
1062 // we should use the entire client area so if it is greater than our
1063 // virtual size, expand it to fit (otherwise if the window is big enough we
1064 // wouldn't be using parts of it)
1065 wxSize size = GetClientSize();
1066 if ( m_virtualSize.x > size.x )
1067 size.x = m_virtualSize.x;
1068
1069 if ( m_virtualSize.y >= size.y )
1070 size.y = m_virtualSize.y;
1071
1072 return size;
1073 }
1074
1075 void wxWindowBase::DoGetScreenPosition(int *x, int *y) const
1076 {
1077 // screen position is the same as (0, 0) in client coords for non TLWs (and
1078 // TLWs override this method)
1079 if ( x )
1080 *x = 0;
1081 if ( y )
1082 *y = 0;
1083
1084 ClientToScreen(x, y);
1085 }
1086
1087 void wxWindowBase::SendSizeEvent(int flags)
1088 {
1089 wxSizeEvent event(GetSize(), GetId());
1090 event.SetEventObject(this);
1091 if ( flags & wxSEND_EVENT_POST )
1092 wxPostEvent(GetEventHandler(), event);
1093 else
1094 HandleWindowEvent(event);
1095 }
1096
1097 void wxWindowBase::SendSizeEventToParent(int flags)
1098 {
1099 wxWindow * const parent = GetParent();
1100 if ( parent && !parent->IsBeingDeleted() )
1101 parent->SendSizeEvent(flags);
1102 }
1103
1104 bool wxWindowBase::HasScrollbar(int orient) const
1105 {
1106 // if scrolling in the given direction is disabled, we can't have the
1107 // corresponding scrollbar no matter what
1108 if ( !CanScroll(orient) )
1109 return false;
1110
1111 const wxSize sizeVirt = GetVirtualSize();
1112 const wxSize sizeClient = GetClientSize();
1113
1114 return orient == wxHORIZONTAL ? sizeVirt.x > sizeClient.x
1115 : sizeVirt.y > sizeClient.y;
1116 }
1117
1118 // ----------------------------------------------------------------------------
1119 // show/hide/enable/disable the window
1120 // ----------------------------------------------------------------------------
1121
1122 bool wxWindowBase::Show(bool show)
1123 {
1124 if ( show != m_isShown )
1125 {
1126 m_isShown = show;
1127
1128 return true;
1129 }
1130 else
1131 {
1132 return false;
1133 }
1134 }
1135
1136 bool wxWindowBase::IsEnabled() const
1137 {
1138 return IsThisEnabled() && (IsTopLevel() || !GetParent() || GetParent()->IsEnabled());
1139 }
1140
1141 void wxWindowBase::NotifyWindowOnEnableChange(bool enabled)
1142 {
1143 // Under some platforms there is no need to update the window state
1144 // explicitly, it will become disabled when its parent is. On other ones we
1145 // do need to disable all windows recursively though.
1146 #ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
1147 DoEnable(enabled);
1148 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1149
1150 OnEnabled(enabled);
1151
1152 // Disabling a top level window is typically done when showing a modal
1153 // dialog and we don't need to disable its children in this case, they will
1154 // be logically disabled anyhow (i.e. their IsEnabled() will return false)
1155 // and the TLW won't accept any input for them. Moreover, explicitly
1156 // disabling them would look ugly as the entire TLW would be greyed out
1157 // whenever a modal dialog is shown and no native applications under any
1158 // platform behave like this.
1159 if ( IsTopLevel() && !enabled )
1160 return;
1161
1162 // When disabling (or enabling back) a non-TLW window we need to
1163 // recursively propagate the change of the state to its children, otherwise
1164 // they would still show as enabled even though they wouldn't actually
1165 // accept any input (at least under MSW where children don't accept input
1166 // if any of the windows in their parent chain is enabled).
1167 //
1168 // Notice that we must do this even for wxHAS_NATIVE_ENABLED_MANAGEMENT
1169 // platforms as we still need to call the children OnEnabled() recursively.
1170 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1171 node;
1172 node = node->GetNext() )
1173 {
1174 wxWindowBase * const child = node->GetData();
1175 if ( !child->IsTopLevel() && child->IsThisEnabled() )
1176 child->NotifyWindowOnEnableChange(enabled);
1177 }
1178 }
1179
1180 bool wxWindowBase::Enable(bool enable)
1181 {
1182 if ( enable == IsThisEnabled() )
1183 return false;
1184
1185 m_isEnabled = enable;
1186
1187 // If we call DoEnable() from NotifyWindowOnEnableChange(), we don't need
1188 // to do it from here.
1189 #ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
1190 DoEnable(enable);
1191 #endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1192
1193 NotifyWindowOnEnableChange(enable);
1194
1195 return true;
1196 }
1197
1198 bool wxWindowBase::IsShownOnScreen() const
1199 {
1200 // A window is shown on screen if it itself is shown and so are all its
1201 // parents. But if a window is toplevel one, then its always visible on
1202 // screen if IsShown() returns true, even if it has a hidden parent.
1203 return IsShown() &&
1204 (IsTopLevel() || GetParent() == NULL || GetParent()->IsShownOnScreen());
1205 }
1206
1207 // ----------------------------------------------------------------------------
1208 // RTTI
1209 // ----------------------------------------------------------------------------
1210
1211 bool wxWindowBase::IsTopLevel() const
1212 {
1213 return false;
1214 }
1215
1216 // ----------------------------------------------------------------------------
1217 // Freeze/Thaw
1218 // ----------------------------------------------------------------------------
1219
1220 void wxWindowBase::Freeze()
1221 {
1222 if ( !m_freezeCount++ )
1223 {
1224 // physically freeze this window:
1225 DoFreeze();
1226
1227 // and recursively freeze all children:
1228 for ( wxWindowList::iterator i = GetChildren().begin();
1229 i != GetChildren().end(); ++i )
1230 {
1231 wxWindow *child = *i;
1232 if ( child->IsTopLevel() )
1233 continue;
1234
1235 child->Freeze();
1236 }
1237 }
1238 }
1239
1240 void wxWindowBase::Thaw()
1241 {
1242 wxASSERT_MSG( m_freezeCount, "Thaw() without matching Freeze()" );
1243
1244 if ( !--m_freezeCount )
1245 {
1246 // recursively thaw all children:
1247 for ( wxWindowList::iterator i = GetChildren().begin();
1248 i != GetChildren().end(); ++i )
1249 {
1250 wxWindow *child = *i;
1251 if ( child->IsTopLevel() )
1252 continue;
1253
1254 child->Thaw();
1255 }
1256
1257 // physically thaw this window:
1258 DoThaw();
1259 }
1260 }
1261
1262 // ----------------------------------------------------------------------------
1263 // Dealing with parents and children.
1264 // ----------------------------------------------------------------------------
1265
1266 bool wxWindowBase::IsDescendant(wxWindowBase* win) const
1267 {
1268 // Iterate until we find this window in the parent chain or exhaust it.
1269 while ( win )
1270 {
1271 wxWindow* const parent = win->GetParent();
1272 if ( parent == this )
1273 return true;
1274
1275 // Stop iterating on reaching the top level window boundary.
1276 if ( parent->IsTopLevel() )
1277 break;
1278
1279 win = parent;
1280 }
1281
1282 return false;
1283 }
1284
1285 void wxWindowBase::AddChild(wxWindowBase *child)
1286 {
1287 wxCHECK_RET( child, wxT("can't add a NULL child") );
1288
1289 // this should never happen and it will lead to a crash later if it does
1290 // because RemoveChild() will remove only one node from the children list
1291 // and the other(s) one(s) will be left with dangling pointers in them
1292 wxASSERT_MSG( !GetChildren().Find((wxWindow*)child), wxT("AddChild() called twice") );
1293
1294 GetChildren().Append((wxWindow*)child);
1295 child->SetParent(this);
1296
1297 // adding a child while frozen will assert when thawed, so freeze it as if
1298 // it had been already present when we were frozen
1299 if ( IsFrozen() && !child->IsTopLevel() )
1300 child->Freeze();
1301 }
1302
1303 void wxWindowBase::RemoveChild(wxWindowBase *child)
1304 {
1305 wxCHECK_RET( child, wxT("can't remove a NULL child") );
1306
1307 // removing a child while frozen may result in permanently frozen window
1308 // if used e.g. from Reparent(), so thaw it
1309 //
1310 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1311 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1312 if ( IsFrozen() && !child->IsBeingDeleted() && !child->IsTopLevel() )
1313 child->Thaw();
1314
1315 GetChildren().DeleteObject((wxWindow *)child);
1316 child->SetParent(NULL);
1317 }
1318
1319 bool wxWindowBase::Reparent(wxWindowBase *newParent)
1320 {
1321 wxWindow *oldParent = GetParent();
1322 if ( newParent == oldParent )
1323 {
1324 // nothing done
1325 return false;
1326 }
1327
1328 const bool oldEnabledState = IsEnabled();
1329
1330 // unlink this window from the existing parent.
1331 if ( oldParent )
1332 {
1333 oldParent->RemoveChild(this);
1334 }
1335 else
1336 {
1337 wxTopLevelWindows.DeleteObject((wxWindow *)this);
1338 }
1339
1340 // add it to the new one
1341 if ( newParent )
1342 {
1343 newParent->AddChild(this);
1344 }
1345 else
1346 {
1347 wxTopLevelWindows.Append((wxWindow *)this);
1348 }
1349
1350 // We need to notify window (and its subwindows) if by changing the parent
1351 // we also change our enabled/disabled status.
1352 const bool newEnabledState = IsEnabled();
1353 if ( newEnabledState != oldEnabledState )
1354 {
1355 NotifyWindowOnEnableChange(newEnabledState);
1356 }
1357
1358 return true;
1359 }
1360
1361 // ----------------------------------------------------------------------------
1362 // event handler stuff
1363 // ----------------------------------------------------------------------------
1364
1365 void wxWindowBase::SetEventHandler(wxEvtHandler *handler)
1366 {
1367 wxCHECK_RET(handler != NULL, "SetEventHandler(NULL) called");
1368
1369 m_eventHandler = handler;
1370 }
1371
1372 void wxWindowBase::SetNextHandler(wxEvtHandler *WXUNUSED(handler))
1373 {
1374 // disable wxEvtHandler chain mechanism for wxWindows:
1375 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1376
1377 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1378 }
1379 void wxWindowBase::SetPreviousHandler(wxEvtHandler *WXUNUSED(handler))
1380 {
1381 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1382 // handler of our stack when is destroyed will be Unlink()ed and thus
1383 // will call this function to update the pointer of this window...
1384
1385 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1386 }
1387
1388 void wxWindowBase::PushEventHandler(wxEvtHandler *handlerToPush)
1389 {
1390 wxCHECK_RET( handlerToPush != NULL, "PushEventHandler(NULL) called" );
1391
1392 // the new handler is going to be part of the wxWindow stack of event handlers:
1393 // it can't be part also of an event handler double-linked chain:
1394 wxASSERT_MSG(handlerToPush->IsUnlinked(),
1395 "The handler being pushed in the wxWindow stack shouldn't be part of "
1396 "a wxEvtHandler chain; call Unlink() on it first");
1397
1398 wxEvtHandler *handlerOld = GetEventHandler();
1399 wxCHECK_RET( handlerOld, "an old event handler is NULL?" );
1400
1401 // now use wxEvtHandler double-linked list to implement a stack:
1402 handlerToPush->SetNextHandler(handlerOld);
1403
1404 if (handlerOld != this)
1405 handlerOld->SetPreviousHandler(handlerToPush);
1406
1407 SetEventHandler(handlerToPush);
1408
1409 #if wxDEBUG_LEVEL
1410 // final checks of the operations done above:
1411 wxASSERT_MSG( handlerToPush->GetPreviousHandler() == NULL,
1412 "the first handler of the wxWindow stack should "
1413 "have no previous handlers set" );
1414 wxASSERT_MSG( handlerToPush->GetNextHandler() != NULL,
1415 "the first handler of the wxWindow stack should "
1416 "have non-NULL next handler" );
1417
1418 wxEvtHandler* pLast = handlerToPush;
1419 while ( pLast && pLast != this )
1420 pLast = pLast->GetNextHandler();
1421 wxASSERT_MSG( pLast->GetNextHandler() == NULL,
1422 "the last handler of the wxWindow stack should "
1423 "have this window as next handler" );
1424 #endif // wxDEBUG_LEVEL
1425 }
1426
1427 wxEvtHandler *wxWindowBase::PopEventHandler(bool deleteHandler)
1428 {
1429 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
1430
1431 wxEvtHandler *firstHandler = GetEventHandler();
1432 wxCHECK_MSG( firstHandler != NULL, NULL, "wxWindow cannot have a NULL event handler" );
1433 wxCHECK_MSG( firstHandler != this, NULL, "cannot pop the wxWindow itself" );
1434 wxCHECK_MSG( firstHandler->GetPreviousHandler() == NULL, NULL,
1435 "the first handler of the wxWindow stack should have no previous handlers set" );
1436
1437 wxEvtHandler *secondHandler = firstHandler->GetNextHandler();
1438 wxCHECK_MSG( secondHandler != NULL, NULL,
1439 "the first handler of the wxWindow stack should have non-NULL next handler" );
1440
1441 firstHandler->SetNextHandler(NULL);
1442
1443 // It is harmless but useless to unset the previous handler of the window
1444 // itself as it's always NULL anyhow, so don't do this.
1445 if ( secondHandler != this )
1446 secondHandler->SetPreviousHandler(NULL);
1447
1448 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1449 SetEventHandler(secondHandler);
1450
1451 if ( deleteHandler )
1452 {
1453 wxDELETE(firstHandler);
1454 }
1455
1456 return firstHandler;
1457 }
1458
1459 bool wxWindowBase::RemoveEventHandler(wxEvtHandler *handlerToRemove)
1460 {
1461 wxCHECK_MSG( handlerToRemove != NULL, false, "RemoveEventHandler(NULL) called" );
1462 wxCHECK_MSG( handlerToRemove != this, false, "Cannot remove the window itself" );
1463
1464 if (handlerToRemove == GetEventHandler())
1465 {
1466 // removing the first event handler is equivalent to "popping" the stack
1467 PopEventHandler(false);
1468 return true;
1469 }
1470
1471 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1472 wxEvtHandler *handlerCur = GetEventHandler()->GetNextHandler();
1473 while ( handlerCur != this && handlerCur )
1474 {
1475 wxEvtHandler *handlerNext = handlerCur->GetNextHandler();
1476
1477 if ( handlerCur == handlerToRemove )
1478 {
1479 handlerCur->Unlink();
1480
1481 wxASSERT_MSG( handlerCur != GetEventHandler(),
1482 "the case Remove == Pop should was already handled" );
1483 return true;
1484 }
1485
1486 handlerCur = handlerNext;
1487 }
1488
1489 wxFAIL_MSG( wxT("where has the event handler gone?") );
1490
1491 return false;
1492 }
1493
1494 bool wxWindowBase::HandleWindowEvent(wxEvent& event) const
1495 {
1496 // SafelyProcessEvent() will handle exceptions nicely
1497 return GetEventHandler()->SafelyProcessEvent(event);
1498 }
1499
1500 // ----------------------------------------------------------------------------
1501 // colours, fonts &c
1502 // ----------------------------------------------------------------------------
1503
1504 void wxWindowBase::InheritAttributes()
1505 {
1506 const wxWindowBase * const parent = GetParent();
1507 if ( !parent )
1508 return;
1509
1510 // we only inherit attributes which had been explicitly set for the parent
1511 // which ensures that this only happens if the user really wants it and
1512 // not by default which wouldn't make any sense in modern GUIs where the
1513 // controls don't all use the same fonts (nor colours)
1514 if ( parent->m_inheritFont && !m_hasFont )
1515 SetFont(parent->GetFont());
1516
1517 // in addition, there is a possibility to explicitly forbid inheriting
1518 // colours at each class level by overriding ShouldInheritColours()
1519 if ( ShouldInheritColours() )
1520 {
1521 if ( parent->m_inheritFgCol && !m_hasFgCol )
1522 SetForegroundColour(parent->GetForegroundColour());
1523
1524 // inheriting (solid) background colour is wrong as it totally breaks
1525 // any kind of themed backgrounds
1526 //
1527 // instead, the controls should use the same background as their parent
1528 // (ideally by not drawing it at all)
1529 #if 0
1530 if ( parent->m_inheritBgCol && !m_hasBgCol )
1531 SetBackgroundColour(parent->GetBackgroundColour());
1532 #endif // 0
1533 }
1534 }
1535
1536 /* static */ wxVisualAttributes
1537 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1538 {
1539 // it is important to return valid values for all attributes from here,
1540 // GetXXX() below rely on this
1541 wxVisualAttributes attrs;
1542 attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
1543 attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
1544
1545 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1546 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1547 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1548 // colour on other platforms.
1549
1550 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1551 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
1552 #else
1553 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
1554 #endif
1555 return attrs;
1556 }
1557
1558 wxColour wxWindowBase::GetBackgroundColour() const
1559 {
1560 if ( !m_backgroundColour.IsOk() )
1561 {
1562 wxASSERT_MSG( !m_hasBgCol, wxT("we have invalid explicit bg colour?") );
1563
1564 // get our default background colour
1565 wxColour colBg = GetDefaultAttributes().colBg;
1566
1567 // we must return some valid colour to avoid redoing this every time
1568 // and also to avoid surprising the applications written for older
1569 // wxWidgets versions where GetBackgroundColour() always returned
1570 // something -- so give them something even if it doesn't make sense
1571 // for this window (e.g. it has a themed background)
1572 if ( !colBg.IsOk() )
1573 colBg = GetClassDefaultAttributes().colBg;
1574
1575 return colBg;
1576 }
1577 else
1578 return m_backgroundColour;
1579 }
1580
1581 wxColour wxWindowBase::GetForegroundColour() const
1582 {
1583 // logic is the same as above
1584 if ( !m_hasFgCol && !m_foregroundColour.IsOk() )
1585 {
1586 wxColour colFg = GetDefaultAttributes().colFg;
1587
1588 if ( !colFg.IsOk() )
1589 colFg = GetClassDefaultAttributes().colFg;
1590
1591 return colFg;
1592 }
1593 else
1594 return m_foregroundColour;
1595 }
1596
1597 bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style)
1598 {
1599 // The checks below shouldn't be triggered if we're not really changing the
1600 // style.
1601 if ( style == m_backgroundStyle )
1602 return true;
1603
1604 // Transparent background style can be only set before creation because of
1605 // wxGTK limitation.
1606 wxCHECK_MSG( (style != wxBG_STYLE_TRANSPARENT) || !GetHandle(),
1607 false,
1608 "wxBG_STYLE_TRANSPARENT style can only be set before "
1609 "Create()-ing the window." );
1610
1611 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1612 wxCHECK_MSG( (m_backgroundStyle != wxBG_STYLE_TRANSPARENT) ||
1613 (style == wxBG_STYLE_TRANSPARENT),
1614 false,
1615 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1616
1617 m_backgroundStyle = style;
1618
1619 return true;
1620 }
1621
1622 bool wxWindowBase::IsTransparentBackgroundSupported(wxString *reason) const
1623 {
1624 if ( reason )
1625 *reason = _("This platform does not support background transparency.");
1626
1627 return false;
1628 }
1629
1630 bool wxWindowBase::SetBackgroundColour( const wxColour &colour )
1631 {
1632 if ( colour == m_backgroundColour )
1633 return false;
1634
1635 m_hasBgCol = colour.IsOk();
1636
1637 m_inheritBgCol = m_hasBgCol;
1638 m_backgroundColour = colour;
1639 SetThemeEnabled( !m_hasBgCol && !m_foregroundColour.IsOk() );
1640 return true;
1641 }
1642
1643 bool wxWindowBase::SetForegroundColour( const wxColour &colour )
1644 {
1645 if (colour == m_foregroundColour )
1646 return false;
1647
1648 m_hasFgCol = colour.IsOk();
1649 m_inheritFgCol = m_hasFgCol;
1650 m_foregroundColour = colour;
1651 SetThemeEnabled( !m_hasFgCol && !m_backgroundColour.IsOk() );
1652 return true;
1653 }
1654
1655 bool wxWindowBase::SetCursor(const wxCursor& cursor)
1656 {
1657 // setting an invalid cursor is ok, it means that we don't have any special
1658 // cursor
1659 if ( m_cursor.IsSameAs(cursor) )
1660 {
1661 // no change
1662 return false;
1663 }
1664
1665 m_cursor = cursor;
1666
1667 return true;
1668 }
1669
1670 wxFont wxWindowBase::GetFont() const
1671 {
1672 // logic is the same as in GetBackgroundColour()
1673 if ( !m_font.IsOk() )
1674 {
1675 wxASSERT_MSG( !m_hasFont, wxT("we have invalid explicit font?") );
1676
1677 wxFont font = GetDefaultAttributes().font;
1678 if ( !font.IsOk() )
1679 font = GetClassDefaultAttributes().font;
1680
1681 return font;
1682 }
1683 else
1684 return m_font;
1685 }
1686
1687 bool wxWindowBase::SetFont(const wxFont& font)
1688 {
1689 if ( font == m_font )
1690 {
1691 // no change
1692 return false;
1693 }
1694
1695 m_font = font;
1696 m_hasFont = font.IsOk();
1697 m_inheritFont = m_hasFont;
1698
1699 InvalidateBestSize();
1700
1701 return true;
1702 }
1703
1704 #if wxUSE_PALETTE
1705
1706 void wxWindowBase::SetPalette(const wxPalette& pal)
1707 {
1708 m_hasCustomPalette = true;
1709 m_palette = pal;
1710
1711 // VZ: can anyone explain me what do we do here?
1712 wxWindowDC d((wxWindow *) this);
1713 d.SetPalette(pal);
1714 }
1715
1716 wxWindow *wxWindowBase::GetAncestorWithCustomPalette() const
1717 {
1718 wxWindow *win = (wxWindow *)this;
1719 while ( win && !win->HasCustomPalette() )
1720 {
1721 win = win->GetParent();
1722 }
1723
1724 return win;
1725 }
1726
1727 #endif // wxUSE_PALETTE
1728
1729 #if wxUSE_CARET
1730 void wxWindowBase::SetCaret(wxCaret *caret)
1731 {
1732 if ( m_caret )
1733 {
1734 delete m_caret;
1735 }
1736
1737 m_caret = caret;
1738
1739 if ( m_caret )
1740 {
1741 wxASSERT_MSG( m_caret->GetWindow() == this,
1742 wxT("caret should be created associated to this window") );
1743 }
1744 }
1745 #endif // wxUSE_CARET
1746
1747 #if wxUSE_VALIDATORS
1748 // ----------------------------------------------------------------------------
1749 // validators
1750 // ----------------------------------------------------------------------------
1751
1752 void wxWindowBase::SetValidator(const wxValidator& validator)
1753 {
1754 if ( m_windowValidator )
1755 delete m_windowValidator;
1756
1757 m_windowValidator = (wxValidator *)validator.Clone();
1758
1759 if ( m_windowValidator )
1760 m_windowValidator->SetWindow(this);
1761 }
1762 #endif // wxUSE_VALIDATORS
1763
1764 // ----------------------------------------------------------------------------
1765 // update region stuff
1766 // ----------------------------------------------------------------------------
1767
1768 wxRect wxWindowBase::GetUpdateClientRect() const
1769 {
1770 wxRegion rgnUpdate = GetUpdateRegion();
1771 rgnUpdate.Intersect(GetClientRect());
1772 wxRect rectUpdate = rgnUpdate.GetBox();
1773 wxPoint ptOrigin = GetClientAreaOrigin();
1774 rectUpdate.x -= ptOrigin.x;
1775 rectUpdate.y -= ptOrigin.y;
1776
1777 return rectUpdate;
1778 }
1779
1780 bool wxWindowBase::DoIsExposed(int x, int y) const
1781 {
1782 return m_updateRegion.Contains(x, y) != wxOutRegion;
1783 }
1784
1785 bool wxWindowBase::DoIsExposed(int x, int y, int w, int h) const
1786 {
1787 return m_updateRegion.Contains(x, y, w, h) != wxOutRegion;
1788 }
1789
1790 void wxWindowBase::ClearBackground()
1791 {
1792 // wxGTK uses its own version, no need to add never used code
1793 #ifndef __WXGTK__
1794 wxClientDC dc((wxWindow *)this);
1795 wxBrush brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID);
1796 dc.SetBackground(brush);
1797 dc.Clear();
1798 #endif // __WXGTK__
1799 }
1800
1801 // ----------------------------------------------------------------------------
1802 // find child window by id or name
1803 // ----------------------------------------------------------------------------
1804
1805 wxWindow *wxWindowBase::FindWindow(long id) const
1806 {
1807 if ( id == m_windowId )
1808 return (wxWindow *)this;
1809
1810 wxWindowBase *res = NULL;
1811 wxWindowList::compatibility_iterator node;
1812 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1813 {
1814 wxWindowBase *child = node->GetData();
1815 res = child->FindWindow( id );
1816 }
1817
1818 return (wxWindow *)res;
1819 }
1820
1821 wxWindow *wxWindowBase::FindWindow(const wxString& name) const
1822 {
1823 if ( name == m_windowName )
1824 return (wxWindow *)this;
1825
1826 wxWindowBase *res = NULL;
1827 wxWindowList::compatibility_iterator node;
1828 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1829 {
1830 wxWindow *child = node->GetData();
1831 res = child->FindWindow(name);
1832 }
1833
1834 return (wxWindow *)res;
1835 }
1836
1837
1838 // find any window by id or name or label: If parent is non-NULL, look through
1839 // children for a label or title matching the specified string. If NULL, look
1840 // through all top-level windows.
1841 //
1842 // to avoid duplicating code we reuse the same helper function but with
1843 // different comparators
1844
1845 typedef bool (*wxFindWindowCmp)(const wxWindow *win,
1846 const wxString& label, long id);
1847
1848 static
1849 bool wxFindWindowCmpLabels(const wxWindow *win, const wxString& label,
1850 long WXUNUSED(id))
1851 {
1852 return win->GetLabel() == label;
1853 }
1854
1855 static
1856 bool wxFindWindowCmpNames(const wxWindow *win, const wxString& label,
1857 long WXUNUSED(id))
1858 {
1859 return win->GetName() == label;
1860 }
1861
1862 static
1863 bool wxFindWindowCmpIds(const wxWindow *win, const wxString& WXUNUSED(label),
1864 long id)
1865 {
1866 return win->GetId() == id;
1867 }
1868
1869 // recursive helper for the FindWindowByXXX() functions
1870 static
1871 wxWindow *wxFindWindowRecursively(const wxWindow *parent,
1872 const wxString& label,
1873 long id,
1874 wxFindWindowCmp cmp)
1875 {
1876 if ( parent )
1877 {
1878 // see if this is the one we're looking for
1879 if ( (*cmp)(parent, label, id) )
1880 return (wxWindow *)parent;
1881
1882 // It wasn't, so check all its children
1883 for ( wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
1884 node;
1885 node = node->GetNext() )
1886 {
1887 // recursively check each child
1888 wxWindow *win = (wxWindow *)node->GetData();
1889 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1890 if (retwin)
1891 return retwin;
1892 }
1893 }
1894
1895 // Not found
1896 return NULL;
1897 }
1898
1899 // helper for FindWindowByXXX()
1900 static
1901 wxWindow *wxFindWindowHelper(const wxWindow *parent,
1902 const wxString& label,
1903 long id,
1904 wxFindWindowCmp cmp)
1905 {
1906 if ( parent )
1907 {
1908 // just check parent and all its children
1909 return wxFindWindowRecursively(parent, label, id, cmp);
1910 }
1911
1912 // start at very top of wx's windows
1913 for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1914 node;
1915 node = node->GetNext() )
1916 {
1917 // recursively check each window & its children
1918 wxWindow *win = node->GetData();
1919 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1920 if (retwin)
1921 return retwin;
1922 }
1923
1924 return NULL;
1925 }
1926
1927 /* static */
1928 wxWindow *
1929 wxWindowBase::FindWindowByLabel(const wxString& title, const wxWindow *parent)
1930 {
1931 return wxFindWindowHelper(parent, title, 0, wxFindWindowCmpLabels);
1932 }
1933
1934 /* static */
1935 wxWindow *
1936 wxWindowBase::FindWindowByName(const wxString& title, const wxWindow *parent)
1937 {
1938 wxWindow *win = wxFindWindowHelper(parent, title, 0, wxFindWindowCmpNames);
1939
1940 if ( !win )
1941 {
1942 // fall back to the label
1943 win = FindWindowByLabel(title, parent);
1944 }
1945
1946 return win;
1947 }
1948
1949 /* static */
1950 wxWindow *
1951 wxWindowBase::FindWindowById( long id, const wxWindow* parent )
1952 {
1953 return wxFindWindowHelper(parent, wxEmptyString, id, wxFindWindowCmpIds);
1954 }
1955
1956 // ----------------------------------------------------------------------------
1957 // dialog oriented functions
1958 // ----------------------------------------------------------------------------
1959
1960 #if WXWIN_COMPATIBILITY_2_8
1961 void wxWindowBase::MakeModal(bool modal)
1962 {
1963 // Disable all other windows
1964 if ( IsTopLevel() )
1965 {
1966 wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1967 while (node)
1968 {
1969 wxWindow *win = node->GetData();
1970 if (win != this)
1971 win->Enable(!modal);
1972
1973 node = node->GetNext();
1974 }
1975 }
1976 }
1977 #endif // WXWIN_COMPATIBILITY_2_8
1978
1979 bool wxWindowBase::Validate()
1980 {
1981 #if wxUSE_VALIDATORS
1982 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
1983
1984 wxWindowList::compatibility_iterator node;
1985 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
1986 {
1987 wxWindowBase *child = node->GetData();
1988 wxValidator *validator = child->GetValidator();
1989 if ( validator && !validator->Validate((wxWindow *)this) )
1990 {
1991 return false;
1992 }
1993
1994 if ( recurse && !child->Validate() )
1995 {
1996 return false;
1997 }
1998 }
1999 #endif // wxUSE_VALIDATORS
2000
2001 return true;
2002 }
2003
2004 bool wxWindowBase::TransferDataToWindow()
2005 {
2006 #if wxUSE_VALIDATORS
2007 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
2008
2009 wxWindowList::compatibility_iterator node;
2010 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
2011 {
2012 wxWindowBase *child = node->GetData();
2013 wxValidator *validator = child->GetValidator();
2014 if ( validator && !validator->TransferToWindow() )
2015 {
2016 wxLogWarning(_("Could not transfer data to window"));
2017 #if wxUSE_LOG
2018 wxLog::FlushActive();
2019 #endif // wxUSE_LOG
2020
2021 return false;
2022 }
2023
2024 if ( recurse )
2025 {
2026 if ( !child->TransferDataToWindow() )
2027 {
2028 // warning already given
2029 return false;
2030 }
2031 }
2032 }
2033 #endif // wxUSE_VALIDATORS
2034
2035 return true;
2036 }
2037
2038 bool wxWindowBase::TransferDataFromWindow()
2039 {
2040 #if wxUSE_VALIDATORS
2041 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
2042
2043 wxWindowList::compatibility_iterator node;
2044 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
2045 {
2046 wxWindow *child = node->GetData();
2047 wxValidator *validator = child->GetValidator();
2048 if ( validator && !validator->TransferFromWindow() )
2049 {
2050 // nop warning here because the application is supposed to give
2051 // one itself - we don't know here what might have gone wrongly
2052
2053 return false;
2054 }
2055
2056 if ( recurse )
2057 {
2058 if ( !child->TransferDataFromWindow() )
2059 {
2060 // warning already given
2061 return false;
2062 }
2063 }
2064 }
2065 #endif // wxUSE_VALIDATORS
2066
2067 return true;
2068 }
2069
2070 void wxWindowBase::InitDialog()
2071 {
2072 wxInitDialogEvent event(GetId());
2073 event.SetEventObject( this );
2074 GetEventHandler()->ProcessEvent(event);
2075 }
2076
2077 // ----------------------------------------------------------------------------
2078 // context-sensitive help support
2079 // ----------------------------------------------------------------------------
2080
2081 #if wxUSE_HELP
2082
2083 // associate this help text with this window
2084 void wxWindowBase::SetHelpText(const wxString& text)
2085 {
2086 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2087 if ( helpProvider )
2088 {
2089 helpProvider->AddHelp(this, text);
2090 }
2091 }
2092
2093 #if WXWIN_COMPATIBILITY_2_8
2094 // associate this help text with all windows with the same id as this
2095 // one
2096 void wxWindowBase::SetHelpTextForId(const wxString& text)
2097 {
2098 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2099 if ( helpProvider )
2100 {
2101 helpProvider->AddHelp(GetId(), text);
2102 }
2103 }
2104 #endif // WXWIN_COMPATIBILITY_2_8
2105
2106 // get the help string associated with this window (may be empty)
2107 // default implementation forwards calls to the help provider
2108 wxString
2109 wxWindowBase::GetHelpTextAtPoint(const wxPoint & WXUNUSED(pt),
2110 wxHelpEvent::Origin WXUNUSED(origin)) const
2111 {
2112 wxString text;
2113 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2114 if ( helpProvider )
2115 {
2116 text = helpProvider->GetHelp(this);
2117 }
2118
2119 return text;
2120 }
2121
2122 // show help for this window
2123 void wxWindowBase::OnHelp(wxHelpEvent& event)
2124 {
2125 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2126 if ( helpProvider )
2127 {
2128 wxPoint pos = event.GetPosition();
2129 const wxHelpEvent::Origin origin = event.GetOrigin();
2130 if ( origin == wxHelpEvent::Origin_Keyboard )
2131 {
2132 // if the help event was generated from keyboard it shouldn't
2133 // appear at the mouse position (which is still the only position
2134 // associated with help event) if the mouse is far away, although
2135 // we still do use the mouse position if it's over the window
2136 // because we suppose the user looks approximately at the mouse
2137 // already and so it would be more convenient than showing tooltip
2138 // at some arbitrary position which can be quite far from it
2139 const wxRect rectClient = GetClientRect();
2140 if ( !rectClient.Contains(ScreenToClient(pos)) )
2141 {
2142 // position help slightly under and to the right of this window
2143 pos = ClientToScreen(wxPoint(
2144 2*GetCharWidth(),
2145 rectClient.height + GetCharHeight()
2146 ));
2147 }
2148 }
2149
2150 if ( helpProvider->ShowHelpAtPoint(this, pos, origin) )
2151 {
2152 // skip the event.Skip() below
2153 return;
2154 }
2155 }
2156
2157 event.Skip();
2158 }
2159
2160 #endif // wxUSE_HELP
2161
2162 // ----------------------------------------------------------------------------
2163 // tooltips
2164 // ----------------------------------------------------------------------------
2165
2166 #if wxUSE_TOOLTIPS
2167
2168 wxString wxWindowBase::GetToolTipText() const
2169 {
2170 return m_tooltip ? m_tooltip->GetTip() : wxString();
2171 }
2172
2173 void wxWindowBase::SetToolTip( const wxString &tip )
2174 {
2175 // don't create the new tooltip if we already have one
2176 if ( m_tooltip )
2177 {
2178 m_tooltip->SetTip( tip );
2179 }
2180 else
2181 {
2182 SetToolTip( new wxToolTip( tip ) );
2183 }
2184
2185 // setting empty tooltip text does not remove the tooltip any more - use
2186 // SetToolTip(NULL) for this
2187 }
2188
2189 void wxWindowBase::DoSetToolTip(wxToolTip *tooltip)
2190 {
2191 if ( m_tooltip != tooltip )
2192 {
2193 if ( m_tooltip )
2194 delete m_tooltip;
2195
2196 m_tooltip = tooltip;
2197 }
2198 }
2199
2200 bool wxWindowBase::CopyToolTip(wxToolTip *tip)
2201 {
2202 SetToolTip(tip ? new wxToolTip(tip->GetTip()) : NULL);
2203
2204 return tip != NULL;
2205 }
2206
2207 #endif // wxUSE_TOOLTIPS
2208
2209 // ----------------------------------------------------------------------------
2210 // constraints and sizers
2211 // ----------------------------------------------------------------------------
2212
2213 #if wxUSE_CONSTRAINTS
2214
2215 void wxWindowBase::SetConstraints( wxLayoutConstraints *constraints )
2216 {
2217 if ( m_constraints )
2218 {
2219 UnsetConstraints(m_constraints);
2220 delete m_constraints;
2221 }
2222 m_constraints = constraints;
2223 if ( m_constraints )
2224 {
2225 // Make sure other windows know they're part of a 'meaningful relationship'
2226 if ( m_constraints->left.GetOtherWindow() && (m_constraints->left.GetOtherWindow() != this) )
2227 m_constraints->left.GetOtherWindow()->AddConstraintReference(this);
2228 if ( m_constraints->top.GetOtherWindow() && (m_constraints->top.GetOtherWindow() != this) )
2229 m_constraints->top.GetOtherWindow()->AddConstraintReference(this);
2230 if ( m_constraints->right.GetOtherWindow() && (m_constraints->right.GetOtherWindow() != this) )
2231 m_constraints->right.GetOtherWindow()->AddConstraintReference(this);
2232 if ( m_constraints->bottom.GetOtherWindow() && (m_constraints->bottom.GetOtherWindow() != this) )
2233 m_constraints->bottom.GetOtherWindow()->AddConstraintReference(this);
2234 if ( m_constraints->width.GetOtherWindow() && (m_constraints->width.GetOtherWindow() != this) )
2235 m_constraints->width.GetOtherWindow()->AddConstraintReference(this);
2236 if ( m_constraints->height.GetOtherWindow() && (m_constraints->height.GetOtherWindow() != this) )
2237 m_constraints->height.GetOtherWindow()->AddConstraintReference(this);
2238 if ( m_constraints->centreX.GetOtherWindow() && (m_constraints->centreX.GetOtherWindow() != this) )
2239 m_constraints->centreX.GetOtherWindow()->AddConstraintReference(this);
2240 if ( m_constraints->centreY.GetOtherWindow() && (m_constraints->centreY.GetOtherWindow() != this) )
2241 m_constraints->centreY.GetOtherWindow()->AddConstraintReference(this);
2242 }
2243 }
2244
2245 // This removes any dangling pointers to this window in other windows'
2246 // constraintsInvolvedIn lists.
2247 void wxWindowBase::UnsetConstraints(wxLayoutConstraints *c)
2248 {
2249 if ( c )
2250 {
2251 if ( c->left.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2252 c->left.GetOtherWindow()->RemoveConstraintReference(this);
2253 if ( c->top.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2254 c->top.GetOtherWindow()->RemoveConstraintReference(this);
2255 if ( c->right.GetOtherWindow() && (c->right.GetOtherWindow() != this) )
2256 c->right.GetOtherWindow()->RemoveConstraintReference(this);
2257 if ( c->bottom.GetOtherWindow() && (c->bottom.GetOtherWindow() != this) )
2258 c->bottom.GetOtherWindow()->RemoveConstraintReference(this);
2259 if ( c->width.GetOtherWindow() && (c->width.GetOtherWindow() != this) )
2260 c->width.GetOtherWindow()->RemoveConstraintReference(this);
2261 if ( c->height.GetOtherWindow() && (c->height.GetOtherWindow() != this) )
2262 c->height.GetOtherWindow()->RemoveConstraintReference(this);
2263 if ( c->centreX.GetOtherWindow() && (c->centreX.GetOtherWindow() != this) )
2264 c->centreX.GetOtherWindow()->RemoveConstraintReference(this);
2265 if ( c->centreY.GetOtherWindow() && (c->centreY.GetOtherWindow() != this) )
2266 c->centreY.GetOtherWindow()->RemoveConstraintReference(this);
2267 }
2268 }
2269
2270 // Back-pointer to other windows we're involved with, so if we delete this
2271 // window, we must delete any constraints we're involved with.
2272 void wxWindowBase::AddConstraintReference(wxWindowBase *otherWin)
2273 {
2274 if ( !m_constraintsInvolvedIn )
2275 m_constraintsInvolvedIn = new wxWindowList;
2276 if ( !m_constraintsInvolvedIn->Find((wxWindow *)otherWin) )
2277 m_constraintsInvolvedIn->Append((wxWindow *)otherWin);
2278 }
2279
2280 // REMOVE back-pointer to other windows we're involved with.
2281 void wxWindowBase::RemoveConstraintReference(wxWindowBase *otherWin)
2282 {
2283 if ( m_constraintsInvolvedIn )
2284 m_constraintsInvolvedIn->DeleteObject((wxWindow *)otherWin);
2285 }
2286
2287 // Reset any constraints that mention this window
2288 void wxWindowBase::DeleteRelatedConstraints()
2289 {
2290 if ( m_constraintsInvolvedIn )
2291 {
2292 wxWindowList::compatibility_iterator node = m_constraintsInvolvedIn->GetFirst();
2293 while (node)
2294 {
2295 wxWindow *win = node->GetData();
2296 wxLayoutConstraints *constr = win->GetConstraints();
2297
2298 // Reset any constraints involving this window
2299 if ( constr )
2300 {
2301 constr->left.ResetIfWin(this);
2302 constr->top.ResetIfWin(this);
2303 constr->right.ResetIfWin(this);
2304 constr->bottom.ResetIfWin(this);
2305 constr->width.ResetIfWin(this);
2306 constr->height.ResetIfWin(this);
2307 constr->centreX.ResetIfWin(this);
2308 constr->centreY.ResetIfWin(this);
2309 }
2310
2311 wxWindowList::compatibility_iterator next = node->GetNext();
2312 m_constraintsInvolvedIn->Erase(node);
2313 node = next;
2314 }
2315
2316 wxDELETE(m_constraintsInvolvedIn);
2317 }
2318 }
2319
2320 #endif // wxUSE_CONSTRAINTS
2321
2322 void wxWindowBase::SetSizer(wxSizer *sizer, bool deleteOld)
2323 {
2324 if ( sizer == m_windowSizer)
2325 return;
2326
2327 if ( m_windowSizer )
2328 {
2329 m_windowSizer->SetContainingWindow(NULL);
2330
2331 if ( deleteOld )
2332 delete m_windowSizer;
2333 }
2334
2335 m_windowSizer = sizer;
2336 if ( m_windowSizer )
2337 {
2338 m_windowSizer->SetContainingWindow((wxWindow *)this);
2339 }
2340
2341 SetAutoLayout(m_windowSizer != NULL);
2342 }
2343
2344 void wxWindowBase::SetSizerAndFit(wxSizer *sizer, bool deleteOld)
2345 {
2346 SetSizer( sizer, deleteOld );
2347 sizer->SetSizeHints( (wxWindow*) this );
2348 }
2349
2350
2351 void wxWindowBase::SetContainingSizer(wxSizer* sizer)
2352 {
2353 // adding a window to a sizer twice is going to result in fatal and
2354 // hard to debug problems later because when deleting the second
2355 // associated wxSizerItem we're going to dereference a dangling
2356 // pointer; so try to detect this as early as possible
2357 wxASSERT_MSG( !sizer || m_containingSizer != sizer,
2358 wxT("Adding a window to the same sizer twice?") );
2359
2360 m_containingSizer = sizer;
2361 }
2362
2363 #if wxUSE_CONSTRAINTS
2364
2365 void wxWindowBase::SatisfyConstraints()
2366 {
2367 wxLayoutConstraints *constr = GetConstraints();
2368 bool wasOk = constr && constr->AreSatisfied();
2369
2370 ResetConstraints(); // Mark all constraints as unevaluated
2371
2372 int noChanges = 1;
2373
2374 // if we're a top level panel (i.e. our parent is frame/dialog), our
2375 // own constraints will never be satisfied any more unless we do it
2376 // here
2377 if ( wasOk )
2378 {
2379 while ( noChanges > 0 )
2380 {
2381 LayoutPhase1(&noChanges);
2382 }
2383 }
2384
2385 LayoutPhase2(&noChanges);
2386 }
2387
2388 #endif // wxUSE_CONSTRAINTS
2389
2390 bool wxWindowBase::Layout()
2391 {
2392 // If there is a sizer, use it instead of the constraints
2393 if ( GetSizer() )
2394 {
2395 int w = 0, h = 0;
2396 GetVirtualSize(&w, &h);
2397 GetSizer()->SetDimension( 0, 0, w, h );
2398 }
2399 #if wxUSE_CONSTRAINTS
2400 else
2401 {
2402 SatisfyConstraints(); // Find the right constraints values
2403 SetConstraintSizes(); // Recursively set the real window sizes
2404 }
2405 #endif
2406
2407 return true;
2408 }
2409
2410 void wxWindowBase::InternalOnSize(wxSizeEvent& event)
2411 {
2412 if ( GetAutoLayout() )
2413 Layout();
2414
2415 event.Skip();
2416 }
2417
2418 #if wxUSE_CONSTRAINTS
2419
2420 // first phase of the constraints evaluation: set our own constraints
2421 bool wxWindowBase::LayoutPhase1(int *noChanges)
2422 {
2423 wxLayoutConstraints *constr = GetConstraints();
2424
2425 return !constr || constr->SatisfyConstraints(this, noChanges);
2426 }
2427
2428 // second phase: set the constraints for our children
2429 bool wxWindowBase::LayoutPhase2(int *noChanges)
2430 {
2431 *noChanges = 0;
2432
2433 // Layout children
2434 DoPhase(1);
2435
2436 // Layout grand children
2437 DoPhase(2);
2438
2439 return true;
2440 }
2441
2442 // Do a phase of evaluating child constraints
2443 bool wxWindowBase::DoPhase(int phase)
2444 {
2445 // the list containing the children for which the constraints are already
2446 // set correctly
2447 wxWindowList succeeded;
2448
2449 // the max number of iterations we loop before concluding that we can't set
2450 // the constraints
2451 static const int maxIterations = 500;
2452
2453 for ( int noIterations = 0; noIterations < maxIterations; noIterations++ )
2454 {
2455 int noChanges = 0;
2456
2457 // loop over all children setting their constraints
2458 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2459 node;
2460 node = node->GetNext() )
2461 {
2462 wxWindow *child = node->GetData();
2463 if ( child->IsTopLevel() )
2464 {
2465 // top level children are not inside our client area
2466 continue;
2467 }
2468
2469 if ( !child->GetConstraints() || succeeded.Find(child) )
2470 {
2471 // this one is either already ok or nothing we can do about it
2472 continue;
2473 }
2474
2475 int tempNoChanges = 0;
2476 bool success = phase == 1 ? child->LayoutPhase1(&tempNoChanges)
2477 : child->LayoutPhase2(&tempNoChanges);
2478 noChanges += tempNoChanges;
2479
2480 if ( success )
2481 {
2482 succeeded.Append(child);
2483 }
2484 }
2485
2486 if ( !noChanges )
2487 {
2488 // constraints are set
2489 break;
2490 }
2491 }
2492
2493 return true;
2494 }
2495
2496 void wxWindowBase::ResetConstraints()
2497 {
2498 wxLayoutConstraints *constr = GetConstraints();
2499 if ( constr )
2500 {
2501 constr->left.SetDone(false);
2502 constr->top.SetDone(false);
2503 constr->right.SetDone(false);
2504 constr->bottom.SetDone(false);
2505 constr->width.SetDone(false);
2506 constr->height.SetDone(false);
2507 constr->centreX.SetDone(false);
2508 constr->centreY.SetDone(false);
2509 }
2510
2511 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2512 while (node)
2513 {
2514 wxWindow *win = node->GetData();
2515 if ( !win->IsTopLevel() )
2516 win->ResetConstraints();
2517 node = node->GetNext();
2518 }
2519 }
2520
2521 // Need to distinguish between setting the 'fake' size for windows and sizers,
2522 // and setting the real values.
2523 void wxWindowBase::SetConstraintSizes(bool recurse)
2524 {
2525 wxLayoutConstraints *constr = GetConstraints();
2526 if ( constr && constr->AreSatisfied() )
2527 {
2528 int x = constr->left.GetValue();
2529 int y = constr->top.GetValue();
2530 int w = constr->width.GetValue();
2531 int h = constr->height.GetValue();
2532
2533 if ( (constr->width.GetRelationship() != wxAsIs ) ||
2534 (constr->height.GetRelationship() != wxAsIs) )
2535 {
2536 // We really shouldn't set negative sizes for the windows so make
2537 // them at least of 1*1 size
2538 SetSize(x, y, w > 0 ? w : 1, h > 0 ? h : 1);
2539 }
2540 else
2541 {
2542 // If we don't want to resize this window, just move it...
2543 Move(x, y);
2544 }
2545 }
2546 else if ( constr )
2547 {
2548 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2549 GetClassInfo()->GetClassName(),
2550 GetName().c_str());
2551 }
2552
2553 if ( recurse )
2554 {
2555 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2556 while (node)
2557 {
2558 wxWindow *win = node->GetData();
2559 if ( !win->IsTopLevel() && win->GetConstraints() )
2560 win->SetConstraintSizes();
2561 node = node->GetNext();
2562 }
2563 }
2564 }
2565
2566 // Only set the size/position of the constraint (if any)
2567 void wxWindowBase::SetSizeConstraint(int x, int y, int w, int h)
2568 {
2569 wxLayoutConstraints *constr = GetConstraints();
2570 if ( constr )
2571 {
2572 if ( x != wxDefaultCoord )
2573 {
2574 constr->left.SetValue(x);
2575 constr->left.SetDone(true);
2576 }
2577 if ( y != wxDefaultCoord )
2578 {
2579 constr->top.SetValue(y);
2580 constr->top.SetDone(true);
2581 }
2582 if ( w != wxDefaultCoord )
2583 {
2584 constr->width.SetValue(w);
2585 constr->width.SetDone(true);
2586 }
2587 if ( h != wxDefaultCoord )
2588 {
2589 constr->height.SetValue(h);
2590 constr->height.SetDone(true);
2591 }
2592 }
2593 }
2594
2595 void wxWindowBase::MoveConstraint(int x, int y)
2596 {
2597 wxLayoutConstraints *constr = GetConstraints();
2598 if ( constr )
2599 {
2600 if ( x != wxDefaultCoord )
2601 {
2602 constr->left.SetValue(x);
2603 constr->left.SetDone(true);
2604 }
2605 if ( y != wxDefaultCoord )
2606 {
2607 constr->top.SetValue(y);
2608 constr->top.SetDone(true);
2609 }
2610 }
2611 }
2612
2613 void wxWindowBase::GetSizeConstraint(int *w, int *h) const
2614 {
2615 wxLayoutConstraints *constr = GetConstraints();
2616 if ( constr )
2617 {
2618 *w = constr->width.GetValue();
2619 *h = constr->height.GetValue();
2620 }
2621 else
2622 GetSize(w, h);
2623 }
2624
2625 void wxWindowBase::GetClientSizeConstraint(int *w, int *h) const
2626 {
2627 wxLayoutConstraints *constr = GetConstraints();
2628 if ( constr )
2629 {
2630 *w = constr->width.GetValue();
2631 *h = constr->height.GetValue();
2632 }
2633 else
2634 GetClientSize(w, h);
2635 }
2636
2637 void wxWindowBase::GetPositionConstraint(int *x, int *y) const
2638 {
2639 wxLayoutConstraints *constr = GetConstraints();
2640 if ( constr )
2641 {
2642 *x = constr->left.GetValue();
2643 *y = constr->top.GetValue();
2644 }
2645 else
2646 GetPosition(x, y);
2647 }
2648
2649 #endif // wxUSE_CONSTRAINTS
2650
2651 void wxWindowBase::AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const
2652 {
2653 wxWindow *parent = GetParent();
2654 if ( !(sizeFlags & wxSIZE_NO_ADJUSTMENTS) && parent )
2655 {
2656 wxPoint pt(parent->GetClientAreaOrigin());
2657 x += pt.x;
2658 y += pt.y;
2659 }
2660 }
2661
2662 // ----------------------------------------------------------------------------
2663 // Update UI processing
2664 // ----------------------------------------------------------------------------
2665
2666 void wxWindowBase::UpdateWindowUI(long flags)
2667 {
2668 wxUpdateUIEvent event(GetId());
2669 event.SetEventObject(this);
2670
2671 if ( GetEventHandler()->ProcessEvent(event) )
2672 {
2673 DoUpdateWindowUI(event);
2674 }
2675
2676 if (flags & wxUPDATE_UI_RECURSE)
2677 {
2678 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2679 while (node)
2680 {
2681 wxWindow* child = (wxWindow*) node->GetData();
2682 child->UpdateWindowUI(flags);
2683 node = node->GetNext();
2684 }
2685 }
2686 }
2687
2688 // do the window-specific processing after processing the update event
2689 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
2690 {
2691 if ( event.GetSetEnabled() )
2692 Enable(event.GetEnabled());
2693
2694 if ( event.GetSetShown() )
2695 Show(event.GetShown());
2696 }
2697
2698 // ----------------------------------------------------------------------------
2699 // Idle processing
2700 // ----------------------------------------------------------------------------
2701
2702 // Send idle event to window and all subwindows
2703 bool wxWindowBase::SendIdleEvents(wxIdleEvent& event)
2704 {
2705 bool needMore = false;
2706
2707 OnInternalIdle();
2708
2709 // should we send idle event to this window?
2710 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
2711 HasExtraStyle(wxWS_EX_PROCESS_IDLE))
2712 {
2713 event.SetEventObject(this);
2714 HandleWindowEvent(event);
2715
2716 if (event.MoreRequested())
2717 needMore = true;
2718 }
2719 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2720 for (; node; node = node->GetNext())
2721 {
2722 wxWindow* child = node->GetData();
2723 if (child->SendIdleEvents(event))
2724 needMore = true;
2725 }
2726
2727 return needMore;
2728 }
2729
2730 void wxWindowBase::OnInternalIdle()
2731 {
2732 if ( wxUpdateUIEvent::CanUpdate(this) )
2733 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
2734 }
2735
2736 // ----------------------------------------------------------------------------
2737 // dialog units translations
2738 // ----------------------------------------------------------------------------
2739
2740 // Windows' computes dialog units using average character width over upper-
2741 // and lower-case ASCII alphabet and not using the average character width
2742 // metadata stored in the font; see
2743 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2744 // It's important that we perform the conversion in identical way, because
2745 // dialog units natively exist only on Windows and Windows HIG is expressed
2746 // using them.
2747 wxSize wxWindowBase::GetDlgUnitBase() const
2748 {
2749 const wxWindowBase * const parent = wxGetTopLevelParent((wxWindow*)this);
2750
2751 if ( !parent->m_font.IsOk() )
2752 {
2753 // Default GUI font is used. This is the most common case, so
2754 // cache the results.
2755 static wxSize s_defFontSize;
2756 if ( s_defFontSize.x == 0 )
2757 s_defFontSize = wxPrivate::GetAverageASCIILetterSize(*parent);
2758 return s_defFontSize;
2759 }
2760 else
2761 {
2762 // Custom font, we always need to compute the result
2763 return wxPrivate::GetAverageASCIILetterSize(*parent);
2764 }
2765 }
2766
2767 wxPoint wxWindowBase::ConvertPixelsToDialog(const wxPoint& pt) const
2768 {
2769 const wxSize base = GetDlgUnitBase();
2770
2771 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2772
2773 wxPoint pt2 = wxDefaultPosition;
2774 if (pt.x != wxDefaultCoord)
2775 pt2.x = wxMulDivInt32(pt.x, 4, base.x);
2776 if (pt.y != wxDefaultCoord)
2777 pt2.y = wxMulDivInt32(pt.y, 8, base.y);
2778
2779 return pt2;
2780 }
2781
2782 wxPoint wxWindowBase::ConvertDialogToPixels(const wxPoint& pt) const
2783 {
2784 const wxSize base = GetDlgUnitBase();
2785
2786 wxPoint pt2 = wxDefaultPosition;
2787 if (pt.x != wxDefaultCoord)
2788 pt2.x = wxMulDivInt32(pt.x, base.x, 4);
2789 if (pt.y != wxDefaultCoord)
2790 pt2.y = wxMulDivInt32(pt.y, base.y, 8);
2791
2792 return pt2;
2793 }
2794
2795 // ----------------------------------------------------------------------------
2796 // event handlers
2797 // ----------------------------------------------------------------------------
2798
2799 // propagate the colour change event to the subwindows
2800 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
2801 {
2802 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2803 while ( node )
2804 {
2805 // Only propagate to non-top-level windows
2806 wxWindow *win = node->GetData();
2807 if ( !win->IsTopLevel() )
2808 {
2809 wxSysColourChangedEvent event2;
2810 event2.SetEventObject(win);
2811 win->GetEventHandler()->ProcessEvent(event2);
2812 }
2813
2814 node = node->GetNext();
2815 }
2816
2817 Refresh();
2818 }
2819
2820 // the default action is to populate dialog with data when it's created,
2821 // and nudge the UI into displaying itself correctly in case
2822 // we've turned the wxUpdateUIEvents frequency down low.
2823 void wxWindowBase::OnInitDialog( wxInitDialogEvent &WXUNUSED(event) )
2824 {
2825 TransferDataToWindow();
2826
2827 // Update the UI at this point
2828 UpdateWindowUI(wxUPDATE_UI_RECURSE);
2829 }
2830
2831 // ----------------------------------------------------------------------------
2832 // menu-related functions
2833 // ----------------------------------------------------------------------------
2834
2835 #if wxUSE_MENUS
2836
2837 bool wxWindowBase::PopupMenu(wxMenu *menu, int x, int y)
2838 {
2839 wxCHECK_MSG( menu, false, "can't popup NULL menu" );
2840
2841 wxMenuInvokingWindowSetter
2842 setInvokingWin(*menu, static_cast<wxWindow *>(this));
2843
2844 wxCurrentPopupMenu = menu;
2845 const bool rc = DoPopupMenu(menu, x, y);
2846 wxCurrentPopupMenu = NULL;
2847
2848 return rc;
2849 }
2850
2851 // this is used to pass the id of the selected item from the menu event handler
2852 // to the main function itself
2853 //
2854 // it's ok to use a global here as there can be at most one popup menu shown at
2855 // any time
2856 static int gs_popupMenuSelection = wxID_NONE;
2857
2858 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent& event)
2859 {
2860 // store the id in a global variable where we'll retrieve it from later
2861 gs_popupMenuSelection = event.GetId();
2862 }
2863
2864 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent& WXUNUSED(event))
2865 {
2866 // nothing to do but do not skip it
2867 }
2868
2869 int
2870 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y)
2871 {
2872 gs_popupMenuSelection = wxID_NONE;
2873
2874 Connect(wxEVT_COMMAND_MENU_SELECTED,
2875 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2876 NULL,
2877 this);
2878
2879 // it is common to construct the menu passed to this function dynamically
2880 // using some fixed range of ids which could clash with the ids used
2881 // elsewhere in the program, which could result in some menu items being
2882 // unintentionally disabled or otherwise modified by update UI handlers
2883 // elsewhere in the program code and this is difficult to avoid in the
2884 // program itself, so instead we just temporarily suspend UI updating while
2885 // this menu is shown
2886 Connect(wxEVT_UPDATE_UI,
2887 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2888 NULL,
2889 this);
2890
2891 PopupMenu(&menu, x, y);
2892
2893 Disconnect(wxEVT_UPDATE_UI,
2894 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2895 NULL,
2896 this);
2897 Disconnect(wxEVT_COMMAND_MENU_SELECTED,
2898 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2899 NULL,
2900 this);
2901
2902 return gs_popupMenuSelection;
2903 }
2904
2905 #endif // wxUSE_MENUS
2906
2907 // methods for drawing the sizers in a visible way: this is currently only
2908 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2909 // that well and also because we don't want to leave it enabled in default
2910 // builds used for production
2911 #if wxDEBUG_LEVEL > 1
2912
2913 static void DrawSizers(wxWindowBase *win);
2914
2915 static void DrawBorder(wxWindowBase *win, const wxRect& rect, bool fill, const wxPen* pen)
2916 {
2917 wxClientDC dc((wxWindow *)win);
2918 dc.SetPen(*pen);
2919 dc.SetBrush(fill ? wxBrush(pen->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH) :
2920 *wxTRANSPARENT_BRUSH);
2921 dc.DrawRectangle(rect.Deflate(1, 1));
2922 }
2923
2924 static void DrawSizer(wxWindowBase *win, wxSizer *sizer)
2925 {
2926 const wxSizerItemList& items = sizer->GetChildren();
2927 for ( wxSizerItemList::const_iterator i = items.begin(),
2928 end = items.end();
2929 i != end;
2930 ++i )
2931 {
2932 wxSizerItem *item = *i;
2933 if ( item->IsSizer() )
2934 {
2935 DrawBorder(win, item->GetRect().Deflate(2), false, wxRED_PEN);
2936 DrawSizer(win, item->GetSizer());
2937 }
2938 else if ( item->IsSpacer() )
2939 {
2940 DrawBorder(win, item->GetRect().Deflate(2), true, wxBLUE_PEN);
2941 }
2942 else if ( item->IsWindow() )
2943 {
2944 DrawSizers(item->GetWindow());
2945 }
2946 else
2947 wxFAIL_MSG("inconsistent wxSizerItem status!");
2948 }
2949 }
2950
2951 static void DrawSizers(wxWindowBase *win)
2952 {
2953 DrawBorder(win, win->GetClientSize(), false, wxGREEN_PEN);
2954
2955 wxSizer *sizer = win->GetSizer();
2956 if ( sizer )
2957 {
2958 DrawSizer(win, sizer);
2959 }
2960 else // no sizer, still recurse into the children
2961 {
2962 const wxWindowList& children = win->GetChildren();
2963 for ( wxWindowList::const_iterator i = children.begin(),
2964 end = children.end();
2965 i != end;
2966 ++i )
2967 {
2968 DrawSizers(*i);
2969 }
2970
2971 // show all kind of sizes of this window; see the "window sizing" topic
2972 // overview for more info about the various differences:
2973 wxSize fullSz = win->GetSize();
2974 wxSize clientSz = win->GetClientSize();
2975 wxSize bestSz = win->GetBestSize();
2976 wxSize minSz = win->GetMinSize();
2977 wxSize maxSz = win->GetMaxSize();
2978 wxSize virtualSz = win->GetVirtualSize();
2979
2980 wxMessageOutputDebug dbgout;
2981 dbgout.Printf(
2982 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
2983 win->GetName(),
2984 fullSz.x, fullSz.y,
2985 clientSz.x, clientSz.y,
2986 bestSz.x, bestSz.y,
2987 minSz.x, minSz.y,
2988 maxSz.x, maxSz.y,
2989 virtualSz.x, virtualSz.y);
2990 }
2991 }
2992
2993 #endif // wxDEBUG_LEVEL
2994
2995 // process special middle clicks
2996 void wxWindowBase::OnMiddleClick( wxMouseEvent& event )
2997 {
2998 if ( event.ControlDown() && event.AltDown() )
2999 {
3000 #if wxDEBUG_LEVEL > 1
3001 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3002 if ( event.ShiftDown() )
3003 {
3004 DrawSizers(this);
3005 }
3006 else
3007 #endif // __WXDEBUG__
3008 {
3009 #if wxUSE_MSGDLG
3010 // just Ctrl-Alt-middle click shows information about wx version
3011 ::wxInfoMessageBox((wxWindow*)this);
3012 #endif // wxUSE_MSGDLG
3013 }
3014 }
3015 else
3016 {
3017 event.Skip();
3018 }
3019 }
3020
3021 // ----------------------------------------------------------------------------
3022 // accessibility
3023 // ----------------------------------------------------------------------------
3024
3025 #if wxUSE_ACCESSIBILITY
3026 void wxWindowBase::SetAccessible(wxAccessible* accessible)
3027 {
3028 if (m_accessible && (accessible != m_accessible))
3029 delete m_accessible;
3030 m_accessible = accessible;
3031 if (m_accessible)
3032 m_accessible->SetWindow((wxWindow*) this);
3033 }
3034
3035 // Returns the accessible object, creating if necessary.
3036 wxAccessible* wxWindowBase::GetOrCreateAccessible()
3037 {
3038 if (!m_accessible)
3039 m_accessible = CreateAccessible();
3040 return m_accessible;
3041 }
3042
3043 // Override to create a specific accessible object.
3044 wxAccessible* wxWindowBase::CreateAccessible()
3045 {
3046 return new wxWindowAccessible((wxWindow*) this);
3047 }
3048
3049 #endif
3050
3051 // ----------------------------------------------------------------------------
3052 // list classes implementation
3053 // ----------------------------------------------------------------------------
3054
3055 #if wxUSE_STD_CONTAINERS
3056
3057 #include "wx/listimpl.cpp"
3058 WX_DEFINE_LIST(wxWindowList)
3059
3060 #else // !wxUSE_STD_CONTAINERS
3061
3062 void wxWindowListNode::DeleteData()
3063 {
3064 delete (wxWindow *)GetData();
3065 }
3066
3067 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3068
3069 // ----------------------------------------------------------------------------
3070 // borders
3071 // ----------------------------------------------------------------------------
3072
3073 wxBorder wxWindowBase::GetBorder(long flags) const
3074 {
3075 wxBorder border = (wxBorder)(flags & wxBORDER_MASK);
3076 if ( border == wxBORDER_DEFAULT )
3077 {
3078 border = GetDefaultBorder();
3079 }
3080 else if ( border == wxBORDER_THEME )
3081 {
3082 border = GetDefaultBorderForControl();
3083 }
3084
3085 return border;
3086 }
3087
3088 wxBorder wxWindowBase::GetDefaultBorder() const
3089 {
3090 return wxBORDER_NONE;
3091 }
3092
3093 // ----------------------------------------------------------------------------
3094 // hit testing
3095 // ----------------------------------------------------------------------------
3096
3097 wxHitTest wxWindowBase::DoHitTest(wxCoord x, wxCoord y) const
3098 {
3099 // here we just check if the point is inside the window or not
3100
3101 // check the top and left border first
3102 bool outside = x < 0 || y < 0;
3103 if ( !outside )
3104 {
3105 // check the right and bottom borders too
3106 wxSize size = GetSize();
3107 outside = x >= size.x || y >= size.y;
3108 }
3109
3110 return outside ? wxHT_WINDOW_OUTSIDE : wxHT_WINDOW_INSIDE;
3111 }
3112
3113 // ----------------------------------------------------------------------------
3114 // mouse capture
3115 // ----------------------------------------------------------------------------
3116
3117 struct WXDLLEXPORT wxWindowNext
3118 {
3119 wxWindow *win;
3120 wxWindowNext *next;
3121 } *wxWindowBase::ms_winCaptureNext = NULL;
3122 wxWindow *wxWindowBase::ms_winCaptureCurrent = NULL;
3123 bool wxWindowBase::ms_winCaptureChanging = false;
3124
3125 void wxWindowBase::CaptureMouse()
3126 {
3127 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3128
3129 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive CaptureMouse call?") );
3130
3131 ms_winCaptureChanging = true;
3132
3133 wxWindow *winOld = GetCapture();
3134 if ( winOld )
3135 {
3136 ((wxWindowBase*) winOld)->DoReleaseMouse();
3137
3138 // save it on stack
3139 wxWindowNext *item = new wxWindowNext;
3140 item->win = winOld;
3141 item->next = ms_winCaptureNext;
3142 ms_winCaptureNext = item;
3143 }
3144 //else: no mouse capture to save
3145
3146 DoCaptureMouse();
3147 ms_winCaptureCurrent = (wxWindow*)this;
3148
3149 ms_winCaptureChanging = false;
3150 }
3151
3152 void wxWindowBase::ReleaseMouse()
3153 {
3154 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3155
3156 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive ReleaseMouse call?") );
3157
3158 wxASSERT_MSG( GetCapture() == this,
3159 "attempt to release mouse, but this window hasn't captured it" );
3160 wxASSERT_MSG( ms_winCaptureCurrent == this,
3161 "attempt to release mouse, but this window hasn't captured it" );
3162
3163 ms_winCaptureChanging = true;
3164
3165 DoReleaseMouse();
3166 ms_winCaptureCurrent = NULL;
3167
3168 if ( ms_winCaptureNext )
3169 {
3170 ((wxWindowBase*)ms_winCaptureNext->win)->DoCaptureMouse();
3171 ms_winCaptureCurrent = ms_winCaptureNext->win;
3172
3173 wxWindowNext *item = ms_winCaptureNext;
3174 ms_winCaptureNext = item->next;
3175 delete item;
3176 }
3177 //else: stack is empty, no previous capture
3178
3179 ms_winCaptureChanging = false;
3180
3181 wxLogTrace(wxT("mousecapture"),
3182 (const wxChar *) wxT("After ReleaseMouse() mouse is captured by %p"),
3183 static_cast<void*>(GetCapture()));
3184 }
3185
3186 static void DoNotifyWindowAboutCaptureLost(wxWindow *win)
3187 {
3188 wxMouseCaptureLostEvent event(win->GetId());
3189 event.SetEventObject(win);
3190 if ( !win->GetEventHandler()->ProcessEvent(event) )
3191 {
3192 // windows must handle this event, otherwise the app wouldn't behave
3193 // correctly if it loses capture unexpectedly; see the discussion here:
3194 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3195 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3196 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3197 }
3198 }
3199
3200 /* static */
3201 void wxWindowBase::NotifyCaptureLost()
3202 {
3203 // don't do anything if capture lost was expected, i.e. resulted from
3204 // a wx call to ReleaseMouse or CaptureMouse:
3205 if ( ms_winCaptureChanging )
3206 return;
3207
3208 // if the capture was lost unexpectedly, notify every window that has
3209 // capture (on stack or current) about it and clear the stack:
3210
3211 if ( ms_winCaptureCurrent )
3212 {
3213 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent);
3214 ms_winCaptureCurrent = NULL;
3215 }
3216
3217 while ( ms_winCaptureNext )
3218 {
3219 wxWindowNext *item = ms_winCaptureNext;
3220 ms_winCaptureNext = item->next;
3221
3222 DoNotifyWindowAboutCaptureLost(item->win);
3223
3224 delete item;
3225 }
3226 }
3227
3228 #if wxUSE_HOTKEY
3229
3230 bool
3231 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId),
3232 int WXUNUSED(modifiers),
3233 int WXUNUSED(keycode))
3234 {
3235 // not implemented
3236 return false;
3237 }
3238
3239 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId))
3240 {
3241 // not implemented
3242 return false;
3243 }
3244
3245 #endif // wxUSE_HOTKEY
3246
3247 // ----------------------------------------------------------------------------
3248 // event processing
3249 // ----------------------------------------------------------------------------
3250
3251 bool wxWindowBase::TryBefore(wxEvent& event)
3252 {
3253 #if wxUSE_VALIDATORS
3254 // Can only use the validator of the window which
3255 // is receiving the event
3256 if ( event.GetEventObject() == this )
3257 {
3258 wxValidator * const validator = GetValidator();
3259 if ( validator && validator->ProcessEventLocally(event) )
3260 {
3261 return true;
3262 }
3263 }
3264 #endif // wxUSE_VALIDATORS
3265
3266 return wxEvtHandler::TryBefore(event);
3267 }
3268
3269 bool wxWindowBase::TryAfter(wxEvent& event)
3270 {
3271 // carry on up the parent-child hierarchy if the propagation count hasn't
3272 // reached zero yet
3273 if ( event.ShouldPropagate() )
3274 {
3275 // honour the requests to stop propagation at this window: this is
3276 // used by the dialogs, for example, to prevent processing the events
3277 // from the dialog controls in the parent frame which rarely, if ever,
3278 // makes sense
3279 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
3280 {
3281 wxWindow *parent = GetParent();
3282 if ( parent && !parent->IsBeingDeleted() )
3283 {
3284 wxPropagateOnce propagateOnce(event);
3285
3286 return parent->GetEventHandler()->ProcessEvent(event);
3287 }
3288 }
3289 }
3290
3291 return wxEvtHandler::TryAfter(event);
3292 }
3293
3294 // ----------------------------------------------------------------------------
3295 // window relationships
3296 // ----------------------------------------------------------------------------
3297
3298 wxWindow *wxWindowBase::DoGetSibling(WindowOrder order) const
3299 {
3300 wxCHECK_MSG( GetParent(), NULL,
3301 wxT("GetPrev/NextSibling() don't work for TLWs!") );
3302
3303 wxWindowList& siblings = GetParent()->GetChildren();
3304 wxWindowList::compatibility_iterator i = siblings.Find((wxWindow *)this);
3305 wxCHECK_MSG( i, NULL, wxT("window not a child of its parent?") );
3306
3307 if ( order == OrderBefore )
3308 i = i->GetPrevious();
3309 else // OrderAfter
3310 i = i->GetNext();
3311
3312 return i ? i->GetData() : NULL;
3313 }
3314
3315 // ----------------------------------------------------------------------------
3316 // keyboard navigation
3317 // ----------------------------------------------------------------------------
3318
3319 // Navigates in the specified direction inside this window
3320 bool wxWindowBase::DoNavigateIn(int flags)
3321 {
3322 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3323 // native code doesn't process our wxNavigationKeyEvents anyhow
3324 wxUnusedVar(flags);
3325 return false;
3326 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3327 wxNavigationKeyEvent eventNav;
3328 wxWindow *focused = FindFocus();
3329 eventNav.SetCurrentFocus(focused);
3330 eventNav.SetEventObject(focused);
3331 eventNav.SetFlags(flags);
3332 return GetEventHandler()->ProcessEvent(eventNav);
3333 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3334 }
3335
3336 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent& event)
3337 {
3338 if ( event.GetKeyCode() != WXK_TAB )
3339 return false;
3340
3341 int flags = wxNavigationKeyEvent::FromTab;
3342
3343 if ( event.ShiftDown() )
3344 flags |= wxNavigationKeyEvent::IsBackward;
3345 else
3346 flags |= wxNavigationKeyEvent::IsForward;
3347
3348 if ( event.ControlDown() )
3349 flags |= wxNavigationKeyEvent::WinChange;
3350
3351 Navigate(flags);
3352 return true;
3353 }
3354
3355 void wxWindowBase::DoMoveInTabOrder(wxWindow *win, WindowOrder move)
3356 {
3357 // check that we're not a top level window
3358 wxCHECK_RET( GetParent(),
3359 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3360
3361 // detect the special case when we have nothing to do anyhow and when the
3362 // code below wouldn't work
3363 if ( win == this )
3364 return;
3365
3366 // find the target window in the siblings list
3367 wxWindowList& siblings = GetParent()->GetChildren();
3368 wxWindowList::compatibility_iterator i = siblings.Find(win);
3369 wxCHECK_RET( i, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3370
3371 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3372 // implemented so we can't just move the node around
3373 wxWindow *self = (wxWindow *)this;
3374 siblings.DeleteObject(self);
3375 if ( move == OrderAfter )
3376 {
3377 i = i->GetNext();
3378 }
3379
3380 if ( i )
3381 {
3382 siblings.Insert(i, self);
3383 }
3384 else // OrderAfter and win was the last sibling
3385 {
3386 siblings.Append(self);
3387 }
3388 }
3389
3390 // ----------------------------------------------------------------------------
3391 // focus handling
3392 // ----------------------------------------------------------------------------
3393
3394 /*static*/ wxWindow* wxWindowBase::FindFocus()
3395 {
3396 wxWindowBase *win = DoFindFocus();
3397 return win ? win->GetMainWindowOfCompositeControl() : NULL;
3398 }
3399
3400 bool wxWindowBase::HasFocus() const
3401 {
3402 wxWindowBase* const win = DoFindFocus();
3403 return win &&
3404 (this == win || this == win->GetMainWindowOfCompositeControl());
3405 }
3406
3407 // ----------------------------------------------------------------------------
3408 // drag and drop
3409 // ----------------------------------------------------------------------------
3410
3411 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3412
3413 namespace
3414 {
3415
3416 class DragAcceptFilesTarget : public wxFileDropTarget
3417 {
3418 public:
3419 DragAcceptFilesTarget(wxWindowBase *win) : m_win(win) {}
3420
3421 virtual bool OnDropFiles(wxCoord x, wxCoord y,
3422 const wxArrayString& filenames)
3423 {
3424 wxDropFilesEvent event(wxEVT_DROP_FILES,
3425 filenames.size(),
3426 wxCArrayString(filenames).Release());
3427 event.SetEventObject(m_win);
3428 event.m_pos.x = x;
3429 event.m_pos.y = y;
3430
3431 return m_win->HandleWindowEvent(event);
3432 }
3433
3434 private:
3435 wxWindowBase * const m_win;
3436
3437 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget);
3438 };
3439
3440
3441 } // anonymous namespace
3442
3443 // Generic version of DragAcceptFiles(). It works by installing a simple
3444 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3445 // together with explicit SetDropTarget() calls.
3446 void wxWindowBase::DragAcceptFiles(bool accept)
3447 {
3448 if ( accept )
3449 {
3450 wxASSERT_MSG( !GetDropTarget(),
3451 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3452 SetDropTarget(new DragAcceptFilesTarget(this));
3453 }
3454 else
3455 {
3456 SetDropTarget(NULL);
3457 }
3458 }
3459
3460 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3461
3462 // ----------------------------------------------------------------------------
3463 // global functions
3464 // ----------------------------------------------------------------------------
3465
3466 wxWindow* wxGetTopLevelParent(wxWindow *win)
3467 {
3468 while ( win && !win->IsTopLevel() )
3469 win = win->GetParent();
3470
3471 return win;
3472 }
3473
3474 #if wxUSE_ACCESSIBILITY
3475 // ----------------------------------------------------------------------------
3476 // accessible object for windows
3477 // ----------------------------------------------------------------------------
3478
3479 // Can return either a child object, or an integer
3480 // representing the child element, starting from 1.
3481 wxAccStatus wxWindowAccessible::HitTest(const wxPoint& WXUNUSED(pt), int* WXUNUSED(childId), wxAccessible** WXUNUSED(childObject))
3482 {
3483 wxASSERT( GetWindow() != NULL );
3484 if (!GetWindow())
3485 return wxACC_FAIL;
3486
3487 return wxACC_NOT_IMPLEMENTED;
3488 }
3489
3490 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3491 wxAccStatus wxWindowAccessible::GetLocation(wxRect& rect, int elementId)
3492 {
3493 wxASSERT( GetWindow() != NULL );
3494 if (!GetWindow())
3495 return wxACC_FAIL;
3496
3497 wxWindow* win = NULL;
3498 if (elementId == 0)
3499 {
3500 win = GetWindow();
3501 }
3502 else
3503 {
3504 if (elementId <= (int) GetWindow()->GetChildren().GetCount())
3505 {
3506 win = GetWindow()->GetChildren().Item(elementId-1)->GetData();
3507 }
3508 else
3509 return wxACC_FAIL;
3510 }
3511 if (win)
3512 {
3513 rect = win->GetRect();
3514 if (win->GetParent() && !win->IsKindOf(CLASSINFO(wxTopLevelWindow)))
3515 rect.SetPosition(win->GetParent()->ClientToScreen(rect.GetPosition()));
3516 return wxACC_OK;
3517 }
3518
3519 return wxACC_NOT_IMPLEMENTED;
3520 }
3521
3522 // Navigates from fromId to toId/toObject.
3523 wxAccStatus wxWindowAccessible::Navigate(wxNavDir navDir, int fromId,
3524 int* WXUNUSED(toId), wxAccessible** toObject)
3525 {
3526 wxASSERT( GetWindow() != NULL );
3527 if (!GetWindow())
3528 return wxACC_FAIL;
3529
3530 switch (navDir)
3531 {
3532 case wxNAVDIR_FIRSTCHILD:
3533 {
3534 if (GetWindow()->GetChildren().GetCount() == 0)
3535 return wxACC_FALSE;
3536 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetFirst()->GetData();
3537 *toObject = childWindow->GetOrCreateAccessible();
3538
3539 return wxACC_OK;
3540 }
3541 case wxNAVDIR_LASTCHILD:
3542 {
3543 if (GetWindow()->GetChildren().GetCount() == 0)
3544 return wxACC_FALSE;
3545 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetLast()->GetData();
3546 *toObject = childWindow->GetOrCreateAccessible();
3547
3548 return wxACC_OK;
3549 }
3550 case wxNAVDIR_RIGHT:
3551 case wxNAVDIR_DOWN:
3552 case wxNAVDIR_NEXT:
3553 {
3554 wxWindowList::compatibility_iterator node =
3555 wxWindowList::compatibility_iterator();
3556 if (fromId == 0)
3557 {
3558 // Can't navigate to sibling of this window
3559 // if we're a top-level window.
3560 if (!GetWindow()->GetParent())
3561 return wxACC_NOT_IMPLEMENTED;
3562
3563 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3564 }
3565 else
3566 {
3567 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3568 node = GetWindow()->GetChildren().Item(fromId-1);
3569 }
3570
3571 if (node && node->GetNext())
3572 {
3573 wxWindow* nextWindow = node->GetNext()->GetData();
3574 *toObject = nextWindow->GetOrCreateAccessible();
3575 return wxACC_OK;
3576 }
3577 else
3578 return wxACC_FALSE;
3579 }
3580 case wxNAVDIR_LEFT:
3581 case wxNAVDIR_UP:
3582 case wxNAVDIR_PREVIOUS:
3583 {
3584 wxWindowList::compatibility_iterator node =
3585 wxWindowList::compatibility_iterator();
3586 if (fromId == 0)
3587 {
3588 // Can't navigate to sibling of this window
3589 // if we're a top-level window.
3590 if (!GetWindow()->GetParent())
3591 return wxACC_NOT_IMPLEMENTED;
3592
3593 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3594 }
3595 else
3596 {
3597 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3598 node = GetWindow()->GetChildren().Item(fromId-1);
3599 }
3600
3601 if (node && node->GetPrevious())
3602 {
3603 wxWindow* previousWindow = node->GetPrevious()->GetData();
3604 *toObject = previousWindow->GetOrCreateAccessible();
3605 return wxACC_OK;
3606 }
3607 else
3608 return wxACC_FALSE;
3609 }
3610 }
3611
3612 return wxACC_NOT_IMPLEMENTED;
3613 }
3614
3615 // Gets the name of the specified object.
3616 wxAccStatus wxWindowAccessible::GetName(int childId, wxString* name)
3617 {
3618 wxASSERT( GetWindow() != NULL );
3619 if (!GetWindow())
3620 return wxACC_FAIL;
3621
3622 wxString title;
3623
3624 // If a child, leave wxWidgets to call the function on the actual
3625 // child object.
3626 if (childId > 0)
3627 return wxACC_NOT_IMPLEMENTED;
3628
3629 // This will eventually be replaced by specialised
3630 // accessible classes, one for each kind of wxWidgets
3631 // control or window.
3632 #if wxUSE_BUTTON
3633 if (GetWindow()->IsKindOf(CLASSINFO(wxButton)))
3634 title = ((wxButton*) GetWindow())->GetLabel();
3635 else
3636 #endif
3637 title = GetWindow()->GetName();
3638
3639 if (!title.empty())
3640 {
3641 *name = title;
3642 return wxACC_OK;
3643 }
3644 else
3645 return wxACC_NOT_IMPLEMENTED;
3646 }
3647
3648 // Gets the number of children.
3649 wxAccStatus wxWindowAccessible::GetChildCount(int* childId)
3650 {
3651 wxASSERT( GetWindow() != NULL );
3652 if (!GetWindow())
3653 return wxACC_FAIL;
3654
3655 *childId = (int) GetWindow()->GetChildren().GetCount();
3656 return wxACC_OK;
3657 }
3658
3659 // Gets the specified child (starting from 1).
3660 // If *child is NULL and return value is wxACC_OK,
3661 // this means that the child is a simple element and
3662 // not an accessible object.
3663 wxAccStatus wxWindowAccessible::GetChild(int childId, wxAccessible** child)
3664 {
3665 wxASSERT( GetWindow() != NULL );
3666 if (!GetWindow())
3667 return wxACC_FAIL;
3668
3669 if (childId == 0)
3670 {
3671 *child = this;
3672 return wxACC_OK;
3673 }
3674
3675 if (childId > (int) GetWindow()->GetChildren().GetCount())
3676 return wxACC_FAIL;
3677
3678 wxWindow* childWindow = GetWindow()->GetChildren().Item(childId-1)->GetData();
3679 *child = childWindow->GetOrCreateAccessible();
3680 if (*child)
3681 return wxACC_OK;
3682 else
3683 return wxACC_FAIL;
3684 }
3685
3686 // Gets the parent, or NULL.
3687 wxAccStatus wxWindowAccessible::GetParent(wxAccessible** parent)
3688 {
3689 wxASSERT( GetWindow() != NULL );
3690 if (!GetWindow())
3691 return wxACC_FAIL;
3692
3693 wxWindow* parentWindow = GetWindow()->GetParent();
3694 if (!parentWindow)
3695 {
3696 *parent = NULL;
3697 return wxACC_OK;
3698 }
3699 else
3700 {
3701 *parent = parentWindow->GetOrCreateAccessible();
3702 if (*parent)
3703 return wxACC_OK;
3704 else
3705 return wxACC_FAIL;
3706 }
3707 }
3708
3709 // Performs the default action. childId is 0 (the action for this object)
3710 // or > 0 (the action for a child).
3711 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3712 // window (e.g. an edit control).
3713 wxAccStatus wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
3714 {
3715 wxASSERT( GetWindow() != NULL );
3716 if (!GetWindow())
3717 return wxACC_FAIL;
3718
3719 return wxACC_NOT_IMPLEMENTED;
3720 }
3721
3722 // Gets the default action for this object (0) or > 0 (the action for a child).
3723 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3724 // string if there is no action.
3725 // The retrieved string describes the action that is performed on an object,
3726 // not what the object does as a result. For example, a toolbar button that prints
3727 // a document has a default action of "Press" rather than "Prints the current document."
3728 wxAccStatus wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId), wxString* WXUNUSED(actionName))
3729 {
3730 wxASSERT( GetWindow() != NULL );
3731 if (!GetWindow())
3732 return wxACC_FAIL;
3733
3734 return wxACC_NOT_IMPLEMENTED;
3735 }
3736
3737 // Returns the description for this object or a child.
3738 wxAccStatus wxWindowAccessible::GetDescription(int WXUNUSED(childId), wxString* description)
3739 {
3740 wxASSERT( GetWindow() != NULL );
3741 if (!GetWindow())
3742 return wxACC_FAIL;
3743
3744 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3745 if (!ht.empty())
3746 {
3747 *description = ht;
3748 return wxACC_OK;
3749 }
3750 return wxACC_NOT_IMPLEMENTED;
3751 }
3752
3753 // Returns help text for this object or a child, similar to tooltip text.
3754 wxAccStatus wxWindowAccessible::GetHelpText(int WXUNUSED(childId), wxString* helpText)
3755 {
3756 wxASSERT( GetWindow() != NULL );
3757 if (!GetWindow())
3758 return wxACC_FAIL;
3759
3760 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3761 if (!ht.empty())
3762 {
3763 *helpText = ht;
3764 return wxACC_OK;
3765 }
3766 return wxACC_NOT_IMPLEMENTED;
3767 }
3768
3769 // Returns the keyboard shortcut for this object or child.
3770 // Return e.g. ALT+K
3771 wxAccStatus wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId), wxString* WXUNUSED(shortcut))
3772 {
3773 wxASSERT( GetWindow() != NULL );
3774 if (!GetWindow())
3775 return wxACC_FAIL;
3776
3777 return wxACC_NOT_IMPLEMENTED;
3778 }
3779
3780 // Returns a role constant.
3781 wxAccStatus wxWindowAccessible::GetRole(int childId, wxAccRole* role)
3782 {
3783 wxASSERT( GetWindow() != NULL );
3784 if (!GetWindow())
3785 return wxACC_FAIL;
3786
3787 // If a child, leave wxWidgets to call the function on the actual
3788 // child object.
3789 if (childId > 0)
3790 return wxACC_NOT_IMPLEMENTED;
3791
3792 if (GetWindow()->IsKindOf(CLASSINFO(wxControl)))
3793 return wxACC_NOT_IMPLEMENTED;
3794 #if wxUSE_STATUSBAR
3795 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar)))
3796 return wxACC_NOT_IMPLEMENTED;
3797 #endif
3798 #if wxUSE_TOOLBAR
3799 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar)))
3800 return wxACC_NOT_IMPLEMENTED;
3801 #endif
3802
3803 //*role = wxROLE_SYSTEM_CLIENT;
3804 *role = wxROLE_SYSTEM_CLIENT;
3805 return wxACC_OK;
3806
3807 #if 0
3808 return wxACC_NOT_IMPLEMENTED;
3809 #endif
3810 }
3811
3812 // Returns a state constant.
3813 wxAccStatus wxWindowAccessible::GetState(int childId, long* state)
3814 {
3815 wxASSERT( GetWindow() != NULL );
3816 if (!GetWindow())
3817 return wxACC_FAIL;
3818
3819 // If a child, leave wxWidgets to call the function on the actual
3820 // child object.
3821 if (childId > 0)
3822 return wxACC_NOT_IMPLEMENTED;
3823
3824 if (GetWindow()->IsKindOf(CLASSINFO(wxControl)))
3825 return wxACC_NOT_IMPLEMENTED;
3826
3827 #if wxUSE_STATUSBAR
3828 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar)))
3829 return wxACC_NOT_IMPLEMENTED;
3830 #endif
3831 #if wxUSE_TOOLBAR
3832 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar)))
3833 return wxACC_NOT_IMPLEMENTED;
3834 #endif
3835
3836 *state = 0;
3837 return wxACC_OK;
3838
3839 #if 0
3840 return wxACC_NOT_IMPLEMENTED;
3841 #endif
3842 }
3843
3844 // Returns a localized string representing the value for the object
3845 // or child.
3846 wxAccStatus wxWindowAccessible::GetValue(int WXUNUSED(childId), wxString* WXUNUSED(strValue))
3847 {
3848 wxASSERT( GetWindow() != NULL );
3849 if (!GetWindow())
3850 return wxACC_FAIL;
3851
3852 return wxACC_NOT_IMPLEMENTED;
3853 }
3854
3855 // Selects the object or child.
3856 wxAccStatus wxWindowAccessible::Select(int WXUNUSED(childId), wxAccSelectionFlags WXUNUSED(selectFlags))
3857 {
3858 wxASSERT( GetWindow() != NULL );
3859 if (!GetWindow())
3860 return wxACC_FAIL;
3861
3862 return wxACC_NOT_IMPLEMENTED;
3863 }
3864
3865 // Gets the window with the keyboard focus.
3866 // If childId is 0 and child is NULL, no object in
3867 // this subhierarchy has the focus.
3868 // If this object has the focus, child should be 'this'.
3869 wxAccStatus wxWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
3870 {
3871 wxASSERT( GetWindow() != NULL );
3872 if (!GetWindow())
3873 return wxACC_FAIL;
3874
3875 return wxACC_NOT_IMPLEMENTED;
3876 }
3877
3878 #if wxUSE_VARIANT
3879 // Gets a variant representing the selected children
3880 // of this object.
3881 // Acceptable values:
3882 // - a null variant (IsNull() returns true)
3883 // - a list variant (GetType() == wxT("list")
3884 // - an integer representing the selected child element,
3885 // or 0 if this object is selected (GetType() == wxT("long")
3886 // - a "void*" pointer to a wxAccessible child object
3887 wxAccStatus wxWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
3888 {
3889 wxASSERT( GetWindow() != NULL );
3890 if (!GetWindow())
3891 return wxACC_FAIL;
3892
3893 return wxACC_NOT_IMPLEMENTED;
3894 }
3895 #endif // wxUSE_VARIANT
3896
3897 #endif // wxUSE_ACCESSIBILITY
3898
3899 // ----------------------------------------------------------------------------
3900 // RTL support
3901 // ----------------------------------------------------------------------------
3902
3903 wxCoord
3904 wxWindowBase::AdjustForLayoutDirection(wxCoord x,
3905 wxCoord width,
3906 wxCoord widthTotal) const
3907 {
3908 if ( GetLayoutDirection() == wxLayout_RightToLeft )
3909 {
3910 x = widthTotal - x - width;
3911 }
3912
3913 return x;
3914 }
3915
3916