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