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