Fix wxWindow::IsDescendant() to work with argument equal to this window.
[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 && !wxDynamicCast(win, 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 if ( win == this )
1272 return true;
1273
1274 // Stop iterating on reaching the top level window boundary.
1275 if ( win->IsTopLevel() )
1276 break;
1277
1278 win = win->GetParent();
1279 }
1280
1281 return false;
1282 }
1283
1284 void wxWindowBase::AddChild(wxWindowBase *child)
1285 {
1286 wxCHECK_RET( child, wxT("can't add a NULL child") );
1287
1288 // this should never happen and it will lead to a crash later if it does
1289 // because RemoveChild() will remove only one node from the children list
1290 // and the other(s) one(s) will be left with dangling pointers in them
1291 wxASSERT_MSG( !GetChildren().Find((wxWindow*)child), wxT("AddChild() called twice") );
1292
1293 GetChildren().Append((wxWindow*)child);
1294 child->SetParent(this);
1295
1296 // adding a child while frozen will assert when thawed, so freeze it as if
1297 // it had been already present when we were frozen
1298 if ( IsFrozen() && !child->IsTopLevel() )
1299 child->Freeze();
1300 }
1301
1302 void wxWindowBase::RemoveChild(wxWindowBase *child)
1303 {
1304 wxCHECK_RET( child, wxT("can't remove a NULL child") );
1305
1306 // removing a child while frozen may result in permanently frozen window
1307 // if used e.g. from Reparent(), so thaw it
1308 //
1309 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1310 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1311 if ( IsFrozen() && !child->IsBeingDeleted() && !child->IsTopLevel() )
1312 child->Thaw();
1313
1314 GetChildren().DeleteObject((wxWindow *)child);
1315 child->SetParent(NULL);
1316 }
1317
1318 bool wxWindowBase::Reparent(wxWindowBase *newParent)
1319 {
1320 wxWindow *oldParent = GetParent();
1321 if ( newParent == oldParent )
1322 {
1323 // nothing done
1324 return false;
1325 }
1326
1327 const bool oldEnabledState = IsEnabled();
1328
1329 // unlink this window from the existing parent.
1330 if ( oldParent )
1331 {
1332 oldParent->RemoveChild(this);
1333 }
1334 else
1335 {
1336 wxTopLevelWindows.DeleteObject((wxWindow *)this);
1337 }
1338
1339 // add it to the new one
1340 if ( newParent )
1341 {
1342 newParent->AddChild(this);
1343 }
1344 else
1345 {
1346 wxTopLevelWindows.Append((wxWindow *)this);
1347 }
1348
1349 // We need to notify window (and its subwindows) if by changing the parent
1350 // we also change our enabled/disabled status.
1351 const bool newEnabledState = IsEnabled();
1352 if ( newEnabledState != oldEnabledState )
1353 {
1354 NotifyWindowOnEnableChange(newEnabledState);
1355 }
1356
1357 return true;
1358 }
1359
1360 // ----------------------------------------------------------------------------
1361 // event handler stuff
1362 // ----------------------------------------------------------------------------
1363
1364 void wxWindowBase::SetEventHandler(wxEvtHandler *handler)
1365 {
1366 wxCHECK_RET(handler != NULL, "SetEventHandler(NULL) called");
1367
1368 m_eventHandler = handler;
1369 }
1370
1371 void wxWindowBase::SetNextHandler(wxEvtHandler *WXUNUSED(handler))
1372 {
1373 // disable wxEvtHandler chain mechanism for wxWindows:
1374 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1375
1376 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1377 }
1378 void wxWindowBase::SetPreviousHandler(wxEvtHandler *WXUNUSED(handler))
1379 {
1380 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1381 // handler of our stack when is destroyed will be Unlink()ed and thus
1382 // will call this function to update the pointer of this window...
1383
1384 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1385 }
1386
1387 void wxWindowBase::PushEventHandler(wxEvtHandler *handlerToPush)
1388 {
1389 wxCHECK_RET( handlerToPush != NULL, "PushEventHandler(NULL) called" );
1390
1391 // the new handler is going to be part of the wxWindow stack of event handlers:
1392 // it can't be part also of an event handler double-linked chain:
1393 wxASSERT_MSG(handlerToPush->IsUnlinked(),
1394 "The handler being pushed in the wxWindow stack shouldn't be part of "
1395 "a wxEvtHandler chain; call Unlink() on it first");
1396
1397 wxEvtHandler *handlerOld = GetEventHandler();
1398 wxCHECK_RET( handlerOld, "an old event handler is NULL?" );
1399
1400 // now use wxEvtHandler double-linked list to implement a stack:
1401 handlerToPush->SetNextHandler(handlerOld);
1402
1403 if (handlerOld != this)
1404 handlerOld->SetPreviousHandler(handlerToPush);
1405
1406 SetEventHandler(handlerToPush);
1407
1408 #if wxDEBUG_LEVEL
1409 // final checks of the operations done above:
1410 wxASSERT_MSG( handlerToPush->GetPreviousHandler() == NULL,
1411 "the first handler of the wxWindow stack should "
1412 "have no previous handlers set" );
1413 wxASSERT_MSG( handlerToPush->GetNextHandler() != NULL,
1414 "the first handler of the wxWindow stack should "
1415 "have non-NULL next handler" );
1416
1417 wxEvtHandler* pLast = handlerToPush;
1418 while ( pLast && pLast != this )
1419 pLast = pLast->GetNextHandler();
1420 wxASSERT_MSG( pLast->GetNextHandler() == NULL,
1421 "the last handler of the wxWindow stack should "
1422 "have this window as next handler" );
1423 #endif // wxDEBUG_LEVEL
1424 }
1425
1426 wxEvtHandler *wxWindowBase::PopEventHandler(bool deleteHandler)
1427 {
1428 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
1429
1430 wxEvtHandler *firstHandler = GetEventHandler();
1431 wxCHECK_MSG( firstHandler != NULL, NULL, "wxWindow cannot have a NULL event handler" );
1432 wxCHECK_MSG( firstHandler != this, NULL, "cannot pop the wxWindow itself" );
1433 wxCHECK_MSG( firstHandler->GetPreviousHandler() == NULL, NULL,
1434 "the first handler of the wxWindow stack should have no previous handlers set" );
1435
1436 wxEvtHandler *secondHandler = firstHandler->GetNextHandler();
1437 wxCHECK_MSG( secondHandler != NULL, NULL,
1438 "the first handler of the wxWindow stack should have non-NULL next handler" );
1439
1440 firstHandler->SetNextHandler(NULL);
1441
1442 // It is harmless but useless to unset the previous handler of the window
1443 // itself as it's always NULL anyhow, so don't do this.
1444 if ( secondHandler != this )
1445 secondHandler->SetPreviousHandler(NULL);
1446
1447 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1448 SetEventHandler(secondHandler);
1449
1450 if ( deleteHandler )
1451 {
1452 wxDELETE(firstHandler);
1453 }
1454
1455 return firstHandler;
1456 }
1457
1458 bool wxWindowBase::RemoveEventHandler(wxEvtHandler *handlerToRemove)
1459 {
1460 wxCHECK_MSG( handlerToRemove != NULL, false, "RemoveEventHandler(NULL) called" );
1461 wxCHECK_MSG( handlerToRemove != this, false, "Cannot remove the window itself" );
1462
1463 if (handlerToRemove == GetEventHandler())
1464 {
1465 // removing the first event handler is equivalent to "popping" the stack
1466 PopEventHandler(false);
1467 return true;
1468 }
1469
1470 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1471 wxEvtHandler *handlerCur = GetEventHandler()->GetNextHandler();
1472 while ( handlerCur != this && handlerCur )
1473 {
1474 wxEvtHandler *handlerNext = handlerCur->GetNextHandler();
1475
1476 if ( handlerCur == handlerToRemove )
1477 {
1478 handlerCur->Unlink();
1479
1480 wxASSERT_MSG( handlerCur != GetEventHandler(),
1481 "the case Remove == Pop should was already handled" );
1482 return true;
1483 }
1484
1485 handlerCur = handlerNext;
1486 }
1487
1488 wxFAIL_MSG( wxT("where has the event handler gone?") );
1489
1490 return false;
1491 }
1492
1493 bool wxWindowBase::HandleWindowEvent(wxEvent& event) const
1494 {
1495 // SafelyProcessEvent() will handle exceptions nicely
1496 return GetEventHandler()->SafelyProcessEvent(event);
1497 }
1498
1499 // ----------------------------------------------------------------------------
1500 // colours, fonts &c
1501 // ----------------------------------------------------------------------------
1502
1503 void wxWindowBase::InheritAttributes()
1504 {
1505 const wxWindowBase * const parent = GetParent();
1506 if ( !parent )
1507 return;
1508
1509 // we only inherit attributes which had been explicitly set for the parent
1510 // which ensures that this only happens if the user really wants it and
1511 // not by default which wouldn't make any sense in modern GUIs where the
1512 // controls don't all use the same fonts (nor colours)
1513 if ( parent->m_inheritFont && !m_hasFont )
1514 SetFont(parent->GetFont());
1515
1516 // in addition, there is a possibility to explicitly forbid inheriting
1517 // colours at each class level by overriding ShouldInheritColours()
1518 if ( ShouldInheritColours() )
1519 {
1520 if ( parent->m_inheritFgCol && !m_hasFgCol )
1521 SetForegroundColour(parent->GetForegroundColour());
1522
1523 // inheriting (solid) background colour is wrong as it totally breaks
1524 // any kind of themed backgrounds
1525 //
1526 // instead, the controls should use the same background as their parent
1527 // (ideally by not drawing it at all)
1528 #if 0
1529 if ( parent->m_inheritBgCol && !m_hasBgCol )
1530 SetBackgroundColour(parent->GetBackgroundColour());
1531 #endif // 0
1532 }
1533 }
1534
1535 /* static */ wxVisualAttributes
1536 wxWindowBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1537 {
1538 // it is important to return valid values for all attributes from here,
1539 // GetXXX() below rely on this
1540 wxVisualAttributes attrs;
1541 attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
1542 attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
1543
1544 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1545 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1546 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1547 // colour on other platforms.
1548
1549 #if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1550 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
1551 #else
1552 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
1553 #endif
1554 return attrs;
1555 }
1556
1557 wxColour wxWindowBase::GetBackgroundColour() const
1558 {
1559 if ( !m_backgroundColour.IsOk() )
1560 {
1561 wxASSERT_MSG( !m_hasBgCol, wxT("we have invalid explicit bg colour?") );
1562
1563 // get our default background colour
1564 wxColour colBg = GetDefaultAttributes().colBg;
1565
1566 // we must return some valid colour to avoid redoing this every time
1567 // and also to avoid surprising the applications written for older
1568 // wxWidgets versions where GetBackgroundColour() always returned
1569 // something -- so give them something even if it doesn't make sense
1570 // for this window (e.g. it has a themed background)
1571 if ( !colBg.IsOk() )
1572 colBg = GetClassDefaultAttributes().colBg;
1573
1574 return colBg;
1575 }
1576 else
1577 return m_backgroundColour;
1578 }
1579
1580 wxColour wxWindowBase::GetForegroundColour() const
1581 {
1582 // logic is the same as above
1583 if ( !m_hasFgCol && !m_foregroundColour.IsOk() )
1584 {
1585 wxColour colFg = GetDefaultAttributes().colFg;
1586
1587 if ( !colFg.IsOk() )
1588 colFg = GetClassDefaultAttributes().colFg;
1589
1590 return colFg;
1591 }
1592 else
1593 return m_foregroundColour;
1594 }
1595
1596 bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style)
1597 {
1598 // The checks below shouldn't be triggered if we're not really changing the
1599 // style.
1600 if ( style == m_backgroundStyle )
1601 return true;
1602
1603 // Transparent background style can be only set before creation because of
1604 // wxGTK limitation.
1605 wxCHECK_MSG( (style != wxBG_STYLE_TRANSPARENT) || !GetHandle(),
1606 false,
1607 "wxBG_STYLE_TRANSPARENT style can only be set before "
1608 "Create()-ing the window." );
1609
1610 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1611 wxCHECK_MSG( (m_backgroundStyle != wxBG_STYLE_TRANSPARENT) ||
1612 (style == wxBG_STYLE_TRANSPARENT),
1613 false,
1614 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1615
1616 m_backgroundStyle = style;
1617
1618 return true;
1619 }
1620
1621 bool wxWindowBase::IsTransparentBackgroundSupported(wxString *reason) const
1622 {
1623 if ( reason )
1624 *reason = _("This platform does not support background transparency.");
1625
1626 return false;
1627 }
1628
1629 bool wxWindowBase::SetBackgroundColour( const wxColour &colour )
1630 {
1631 if ( colour == m_backgroundColour )
1632 return false;
1633
1634 m_hasBgCol = colour.IsOk();
1635
1636 m_inheritBgCol = m_hasBgCol;
1637 m_backgroundColour = colour;
1638 SetThemeEnabled( !m_hasBgCol && !m_foregroundColour.IsOk() );
1639 return true;
1640 }
1641
1642 bool wxWindowBase::SetForegroundColour( const wxColour &colour )
1643 {
1644 if (colour == m_foregroundColour )
1645 return false;
1646
1647 m_hasFgCol = colour.IsOk();
1648 m_inheritFgCol = m_hasFgCol;
1649 m_foregroundColour = colour;
1650 SetThemeEnabled( !m_hasFgCol && !m_backgroundColour.IsOk() );
1651 return true;
1652 }
1653
1654 bool wxWindowBase::SetCursor(const wxCursor& cursor)
1655 {
1656 // setting an invalid cursor is ok, it means that we don't have any special
1657 // cursor
1658 if ( m_cursor.IsSameAs(cursor) )
1659 {
1660 // no change
1661 return false;
1662 }
1663
1664 m_cursor = cursor;
1665
1666 return true;
1667 }
1668
1669 wxFont wxWindowBase::GetFont() const
1670 {
1671 // logic is the same as in GetBackgroundColour()
1672 if ( !m_font.IsOk() )
1673 {
1674 wxASSERT_MSG( !m_hasFont, wxT("we have invalid explicit font?") );
1675
1676 wxFont font = GetDefaultAttributes().font;
1677 if ( !font.IsOk() )
1678 font = GetClassDefaultAttributes().font;
1679
1680 return font;
1681 }
1682 else
1683 return m_font;
1684 }
1685
1686 bool wxWindowBase::SetFont(const wxFont& font)
1687 {
1688 if ( font == m_font )
1689 {
1690 // no change
1691 return false;
1692 }
1693
1694 m_font = font;
1695 m_hasFont = font.IsOk();
1696 m_inheritFont = m_hasFont;
1697
1698 InvalidateBestSize();
1699
1700 return true;
1701 }
1702
1703 #if wxUSE_PALETTE
1704
1705 void wxWindowBase::SetPalette(const wxPalette& pal)
1706 {
1707 m_hasCustomPalette = true;
1708 m_palette = pal;
1709
1710 // VZ: can anyone explain me what do we do here?
1711 wxWindowDC d((wxWindow *) this);
1712 d.SetPalette(pal);
1713 }
1714
1715 wxWindow *wxWindowBase::GetAncestorWithCustomPalette() const
1716 {
1717 wxWindow *win = (wxWindow *)this;
1718 while ( win && !win->HasCustomPalette() )
1719 {
1720 win = win->GetParent();
1721 }
1722
1723 return win;
1724 }
1725
1726 #endif // wxUSE_PALETTE
1727
1728 #if wxUSE_CARET
1729 void wxWindowBase::SetCaret(wxCaret *caret)
1730 {
1731 if ( m_caret )
1732 {
1733 delete m_caret;
1734 }
1735
1736 m_caret = caret;
1737
1738 if ( m_caret )
1739 {
1740 wxASSERT_MSG( m_caret->GetWindow() == this,
1741 wxT("caret should be created associated to this window") );
1742 }
1743 }
1744 #endif // wxUSE_CARET
1745
1746 #if wxUSE_VALIDATORS
1747 // ----------------------------------------------------------------------------
1748 // validators
1749 // ----------------------------------------------------------------------------
1750
1751 void wxWindowBase::SetValidator(const wxValidator& validator)
1752 {
1753 if ( m_windowValidator )
1754 delete m_windowValidator;
1755
1756 m_windowValidator = (wxValidator *)validator.Clone();
1757
1758 if ( m_windowValidator )
1759 m_windowValidator->SetWindow(this);
1760 }
1761 #endif // wxUSE_VALIDATORS
1762
1763 // ----------------------------------------------------------------------------
1764 // update region stuff
1765 // ----------------------------------------------------------------------------
1766
1767 wxRect wxWindowBase::GetUpdateClientRect() const
1768 {
1769 wxRegion rgnUpdate = GetUpdateRegion();
1770 rgnUpdate.Intersect(GetClientRect());
1771 wxRect rectUpdate = rgnUpdate.GetBox();
1772 wxPoint ptOrigin = GetClientAreaOrigin();
1773 rectUpdate.x -= ptOrigin.x;
1774 rectUpdate.y -= ptOrigin.y;
1775
1776 return rectUpdate;
1777 }
1778
1779 bool wxWindowBase::DoIsExposed(int x, int y) const
1780 {
1781 return m_updateRegion.Contains(x, y) != wxOutRegion;
1782 }
1783
1784 bool wxWindowBase::DoIsExposed(int x, int y, int w, int h) const
1785 {
1786 return m_updateRegion.Contains(x, y, w, h) != wxOutRegion;
1787 }
1788
1789 void wxWindowBase::ClearBackground()
1790 {
1791 // wxGTK uses its own version, no need to add never used code
1792 #ifndef __WXGTK__
1793 wxClientDC dc((wxWindow *)this);
1794 wxBrush brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID);
1795 dc.SetBackground(brush);
1796 dc.Clear();
1797 #endif // __WXGTK__
1798 }
1799
1800 // ----------------------------------------------------------------------------
1801 // find child window by id or name
1802 // ----------------------------------------------------------------------------
1803
1804 wxWindow *wxWindowBase::FindWindow(long id) const
1805 {
1806 if ( id == m_windowId )
1807 return (wxWindow *)this;
1808
1809 wxWindowBase *res = NULL;
1810 wxWindowList::compatibility_iterator node;
1811 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1812 {
1813 wxWindowBase *child = node->GetData();
1814 res = child->FindWindow( id );
1815 }
1816
1817 return (wxWindow *)res;
1818 }
1819
1820 wxWindow *wxWindowBase::FindWindow(const wxString& name) const
1821 {
1822 if ( name == m_windowName )
1823 return (wxWindow *)this;
1824
1825 wxWindowBase *res = NULL;
1826 wxWindowList::compatibility_iterator node;
1827 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1828 {
1829 wxWindow *child = node->GetData();
1830 res = child->FindWindow(name);
1831 }
1832
1833 return (wxWindow *)res;
1834 }
1835
1836
1837 // find any window by id or name or label: If parent is non-NULL, look through
1838 // children for a label or title matching the specified string. If NULL, look
1839 // through all top-level windows.
1840 //
1841 // to avoid duplicating code we reuse the same helper function but with
1842 // different comparators
1843
1844 typedef bool (*wxFindWindowCmp)(const wxWindow *win,
1845 const wxString& label, long id);
1846
1847 static
1848 bool wxFindWindowCmpLabels(const wxWindow *win, const wxString& label,
1849 long WXUNUSED(id))
1850 {
1851 return win->GetLabel() == label;
1852 }
1853
1854 static
1855 bool wxFindWindowCmpNames(const wxWindow *win, const wxString& label,
1856 long WXUNUSED(id))
1857 {
1858 return win->GetName() == label;
1859 }
1860
1861 static
1862 bool wxFindWindowCmpIds(const wxWindow *win, const wxString& WXUNUSED(label),
1863 long id)
1864 {
1865 return win->GetId() == id;
1866 }
1867
1868 // recursive helper for the FindWindowByXXX() functions
1869 static
1870 wxWindow *wxFindWindowRecursively(const wxWindow *parent,
1871 const wxString& label,
1872 long id,
1873 wxFindWindowCmp cmp)
1874 {
1875 if ( parent )
1876 {
1877 // see if this is the one we're looking for
1878 if ( (*cmp)(parent, label, id) )
1879 return (wxWindow *)parent;
1880
1881 // It wasn't, so check all its children
1882 for ( wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
1883 node;
1884 node = node->GetNext() )
1885 {
1886 // recursively check each child
1887 wxWindow *win = (wxWindow *)node->GetData();
1888 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1889 if (retwin)
1890 return retwin;
1891 }
1892 }
1893
1894 // Not found
1895 return NULL;
1896 }
1897
1898 // helper for FindWindowByXXX()
1899 static
1900 wxWindow *wxFindWindowHelper(const wxWindow *parent,
1901 const wxString& label,
1902 long id,
1903 wxFindWindowCmp cmp)
1904 {
1905 if ( parent )
1906 {
1907 // just check parent and all its children
1908 return wxFindWindowRecursively(parent, label, id, cmp);
1909 }
1910
1911 // start at very top of wx's windows
1912 for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1913 node;
1914 node = node->GetNext() )
1915 {
1916 // recursively check each window & its children
1917 wxWindow *win = node->GetData();
1918 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1919 if (retwin)
1920 return retwin;
1921 }
1922
1923 return NULL;
1924 }
1925
1926 /* static */
1927 wxWindow *
1928 wxWindowBase::FindWindowByLabel(const wxString& title, const wxWindow *parent)
1929 {
1930 return wxFindWindowHelper(parent, title, 0, wxFindWindowCmpLabels);
1931 }
1932
1933 /* static */
1934 wxWindow *
1935 wxWindowBase::FindWindowByName(const wxString& title, const wxWindow *parent)
1936 {
1937 wxWindow *win = wxFindWindowHelper(parent, title, 0, wxFindWindowCmpNames);
1938
1939 if ( !win )
1940 {
1941 // fall back to the label
1942 win = FindWindowByLabel(title, parent);
1943 }
1944
1945 return win;
1946 }
1947
1948 /* static */
1949 wxWindow *
1950 wxWindowBase::FindWindowById( long id, const wxWindow* parent )
1951 {
1952 return wxFindWindowHelper(parent, wxEmptyString, id, wxFindWindowCmpIds);
1953 }
1954
1955 // ----------------------------------------------------------------------------
1956 // dialog oriented functions
1957 // ----------------------------------------------------------------------------
1958
1959 #if WXWIN_COMPATIBILITY_2_8
1960 void wxWindowBase::MakeModal(bool modal)
1961 {
1962 // Disable all other windows
1963 if ( IsTopLevel() )
1964 {
1965 wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1966 while (node)
1967 {
1968 wxWindow *win = node->GetData();
1969 if (win != this)
1970 win->Enable(!modal);
1971
1972 node = node->GetNext();
1973 }
1974 }
1975 }
1976 #endif // WXWIN_COMPATIBILITY_2_8
1977
1978 bool wxWindowBase::Validate()
1979 {
1980 #if wxUSE_VALIDATORS
1981 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
1982
1983 wxWindowList::compatibility_iterator node;
1984 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
1985 {
1986 wxWindowBase *child = node->GetData();
1987 wxValidator *validator = child->GetValidator();
1988 if ( validator && !validator->Validate((wxWindow *)this) )
1989 {
1990 return false;
1991 }
1992
1993 if ( recurse && !child->Validate() )
1994 {
1995 return false;
1996 }
1997 }
1998 #endif // wxUSE_VALIDATORS
1999
2000 return true;
2001 }
2002
2003 bool wxWindowBase::TransferDataToWindow()
2004 {
2005 #if wxUSE_VALIDATORS
2006 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
2007
2008 wxWindowList::compatibility_iterator node;
2009 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
2010 {
2011 wxWindowBase *child = node->GetData();
2012 wxValidator *validator = child->GetValidator();
2013 if ( validator && !validator->TransferToWindow() )
2014 {
2015 wxLogWarning(_("Could not transfer data to window"));
2016 #if wxUSE_LOG
2017 wxLog::FlushActive();
2018 #endif // wxUSE_LOG
2019
2020 return false;
2021 }
2022
2023 if ( recurse )
2024 {
2025 if ( !child->TransferDataToWindow() )
2026 {
2027 // warning already given
2028 return false;
2029 }
2030 }
2031 }
2032 #endif // wxUSE_VALIDATORS
2033
2034 return true;
2035 }
2036
2037 bool wxWindowBase::TransferDataFromWindow()
2038 {
2039 #if wxUSE_VALIDATORS
2040 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
2041
2042 wxWindowList::compatibility_iterator node;
2043 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
2044 {
2045 wxWindow *child = node->GetData();
2046 wxValidator *validator = child->GetValidator();
2047 if ( validator && !validator->TransferFromWindow() )
2048 {
2049 // nop warning here because the application is supposed to give
2050 // one itself - we don't know here what might have gone wrongly
2051
2052 return false;
2053 }
2054
2055 if ( recurse )
2056 {
2057 if ( !child->TransferDataFromWindow() )
2058 {
2059 // warning already given
2060 return false;
2061 }
2062 }
2063 }
2064 #endif // wxUSE_VALIDATORS
2065
2066 return true;
2067 }
2068
2069 void wxWindowBase::InitDialog()
2070 {
2071 wxInitDialogEvent event(GetId());
2072 event.SetEventObject( this );
2073 GetEventHandler()->ProcessEvent(event);
2074 }
2075
2076 // ----------------------------------------------------------------------------
2077 // context-sensitive help support
2078 // ----------------------------------------------------------------------------
2079
2080 #if wxUSE_HELP
2081
2082 // associate this help text with this window
2083 void wxWindowBase::SetHelpText(const wxString& text)
2084 {
2085 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2086 if ( helpProvider )
2087 {
2088 helpProvider->AddHelp(this, text);
2089 }
2090 }
2091
2092 #if WXWIN_COMPATIBILITY_2_8
2093 // associate this help text with all windows with the same id as this
2094 // one
2095 void wxWindowBase::SetHelpTextForId(const wxString& text)
2096 {
2097 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2098 if ( helpProvider )
2099 {
2100 helpProvider->AddHelp(GetId(), text);
2101 }
2102 }
2103 #endif // WXWIN_COMPATIBILITY_2_8
2104
2105 // get the help string associated with this window (may be empty)
2106 // default implementation forwards calls to the help provider
2107 wxString
2108 wxWindowBase::GetHelpTextAtPoint(const wxPoint & WXUNUSED(pt),
2109 wxHelpEvent::Origin WXUNUSED(origin)) const
2110 {
2111 wxString text;
2112 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2113 if ( helpProvider )
2114 {
2115 text = helpProvider->GetHelp(this);
2116 }
2117
2118 return text;
2119 }
2120
2121 // show help for this window
2122 void wxWindowBase::OnHelp(wxHelpEvent& event)
2123 {
2124 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2125 if ( helpProvider )
2126 {
2127 wxPoint pos = event.GetPosition();
2128 const wxHelpEvent::Origin origin = event.GetOrigin();
2129 if ( origin == wxHelpEvent::Origin_Keyboard )
2130 {
2131 // if the help event was generated from keyboard it shouldn't
2132 // appear at the mouse position (which is still the only position
2133 // associated with help event) if the mouse is far away, although
2134 // we still do use the mouse position if it's over the window
2135 // because we suppose the user looks approximately at the mouse
2136 // already and so it would be more convenient than showing tooltip
2137 // at some arbitrary position which can be quite far from it
2138 const wxRect rectClient = GetClientRect();
2139 if ( !rectClient.Contains(ScreenToClient(pos)) )
2140 {
2141 // position help slightly under and to the right of this window
2142 pos = ClientToScreen(wxPoint(
2143 2*GetCharWidth(),
2144 rectClient.height + GetCharHeight()
2145 ));
2146 }
2147 }
2148
2149 if ( helpProvider->ShowHelpAtPoint(this, pos, origin) )
2150 {
2151 // skip the event.Skip() below
2152 return;
2153 }
2154 }
2155
2156 event.Skip();
2157 }
2158
2159 #endif // wxUSE_HELP
2160
2161 // ----------------------------------------------------------------------------
2162 // tooltips
2163 // ----------------------------------------------------------------------------
2164
2165 #if wxUSE_TOOLTIPS
2166
2167 wxString wxWindowBase::GetToolTipText() const
2168 {
2169 return m_tooltip ? m_tooltip->GetTip() : wxString();
2170 }
2171
2172 void wxWindowBase::SetToolTip( const wxString &tip )
2173 {
2174 // don't create the new tooltip if we already have one
2175 if ( m_tooltip )
2176 {
2177 m_tooltip->SetTip( tip );
2178 }
2179 else
2180 {
2181 SetToolTip( new wxToolTip( tip ) );
2182 }
2183
2184 // setting empty tooltip text does not remove the tooltip any more - use
2185 // SetToolTip(NULL) for this
2186 }
2187
2188 void wxWindowBase::DoSetToolTip(wxToolTip *tooltip)
2189 {
2190 if ( m_tooltip != tooltip )
2191 {
2192 if ( m_tooltip )
2193 delete m_tooltip;
2194
2195 m_tooltip = tooltip;
2196 }
2197 }
2198
2199 bool wxWindowBase::CopyToolTip(wxToolTip *tip)
2200 {
2201 SetToolTip(tip ? new wxToolTip(tip->GetTip()) : NULL);
2202
2203 return tip != NULL;
2204 }
2205
2206 #endif // wxUSE_TOOLTIPS
2207
2208 // ----------------------------------------------------------------------------
2209 // constraints and sizers
2210 // ----------------------------------------------------------------------------
2211
2212 #if wxUSE_CONSTRAINTS
2213
2214 void wxWindowBase::SetConstraints( wxLayoutConstraints *constraints )
2215 {
2216 if ( m_constraints )
2217 {
2218 UnsetConstraints(m_constraints);
2219 delete m_constraints;
2220 }
2221 m_constraints = constraints;
2222 if ( m_constraints )
2223 {
2224 // Make sure other windows know they're part of a 'meaningful relationship'
2225 if ( m_constraints->left.GetOtherWindow() && (m_constraints->left.GetOtherWindow() != this) )
2226 m_constraints->left.GetOtherWindow()->AddConstraintReference(this);
2227 if ( m_constraints->top.GetOtherWindow() && (m_constraints->top.GetOtherWindow() != this) )
2228 m_constraints->top.GetOtherWindow()->AddConstraintReference(this);
2229 if ( m_constraints->right.GetOtherWindow() && (m_constraints->right.GetOtherWindow() != this) )
2230 m_constraints->right.GetOtherWindow()->AddConstraintReference(this);
2231 if ( m_constraints->bottom.GetOtherWindow() && (m_constraints->bottom.GetOtherWindow() != this) )
2232 m_constraints->bottom.GetOtherWindow()->AddConstraintReference(this);
2233 if ( m_constraints->width.GetOtherWindow() && (m_constraints->width.GetOtherWindow() != this) )
2234 m_constraints->width.GetOtherWindow()->AddConstraintReference(this);
2235 if ( m_constraints->height.GetOtherWindow() && (m_constraints->height.GetOtherWindow() != this) )
2236 m_constraints->height.GetOtherWindow()->AddConstraintReference(this);
2237 if ( m_constraints->centreX.GetOtherWindow() && (m_constraints->centreX.GetOtherWindow() != this) )
2238 m_constraints->centreX.GetOtherWindow()->AddConstraintReference(this);
2239 if ( m_constraints->centreY.GetOtherWindow() && (m_constraints->centreY.GetOtherWindow() != this) )
2240 m_constraints->centreY.GetOtherWindow()->AddConstraintReference(this);
2241 }
2242 }
2243
2244 // This removes any dangling pointers to this window in other windows'
2245 // constraintsInvolvedIn lists.
2246 void wxWindowBase::UnsetConstraints(wxLayoutConstraints *c)
2247 {
2248 if ( c )
2249 {
2250 if ( c->left.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2251 c->left.GetOtherWindow()->RemoveConstraintReference(this);
2252 if ( c->top.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2253 c->top.GetOtherWindow()->RemoveConstraintReference(this);
2254 if ( c->right.GetOtherWindow() && (c->right.GetOtherWindow() != this) )
2255 c->right.GetOtherWindow()->RemoveConstraintReference(this);
2256 if ( c->bottom.GetOtherWindow() && (c->bottom.GetOtherWindow() != this) )
2257 c->bottom.GetOtherWindow()->RemoveConstraintReference(this);
2258 if ( c->width.GetOtherWindow() && (c->width.GetOtherWindow() != this) )
2259 c->width.GetOtherWindow()->RemoveConstraintReference(this);
2260 if ( c->height.GetOtherWindow() && (c->height.GetOtherWindow() != this) )
2261 c->height.GetOtherWindow()->RemoveConstraintReference(this);
2262 if ( c->centreX.GetOtherWindow() && (c->centreX.GetOtherWindow() != this) )
2263 c->centreX.GetOtherWindow()->RemoveConstraintReference(this);
2264 if ( c->centreY.GetOtherWindow() && (c->centreY.GetOtherWindow() != this) )
2265 c->centreY.GetOtherWindow()->RemoveConstraintReference(this);
2266 }
2267 }
2268
2269 // Back-pointer to other windows we're involved with, so if we delete this
2270 // window, we must delete any constraints we're involved with.
2271 void wxWindowBase::AddConstraintReference(wxWindowBase *otherWin)
2272 {
2273 if ( !m_constraintsInvolvedIn )
2274 m_constraintsInvolvedIn = new wxWindowList;
2275 if ( !m_constraintsInvolvedIn->Find((wxWindow *)otherWin) )
2276 m_constraintsInvolvedIn->Append((wxWindow *)otherWin);
2277 }
2278
2279 // REMOVE back-pointer to other windows we're involved with.
2280 void wxWindowBase::RemoveConstraintReference(wxWindowBase *otherWin)
2281 {
2282 if ( m_constraintsInvolvedIn )
2283 m_constraintsInvolvedIn->DeleteObject((wxWindow *)otherWin);
2284 }
2285
2286 // Reset any constraints that mention this window
2287 void wxWindowBase::DeleteRelatedConstraints()
2288 {
2289 if ( m_constraintsInvolvedIn )
2290 {
2291 wxWindowList::compatibility_iterator node = m_constraintsInvolvedIn->GetFirst();
2292 while (node)
2293 {
2294 wxWindow *win = node->GetData();
2295 wxLayoutConstraints *constr = win->GetConstraints();
2296
2297 // Reset any constraints involving this window
2298 if ( constr )
2299 {
2300 constr->left.ResetIfWin(this);
2301 constr->top.ResetIfWin(this);
2302 constr->right.ResetIfWin(this);
2303 constr->bottom.ResetIfWin(this);
2304 constr->width.ResetIfWin(this);
2305 constr->height.ResetIfWin(this);
2306 constr->centreX.ResetIfWin(this);
2307 constr->centreY.ResetIfWin(this);
2308 }
2309
2310 wxWindowList::compatibility_iterator next = node->GetNext();
2311 m_constraintsInvolvedIn->Erase(node);
2312 node = next;
2313 }
2314
2315 wxDELETE(m_constraintsInvolvedIn);
2316 }
2317 }
2318
2319 #endif // wxUSE_CONSTRAINTS
2320
2321 void wxWindowBase::SetSizer(wxSizer *sizer, bool deleteOld)
2322 {
2323 if ( sizer == m_windowSizer)
2324 return;
2325
2326 if ( m_windowSizer )
2327 {
2328 m_windowSizer->SetContainingWindow(NULL);
2329
2330 if ( deleteOld )
2331 delete m_windowSizer;
2332 }
2333
2334 m_windowSizer = sizer;
2335 if ( m_windowSizer )
2336 {
2337 m_windowSizer->SetContainingWindow((wxWindow *)this);
2338 }
2339
2340 SetAutoLayout(m_windowSizer != NULL);
2341 }
2342
2343 void wxWindowBase::SetSizerAndFit(wxSizer *sizer, bool deleteOld)
2344 {
2345 SetSizer( sizer, deleteOld );
2346 sizer->SetSizeHints( (wxWindow*) this );
2347 }
2348
2349
2350 void wxWindowBase::SetContainingSizer(wxSizer* sizer)
2351 {
2352 // adding a window to a sizer twice is going to result in fatal and
2353 // hard to debug problems later because when deleting the second
2354 // associated wxSizerItem we're going to dereference a dangling
2355 // pointer; so try to detect this as early as possible
2356 wxASSERT_MSG( !sizer || m_containingSizer != sizer,
2357 wxT("Adding a window to the same sizer twice?") );
2358
2359 m_containingSizer = sizer;
2360 }
2361
2362 #if wxUSE_CONSTRAINTS
2363
2364 void wxWindowBase::SatisfyConstraints()
2365 {
2366 wxLayoutConstraints *constr = GetConstraints();
2367 bool wasOk = constr && constr->AreSatisfied();
2368
2369 ResetConstraints(); // Mark all constraints as unevaluated
2370
2371 int noChanges = 1;
2372
2373 // if we're a top level panel (i.e. our parent is frame/dialog), our
2374 // own constraints will never be satisfied any more unless we do it
2375 // here
2376 if ( wasOk )
2377 {
2378 while ( noChanges > 0 )
2379 {
2380 LayoutPhase1(&noChanges);
2381 }
2382 }
2383
2384 LayoutPhase2(&noChanges);
2385 }
2386
2387 #endif // wxUSE_CONSTRAINTS
2388
2389 bool wxWindowBase::Layout()
2390 {
2391 // If there is a sizer, use it instead of the constraints
2392 if ( GetSizer() )
2393 {
2394 int w = 0, h = 0;
2395 GetVirtualSize(&w, &h);
2396 GetSizer()->SetDimension( 0, 0, w, h );
2397 }
2398 #if wxUSE_CONSTRAINTS
2399 else
2400 {
2401 SatisfyConstraints(); // Find the right constraints values
2402 SetConstraintSizes(); // Recursively set the real window sizes
2403 }
2404 #endif
2405
2406 return true;
2407 }
2408
2409 void wxWindowBase::InternalOnSize(wxSizeEvent& event)
2410 {
2411 if ( GetAutoLayout() )
2412 Layout();
2413
2414 event.Skip();
2415 }
2416
2417 #if wxUSE_CONSTRAINTS
2418
2419 // first phase of the constraints evaluation: set our own constraints
2420 bool wxWindowBase::LayoutPhase1(int *noChanges)
2421 {
2422 wxLayoutConstraints *constr = GetConstraints();
2423
2424 return !constr || constr->SatisfyConstraints(this, noChanges);
2425 }
2426
2427 // second phase: set the constraints for our children
2428 bool wxWindowBase::LayoutPhase2(int *noChanges)
2429 {
2430 *noChanges = 0;
2431
2432 // Layout children
2433 DoPhase(1);
2434
2435 // Layout grand children
2436 DoPhase(2);
2437
2438 return true;
2439 }
2440
2441 // Do a phase of evaluating child constraints
2442 bool wxWindowBase::DoPhase(int phase)
2443 {
2444 // the list containing the children for which the constraints are already
2445 // set correctly
2446 wxWindowList succeeded;
2447
2448 // the max number of iterations we loop before concluding that we can't set
2449 // the constraints
2450 static const int maxIterations = 500;
2451
2452 for ( int noIterations = 0; noIterations < maxIterations; noIterations++ )
2453 {
2454 int noChanges = 0;
2455
2456 // loop over all children setting their constraints
2457 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2458 node;
2459 node = node->GetNext() )
2460 {
2461 wxWindow *child = node->GetData();
2462 if ( child->IsTopLevel() )
2463 {
2464 // top level children are not inside our client area
2465 continue;
2466 }
2467
2468 if ( !child->GetConstraints() || succeeded.Find(child) )
2469 {
2470 // this one is either already ok or nothing we can do about it
2471 continue;
2472 }
2473
2474 int tempNoChanges = 0;
2475 bool success = phase == 1 ? child->LayoutPhase1(&tempNoChanges)
2476 : child->LayoutPhase2(&tempNoChanges);
2477 noChanges += tempNoChanges;
2478
2479 if ( success )
2480 {
2481 succeeded.Append(child);
2482 }
2483 }
2484
2485 if ( !noChanges )
2486 {
2487 // constraints are set
2488 break;
2489 }
2490 }
2491
2492 return true;
2493 }
2494
2495 void wxWindowBase::ResetConstraints()
2496 {
2497 wxLayoutConstraints *constr = GetConstraints();
2498 if ( constr )
2499 {
2500 constr->left.SetDone(false);
2501 constr->top.SetDone(false);
2502 constr->right.SetDone(false);
2503 constr->bottom.SetDone(false);
2504 constr->width.SetDone(false);
2505 constr->height.SetDone(false);
2506 constr->centreX.SetDone(false);
2507 constr->centreY.SetDone(false);
2508 }
2509
2510 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2511 while (node)
2512 {
2513 wxWindow *win = node->GetData();
2514 if ( !win->IsTopLevel() )
2515 win->ResetConstraints();
2516 node = node->GetNext();
2517 }
2518 }
2519
2520 // Need to distinguish between setting the 'fake' size for windows and sizers,
2521 // and setting the real values.
2522 void wxWindowBase::SetConstraintSizes(bool recurse)
2523 {
2524 wxLayoutConstraints *constr = GetConstraints();
2525 if ( constr && constr->AreSatisfied() )
2526 {
2527 int x = constr->left.GetValue();
2528 int y = constr->top.GetValue();
2529 int w = constr->width.GetValue();
2530 int h = constr->height.GetValue();
2531
2532 if ( (constr->width.GetRelationship() != wxAsIs ) ||
2533 (constr->height.GetRelationship() != wxAsIs) )
2534 {
2535 // We really shouldn't set negative sizes for the windows so make
2536 // them at least of 1*1 size
2537 SetSize(x, y, w > 0 ? w : 1, h > 0 ? h : 1);
2538 }
2539 else
2540 {
2541 // If we don't want to resize this window, just move it...
2542 Move(x, y);
2543 }
2544 }
2545 else if ( constr )
2546 {
2547 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2548 GetClassInfo()->GetClassName(),
2549 GetName().c_str());
2550 }
2551
2552 if ( recurse )
2553 {
2554 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2555 while (node)
2556 {
2557 wxWindow *win = node->GetData();
2558 if ( !win->IsTopLevel() && win->GetConstraints() )
2559 win->SetConstraintSizes();
2560 node = node->GetNext();
2561 }
2562 }
2563 }
2564
2565 // Only set the size/position of the constraint (if any)
2566 void wxWindowBase::SetSizeConstraint(int x, int y, int w, int h)
2567 {
2568 wxLayoutConstraints *constr = GetConstraints();
2569 if ( constr )
2570 {
2571 if ( x != wxDefaultCoord )
2572 {
2573 constr->left.SetValue(x);
2574 constr->left.SetDone(true);
2575 }
2576 if ( y != wxDefaultCoord )
2577 {
2578 constr->top.SetValue(y);
2579 constr->top.SetDone(true);
2580 }
2581 if ( w != wxDefaultCoord )
2582 {
2583 constr->width.SetValue(w);
2584 constr->width.SetDone(true);
2585 }
2586 if ( h != wxDefaultCoord )
2587 {
2588 constr->height.SetValue(h);
2589 constr->height.SetDone(true);
2590 }
2591 }
2592 }
2593
2594 void wxWindowBase::MoveConstraint(int x, int y)
2595 {
2596 wxLayoutConstraints *constr = GetConstraints();
2597 if ( constr )
2598 {
2599 if ( x != wxDefaultCoord )
2600 {
2601 constr->left.SetValue(x);
2602 constr->left.SetDone(true);
2603 }
2604 if ( y != wxDefaultCoord )
2605 {
2606 constr->top.SetValue(y);
2607 constr->top.SetDone(true);
2608 }
2609 }
2610 }
2611
2612 void wxWindowBase::GetSizeConstraint(int *w, int *h) const
2613 {
2614 wxLayoutConstraints *constr = GetConstraints();
2615 if ( constr )
2616 {
2617 *w = constr->width.GetValue();
2618 *h = constr->height.GetValue();
2619 }
2620 else
2621 GetSize(w, h);
2622 }
2623
2624 void wxWindowBase::GetClientSizeConstraint(int *w, int *h) const
2625 {
2626 wxLayoutConstraints *constr = GetConstraints();
2627 if ( constr )
2628 {
2629 *w = constr->width.GetValue();
2630 *h = constr->height.GetValue();
2631 }
2632 else
2633 GetClientSize(w, h);
2634 }
2635
2636 void wxWindowBase::GetPositionConstraint(int *x, int *y) const
2637 {
2638 wxLayoutConstraints *constr = GetConstraints();
2639 if ( constr )
2640 {
2641 *x = constr->left.GetValue();
2642 *y = constr->top.GetValue();
2643 }
2644 else
2645 GetPosition(x, y);
2646 }
2647
2648 #endif // wxUSE_CONSTRAINTS
2649
2650 void wxWindowBase::AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const
2651 {
2652 wxWindow *parent = GetParent();
2653 if ( !(sizeFlags & wxSIZE_NO_ADJUSTMENTS) && parent )
2654 {
2655 wxPoint pt(parent->GetClientAreaOrigin());
2656 x += pt.x;
2657 y += pt.y;
2658 }
2659 }
2660
2661 // ----------------------------------------------------------------------------
2662 // Update UI processing
2663 // ----------------------------------------------------------------------------
2664
2665 void wxWindowBase::UpdateWindowUI(long flags)
2666 {
2667 wxUpdateUIEvent event(GetId());
2668 event.SetEventObject(this);
2669
2670 if ( GetEventHandler()->ProcessEvent(event) )
2671 {
2672 DoUpdateWindowUI(event);
2673 }
2674
2675 if (flags & wxUPDATE_UI_RECURSE)
2676 {
2677 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2678 while (node)
2679 {
2680 wxWindow* child = (wxWindow*) node->GetData();
2681 child->UpdateWindowUI(flags);
2682 node = node->GetNext();
2683 }
2684 }
2685 }
2686
2687 // do the window-specific processing after processing the update event
2688 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
2689 {
2690 if ( event.GetSetEnabled() )
2691 Enable(event.GetEnabled());
2692
2693 if ( event.GetSetShown() )
2694 Show(event.GetShown());
2695 }
2696
2697 // ----------------------------------------------------------------------------
2698 // Idle processing
2699 // ----------------------------------------------------------------------------
2700
2701 // Send idle event to window and all subwindows
2702 bool wxWindowBase::SendIdleEvents(wxIdleEvent& event)
2703 {
2704 bool needMore = false;
2705
2706 OnInternalIdle();
2707
2708 // should we send idle event to this window?
2709 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
2710 HasExtraStyle(wxWS_EX_PROCESS_IDLE))
2711 {
2712 event.SetEventObject(this);
2713 HandleWindowEvent(event);
2714
2715 if (event.MoreRequested())
2716 needMore = true;
2717 }
2718 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2719 for (; node; node = node->GetNext())
2720 {
2721 wxWindow* child = node->GetData();
2722 if (child->SendIdleEvents(event))
2723 needMore = true;
2724 }
2725
2726 return needMore;
2727 }
2728
2729 void wxWindowBase::OnInternalIdle()
2730 {
2731 if ( wxUpdateUIEvent::CanUpdate(this) )
2732 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
2733 }
2734
2735 // ----------------------------------------------------------------------------
2736 // dialog units translations
2737 // ----------------------------------------------------------------------------
2738
2739 // Windows' computes dialog units using average character width over upper-
2740 // and lower-case ASCII alphabet and not using the average character width
2741 // metadata stored in the font; see
2742 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2743 // It's important that we perform the conversion in identical way, because
2744 // dialog units natively exist only on Windows and Windows HIG is expressed
2745 // using them.
2746 wxSize wxWindowBase::GetDlgUnitBase() const
2747 {
2748 const wxWindowBase * const parent = wxGetTopLevelParent((wxWindow*)this);
2749
2750 if ( !parent->m_font.IsOk() )
2751 {
2752 // Default GUI font is used. This is the most common case, so
2753 // cache the results.
2754 static wxSize s_defFontSize;
2755 if ( s_defFontSize.x == 0 )
2756 s_defFontSize = wxPrivate::GetAverageASCIILetterSize(*parent);
2757 return s_defFontSize;
2758 }
2759 else
2760 {
2761 // Custom font, we always need to compute the result
2762 return wxPrivate::GetAverageASCIILetterSize(*parent);
2763 }
2764 }
2765
2766 wxPoint wxWindowBase::ConvertPixelsToDialog(const wxPoint& pt) const
2767 {
2768 const wxSize base = GetDlgUnitBase();
2769
2770 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2771
2772 wxPoint pt2 = wxDefaultPosition;
2773 if (pt.x != wxDefaultCoord)
2774 pt2.x = wxMulDivInt32(pt.x, 4, base.x);
2775 if (pt.y != wxDefaultCoord)
2776 pt2.y = wxMulDivInt32(pt.y, 8, base.y);
2777
2778 return pt2;
2779 }
2780
2781 wxPoint wxWindowBase::ConvertDialogToPixels(const wxPoint& pt) const
2782 {
2783 const wxSize base = GetDlgUnitBase();
2784
2785 wxPoint pt2 = wxDefaultPosition;
2786 if (pt.x != wxDefaultCoord)
2787 pt2.x = wxMulDivInt32(pt.x, base.x, 4);
2788 if (pt.y != wxDefaultCoord)
2789 pt2.y = wxMulDivInt32(pt.y, base.y, 8);
2790
2791 return pt2;
2792 }
2793
2794 // ----------------------------------------------------------------------------
2795 // event handlers
2796 // ----------------------------------------------------------------------------
2797
2798 // propagate the colour change event to the subwindows
2799 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
2800 {
2801 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2802 while ( node )
2803 {
2804 // Only propagate to non-top-level windows
2805 wxWindow *win = node->GetData();
2806 if ( !win->IsTopLevel() )
2807 {
2808 wxSysColourChangedEvent event2;
2809 event2.SetEventObject(win);
2810 win->GetEventHandler()->ProcessEvent(event2);
2811 }
2812
2813 node = node->GetNext();
2814 }
2815
2816 Refresh();
2817 }
2818
2819 // the default action is to populate dialog with data when it's created,
2820 // and nudge the UI into displaying itself correctly in case
2821 // we've turned the wxUpdateUIEvents frequency down low.
2822 void wxWindowBase::OnInitDialog( wxInitDialogEvent &WXUNUSED(event) )
2823 {
2824 TransferDataToWindow();
2825
2826 // Update the UI at this point
2827 UpdateWindowUI(wxUPDATE_UI_RECURSE);
2828 }
2829
2830 // ----------------------------------------------------------------------------
2831 // menu-related functions
2832 // ----------------------------------------------------------------------------
2833
2834 #if wxUSE_MENUS
2835
2836 bool wxWindowBase::PopupMenu(wxMenu *menu, int x, int y)
2837 {
2838 wxCHECK_MSG( menu, false, "can't popup NULL menu" );
2839
2840 wxMenuInvokingWindowSetter
2841 setInvokingWin(*menu, static_cast<wxWindow *>(this));
2842
2843 wxCurrentPopupMenu = menu;
2844 const bool rc = DoPopupMenu(menu, x, y);
2845 wxCurrentPopupMenu = NULL;
2846
2847 return rc;
2848 }
2849
2850 // this is used to pass the id of the selected item from the menu event handler
2851 // to the main function itself
2852 //
2853 // it's ok to use a global here as there can be at most one popup menu shown at
2854 // any time
2855 static int gs_popupMenuSelection = wxID_NONE;
2856
2857 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent& event)
2858 {
2859 // store the id in a global variable where we'll retrieve it from later
2860 gs_popupMenuSelection = event.GetId();
2861 }
2862
2863 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent& WXUNUSED(event))
2864 {
2865 // nothing to do but do not skip it
2866 }
2867
2868 int
2869 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y)
2870 {
2871 gs_popupMenuSelection = wxID_NONE;
2872
2873 Connect(wxEVT_COMMAND_MENU_SELECTED,
2874 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2875 NULL,
2876 this);
2877
2878 // it is common to construct the menu passed to this function dynamically
2879 // using some fixed range of ids which could clash with the ids used
2880 // elsewhere in the program, which could result in some menu items being
2881 // unintentionally disabled or otherwise modified by update UI handlers
2882 // elsewhere in the program code and this is difficult to avoid in the
2883 // program itself, so instead we just temporarily suspend UI updating while
2884 // this menu is shown
2885 Connect(wxEVT_UPDATE_UI,
2886 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2887 NULL,
2888 this);
2889
2890 PopupMenu(&menu, x, y);
2891
2892 Disconnect(wxEVT_UPDATE_UI,
2893 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2894 NULL,
2895 this);
2896 Disconnect(wxEVT_COMMAND_MENU_SELECTED,
2897 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2898 NULL,
2899 this);
2900
2901 return gs_popupMenuSelection;
2902 }
2903
2904 #endif // wxUSE_MENUS
2905
2906 // methods for drawing the sizers in a visible way: this is currently only
2907 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2908 // that well and also because we don't want to leave it enabled in default
2909 // builds used for production
2910 #if wxDEBUG_LEVEL > 1
2911
2912 static void DrawSizers(wxWindowBase *win);
2913
2914 static void DrawBorder(wxWindowBase *win, const wxRect& rect, bool fill, const wxPen* pen)
2915 {
2916 wxClientDC dc((wxWindow *)win);
2917 dc.SetPen(*pen);
2918 dc.SetBrush(fill ? wxBrush(pen->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH) :
2919 *wxTRANSPARENT_BRUSH);
2920 dc.DrawRectangle(rect.Deflate(1, 1));
2921 }
2922
2923 static void DrawSizer(wxWindowBase *win, wxSizer *sizer)
2924 {
2925 const wxSizerItemList& items = sizer->GetChildren();
2926 for ( wxSizerItemList::const_iterator i = items.begin(),
2927 end = items.end();
2928 i != end;
2929 ++i )
2930 {
2931 wxSizerItem *item = *i;
2932 if ( item->IsSizer() )
2933 {
2934 DrawBorder(win, item->GetRect().Deflate(2), false, wxRED_PEN);
2935 DrawSizer(win, item->GetSizer());
2936 }
2937 else if ( item->IsSpacer() )
2938 {
2939 DrawBorder(win, item->GetRect().Deflate(2), true, wxBLUE_PEN);
2940 }
2941 else if ( item->IsWindow() )
2942 {
2943 DrawSizers(item->GetWindow());
2944 }
2945 else
2946 wxFAIL_MSG("inconsistent wxSizerItem status!");
2947 }
2948 }
2949
2950 static void DrawSizers(wxWindowBase *win)
2951 {
2952 DrawBorder(win, win->GetClientSize(), false, wxGREEN_PEN);
2953
2954 wxSizer *sizer = win->GetSizer();
2955 if ( sizer )
2956 {
2957 DrawSizer(win, sizer);
2958 }
2959 else // no sizer, still recurse into the children
2960 {
2961 const wxWindowList& children = win->GetChildren();
2962 for ( wxWindowList::const_iterator i = children.begin(),
2963 end = children.end();
2964 i != end;
2965 ++i )
2966 {
2967 DrawSizers(*i);
2968 }
2969
2970 // show all kind of sizes of this window; see the "window sizing" topic
2971 // overview for more info about the various differences:
2972 wxSize fullSz = win->GetSize();
2973 wxSize clientSz = win->GetClientSize();
2974 wxSize bestSz = win->GetBestSize();
2975 wxSize minSz = win->GetMinSize();
2976 wxSize maxSz = win->GetMaxSize();
2977 wxSize virtualSz = win->GetVirtualSize();
2978
2979 wxMessageOutputDebug dbgout;
2980 dbgout.Printf(
2981 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
2982 win->GetName(),
2983 fullSz.x, fullSz.y,
2984 clientSz.x, clientSz.y,
2985 bestSz.x, bestSz.y,
2986 minSz.x, minSz.y,
2987 maxSz.x, maxSz.y,
2988 virtualSz.x, virtualSz.y);
2989 }
2990 }
2991
2992 #endif // wxDEBUG_LEVEL
2993
2994 // process special middle clicks
2995 void wxWindowBase::OnMiddleClick( wxMouseEvent& event )
2996 {
2997 if ( event.ControlDown() && event.AltDown() )
2998 {
2999 #if wxDEBUG_LEVEL > 1
3000 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3001 if ( event.ShiftDown() )
3002 {
3003 DrawSizers(this);
3004 }
3005 else
3006 #endif // __WXDEBUG__
3007 {
3008 #if wxUSE_MSGDLG
3009 // just Ctrl-Alt-middle click shows information about wx version
3010 ::wxInfoMessageBox((wxWindow*)this);
3011 #endif // wxUSE_MSGDLG
3012 }
3013 }
3014 else
3015 {
3016 event.Skip();
3017 }
3018 }
3019
3020 // ----------------------------------------------------------------------------
3021 // accessibility
3022 // ----------------------------------------------------------------------------
3023
3024 #if wxUSE_ACCESSIBILITY
3025 void wxWindowBase::SetAccessible(wxAccessible* accessible)
3026 {
3027 if (m_accessible && (accessible != m_accessible))
3028 delete m_accessible;
3029 m_accessible = accessible;
3030 if (m_accessible)
3031 m_accessible->SetWindow((wxWindow*) this);
3032 }
3033
3034 // Returns the accessible object, creating if necessary.
3035 wxAccessible* wxWindowBase::GetOrCreateAccessible()
3036 {
3037 if (!m_accessible)
3038 m_accessible = CreateAccessible();
3039 return m_accessible;
3040 }
3041
3042 // Override to create a specific accessible object.
3043 wxAccessible* wxWindowBase::CreateAccessible()
3044 {
3045 return new wxWindowAccessible((wxWindow*) this);
3046 }
3047
3048 #endif
3049
3050 // ----------------------------------------------------------------------------
3051 // list classes implementation
3052 // ----------------------------------------------------------------------------
3053
3054 #if wxUSE_STD_CONTAINERS
3055
3056 #include "wx/listimpl.cpp"
3057 WX_DEFINE_LIST(wxWindowList)
3058
3059 #else // !wxUSE_STD_CONTAINERS
3060
3061 void wxWindowListNode::DeleteData()
3062 {
3063 delete (wxWindow *)GetData();
3064 }
3065
3066 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3067
3068 // ----------------------------------------------------------------------------
3069 // borders
3070 // ----------------------------------------------------------------------------
3071
3072 wxBorder wxWindowBase::GetBorder(long flags) const
3073 {
3074 wxBorder border = (wxBorder)(flags & wxBORDER_MASK);
3075 if ( border == wxBORDER_DEFAULT )
3076 {
3077 border = GetDefaultBorder();
3078 }
3079 else if ( border == wxBORDER_THEME )
3080 {
3081 border = GetDefaultBorderForControl();
3082 }
3083
3084 return border;
3085 }
3086
3087 wxBorder wxWindowBase::GetDefaultBorder() const
3088 {
3089 return wxBORDER_NONE;
3090 }
3091
3092 // ----------------------------------------------------------------------------
3093 // hit testing
3094 // ----------------------------------------------------------------------------
3095
3096 wxHitTest wxWindowBase::DoHitTest(wxCoord x, wxCoord y) const
3097 {
3098 // here we just check if the point is inside the window or not
3099
3100 // check the top and left border first
3101 bool outside = x < 0 || y < 0;
3102 if ( !outside )
3103 {
3104 // check the right and bottom borders too
3105 wxSize size = GetSize();
3106 outside = x >= size.x || y >= size.y;
3107 }
3108
3109 return outside ? wxHT_WINDOW_OUTSIDE : wxHT_WINDOW_INSIDE;
3110 }
3111
3112 // ----------------------------------------------------------------------------
3113 // mouse capture
3114 // ----------------------------------------------------------------------------
3115
3116 struct WXDLLEXPORT wxWindowNext
3117 {
3118 wxWindow *win;
3119 wxWindowNext *next;
3120 } *wxWindowBase::ms_winCaptureNext = NULL;
3121 wxWindow *wxWindowBase::ms_winCaptureCurrent = NULL;
3122 bool wxWindowBase::ms_winCaptureChanging = false;
3123
3124 void wxWindowBase::CaptureMouse()
3125 {
3126 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3127
3128 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive CaptureMouse call?") );
3129
3130 ms_winCaptureChanging = true;
3131
3132 wxWindow *winOld = GetCapture();
3133 if ( winOld )
3134 {
3135 ((wxWindowBase*) winOld)->DoReleaseMouse();
3136
3137 // save it on stack
3138 wxWindowNext *item = new wxWindowNext;
3139 item->win = winOld;
3140 item->next = ms_winCaptureNext;
3141 ms_winCaptureNext = item;
3142 }
3143 //else: no mouse capture to save
3144
3145 DoCaptureMouse();
3146 ms_winCaptureCurrent = (wxWindow*)this;
3147
3148 ms_winCaptureChanging = false;
3149 }
3150
3151 void wxWindowBase::ReleaseMouse()
3152 {
3153 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3154
3155 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive ReleaseMouse call?") );
3156
3157 wxASSERT_MSG( GetCapture() == this,
3158 "attempt to release mouse, but this window hasn't captured it" );
3159 wxASSERT_MSG( ms_winCaptureCurrent == this,
3160 "attempt to release mouse, but this window hasn't captured it" );
3161
3162 ms_winCaptureChanging = true;
3163
3164 DoReleaseMouse();
3165 ms_winCaptureCurrent = NULL;
3166
3167 if ( ms_winCaptureNext )
3168 {
3169 ((wxWindowBase*)ms_winCaptureNext->win)->DoCaptureMouse();
3170 ms_winCaptureCurrent = ms_winCaptureNext->win;
3171
3172 wxWindowNext *item = ms_winCaptureNext;
3173 ms_winCaptureNext = item->next;
3174 delete item;
3175 }
3176 //else: stack is empty, no previous capture
3177
3178 ms_winCaptureChanging = false;
3179
3180 wxLogTrace(wxT("mousecapture"),
3181 (const wxChar *) wxT("After ReleaseMouse() mouse is captured by %p"),
3182 static_cast<void*>(GetCapture()));
3183 }
3184
3185 static void DoNotifyWindowAboutCaptureLost(wxWindow *win)
3186 {
3187 wxMouseCaptureLostEvent event(win->GetId());
3188 event.SetEventObject(win);
3189 if ( !win->GetEventHandler()->ProcessEvent(event) )
3190 {
3191 // windows must handle this event, otherwise the app wouldn't behave
3192 // correctly if it loses capture unexpectedly; see the discussion here:
3193 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3194 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3195 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3196 }
3197 }
3198
3199 /* static */
3200 void wxWindowBase::NotifyCaptureLost()
3201 {
3202 // don't do anything if capture lost was expected, i.e. resulted from
3203 // a wx call to ReleaseMouse or CaptureMouse:
3204 if ( ms_winCaptureChanging )
3205 return;
3206
3207 // if the capture was lost unexpectedly, notify every window that has
3208 // capture (on stack or current) about it and clear the stack:
3209
3210 if ( ms_winCaptureCurrent )
3211 {
3212 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent);
3213 ms_winCaptureCurrent = NULL;
3214 }
3215
3216 while ( ms_winCaptureNext )
3217 {
3218 wxWindowNext *item = ms_winCaptureNext;
3219 ms_winCaptureNext = item->next;
3220
3221 DoNotifyWindowAboutCaptureLost(item->win);
3222
3223 delete item;
3224 }
3225 }
3226
3227 #if wxUSE_HOTKEY
3228
3229 bool
3230 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId),
3231 int WXUNUSED(modifiers),
3232 int WXUNUSED(keycode))
3233 {
3234 // not implemented
3235 return false;
3236 }
3237
3238 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId))
3239 {
3240 // not implemented
3241 return false;
3242 }
3243
3244 #endif // wxUSE_HOTKEY
3245
3246 // ----------------------------------------------------------------------------
3247 // event processing
3248 // ----------------------------------------------------------------------------
3249
3250 bool wxWindowBase::TryBefore(wxEvent& event)
3251 {
3252 #if wxUSE_VALIDATORS
3253 // Can only use the validator of the window which
3254 // is receiving the event
3255 if ( event.GetEventObject() == this )
3256 {
3257 wxValidator * const validator = GetValidator();
3258 if ( validator && validator->ProcessEventLocally(event) )
3259 {
3260 return true;
3261 }
3262 }
3263 #endif // wxUSE_VALIDATORS
3264
3265 return wxEvtHandler::TryBefore(event);
3266 }
3267
3268 bool wxWindowBase::TryAfter(wxEvent& event)
3269 {
3270 // carry on up the parent-child hierarchy if the propagation count hasn't
3271 // reached zero yet
3272 if ( event.ShouldPropagate() )
3273 {
3274 // honour the requests to stop propagation at this window: this is
3275 // used by the dialogs, for example, to prevent processing the events
3276 // from the dialog controls in the parent frame which rarely, if ever,
3277 // makes sense
3278 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
3279 {
3280 wxWindow *parent = GetParent();
3281 if ( parent && !parent->IsBeingDeleted() )
3282 {
3283 wxPropagateOnce propagateOnce(event);
3284
3285 return parent->GetEventHandler()->ProcessEvent(event);
3286 }
3287 }
3288 }
3289
3290 return wxEvtHandler::TryAfter(event);
3291 }
3292
3293 // ----------------------------------------------------------------------------
3294 // window relationships
3295 // ----------------------------------------------------------------------------
3296
3297 wxWindow *wxWindowBase::DoGetSibling(WindowOrder order) const
3298 {
3299 wxCHECK_MSG( GetParent(), NULL,
3300 wxT("GetPrev/NextSibling() don't work for TLWs!") );
3301
3302 wxWindowList& siblings = GetParent()->GetChildren();
3303 wxWindowList::compatibility_iterator i = siblings.Find((wxWindow *)this);
3304 wxCHECK_MSG( i, NULL, wxT("window not a child of its parent?") );
3305
3306 if ( order == OrderBefore )
3307 i = i->GetPrevious();
3308 else // OrderAfter
3309 i = i->GetNext();
3310
3311 return i ? i->GetData() : NULL;
3312 }
3313
3314 // ----------------------------------------------------------------------------
3315 // keyboard navigation
3316 // ----------------------------------------------------------------------------
3317
3318 // Navigates in the specified direction inside this window
3319 bool wxWindowBase::DoNavigateIn(int flags)
3320 {
3321 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3322 // native code doesn't process our wxNavigationKeyEvents anyhow
3323 wxUnusedVar(flags);
3324 return false;
3325 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3326 wxNavigationKeyEvent eventNav;
3327 wxWindow *focused = FindFocus();
3328 eventNav.SetCurrentFocus(focused);
3329 eventNav.SetEventObject(focused);
3330 eventNav.SetFlags(flags);
3331 return GetEventHandler()->ProcessEvent(eventNav);
3332 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3333 }
3334
3335 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent& event)
3336 {
3337 if ( event.GetKeyCode() != WXK_TAB )
3338 return false;
3339
3340 int flags = wxNavigationKeyEvent::FromTab;
3341
3342 if ( event.ShiftDown() )
3343 flags |= wxNavigationKeyEvent::IsBackward;
3344 else
3345 flags |= wxNavigationKeyEvent::IsForward;
3346
3347 if ( event.ControlDown() )
3348 flags |= wxNavigationKeyEvent::WinChange;
3349
3350 Navigate(flags);
3351 return true;
3352 }
3353
3354 void wxWindowBase::DoMoveInTabOrder(wxWindow *win, WindowOrder move)
3355 {
3356 // check that we're not a top level window
3357 wxCHECK_RET( GetParent(),
3358 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3359
3360 // detect the special case when we have nothing to do anyhow and when the
3361 // code below wouldn't work
3362 if ( win == this )
3363 return;
3364
3365 // find the target window in the siblings list
3366 wxWindowList& siblings = GetParent()->GetChildren();
3367 wxWindowList::compatibility_iterator i = siblings.Find(win);
3368 wxCHECK_RET( i, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3369
3370 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3371 // implemented so we can't just move the node around
3372 wxWindow *self = (wxWindow *)this;
3373 siblings.DeleteObject(self);
3374 if ( move == OrderAfter )
3375 {
3376 i = i->GetNext();
3377 }
3378
3379 if ( i )
3380 {
3381 siblings.Insert(i, self);
3382 }
3383 else // OrderAfter and win was the last sibling
3384 {
3385 siblings.Append(self);
3386 }
3387 }
3388
3389 // ----------------------------------------------------------------------------
3390 // focus handling
3391 // ----------------------------------------------------------------------------
3392
3393 /*static*/ wxWindow* wxWindowBase::FindFocus()
3394 {
3395 wxWindowBase *win = DoFindFocus();
3396 return win ? win->GetMainWindowOfCompositeControl() : NULL;
3397 }
3398
3399 bool wxWindowBase::HasFocus() const
3400 {
3401 wxWindowBase* const win = DoFindFocus();
3402 return win &&
3403 (this == win || this == win->GetMainWindowOfCompositeControl());
3404 }
3405
3406 // ----------------------------------------------------------------------------
3407 // drag and drop
3408 // ----------------------------------------------------------------------------
3409
3410 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3411
3412 namespace
3413 {
3414
3415 class DragAcceptFilesTarget : public wxFileDropTarget
3416 {
3417 public:
3418 DragAcceptFilesTarget(wxWindowBase *win) : m_win(win) {}
3419
3420 virtual bool OnDropFiles(wxCoord x, wxCoord y,
3421 const wxArrayString& filenames)
3422 {
3423 wxDropFilesEvent event(wxEVT_DROP_FILES,
3424 filenames.size(),
3425 wxCArrayString(filenames).Release());
3426 event.SetEventObject(m_win);
3427 event.m_pos.x = x;
3428 event.m_pos.y = y;
3429
3430 return m_win->HandleWindowEvent(event);
3431 }
3432
3433 private:
3434 wxWindowBase * const m_win;
3435
3436 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget);
3437 };
3438
3439
3440 } // anonymous namespace
3441
3442 // Generic version of DragAcceptFiles(). It works by installing a simple
3443 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3444 // together with explicit SetDropTarget() calls.
3445 void wxWindowBase::DragAcceptFiles(bool accept)
3446 {
3447 if ( accept )
3448 {
3449 wxASSERT_MSG( !GetDropTarget(),
3450 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3451 SetDropTarget(new DragAcceptFilesTarget(this));
3452 }
3453 else
3454 {
3455 SetDropTarget(NULL);
3456 }
3457 }
3458
3459 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3460
3461 // ----------------------------------------------------------------------------
3462 // global functions
3463 // ----------------------------------------------------------------------------
3464
3465 wxWindow* wxGetTopLevelParent(wxWindow *win)
3466 {
3467 while ( win && !win->IsTopLevel() )
3468 win = win->GetParent();
3469
3470 return win;
3471 }
3472
3473 #if wxUSE_ACCESSIBILITY
3474 // ----------------------------------------------------------------------------
3475 // accessible object for windows
3476 // ----------------------------------------------------------------------------
3477
3478 // Can return either a child object, or an integer
3479 // representing the child element, starting from 1.
3480 wxAccStatus wxWindowAccessible::HitTest(const wxPoint& WXUNUSED(pt), int* WXUNUSED(childId), wxAccessible** WXUNUSED(childObject))
3481 {
3482 wxASSERT( GetWindow() != NULL );
3483 if (!GetWindow())
3484 return wxACC_FAIL;
3485
3486 return wxACC_NOT_IMPLEMENTED;
3487 }
3488
3489 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3490 wxAccStatus wxWindowAccessible::GetLocation(wxRect& rect, int elementId)
3491 {
3492 wxASSERT( GetWindow() != NULL );
3493 if (!GetWindow())
3494 return wxACC_FAIL;
3495
3496 wxWindow* win = NULL;
3497 if (elementId == 0)
3498 {
3499 win = GetWindow();
3500 }
3501 else
3502 {
3503 if (elementId <= (int) GetWindow()->GetChildren().GetCount())
3504 {
3505 win = GetWindow()->GetChildren().Item(elementId-1)->GetData();
3506 }
3507 else
3508 return wxACC_FAIL;
3509 }
3510 if (win)
3511 {
3512 rect = win->GetRect();
3513 if (win->GetParent() && !wxDynamicCast(win, wxTopLevelWindow))
3514 rect.SetPosition(win->GetParent()->ClientToScreen(rect.GetPosition()));
3515 return wxACC_OK;
3516 }
3517
3518 return wxACC_NOT_IMPLEMENTED;
3519 }
3520
3521 // Navigates from fromId to toId/toObject.
3522 wxAccStatus wxWindowAccessible::Navigate(wxNavDir navDir, int fromId,
3523 int* WXUNUSED(toId), wxAccessible** toObject)
3524 {
3525 wxASSERT( GetWindow() != NULL );
3526 if (!GetWindow())
3527 return wxACC_FAIL;
3528
3529 switch (navDir)
3530 {
3531 case wxNAVDIR_FIRSTCHILD:
3532 {
3533 if (GetWindow()->GetChildren().GetCount() == 0)
3534 return wxACC_FALSE;
3535 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetFirst()->GetData();
3536 *toObject = childWindow->GetOrCreateAccessible();
3537
3538 return wxACC_OK;
3539 }
3540 case wxNAVDIR_LASTCHILD:
3541 {
3542 if (GetWindow()->GetChildren().GetCount() == 0)
3543 return wxACC_FALSE;
3544 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetLast()->GetData();
3545 *toObject = childWindow->GetOrCreateAccessible();
3546
3547 return wxACC_OK;
3548 }
3549 case wxNAVDIR_RIGHT:
3550 case wxNAVDIR_DOWN:
3551 case wxNAVDIR_NEXT:
3552 {
3553 wxWindowList::compatibility_iterator node =
3554 wxWindowList::compatibility_iterator();
3555 if (fromId == 0)
3556 {
3557 // Can't navigate to sibling of this window
3558 // if we're a top-level window.
3559 if (!GetWindow()->GetParent())
3560 return wxACC_NOT_IMPLEMENTED;
3561
3562 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3563 }
3564 else
3565 {
3566 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3567 node = GetWindow()->GetChildren().Item(fromId-1);
3568 }
3569
3570 if (node && node->GetNext())
3571 {
3572 wxWindow* nextWindow = node->GetNext()->GetData();
3573 *toObject = nextWindow->GetOrCreateAccessible();
3574 return wxACC_OK;
3575 }
3576 else
3577 return wxACC_FALSE;
3578 }
3579 case wxNAVDIR_LEFT:
3580 case wxNAVDIR_UP:
3581 case wxNAVDIR_PREVIOUS:
3582 {
3583 wxWindowList::compatibility_iterator node =
3584 wxWindowList::compatibility_iterator();
3585 if (fromId == 0)
3586 {
3587 // Can't navigate to sibling of this window
3588 // if we're a top-level window.
3589 if (!GetWindow()->GetParent())
3590 return wxACC_NOT_IMPLEMENTED;
3591
3592 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3593 }
3594 else
3595 {
3596 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3597 node = GetWindow()->GetChildren().Item(fromId-1);
3598 }
3599
3600 if (node && node->GetPrevious())
3601 {
3602 wxWindow* previousWindow = node->GetPrevious()->GetData();
3603 *toObject = previousWindow->GetOrCreateAccessible();
3604 return wxACC_OK;
3605 }
3606 else
3607 return wxACC_FALSE;
3608 }
3609 }
3610
3611 return wxACC_NOT_IMPLEMENTED;
3612 }
3613
3614 // Gets the name of the specified object.
3615 wxAccStatus wxWindowAccessible::GetName(int childId, wxString* name)
3616 {
3617 wxASSERT( GetWindow() != NULL );
3618 if (!GetWindow())
3619 return wxACC_FAIL;
3620
3621 wxString title;
3622
3623 // If a child, leave wxWidgets to call the function on the actual
3624 // child object.
3625 if (childId > 0)
3626 return wxACC_NOT_IMPLEMENTED;
3627
3628 // This will eventually be replaced by specialised
3629 // accessible classes, one for each kind of wxWidgets
3630 // control or window.
3631 #if wxUSE_BUTTON
3632 if (wxDynamicCast(GetWindow(), wxButton))
3633 title = ((wxButton*) GetWindow())->GetLabel();
3634 else
3635 #endif
3636 title = GetWindow()->GetName();
3637
3638 if (!title.empty())
3639 {
3640 *name = title;
3641 return wxACC_OK;
3642 }
3643 else
3644 return wxACC_NOT_IMPLEMENTED;
3645 }
3646
3647 // Gets the number of children.
3648 wxAccStatus wxWindowAccessible::GetChildCount(int* childId)
3649 {
3650 wxASSERT( GetWindow() != NULL );
3651 if (!GetWindow())
3652 return wxACC_FAIL;
3653
3654 *childId = (int) GetWindow()->GetChildren().GetCount();
3655 return wxACC_OK;
3656 }
3657
3658 // Gets the specified child (starting from 1).
3659 // If *child is NULL and return value is wxACC_OK,
3660 // this means that the child is a simple element and
3661 // not an accessible object.
3662 wxAccStatus wxWindowAccessible::GetChild(int childId, wxAccessible** child)
3663 {
3664 wxASSERT( GetWindow() != NULL );
3665 if (!GetWindow())
3666 return wxACC_FAIL;
3667
3668 if (childId == 0)
3669 {
3670 *child = this;
3671 return wxACC_OK;
3672 }
3673
3674 if (childId > (int) GetWindow()->GetChildren().GetCount())
3675 return wxACC_FAIL;
3676
3677 wxWindow* childWindow = GetWindow()->GetChildren().Item(childId-1)->GetData();
3678 *child = childWindow->GetOrCreateAccessible();
3679 if (*child)
3680 return wxACC_OK;
3681 else
3682 return wxACC_FAIL;
3683 }
3684
3685 // Gets the parent, or NULL.
3686 wxAccStatus wxWindowAccessible::GetParent(wxAccessible** parent)
3687 {
3688 wxASSERT( GetWindow() != NULL );
3689 if (!GetWindow())
3690 return wxACC_FAIL;
3691
3692 wxWindow* parentWindow = GetWindow()->GetParent();
3693 if (!parentWindow)
3694 {
3695 *parent = NULL;
3696 return wxACC_OK;
3697 }
3698 else
3699 {
3700 *parent = parentWindow->GetOrCreateAccessible();
3701 if (*parent)
3702 return wxACC_OK;
3703 else
3704 return wxACC_FAIL;
3705 }
3706 }
3707
3708 // Performs the default action. childId is 0 (the action for this object)
3709 // or > 0 (the action for a child).
3710 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3711 // window (e.g. an edit control).
3712 wxAccStatus wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
3713 {
3714 wxASSERT( GetWindow() != NULL );
3715 if (!GetWindow())
3716 return wxACC_FAIL;
3717
3718 return wxACC_NOT_IMPLEMENTED;
3719 }
3720
3721 // Gets the default action for this object (0) or > 0 (the action for a child).
3722 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3723 // string if there is no action.
3724 // The retrieved string describes the action that is performed on an object,
3725 // not what the object does as a result. For example, a toolbar button that prints
3726 // a document has a default action of "Press" rather than "Prints the current document."
3727 wxAccStatus wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId), wxString* WXUNUSED(actionName))
3728 {
3729 wxASSERT( GetWindow() != NULL );
3730 if (!GetWindow())
3731 return wxACC_FAIL;
3732
3733 return wxACC_NOT_IMPLEMENTED;
3734 }
3735
3736 // Returns the description for this object or a child.
3737 wxAccStatus wxWindowAccessible::GetDescription(int WXUNUSED(childId), wxString* description)
3738 {
3739 wxASSERT( GetWindow() != NULL );
3740 if (!GetWindow())
3741 return wxACC_FAIL;
3742
3743 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3744 if (!ht.empty())
3745 {
3746 *description = ht;
3747 return wxACC_OK;
3748 }
3749 return wxACC_NOT_IMPLEMENTED;
3750 }
3751
3752 // Returns help text for this object or a child, similar to tooltip text.
3753 wxAccStatus wxWindowAccessible::GetHelpText(int WXUNUSED(childId), wxString* helpText)
3754 {
3755 wxASSERT( GetWindow() != NULL );
3756 if (!GetWindow())
3757 return wxACC_FAIL;
3758
3759 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3760 if (!ht.empty())
3761 {
3762 *helpText = ht;
3763 return wxACC_OK;
3764 }
3765 return wxACC_NOT_IMPLEMENTED;
3766 }
3767
3768 // Returns the keyboard shortcut for this object or child.
3769 // Return e.g. ALT+K
3770 wxAccStatus wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId), wxString* WXUNUSED(shortcut))
3771 {
3772 wxASSERT( GetWindow() != NULL );
3773 if (!GetWindow())
3774 return wxACC_FAIL;
3775
3776 return wxACC_NOT_IMPLEMENTED;
3777 }
3778
3779 // Returns a role constant.
3780 wxAccStatus wxWindowAccessible::GetRole(int childId, wxAccRole* role)
3781 {
3782 wxASSERT( GetWindow() != NULL );
3783 if (!GetWindow())
3784 return wxACC_FAIL;
3785
3786 // If a child, leave wxWidgets to call the function on the actual
3787 // child object.
3788 if (childId > 0)
3789 return wxACC_NOT_IMPLEMENTED;
3790
3791 if (wxDynamicCast(GetWindow(), wxControl))
3792 return wxACC_NOT_IMPLEMENTED;
3793 #if wxUSE_STATUSBAR
3794 if (wxDynamicCast(GetWindow(), wxStatusBar))
3795 return wxACC_NOT_IMPLEMENTED;
3796 #endif
3797 #if wxUSE_TOOLBAR
3798 if (wxDynamicCast(GetWindow(), wxToolBar))
3799 return wxACC_NOT_IMPLEMENTED;
3800 #endif
3801
3802 //*role = wxROLE_SYSTEM_CLIENT;
3803 *role = wxROLE_SYSTEM_CLIENT;
3804 return wxACC_OK;
3805
3806 #if 0
3807 return wxACC_NOT_IMPLEMENTED;
3808 #endif
3809 }
3810
3811 // Returns a state constant.
3812 wxAccStatus wxWindowAccessible::GetState(int childId, long* state)
3813 {
3814 wxASSERT( GetWindow() != NULL );
3815 if (!GetWindow())
3816 return wxACC_FAIL;
3817
3818 // If a child, leave wxWidgets to call the function on the actual
3819 // child object.
3820 if (childId > 0)
3821 return wxACC_NOT_IMPLEMENTED;
3822
3823 if (wxDynamicCast(GetWindow(), wxControl))
3824 return wxACC_NOT_IMPLEMENTED;
3825
3826 #if wxUSE_STATUSBAR
3827 if (wxDynamicCast(GetWindow(), wxStatusBar))
3828 return wxACC_NOT_IMPLEMENTED;
3829 #endif
3830 #if wxUSE_TOOLBAR
3831 if (wxDynamicCast(GetWindow(), wxToolBar))
3832 return wxACC_NOT_IMPLEMENTED;
3833 #endif
3834
3835 *state = 0;
3836 return wxACC_OK;
3837
3838 #if 0
3839 return wxACC_NOT_IMPLEMENTED;
3840 #endif
3841 }
3842
3843 // Returns a localized string representing the value for the object
3844 // or child.
3845 wxAccStatus wxWindowAccessible::GetValue(int WXUNUSED(childId), wxString* WXUNUSED(strValue))
3846 {
3847 wxASSERT( GetWindow() != NULL );
3848 if (!GetWindow())
3849 return wxACC_FAIL;
3850
3851 return wxACC_NOT_IMPLEMENTED;
3852 }
3853
3854 // Selects the object or child.
3855 wxAccStatus wxWindowAccessible::Select(int WXUNUSED(childId), wxAccSelectionFlags WXUNUSED(selectFlags))
3856 {
3857 wxASSERT( GetWindow() != NULL );
3858 if (!GetWindow())
3859 return wxACC_FAIL;
3860
3861 return wxACC_NOT_IMPLEMENTED;
3862 }
3863
3864 // Gets the window with the keyboard focus.
3865 // If childId is 0 and child is NULL, no object in
3866 // this subhierarchy has the focus.
3867 // If this object has the focus, child should be 'this'.
3868 wxAccStatus wxWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
3869 {
3870 wxASSERT( GetWindow() != NULL );
3871 if (!GetWindow())
3872 return wxACC_FAIL;
3873
3874 return wxACC_NOT_IMPLEMENTED;
3875 }
3876
3877 #if wxUSE_VARIANT
3878 // Gets a variant representing the selected children
3879 // of this object.
3880 // Acceptable values:
3881 // - a null variant (IsNull() returns true)
3882 // - a list variant (GetType() == wxT("list")
3883 // - an integer representing the selected child element,
3884 // or 0 if this object is selected (GetType() == wxT("long")
3885 // - a "void*" pointer to a wxAccessible child object
3886 wxAccStatus wxWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
3887 {
3888 wxASSERT( GetWindow() != NULL );
3889 if (!GetWindow())
3890 return wxACC_FAIL;
3891
3892 return wxACC_NOT_IMPLEMENTED;
3893 }
3894 #endif // wxUSE_VARIANT
3895
3896 #endif // wxUSE_ACCESSIBILITY
3897
3898 // ----------------------------------------------------------------------------
3899 // RTL support
3900 // ----------------------------------------------------------------------------
3901
3902 wxCoord
3903 wxWindowBase::AdjustForLayoutDirection(wxCoord x,
3904 wxCoord width,
3905 wxCoord widthTotal) const
3906 {
3907 if ( GetLayoutDirection() == wxLayout_RightToLeft )
3908 {
3909 x = widthTotal - x - width;
3910 }
3911
3912 return x;
3913 }
3914
3915