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