]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/common/wincmn.cpp
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Improved wxDCPen/BrushChangers.
[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/statusbr.h"
42 #include "wx/toolbar.h"
43 #include "wx/dcclient.h"
44#endif //WX_PRECOMP
45
46#if defined(__WXMAC__) && wxUSE_SCROLLBAR
47 #include "wx/scrolbar.h"
48#endif
49
50#if wxUSE_CONSTRAINTS
51 #include "wx/layout.h"
52#endif // wxUSE_CONSTRAINTS
53
54#include "wx/sizer.h"
55
56#if wxUSE_DRAG_AND_DROP
57 #include "wx/dnd.h"
58#endif // wxUSE_DRAG_AND_DROP
59
60#if wxUSE_ACCESSIBILITY
61 #include "wx/access.h"
62#endif
63
64#if wxUSE_HELP
65 #include "wx/cshelp.h"
66#endif // wxUSE_HELP
67
68#if wxUSE_TOOLTIPS
69 #include "wx/tooltip.h"
70#endif // wxUSE_TOOLTIPS
71
72#if wxUSE_CARET
73 #include "wx/caret.h"
74#endif // wxUSE_CARET
75
76#if wxUSE_SYSTEM_OPTIONS
77 #include "wx/sysopt.h"
78#endif
79
80// For reporting compile- and runtime version of GTK+ in the ctrl+alt+mclick dialog.
81// The gtk includes don't pull any other headers in, at least not on my system - MR
82#ifdef __WXGTK__
83 #ifdef __WXGTK20__
84 #include <gtk/gtkversion.h>
85 #else
86 #include <gtk/gtkfeatures.h>
87 #endif
88 extern const unsigned int gtk_major_version;
89 extern const unsigned int gtk_minor_version;
90 extern const unsigned int gtk_micro_version;
91#endif
92
93// ----------------------------------------------------------------------------
94// static data
95// ----------------------------------------------------------------------------
96
97#if defined(__WXPALMOS__)
98int wxWindowBase::ms_lastControlId = 32767;
99#elif defined(__WXPM__)
100int wxWindowBase::ms_lastControlId = 2000;
101#else
102int wxWindowBase::ms_lastControlId = -200;
103#endif
104
105IMPLEMENT_ABSTRACT_CLASS(wxWindowBase, wxEvtHandler)
106
107// ----------------------------------------------------------------------------
108// event table
109// ----------------------------------------------------------------------------
110
111BEGIN_EVENT_TABLE(wxWindowBase, wxEvtHandler)
112 EVT_SYS_COLOUR_CHANGED(wxWindowBase::OnSysColourChanged)
113 EVT_INIT_DIALOG(wxWindowBase::OnInitDialog)
114 EVT_MIDDLE_DOWN(wxWindowBase::OnMiddleClick)
115
116#if wxUSE_HELP
117 EVT_HELP(wxID_ANY, wxWindowBase::OnHelp)
118#endif // wxUSE_HELP
119
120END_EVENT_TABLE()
121
122// ============================================================================
123// implementation of the common functionality of the wxWindow class
124// ============================================================================
125
126// ----------------------------------------------------------------------------
127// initialization
128// ----------------------------------------------------------------------------
129
130// the default initialization
131wxWindowBase::wxWindowBase()
132{
133 // no window yet, no parent nor children
134 m_parent = (wxWindow *)NULL;
135 m_windowId = wxID_ANY;
136
137 // no constraints on the minimal window size
138 m_minWidth =
139 m_maxWidth = wxDefaultCoord;
140 m_minHeight =
141 m_maxHeight = wxDefaultCoord;
142
143 // invalidiated cache value
144 m_bestSizeCache = wxDefaultSize;
145
146 // window are created enabled and visible by default
147 m_isShown =
148 m_isEnabled = true;
149
150 // the default event handler is just this window
151 m_eventHandler = this;
152
153#if wxUSE_VALIDATORS
154 // no validator
155 m_windowValidator = (wxValidator *) NULL;
156#endif // wxUSE_VALIDATORS
157
158 // the colours/fonts are default for now, so leave m_font,
159 // m_backgroundColour and m_foregroundColour uninitialized and set those
160 m_hasBgCol =
161 m_hasFgCol =
162 m_hasFont = false;
163 m_inheritBgCol =
164 m_inheritFgCol =
165 m_inheritFont = false;
166
167 // no style bits
168 m_exStyle =
169 m_windowStyle = 0;
170
171 m_backgroundStyle = wxBG_STYLE_SYSTEM;
172
173#if wxUSE_CONSTRAINTS
174 // no constraints whatsoever
175 m_constraints = (wxLayoutConstraints *) NULL;
176 m_constraintsInvolvedIn = (wxWindowList *) NULL;
177#endif // wxUSE_CONSTRAINTS
178
179 m_windowSizer = (wxSizer *) NULL;
180 m_containingSizer = (wxSizer *) NULL;
181 m_autoLayout = false;
182
183#if wxUSE_DRAG_AND_DROP
184 m_dropTarget = (wxDropTarget *)NULL;
185#endif // wxUSE_DRAG_AND_DROP
186
187#if wxUSE_TOOLTIPS
188 m_tooltip = (wxToolTip *)NULL;
189#endif // wxUSE_TOOLTIPS
190
191#if wxUSE_CARET
192 m_caret = (wxCaret *)NULL;
193#endif // wxUSE_CARET
194
195#if wxUSE_PALETTE
196 m_hasCustomPalette = false;
197#endif // wxUSE_PALETTE
198
199#if wxUSE_ACCESSIBILITY
200 m_accessible = NULL;
201#endif
202
203 m_virtualSize = wxDefaultSize;
204
205 m_minVirtualWidth =
206 m_maxVirtualWidth = wxDefaultCoord;
207 m_minVirtualHeight =
208 m_maxVirtualHeight = wxDefaultCoord;
209
210 m_windowVariant = wxWINDOW_VARIANT_NORMAL;
211#if wxUSE_SYSTEM_OPTIONS
212 if ( wxSystemOptions::HasOption(wxWINDOW_DEFAULT_VARIANT) )
213 {
214 m_windowVariant = (wxWindowVariant) wxSystemOptions::GetOptionInt( wxWINDOW_DEFAULT_VARIANT ) ;
215 }
216#endif
217
218 // Whether we're using the current theme for this window (wxGTK only for now)
219 m_themeEnabled = false;
220
221 // VZ: this one shouldn't exist...
222 m_isBeingDeleted = false;
223}
224
225// common part of window creation process
226bool wxWindowBase::CreateBase(wxWindowBase *parent,
227 wxWindowID id,
228 const wxPoint& WXUNUSED(pos),
229 const wxSize& WXUNUSED(size),
230 long style,
231 const wxValidator& wxVALIDATOR_PARAM(validator),
232 const wxString& name)
233{
234#if wxUSE_STATBOX
235 // wxGTK doesn't allow to create controls with static box as the parent so
236 // this will result in a crash when the program is ported to wxGTK so warn
237 // the user about it
238
239 // if you get this assert, the correct solution is to create the controls
240 // as siblings of the static box
241 wxASSERT_MSG( !parent || !wxDynamicCast(parent, wxStaticBox),
242 _T("wxStaticBox can't be used as a window parent!") );
243#endif // wxUSE_STATBOX
244
245 // ids are limited to 16 bits under MSW so if you care about portability,
246 // it's not a good idea to use ids out of this range (and negative ids are
247 // reserved for wxWidgets own usage)
248 wxASSERT_MSG( id == wxID_ANY || (id >= 0 && id < 32767),
249 _T("invalid id value") );
250
251 // generate a new id if the user doesn't care about it
252 m_windowId = id == wxID_ANY ? NewControlId() : id;
253
254 SetName(name);
255 SetWindowStyleFlag(style);
256 SetParent(parent);
257
258#if wxUSE_VALIDATORS
259 SetValidator(validator);
260#endif // wxUSE_VALIDATORS
261
262 // if the parent window has wxWS_EX_VALIDATE_RECURSIVELY set, we want to
263 // have it too - like this it's possible to set it only in the top level
264 // dialog/frame and all children will inherit it by defult
265 if ( parent && (parent->GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) )
266 {
267 SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY);
268 }
269
270 return true;
271}
272
273// ----------------------------------------------------------------------------
274// destruction
275// ----------------------------------------------------------------------------
276
277// common clean up
278wxWindowBase::~wxWindowBase()
279{
280 wxASSERT_MSG( GetCapture() != this, wxT("attempt to destroy window with mouse capture") );
281
282 // FIXME if these 2 cases result from programming errors in the user code
283 // we should probably assert here instead of silently fixing them
284
285 // Just in case the window has been Closed, but we're then deleting
286 // immediately: don't leave dangling pointers.
287 wxPendingDelete.DeleteObject(this);
288
289 // Just in case we've loaded a top-level window via LoadNativeDialog but
290 // we weren't a dialog class
291 wxTopLevelWindows.DeleteObject((wxWindow*)this);
292
293 wxASSERT_MSG( GetChildren().GetCount() == 0, wxT("children not destroyed") );
294
295 // reset the dangling pointer our parent window may keep to us
296 if ( m_parent )
297 {
298 if ( m_parent->GetDefaultItem() == this )
299 {
300 m_parent->SetDefaultItem(NULL);
301 }
302
303 m_parent->RemoveChild(this);
304 }
305
306#if wxUSE_CARET
307 delete m_caret;
308#endif // wxUSE_CARET
309
310#if wxUSE_VALIDATORS
311 delete m_windowValidator;
312#endif // wxUSE_VALIDATORS
313
314#if wxUSE_CONSTRAINTS
315 // Have to delete constraints/sizer FIRST otherwise sizers may try to look
316 // at deleted windows as they delete themselves.
317 DeleteRelatedConstraints();
318
319 if ( m_constraints )
320 {
321 // This removes any dangling pointers to this window in other windows'
322 // constraintsInvolvedIn lists.
323 UnsetConstraints(m_constraints);
324 delete m_constraints;
325 m_constraints = NULL;
326 }
327#endif // wxUSE_CONSTRAINTS
328
329 if ( m_containingSizer )
330 m_containingSizer->Detach( (wxWindow*)this );
331
332 delete m_windowSizer;
333
334#if wxUSE_DRAG_AND_DROP
335 delete m_dropTarget;
336#endif // wxUSE_DRAG_AND_DROP
337
338#if wxUSE_TOOLTIPS
339 delete m_tooltip;
340#endif // wxUSE_TOOLTIPS
341
342#if wxUSE_ACCESSIBILITY
343 delete m_accessible;
344#endif
345}
346
347bool wxWindowBase::Destroy()
348{
349 delete this;
350
351 return true;
352}
353
354bool wxWindowBase::Close(bool force)
355{
356 wxCloseEvent event(wxEVT_CLOSE_WINDOW, m_windowId);
357 event.SetEventObject(this);
358 event.SetCanVeto(!force);
359
360 // return false if window wasn't closed because the application vetoed the
361 // close event
362 return GetEventHandler()->ProcessEvent(event) && !event.GetVeto();
363}
364
365bool wxWindowBase::DestroyChildren()
366{
367 wxWindowList::compatibility_iterator node;
368 for ( ;; )
369 {
370 // we iterate until the list becomes empty
371 node = GetChildren().GetFirst();
372 if ( !node )
373 break;
374
375 wxWindow *child = node->GetData();
376
377 // note that we really want to call delete and not ->Destroy() here
378 // because we want to delete the child immediately, before we are
379 // deleted, and delayed deletion would result in problems as our (top
380 // level) child could outlive its parent
381 delete child;
382
383 wxASSERT_MSG( !GetChildren().Find(child),
384 wxT("child didn't remove itself using RemoveChild()") );
385 }
386
387 return true;
388}
389
390// ----------------------------------------------------------------------------
391// size/position related methods
392// ----------------------------------------------------------------------------
393
394// centre the window with respect to its parent in either (or both) directions
395void wxWindowBase::DoCentre(int dir)
396{
397 wxCHECK_RET( !(dir & wxCENTRE_ON_SCREEN) && GetParent(),
398 _T("this method only implements centering child windows") );
399
400 SetSize(GetRect().CentreIn(GetParent()->GetClientSize(), dir));
401}
402
403// fits the window around the children
404void wxWindowBase::Fit()
405{
406 if ( !GetChildren().empty() )
407 {
408 SetClientSize(GetBestSize());
409 }
410 //else: do nothing if we have no children
411}
412
413// fits virtual size (ie. scrolled area etc.) around children
414void wxWindowBase::FitInside()
415{
416 if ( GetChildren().GetCount() > 0 )
417 {
418 SetVirtualSize( GetBestVirtualSize() );
419 }
420}
421
422// On Mac, scrollbars are explicitly children.
423#ifdef __WXMAC__
424static bool wxHasRealChildren(const wxWindowBase* win)
425{
426 int realChildCount = 0;
427
428 for ( wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
429 node;
430 node = node->GetNext() )
431 {
432 wxWindow *win = node->GetData();
433 if ( !win->IsTopLevel() && win->IsShown() && !win->IsKindOf(CLASSINFO(wxScrollBar)))
434 realChildCount ++;
435 }
436 return (realChildCount > 0);
437}
438#endif
439
440void wxWindowBase::InvalidateBestSize()
441{
442 m_bestSizeCache = wxDefaultSize;
443
444 // parent's best size calculation may depend on its children's
445 // as long as child window we are in is not top level window itself
446 // (because the TLW size is never resized automatically)
447 // so let's invalidate it as well to be safe:
448 if (m_parent && !IsTopLevel())
449 m_parent->InvalidateBestSize();
450}
451
452// return the size best suited for the current window
453wxSize wxWindowBase::DoGetBestSize() const
454{
455 wxSize best;
456
457 if ( m_windowSizer )
458 {
459 best = GetWindowSizeForVirtualSize(m_windowSizer->GetMinSize());
460 }
461#if wxUSE_CONSTRAINTS
462 else if ( m_constraints )
463 {
464 wxConstCast(this, wxWindowBase)->SatisfyConstraints();
465
466 // our minimal acceptable size is such that all our windows fit inside
467 int maxX = 0,
468 maxY = 0;
469
470 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
471 node;
472 node = node->GetNext() )
473 {
474 wxLayoutConstraints *c = node->GetData()->GetConstraints();
475 if ( !c )
476 {
477 // it's not normal that we have an unconstrained child, but
478 // what can we do about it?
479 continue;
480 }
481
482 int x = c->right.GetValue(),
483 y = c->bottom.GetValue();
484
485 if ( x > maxX )
486 maxX = x;
487
488 if ( y > maxY )
489 maxY = y;
490
491 // TODO: we must calculate the overlaps somehow, otherwise we
492 // will never return a size bigger than the current one :-(
493 }
494
495 best = wxSize(maxX, maxY);
496 }
497#endif // wxUSE_CONSTRAINTS
498 else if ( !GetChildren().empty()
499#ifdef __WXMAC__
500 && wxHasRealChildren(this)
501#endif
502 )
503 {
504 // our minimal acceptable size is such that all our visible child windows fit inside
505 int maxX = 0,
506 maxY = 0;
507
508 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
509 node;
510 node = node->GetNext() )
511 {
512 wxWindow *win = node->GetData();
513 if ( win->IsTopLevel() || ( ! win->IsShown() )
514#if wxUSE_STATUSBAR
515 || wxDynamicCast(win, wxStatusBar)
516#endif // wxUSE_STATUSBAR
517 )
518 {
519 // dialogs and frames lie in different top level windows -
520 // don't deal with them here; as for the status bars, they
521 // don't lie in the client area at all
522 continue;
523 }
524
525 int wx, wy, ww, wh;
526 win->GetPosition(&wx, &wy);
527
528 // if the window hadn't been positioned yet, assume that it is in
529 // the origin
530 if ( wx == wxDefaultCoord )
531 wx = 0;
532 if ( wy == wxDefaultCoord )
533 wy = 0;
534
535 win->GetSize(&ww, &wh);
536 if ( wx + ww > maxX )
537 maxX = wx + ww;
538 if ( wy + wh > maxY )
539 maxY = wy + wh;
540 }
541
542 // for compatibility with the old versions and because it really looks
543 // slightly more pretty like this, add a pad
544 maxX += 7;
545 maxY += 14;
546
547 best = wxSize(maxX, maxY);
548 }
549 else // ! has children
550 {
551 // for a generic window there is no natural best size so, if the
552 // minimal size is not set, use the current size but take care to
553 // remember it as minimal size for the next time because our best size
554 // should be constant: otherwise we could get into a situation when the
555 // window is initially at some size, then expanded to a larger size and
556 // then, when the containing window is shrunk back (because our initial
557 // best size had been used for computing the parent min size), we can't
558 // be shrunk back any more because our best size is now bigger
559 wxSize size = GetMinSize();
560 if ( !size.IsFullySpecified() )
561 {
562 size.SetDefaults(GetSize());
563 wxConstCast(this, wxWindowBase)->SetMinSize(size);
564 }
565
566 // return as-is, unadjusted by the client size difference.
567 return size;
568 }
569
570 // Add any difference between size and client size
571 wxSize diff = GetSize() - GetClientSize();
572 best.x += wxMax(0, diff.x);
573 best.y += wxMax(0, diff.y);
574
575 return best;
576}
577
578
579wxSize wxWindowBase::GetBestFittingSize() const
580{
581 // merge the best size with the min size, giving priority to the min size
582 wxSize min = GetMinSize();
583 if (min.x == wxDefaultCoord || min.y == wxDefaultCoord)
584 {
585 wxSize best = GetBestSize();
586 if (min.x == wxDefaultCoord) min.x = best.x;
587 if (min.y == wxDefaultCoord) min.y = best.y;
588 }
589 return min;
590}
591
592
593void wxWindowBase::SetBestFittingSize(const wxSize& size)
594{
595 // Set the min size to the size passed in. This will usually either be
596 // wxDefaultSize or the size passed to this window's ctor/Create function.
597 SetMinSize(size);
598
599 // Merge the size with the best size if needed
600 wxSize best = GetBestFittingSize();
601
602 // If the current size doesn't match then change it
603 if (GetSize() != best)
604 SetSize(best);
605}
606
607
608// by default the origin is not shifted
609wxPoint wxWindowBase::GetClientAreaOrigin() const
610{
611 return wxPoint(0,0);
612}
613
614// set the min/max size of the window
615void wxWindowBase::DoSetSizeHints(int minW, int minH,
616 int maxW, int maxH,
617 int WXUNUSED(incW), int WXUNUSED(incH))
618{
619 // setting min width greater than max width leads to infinite loops under
620 // X11 and generally doesn't make any sense, so don't allow it
621 wxCHECK_RET( (minW == wxDefaultCoord || maxW == wxDefaultCoord || minW <= maxW) &&
622 (minH == wxDefaultCoord || maxH == wxDefaultCoord || minH <= maxH),
623 _T("min width/height must be less than max width/height!") );
624
625 m_minWidth = minW;
626 m_maxWidth = maxW;
627 m_minHeight = minH;
628 m_maxHeight = maxH;
629}
630
631void wxWindowBase::SetWindowVariant( wxWindowVariant variant )
632{
633 if ( m_windowVariant != variant )
634 {
635 m_windowVariant = variant;
636
637 DoSetWindowVariant(variant);
638 }
639}
640
641void wxWindowBase::DoSetWindowVariant( wxWindowVariant variant )
642{
643 // adjust the font height to correspond to our new variant (notice that
644 // we're only called if something really changed)
645 wxFont font = GetFont();
646 int size = font.GetPointSize();
647 switch ( variant )
648 {
649 case wxWINDOW_VARIANT_NORMAL:
650 break;
651
652 case wxWINDOW_VARIANT_SMALL:
653 size *= 3;
654 size /= 4;
655 break;
656
657 case wxWINDOW_VARIANT_MINI:
658 size *= 2;
659 size /= 3;
660 break;
661
662 case wxWINDOW_VARIANT_LARGE:
663 size *= 5;
664 size /= 4;
665 break;
666
667 default:
668 wxFAIL_MSG(_T("unexpected window variant"));
669 break;
670 }
671
672 font.SetPointSize(size);
673 SetFont(font);
674}
675
676void wxWindowBase::SetVirtualSizeHints( int minW, int minH,
677 int maxW, int maxH )
678{
679 m_minVirtualWidth = minW;
680 m_maxVirtualWidth = maxW;
681 m_minVirtualHeight = minH;
682 m_maxVirtualHeight = maxH;
683}
684
685void wxWindowBase::DoSetVirtualSize( int x, int y )
686{
687 if ( m_minVirtualWidth != wxDefaultCoord && m_minVirtualWidth > x )
688 x = m_minVirtualWidth;
689 if ( m_maxVirtualWidth != wxDefaultCoord && m_maxVirtualWidth < x )
690 x = m_maxVirtualWidth;
691 if ( m_minVirtualHeight != wxDefaultCoord && m_minVirtualHeight > y )
692 y = m_minVirtualHeight;
693 if ( m_maxVirtualHeight != wxDefaultCoord && m_maxVirtualHeight < y )
694 y = m_maxVirtualHeight;
695
696 m_virtualSize = wxSize(x, y);
697}
698
699wxSize wxWindowBase::DoGetVirtualSize() const
700{
701 // we should use the entire client area so if it is greater than our
702 // virtual size, expand it to fit (otherwise if the window is big enough we
703 // wouldn't be using parts of it)
704 wxSize size = GetClientSize();
705 if ( m_virtualSize.x > size.x )
706 size.x = m_virtualSize.x;
707
708 if ( m_virtualSize.y >= size.y )
709 size.y = m_virtualSize.y;
710
711 return size;
712}
713
714void wxWindowBase::DoGetScreenPosition(int *x, int *y) const
715{
716 // screen position is the same as (0, 0) in client coords for non TLWs (and
717 // TLWs override this method)
718 if ( x )
719 *x = 0;
720 if ( y )
721 *y = 0;
722
723 ClientToScreen(x, y);
724}
725
726// ----------------------------------------------------------------------------
727// show/hide/enable/disable the window
728// ----------------------------------------------------------------------------
729
730bool wxWindowBase::Show(bool show)
731{
732 if ( show != m_isShown )
733 {
734 m_isShown = show;
735
736 return true;
737 }
738 else
739 {
740 return false;
741 }
742}
743
744bool wxWindowBase::Enable(bool enable)
745{
746 if ( enable != m_isEnabled )
747 {
748 m_isEnabled = enable;
749
750 return true;
751 }
752 else
753 {
754 return false;
755 }
756}
757// ----------------------------------------------------------------------------
758// RTTI
759// ----------------------------------------------------------------------------
760
761bool wxWindowBase::IsTopLevel() const
762{
763 return false;
764}
765
766// ----------------------------------------------------------------------------
767// reparenting the window
768// ----------------------------------------------------------------------------
769
770void wxWindowBase::AddChild(wxWindowBase *child)
771{
772 wxCHECK_RET( child, wxT("can't add a NULL child") );
773
774 // this should never happen and it will lead to a crash later if it does
775 // because RemoveChild() will remove only one node from the children list
776 // and the other(s) one(s) will be left with dangling pointers in them
777 wxASSERT_MSG( !GetChildren().Find((wxWindow*)child), _T("AddChild() called twice") );
778
779 GetChildren().Append((wxWindow*)child);
780 child->SetParent(this);
781}
782
783void wxWindowBase::RemoveChild(wxWindowBase *child)
784{
785 wxCHECK_RET( child, wxT("can't remove a NULL child") );
786
787 GetChildren().DeleteObject((wxWindow *)child);
788 child->SetParent(NULL);
789}
790
791bool wxWindowBase::Reparent(wxWindowBase *newParent)
792{
793 wxWindow *oldParent = GetParent();
794 if ( newParent == oldParent )
795 {
796 // nothing done
797 return false;
798 }
799
800 // unlink this window from the existing parent.
801 if ( oldParent )
802 {
803 oldParent->RemoveChild(this);
804 }
805 else
806 {
807 wxTopLevelWindows.DeleteObject((wxWindow *)this);
808 }
809
810 // add it to the new one
811 if ( newParent )
812 {
813 newParent->AddChild(this);
814 }
815 else
816 {
817 wxTopLevelWindows.Append((wxWindow *)this);
818 }
819
820 return true;
821}
822
823// ----------------------------------------------------------------------------
824// event handler stuff
825// ----------------------------------------------------------------------------
826
827void wxWindowBase::PushEventHandler(wxEvtHandler *handler)
828{
829 wxEvtHandler *handlerOld = GetEventHandler();
830
831 handler->SetNextHandler(handlerOld);
832
833 if ( handlerOld )
834 GetEventHandler()->SetPreviousHandler(handler);
835
836 SetEventHandler(handler);
837}
838
839wxEvtHandler *wxWindowBase::PopEventHandler(bool deleteHandler)
840{
841 wxEvtHandler *handlerA = GetEventHandler();
842 if ( handlerA )
843 {
844 wxEvtHandler *handlerB = handlerA->GetNextHandler();
845 handlerA->SetNextHandler((wxEvtHandler *)NULL);
846
847 if ( handlerB )
848 handlerB->SetPreviousHandler((wxEvtHandler *)NULL);
849 SetEventHandler(handlerB);
850
851 if ( deleteHandler )
852 {
853 delete handlerA;
854 handlerA = (wxEvtHandler *)NULL;
855 }
856 }
857
858 return handlerA;
859}
860
861bool wxWindowBase::RemoveEventHandler(wxEvtHandler *handler)
862{
863 wxCHECK_MSG( handler, false, _T("RemoveEventHandler(NULL) called") );
864
865 wxEvtHandler *handlerPrev = NULL,
866 *handlerCur = GetEventHandler();
867 while ( handlerCur )
868 {
869 wxEvtHandler *handlerNext = handlerCur->GetNextHandler();
870
871 if ( handlerCur == handler )
872 {
873 if ( handlerPrev )
874 {
875 handlerPrev->SetNextHandler(handlerNext);
876 }
877 else
878 {
879 SetEventHandler(handlerNext);
880 }
881
882 if ( handlerNext )
883 {
884 handlerNext->SetPreviousHandler ( handlerPrev );
885 }
886
887 handler->SetNextHandler(NULL);
888 handler->SetPreviousHandler(NULL);
889
890 return true;
891 }
892
893 handlerPrev = handlerCur;
894 handlerCur = handlerNext;
895 }
896
897 wxFAIL_MSG( _T("where has the event handler gone?") );
898
899 return false;
900}
901
902// ----------------------------------------------------------------------------
903// colours, fonts &c
904// ----------------------------------------------------------------------------
905
906void wxWindowBase::InheritAttributes()
907{
908 const wxWindowBase * const parent = GetParent();
909 if ( !parent )
910 return;
911
912 // we only inherit attributes which had been explicitly set for the parent
913 // which ensures that this only happens if the user really wants it and
914 // not by default which wouldn't make any sense in modern GUIs where the
915 // controls don't all use the same fonts (nor colours)
916 if ( parent->m_inheritFont && !m_hasFont )
917 SetFont(parent->GetFont());
918
919 // in addition, there is a possibility to explicitly forbid inheriting
920 // colours at each class level by overriding ShouldInheritColours()
921 if ( ShouldInheritColours() )
922 {
923 if ( parent->m_inheritFgCol && !m_hasFgCol )
924 SetForegroundColour(parent->GetForegroundColour());
925
926 // inheriting (solid) background colour is wrong as it totally breaks
927 // any kind of themed backgrounds
928 //
929 // instead, the controls should use the same background as their parent
930 // (ideally by not drawing it at all)
931#if 0
932 if ( parent->m_inheritBgCol && !m_hasBgCol )
933 SetBackgroundColour(parent->GetBackgroundColour());
934#endif // 0
935 }
936}
937
938/* static */ wxVisualAttributes
939wxWindowBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
940{
941 // it is important to return valid values for all attributes from here,
942 // GetXXX() below rely on this
943 wxVisualAttributes attrs;
944 attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
945 attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
946
947 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
948 // the usual background colour than wxSYS_COLOUR_BTNFACE.
949 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
950 // colour on other platforms.
951
952#if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
953 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
954#else
955 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
956#endif
957 return attrs;
958}
959
960wxColour wxWindowBase::GetBackgroundColour() const
961{
962 if ( !m_backgroundColour.Ok() )
963 {
964 wxASSERT_MSG( !m_hasBgCol, _T("we have invalid explicit bg colour?") );
965
966 // get our default background colour
967 wxColour colBg = GetDefaultAttributes().colBg;
968
969 // we must return some valid colour to avoid redoing this every time
970 // and also to avoid surprizing the applications written for older
971 // wxWidgets versions where GetBackgroundColour() always returned
972 // something -- so give them something even if it doesn't make sense
973 // for this window (e.g. it has a themed background)
974 if ( !colBg.Ok() )
975 colBg = GetClassDefaultAttributes().colBg;
976
977 return colBg;
978 }
979 else
980 return m_backgroundColour;
981}
982
983wxColour wxWindowBase::GetForegroundColour() const
984{
985 // logic is the same as above
986 if ( !m_hasFgCol && !m_foregroundColour.Ok() )
987 {
988 wxASSERT_MSG( !m_hasFgCol, _T("we have invalid explicit fg colour?") );
989
990 wxColour colFg = GetDefaultAttributes().colFg;
991
992 if ( !colFg.Ok() )
993 colFg = GetClassDefaultAttributes().colFg;
994
995 return colFg;
996 }
997 else
998 return m_foregroundColour;
999}
1000
1001bool wxWindowBase::SetBackgroundColour( const wxColour &colour )
1002{
1003 if ( colour == m_backgroundColour )
1004 return false;
1005
1006 m_hasBgCol = colour.Ok();
1007 if ( m_backgroundStyle != wxBG_STYLE_CUSTOM )
1008 m_backgroundStyle = m_hasBgCol ? wxBG_STYLE_COLOUR : wxBG_STYLE_SYSTEM;
1009
1010 m_inheritBgCol = m_hasBgCol;
1011 m_backgroundColour = colour;
1012 SetThemeEnabled( !m_hasBgCol && !m_foregroundColour.Ok() );
1013 return true;
1014}
1015
1016bool wxWindowBase::SetForegroundColour( const wxColour &colour )
1017{
1018 if (colour == m_foregroundColour )
1019 return false;
1020
1021 m_hasFgCol = colour.Ok();
1022 m_inheritFgCol = m_hasFgCol;
1023 m_foregroundColour = colour;
1024 SetThemeEnabled( !m_hasFgCol && !m_backgroundColour.Ok() );
1025 return true;
1026}
1027
1028bool wxWindowBase::SetCursor(const wxCursor& cursor)
1029{
1030 // setting an invalid cursor is ok, it means that we don't have any special
1031 // cursor
1032 if ( m_cursor == cursor )
1033 {
1034 // no change
1035 return false;
1036 }
1037
1038 m_cursor = cursor;
1039
1040 return true;
1041}
1042
1043wxFont wxWindowBase::GetFont() const
1044{
1045 // logic is the same as in GetBackgroundColour()
1046 if ( !m_font.Ok() )
1047 {
1048 wxASSERT_MSG( !m_hasFont, _T("we have invalid explicit font?") );
1049
1050 wxFont font = GetDefaultAttributes().font;
1051 if ( !font.Ok() )
1052 font = GetClassDefaultAttributes().font;
1053
1054 return font;
1055 }
1056 else
1057 return m_font;
1058}
1059
1060bool wxWindowBase::SetFont(const wxFont& font)
1061{
1062 if ( font == m_font )
1063 {
1064 // no change
1065 return false;
1066 }
1067
1068 m_font = font;
1069 m_hasFont = font.Ok();
1070 m_inheritFont = m_hasFont;
1071
1072 InvalidateBestSize();
1073
1074 return true;
1075}
1076
1077#if wxUSE_PALETTE
1078
1079void wxWindowBase::SetPalette(const wxPalette& pal)
1080{
1081 m_hasCustomPalette = true;
1082 m_palette = pal;
1083
1084 // VZ: can anyone explain me what do we do here?
1085 wxWindowDC d((wxWindow *) this);
1086 d.SetPalette(pal);
1087}
1088
1089wxWindow *wxWindowBase::GetAncestorWithCustomPalette() const
1090{
1091 wxWindow *win = (wxWindow *)this;
1092 while ( win && !win->HasCustomPalette() )
1093 {
1094 win = win->GetParent();
1095 }
1096
1097 return win;
1098}
1099
1100#endif // wxUSE_PALETTE
1101
1102#if wxUSE_CARET
1103void wxWindowBase::SetCaret(wxCaret *caret)
1104{
1105 if ( m_caret )
1106 {
1107 delete m_caret;
1108 }
1109
1110 m_caret = caret;
1111
1112 if ( m_caret )
1113 {
1114 wxASSERT_MSG( m_caret->GetWindow() == this,
1115 wxT("caret should be created associated to this window") );
1116 }
1117}
1118#endif // wxUSE_CARET
1119
1120#if wxUSE_VALIDATORS
1121// ----------------------------------------------------------------------------
1122// validators
1123// ----------------------------------------------------------------------------
1124
1125void wxWindowBase::SetValidator(const wxValidator& validator)
1126{
1127 if ( m_windowValidator )
1128 delete m_windowValidator;
1129
1130 m_windowValidator = (wxValidator *)validator.Clone();
1131
1132 if ( m_windowValidator )
1133 m_windowValidator->SetWindow(this);
1134}
1135#endif // wxUSE_VALIDATORS
1136
1137// ----------------------------------------------------------------------------
1138// update region stuff
1139// ----------------------------------------------------------------------------
1140
1141wxRect wxWindowBase::GetUpdateClientRect() const
1142{
1143 wxRegion rgnUpdate = GetUpdateRegion();
1144 rgnUpdate.Intersect(GetClientRect());
1145 wxRect rectUpdate = rgnUpdate.GetBox();
1146 wxPoint ptOrigin = GetClientAreaOrigin();
1147 rectUpdate.x -= ptOrigin.x;
1148 rectUpdate.y -= ptOrigin.y;
1149
1150 return rectUpdate;
1151}
1152
1153bool wxWindowBase::IsExposed(int x, int y) const
1154{
1155 return m_updateRegion.Contains(x, y) != wxOutRegion;
1156}
1157
1158bool wxWindowBase::IsExposed(int x, int y, int w, int h) const
1159{
1160 return m_updateRegion.Contains(x, y, w, h) != wxOutRegion;
1161}
1162
1163void wxWindowBase::ClearBackground()
1164{
1165 // wxGTK uses its own version, no need to add never used code
1166#ifndef __WXGTK__
1167 wxClientDC dc((wxWindow *)this);
1168 wxBrush brush(GetBackgroundColour(), wxSOLID);
1169 dc.SetBackground(brush);
1170 dc.Clear();
1171#endif // __WXGTK__
1172}
1173
1174// ----------------------------------------------------------------------------
1175// find child window by id or name
1176// ----------------------------------------------------------------------------
1177
1178wxWindow *wxWindowBase::FindWindow(long id) const
1179{
1180 if ( id == m_windowId )
1181 return (wxWindow *)this;
1182
1183 wxWindowBase *res = (wxWindow *)NULL;
1184 wxWindowList::compatibility_iterator node;
1185 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1186 {
1187 wxWindowBase *child = node->GetData();
1188 res = child->FindWindow( id );
1189 }
1190
1191 return (wxWindow *)res;
1192}
1193
1194wxWindow *wxWindowBase::FindWindow(const wxString& name) const
1195{
1196 if ( name == m_windowName )
1197 return (wxWindow *)this;
1198
1199 wxWindowBase *res = (wxWindow *)NULL;
1200 wxWindowList::compatibility_iterator node;
1201 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1202 {
1203 wxWindow *child = node->GetData();
1204 res = child->FindWindow(name);
1205 }
1206
1207 return (wxWindow *)res;
1208}
1209
1210
1211// find any window by id or name or label: If parent is non-NULL, look through
1212// children for a label or title matching the specified string. If NULL, look
1213// through all top-level windows.
1214//
1215// to avoid duplicating code we reuse the same helper function but with
1216// different comparators
1217
1218typedef bool (*wxFindWindowCmp)(const wxWindow *win,
1219 const wxString& label, long id);
1220
1221static
1222bool wxFindWindowCmpLabels(const wxWindow *win, const wxString& label,
1223 long WXUNUSED(id))
1224{
1225 return win->GetLabel() == label;
1226}
1227
1228static
1229bool wxFindWindowCmpNames(const wxWindow *win, const wxString& label,
1230 long WXUNUSED(id))
1231{
1232 return win->GetName() == label;
1233}
1234
1235static
1236bool wxFindWindowCmpIds(const wxWindow *win, const wxString& WXUNUSED(label),
1237 long id)
1238{
1239 return win->GetId() == id;
1240}
1241
1242// recursive helper for the FindWindowByXXX() functions
1243static
1244wxWindow *wxFindWindowRecursively(const wxWindow *parent,
1245 const wxString& label,
1246 long id,
1247 wxFindWindowCmp cmp)
1248{
1249 if ( parent )
1250 {
1251 // see if this is the one we're looking for
1252 if ( (*cmp)(parent, label, id) )
1253 return (wxWindow *)parent;
1254
1255 // It wasn't, so check all its children
1256 for ( wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
1257 node;
1258 node = node->GetNext() )
1259 {
1260 // recursively check each child
1261 wxWindow *win = (wxWindow *)node->GetData();
1262 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1263 if (retwin)
1264 return retwin;
1265 }
1266 }
1267
1268 // Not found
1269 return NULL;
1270}
1271
1272// helper for FindWindowByXXX()
1273static
1274wxWindow *wxFindWindowHelper(const wxWindow *parent,
1275 const wxString& label,
1276 long id,
1277 wxFindWindowCmp cmp)
1278{
1279 if ( parent )
1280 {
1281 // just check parent and all its children
1282 return wxFindWindowRecursively(parent, label, id, cmp);
1283 }
1284
1285 // start at very top of wx's windows
1286 for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1287 node;
1288 node = node->GetNext() )
1289 {
1290 // recursively check each window & its children
1291 wxWindow *win = node->GetData();
1292 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1293 if (retwin)
1294 return retwin;
1295 }
1296
1297 return NULL;
1298}
1299
1300/* static */
1301wxWindow *
1302wxWindowBase::FindWindowByLabel(const wxString& title, const wxWindow *parent)
1303{
1304 return wxFindWindowHelper(parent, title, 0, wxFindWindowCmpLabels);
1305}
1306
1307/* static */
1308wxWindow *
1309wxWindowBase::FindWindowByName(const wxString& title, const wxWindow *parent)
1310{
1311 wxWindow *win = wxFindWindowHelper(parent, title, 0, wxFindWindowCmpNames);
1312
1313 if ( !win )
1314 {
1315 // fall back to the label
1316 win = FindWindowByLabel(title, parent);
1317 }
1318
1319 return win;
1320}
1321
1322/* static */
1323wxWindow *
1324wxWindowBase::FindWindowById( long id, const wxWindow* parent )
1325{
1326 return wxFindWindowHelper(parent, wxEmptyString, id, wxFindWindowCmpIds);
1327}
1328
1329// ----------------------------------------------------------------------------
1330// dialog oriented functions
1331// ----------------------------------------------------------------------------
1332
1333void wxWindowBase::MakeModal(bool modal)
1334{
1335 // Disable all other windows
1336 if ( IsTopLevel() )
1337 {
1338 wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1339 while (node)
1340 {
1341 wxWindow *win = node->GetData();
1342 if (win != this)
1343 win->Enable(!modal);
1344
1345 node = node->GetNext();
1346 }
1347 }
1348}
1349
1350bool wxWindowBase::Validate()
1351{
1352#if wxUSE_VALIDATORS
1353 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
1354
1355 wxWindowList::compatibility_iterator node;
1356 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
1357 {
1358 wxWindowBase *child = node->GetData();
1359 wxValidator *validator = child->GetValidator();
1360 if ( validator && !validator->Validate((wxWindow *)this) )
1361 {
1362 return false;
1363 }
1364
1365 if ( recurse && !child->Validate() )
1366 {
1367 return false;
1368 }
1369 }
1370#endif // wxUSE_VALIDATORS
1371
1372 return true;
1373}
1374
1375bool wxWindowBase::TransferDataToWindow()
1376{
1377#if wxUSE_VALIDATORS
1378 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
1379
1380 wxWindowList::compatibility_iterator node;
1381 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
1382 {
1383 wxWindowBase *child = node->GetData();
1384 wxValidator *validator = child->GetValidator();
1385 if ( validator && !validator->TransferToWindow() )
1386 {
1387 wxLogWarning(_("Could not transfer data to window"));
1388#if wxUSE_LOG
1389 wxLog::FlushActive();
1390#endif // wxUSE_LOG
1391
1392 return false;
1393 }
1394
1395 if ( recurse )
1396 {
1397 if ( !child->TransferDataToWindow() )
1398 {
1399 // warning already given
1400 return false;
1401 }
1402 }
1403 }
1404#endif // wxUSE_VALIDATORS
1405
1406 return true;
1407}
1408
1409bool wxWindowBase::TransferDataFromWindow()
1410{
1411#if wxUSE_VALIDATORS
1412 bool recurse = (GetExtraStyle() & wxWS_EX_VALIDATE_RECURSIVELY) != 0;
1413
1414 wxWindowList::compatibility_iterator node;
1415 for ( node = m_children.GetFirst(); node; node = node->GetNext() )
1416 {
1417 wxWindow *child = node->GetData();
1418 wxValidator *validator = child->GetValidator();
1419 if ( validator && !validator->TransferFromWindow() )
1420 {
1421 // nop warning here because the application is supposed to give
1422 // one itself - we don't know here what might have gone wrongly
1423
1424 return false;
1425 }
1426
1427 if ( recurse )
1428 {
1429 if ( !child->TransferDataFromWindow() )
1430 {
1431 // warning already given
1432 return false;
1433 }
1434 }
1435 }
1436#endif // wxUSE_VALIDATORS
1437
1438 return true;
1439}
1440
1441void wxWindowBase::InitDialog()
1442{
1443 wxInitDialogEvent event(GetId());
1444 event.SetEventObject( this );
1445 GetEventHandler()->ProcessEvent(event);
1446}
1447
1448// ----------------------------------------------------------------------------
1449// context-sensitive help support
1450// ----------------------------------------------------------------------------
1451
1452#if wxUSE_HELP
1453
1454// associate this help text with this window
1455void wxWindowBase::SetHelpText(const wxString& text)
1456{
1457 wxHelpProvider *helpProvider = wxHelpProvider::Get();
1458 if ( helpProvider )
1459 {
1460 helpProvider->AddHelp(this, text);
1461 }
1462}
1463
1464// associate this help text with all windows with the same id as this
1465// one
1466void wxWindowBase::SetHelpTextForId(const wxString& text)
1467{
1468 wxHelpProvider *helpProvider = wxHelpProvider::Get();
1469 if ( helpProvider )
1470 {
1471 helpProvider->AddHelp(GetId(), text);
1472 }
1473}
1474
1475// get the help string associated with this window (may be empty)
1476wxString wxWindowBase::GetHelpText() const
1477{
1478 wxString text;
1479 wxHelpProvider *helpProvider = wxHelpProvider::Get();
1480 if ( helpProvider )
1481 {
1482 text = helpProvider->GetHelp(this);
1483 }
1484
1485 return text;
1486}
1487
1488// show help for this window
1489void wxWindowBase::OnHelp(wxHelpEvent& event)
1490{
1491 wxHelpProvider *helpProvider = wxHelpProvider::Get();
1492 if ( helpProvider )
1493 {
1494 if ( helpProvider->ShowHelp(this) )
1495 {
1496 // skip the event.Skip() below
1497 return;
1498 }
1499 }
1500
1501 event.Skip();
1502}
1503
1504#endif // wxUSE_HELP
1505
1506// ----------------------------------------------------------------------------
1507// tooltipsroot.Replace("\\", "/");
1508// ----------------------------------------------------------------------------
1509
1510#if wxUSE_TOOLTIPS
1511
1512void wxWindowBase::SetToolTip( const wxString &tip )
1513{
1514 // don't create the new tooltip if we already have one
1515 if ( m_tooltip )
1516 {
1517 m_tooltip->SetTip( tip );
1518 }
1519 else
1520 {
1521 SetToolTip( new wxToolTip( tip ) );
1522 }
1523
1524 // setting empty tooltip text does not remove the tooltip any more - use
1525 // SetToolTip((wxToolTip *)NULL) for this
1526}
1527
1528void wxWindowBase::DoSetToolTip(wxToolTip *tooltip)
1529{
1530 if ( m_tooltip != tooltip )
1531 {
1532 if ( m_tooltip )
1533 delete m_tooltip;
1534
1535 m_tooltip = tooltip;
1536 }
1537}
1538
1539#endif // wxUSE_TOOLTIPS
1540
1541// ----------------------------------------------------------------------------
1542// constraints and sizers
1543// ----------------------------------------------------------------------------
1544
1545#if wxUSE_CONSTRAINTS
1546
1547void wxWindowBase::SetConstraints( wxLayoutConstraints *constraints )
1548{
1549 if ( m_constraints )
1550 {
1551 UnsetConstraints(m_constraints);
1552 delete m_constraints;
1553 }
1554 m_constraints = constraints;
1555 if ( m_constraints )
1556 {
1557 // Make sure other windows know they're part of a 'meaningful relationship'
1558 if ( m_constraints->left.GetOtherWindow() && (m_constraints->left.GetOtherWindow() != this) )
1559 m_constraints->left.GetOtherWindow()->AddConstraintReference(this);
1560 if ( m_constraints->top.GetOtherWindow() && (m_constraints->top.GetOtherWindow() != this) )
1561 m_constraints->top.GetOtherWindow()->AddConstraintReference(this);
1562 if ( m_constraints->right.GetOtherWindow() && (m_constraints->right.GetOtherWindow() != this) )
1563 m_constraints->right.GetOtherWindow()->AddConstraintReference(this);
1564 if ( m_constraints->bottom.GetOtherWindow() && (m_constraints->bottom.GetOtherWindow() != this) )
1565 m_constraints->bottom.GetOtherWindow()->AddConstraintReference(this);
1566 if ( m_constraints->width.GetOtherWindow() && (m_constraints->width.GetOtherWindow() != this) )
1567 m_constraints->width.GetOtherWindow()->AddConstraintReference(this);
1568 if ( m_constraints->height.GetOtherWindow() && (m_constraints->height.GetOtherWindow() != this) )
1569 m_constraints->height.GetOtherWindow()->AddConstraintReference(this);
1570 if ( m_constraints->centreX.GetOtherWindow() && (m_constraints->centreX.GetOtherWindow() != this) )
1571 m_constraints->centreX.GetOtherWindow()->AddConstraintReference(this);
1572 if ( m_constraints->centreY.GetOtherWindow() && (m_constraints->centreY.GetOtherWindow() != this) )
1573 m_constraints->centreY.GetOtherWindow()->AddConstraintReference(this);
1574 }
1575}
1576
1577// This removes any dangling pointers to this window in other windows'
1578// constraintsInvolvedIn lists.
1579void wxWindowBase::UnsetConstraints(wxLayoutConstraints *c)
1580{
1581 if ( c )
1582 {
1583 if ( c->left.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
1584 c->left.GetOtherWindow()->RemoveConstraintReference(this);
1585 if ( c->top.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
1586 c->top.GetOtherWindow()->RemoveConstraintReference(this);
1587 if ( c->right.GetOtherWindow() && (c->right.GetOtherWindow() != this) )
1588 c->right.GetOtherWindow()->RemoveConstraintReference(this);
1589 if ( c->bottom.GetOtherWindow() && (c->bottom.GetOtherWindow() != this) )
1590 c->bottom.GetOtherWindow()->RemoveConstraintReference(this);
1591 if ( c->width.GetOtherWindow() && (c->width.GetOtherWindow() != this) )
1592 c->width.GetOtherWindow()->RemoveConstraintReference(this);
1593 if ( c->height.GetOtherWindow() && (c->height.GetOtherWindow() != this) )
1594 c->height.GetOtherWindow()->RemoveConstraintReference(this);
1595 if ( c->centreX.GetOtherWindow() && (c->centreX.GetOtherWindow() != this) )
1596 c->centreX.GetOtherWindow()->RemoveConstraintReference(this);
1597 if ( c->centreY.GetOtherWindow() && (c->centreY.GetOtherWindow() != this) )
1598 c->centreY.GetOtherWindow()->RemoveConstraintReference(this);
1599 }
1600}
1601
1602// Back-pointer to other windows we're involved with, so if we delete this
1603// window, we must delete any constraints we're involved with.
1604void wxWindowBase::AddConstraintReference(wxWindowBase *otherWin)
1605{
1606 if ( !m_constraintsInvolvedIn )
1607 m_constraintsInvolvedIn = new wxWindowList;
1608 if ( !m_constraintsInvolvedIn->Find((wxWindow *)otherWin) )
1609 m_constraintsInvolvedIn->Append((wxWindow *)otherWin);
1610}
1611
1612// REMOVE back-pointer to other windows we're involved with.
1613void wxWindowBase::RemoveConstraintReference(wxWindowBase *otherWin)
1614{
1615 if ( m_constraintsInvolvedIn )
1616 m_constraintsInvolvedIn->DeleteObject((wxWindow *)otherWin);
1617}
1618
1619// Reset any constraints that mention this window
1620void wxWindowBase::DeleteRelatedConstraints()
1621{
1622 if ( m_constraintsInvolvedIn )
1623 {
1624 wxWindowList::compatibility_iterator node = m_constraintsInvolvedIn->GetFirst();
1625 while (node)
1626 {
1627 wxWindow *win = node->GetData();
1628 wxLayoutConstraints *constr = win->GetConstraints();
1629
1630 // Reset any constraints involving this window
1631 if ( constr )
1632 {
1633 constr->left.ResetIfWin(this);
1634 constr->top.ResetIfWin(this);
1635 constr->right.ResetIfWin(this);
1636 constr->bottom.ResetIfWin(this);
1637 constr->width.ResetIfWin(this);
1638 constr->height.ResetIfWin(this);
1639 constr->centreX.ResetIfWin(this);
1640 constr->centreY.ResetIfWin(this);
1641 }
1642
1643 wxWindowList::compatibility_iterator next = node->GetNext();
1644 m_constraintsInvolvedIn->Erase(node);
1645 node = next;
1646 }
1647
1648 delete m_constraintsInvolvedIn;
1649 m_constraintsInvolvedIn = (wxWindowList *) NULL;
1650 }
1651}
1652
1653#endif // wxUSE_CONSTRAINTS
1654
1655void wxWindowBase::SetSizer(wxSizer *sizer, bool deleteOld)
1656{
1657 if ( sizer == m_windowSizer)
1658 return;
1659
1660 if ( deleteOld )
1661 delete m_windowSizer;
1662
1663 m_windowSizer = sizer;
1664
1665 SetAutoLayout( sizer != NULL );
1666}
1667
1668void wxWindowBase::SetSizerAndFit(wxSizer *sizer, bool deleteOld)
1669{
1670 SetSizer( sizer, deleteOld );
1671 sizer->SetSizeHints( (wxWindow*) this );
1672}
1673
1674
1675void wxWindowBase::SetContainingSizer(wxSizer* sizer)
1676{
1677 // adding a window to a sizer twice is going to result in fatal and
1678 // hard to debug problems later because when deleting the second
1679 // associated wxSizerItem we're going to dereference a dangling
1680 // pointer; so try to detect this as early as possible
1681 wxASSERT_MSG( !sizer || m_containingSizer != sizer,
1682 _T("Adding a window to the same sizer twice?") );
1683
1684 m_containingSizer = sizer;
1685}
1686
1687#if wxUSE_CONSTRAINTS
1688
1689void wxWindowBase::SatisfyConstraints()
1690{
1691 wxLayoutConstraints *constr = GetConstraints();
1692 bool wasOk = constr && constr->AreSatisfied();
1693
1694 ResetConstraints(); // Mark all constraints as unevaluated
1695
1696 int noChanges = 1;
1697
1698 // if we're a top level panel (i.e. our parent is frame/dialog), our
1699 // own constraints will never be satisfied any more unless we do it
1700 // here
1701 if ( wasOk )
1702 {
1703 while ( noChanges > 0 )
1704 {
1705 LayoutPhase1(&noChanges);
1706 }
1707 }
1708
1709 LayoutPhase2(&noChanges);
1710}
1711
1712#endif // wxUSE_CONSTRAINTS
1713
1714bool wxWindowBase::Layout()
1715{
1716 // If there is a sizer, use it instead of the constraints
1717 if ( GetSizer() )
1718 {
1719 int w = 0, h = 0;
1720 GetVirtualSize(&w, &h);
1721 GetSizer()->SetDimension( 0, 0, w, h );
1722 }
1723#if wxUSE_CONSTRAINTS
1724 else
1725 {
1726 SatisfyConstraints(); // Find the right constraints values
1727 SetConstraintSizes(); // Recursively set the real window sizes
1728 }
1729#endif
1730
1731 return true;
1732}
1733
1734#if wxUSE_CONSTRAINTS
1735
1736// first phase of the constraints evaluation: set our own constraints
1737bool wxWindowBase::LayoutPhase1(int *noChanges)
1738{
1739 wxLayoutConstraints *constr = GetConstraints();
1740
1741 return !constr || constr->SatisfyConstraints(this, noChanges);
1742}
1743
1744// second phase: set the constraints for our children
1745bool wxWindowBase::LayoutPhase2(int *noChanges)
1746{
1747 *noChanges = 0;
1748
1749 // Layout children
1750 DoPhase(1);
1751
1752 // Layout grand children
1753 DoPhase(2);
1754
1755 return true;
1756}
1757
1758// Do a phase of evaluating child constraints
1759bool wxWindowBase::DoPhase(int phase)
1760{
1761 // the list containing the children for which the constraints are already
1762 // set correctly
1763 wxWindowList succeeded;
1764
1765 // the max number of iterations we loop before concluding that we can't set
1766 // the constraints
1767 static const int maxIterations = 500;
1768
1769 for ( int noIterations = 0; noIterations < maxIterations; noIterations++ )
1770 {
1771 int noChanges = 0;
1772
1773 // loop over all children setting their constraints
1774 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1775 node;
1776 node = node->GetNext() )
1777 {
1778 wxWindow *child = node->GetData();
1779 if ( child->IsTopLevel() )
1780 {
1781 // top level children are not inside our client area
1782 continue;
1783 }
1784
1785 if ( !child->GetConstraints() || succeeded.Find(child) )
1786 {
1787 // this one is either already ok or nothing we can do about it
1788 continue;
1789 }
1790
1791 int tempNoChanges = 0;
1792 bool success = phase == 1 ? child->LayoutPhase1(&tempNoChanges)
1793 : child->LayoutPhase2(&tempNoChanges);
1794 noChanges += tempNoChanges;
1795
1796 if ( success )
1797 {
1798 succeeded.Append(child);
1799 }
1800 }
1801
1802 if ( !noChanges )
1803 {
1804 // constraints are set
1805 break;
1806 }
1807 }
1808
1809 return true;
1810}
1811
1812void wxWindowBase::ResetConstraints()
1813{
1814 wxLayoutConstraints *constr = GetConstraints();
1815 if ( constr )
1816 {
1817 constr->left.SetDone(false);
1818 constr->top.SetDone(false);
1819 constr->right.SetDone(false);
1820 constr->bottom.SetDone(false);
1821 constr->width.SetDone(false);
1822 constr->height.SetDone(false);
1823 constr->centreX.SetDone(false);
1824 constr->centreY.SetDone(false);
1825 }
1826
1827 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1828 while (node)
1829 {
1830 wxWindow *win = node->GetData();
1831 if ( !win->IsTopLevel() )
1832 win->ResetConstraints();
1833 node = node->GetNext();
1834 }
1835}
1836
1837// Need to distinguish between setting the 'fake' size for windows and sizers,
1838// and setting the real values.
1839void wxWindowBase::SetConstraintSizes(bool recurse)
1840{
1841 wxLayoutConstraints *constr = GetConstraints();
1842 if ( constr && constr->AreSatisfied() )
1843 {
1844 int x = constr->left.GetValue();
1845 int y = constr->top.GetValue();
1846 int w = constr->width.GetValue();
1847 int h = constr->height.GetValue();
1848
1849 if ( (constr->width.GetRelationship() != wxAsIs ) ||
1850 (constr->height.GetRelationship() != wxAsIs) )
1851 {
1852 SetSize(x, y, w, h);
1853 }
1854 else
1855 {
1856 // If we don't want to resize this window, just move it...
1857 Move(x, y);
1858 }
1859 }
1860 else if ( constr )
1861 {
1862 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
1863 GetClassInfo()->GetClassName(),
1864 GetName().c_str());
1865 }
1866
1867 if ( recurse )
1868 {
1869 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1870 while (node)
1871 {
1872 wxWindow *win = node->GetData();
1873 if ( !win->IsTopLevel() && win->GetConstraints() )
1874 win->SetConstraintSizes();
1875 node = node->GetNext();
1876 }
1877 }
1878}
1879
1880// Only set the size/position of the constraint (if any)
1881void wxWindowBase::SetSizeConstraint(int x, int y, int w, int h)
1882{
1883 wxLayoutConstraints *constr = GetConstraints();
1884 if ( constr )
1885 {
1886 if ( x != wxDefaultCoord )
1887 {
1888 constr->left.SetValue(x);
1889 constr->left.SetDone(true);
1890 }
1891 if ( y != wxDefaultCoord )
1892 {
1893 constr->top.SetValue(y);
1894 constr->top.SetDone(true);
1895 }
1896 if ( w != wxDefaultCoord )
1897 {
1898 constr->width.SetValue(w);
1899 constr->width.SetDone(true);
1900 }
1901 if ( h != wxDefaultCoord )
1902 {
1903 constr->height.SetValue(h);
1904 constr->height.SetDone(true);
1905 }
1906 }
1907}
1908
1909void wxWindowBase::MoveConstraint(int x, int y)
1910{
1911 wxLayoutConstraints *constr = GetConstraints();
1912 if ( constr )
1913 {
1914 if ( x != wxDefaultCoord )
1915 {
1916 constr->left.SetValue(x);
1917 constr->left.SetDone(true);
1918 }
1919 if ( y != wxDefaultCoord )
1920 {
1921 constr->top.SetValue(y);
1922 constr->top.SetDone(true);
1923 }
1924 }
1925}
1926
1927void wxWindowBase::GetSizeConstraint(int *w, int *h) const
1928{
1929 wxLayoutConstraints *constr = GetConstraints();
1930 if ( constr )
1931 {
1932 *w = constr->width.GetValue();
1933 *h = constr->height.GetValue();
1934 }
1935 else
1936 GetSize(w, h);
1937}
1938
1939void wxWindowBase::GetClientSizeConstraint(int *w, int *h) const
1940{
1941 wxLayoutConstraints *constr = GetConstraints();
1942 if ( constr )
1943 {
1944 *w = constr->width.GetValue();
1945 *h = constr->height.GetValue();
1946 }
1947 else
1948 GetClientSize(w, h);
1949}
1950
1951void wxWindowBase::GetPositionConstraint(int *x, int *y) const
1952{
1953 wxLayoutConstraints *constr = GetConstraints();
1954 if ( constr )
1955 {
1956 *x = constr->left.GetValue();
1957 *y = constr->top.GetValue();
1958 }
1959 else
1960 GetPosition(x, y);
1961}
1962
1963#endif // wxUSE_CONSTRAINTS
1964
1965void wxWindowBase::AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const
1966{
1967 // don't do it for the dialogs/frames - they float independently of their
1968 // parent
1969 if ( !IsTopLevel() )
1970 {
1971 wxWindow *parent = GetParent();
1972 if ( !(sizeFlags & wxSIZE_NO_ADJUSTMENTS) && parent )
1973 {
1974 wxPoint pt(parent->GetClientAreaOrigin());
1975 x += pt.x;
1976 y += pt.y;
1977 }
1978 }
1979}
1980
1981// ----------------------------------------------------------------------------
1982// do Update UI processing for child controls
1983// ----------------------------------------------------------------------------
1984
1985void wxWindowBase::UpdateWindowUI(long flags)
1986{
1987 wxUpdateUIEvent event(GetId());
1988 event.SetEventObject(this);
1989
1990 if ( GetEventHandler()->ProcessEvent(event) )
1991 {
1992 DoUpdateWindowUI(event);
1993 }
1994
1995 if (flags & wxUPDATE_UI_RECURSE)
1996 {
1997 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1998 while (node)
1999 {
2000 wxWindow* child = (wxWindow*) node->GetData();
2001 child->UpdateWindowUI(flags);
2002 node = node->GetNext();
2003 }
2004 }
2005}
2006
2007// do the window-specific processing after processing the update event
2008void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
2009{
2010 if ( event.GetSetEnabled() )
2011 Enable(event.GetEnabled());
2012
2013 if ( event.GetSetShown() )
2014 Show(event.GetShown());
2015}
2016
2017#if 0
2018// call internal idle recursively
2019// may be obsolete (wait until OnIdle scheme stabilises)
2020void wxWindowBase::ProcessInternalIdle()
2021{
2022 OnInternalIdle();
2023
2024 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2025 while (node)
2026 {
2027 wxWindow *child = node->GetData();
2028 child->ProcessInternalIdle();
2029 node = node->GetNext();
2030 }
2031}
2032#endif
2033
2034// ----------------------------------------------------------------------------
2035// dialog units translations
2036// ----------------------------------------------------------------------------
2037
2038wxPoint wxWindowBase::ConvertPixelsToDialog(const wxPoint& pt)
2039{
2040 int charWidth = GetCharWidth();
2041 int charHeight = GetCharHeight();
2042 wxPoint pt2 = wxDefaultPosition;
2043 if (pt.x != wxDefaultCoord)
2044 pt2.x = (int) ((pt.x * 4) / charWidth);
2045 if (pt.y != wxDefaultCoord)
2046 pt2.y = (int) ((pt.y * 8) / charHeight);
2047
2048 return pt2;
2049}
2050
2051wxPoint wxWindowBase::ConvertDialogToPixels(const wxPoint& pt)
2052{
2053 int charWidth = GetCharWidth();
2054 int charHeight = GetCharHeight();
2055 wxPoint pt2 = wxDefaultPosition;
2056 if (pt.x != wxDefaultCoord)
2057 pt2.x = (int) ((pt.x * charWidth) / 4);
2058 if (pt.y != wxDefaultCoord)
2059 pt2.y = (int) ((pt.y * charHeight) / 8);
2060
2061 return pt2;
2062}
2063
2064// ----------------------------------------------------------------------------
2065// event handlers
2066// ----------------------------------------------------------------------------
2067
2068// propagate the colour change event to the subwindows
2069void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent& event)
2070{
2071 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2072 while ( node )
2073 {
2074 // Only propagate to non-top-level windows
2075 wxWindow *win = node->GetData();
2076 if ( !win->IsTopLevel() )
2077 {
2078 wxSysColourChangedEvent event2;
2079 event.SetEventObject(win);
2080 win->GetEventHandler()->ProcessEvent(event2);
2081 }
2082
2083 node = node->GetNext();
2084 }
2085
2086 Refresh();
2087}
2088
2089// the default action is to populate dialog with data when it's created,
2090// and nudge the UI into displaying itself correctly in case
2091// we've turned the wxUpdateUIEvents frequency down low.
2092void wxWindowBase::OnInitDialog( wxInitDialogEvent &WXUNUSED(event) )
2093{
2094 TransferDataToWindow();
2095
2096 // Update the UI at this point
2097 UpdateWindowUI(wxUPDATE_UI_RECURSE);
2098}
2099
2100// methods for drawing the sizers in a visible way
2101#ifdef __WXDEBUG__
2102
2103static void DrawSizers(wxWindowBase *win);
2104
2105static void DrawBorder(wxWindowBase *win, const wxRect& rect, bool fill = false)
2106{
2107 wxClientDC dc((wxWindow *)win);
2108 dc.SetPen(*wxRED_PEN);
2109 dc.SetBrush(fill ? wxBrush(*wxRED, wxCROSSDIAG_HATCH): *wxTRANSPARENT_BRUSH);
2110 dc.DrawRectangle(rect.Deflate(1, 1));
2111}
2112
2113static void DrawSizer(wxWindowBase *win, wxSizer *sizer)
2114{
2115 const wxSizerItemList& items = sizer->GetChildren();
2116 for ( wxSizerItemList::const_iterator i = items.begin(),
2117 end = items.end();
2118 i != end;
2119 ++i )
2120 {
2121 wxSizerItem *item = *i;
2122 if ( item->IsSizer() )
2123 {
2124 DrawBorder(win, item->GetRect().Deflate(2));
2125 DrawSizer(win, item->GetSizer());
2126 }
2127 else if ( item->IsSpacer() )
2128 {
2129 DrawBorder(win, item->GetRect().Deflate(2), true);
2130 }
2131 else if ( item->IsWindow() )
2132 {
2133 DrawSizers(item->GetWindow());
2134 }
2135 }
2136}
2137
2138static void DrawSizers(wxWindowBase *win)
2139{
2140 wxSizer *sizer = win->GetSizer();
2141 if ( sizer )
2142 {
2143 DrawBorder(win, win->GetClientSize());
2144 DrawSizer(win, sizer);
2145 }
2146 else // no sizer, still recurse into the children
2147 {
2148 const wxWindowList& children = win->GetChildren();
2149 for ( wxWindowList::const_iterator i = children.begin(),
2150 end = children.end();
2151 i != end;
2152 ++i )
2153 {
2154 DrawSizers(*i);
2155 }
2156 }
2157}
2158
2159#endif // __WXDEBUG__
2160
2161// process special middle clicks
2162void wxWindowBase::OnMiddleClick( wxMouseEvent& event )
2163{
2164 if ( event.ControlDown() && event.AltDown() )
2165 {
2166#ifdef __WXDEBUG__
2167 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
2168 if ( event.ShiftDown() )
2169 {
2170 DrawSizers(this);
2171 return;
2172 }
2173#endif // __WXDEBUG__
2174
2175#if wxUSE_MSGDLG
2176 // don't translate these strings
2177 wxString port;
2178
2179#ifdef __WXUNIVERSAL__
2180 port = _T("Univ/");
2181#endif // __WXUNIVERSAL__
2182
2183 switch ( wxGetOsVersion() )
2184 {
2185 case wxMOTIF_X: port += _T("Motif"); break;
2186 case wxMAC:
2187 case wxMAC_DARWIN: port += _T("Mac"); break;
2188 case wxBEOS: port += _T("BeOS"); break;
2189 case wxGTK:
2190 case wxGTK_WIN32:
2191 case wxGTK_OS2:
2192 case wxGTK_BEOS: port += _T("GTK"); break;
2193 case wxWINDOWS:
2194 case wxPENWINDOWS:
2195 case wxWINDOWS_NT:
2196 case wxWIN32S:
2197 case wxWIN95:
2198 case wxWIN386: port += _T("MS Windows"); break;
2199 case wxMGL_UNIX:
2200 case wxMGL_X:
2201 case wxMGL_WIN32:
2202 case wxMGL_OS2: port += _T("MGL"); break;
2203 case wxWINDOWS_OS2:
2204 case wxOS2_PM: port += _T("OS/2"); break;
2205 case wxPALMOS: port += _T("Palm OS"); break;
2206 case wxWINDOWS_CE: port += _T("Windows CE (generic)"); break;
2207 case wxWINDOWS_POCKETPC: port += _T("Windows CE PocketPC"); break;
2208 case wxWINDOWS_SMARTPHONE: port += _T("Windows CE Smartphone"); break;
2209 default: port += _T("unknown"); break;
2210 }
2211
2212 wxMessageBox(wxString::Format(
2213 _T(
2214 " wxWidgets Library (%s port)\nVersion %d.%d.%d%s%s, compiled at %s %s%s\n Copyright (c) 1995-2006 wxWidgets team"
2215 ),
2216 port.c_str(),
2217 wxMAJOR_VERSION,
2218 wxMINOR_VERSION,
2219 wxRELEASE_NUMBER,
2220#if wxUSE_UNICODE
2221 L" (Unicode)",
2222#else
2223 "",
2224#endif
2225#ifdef __WXDEBUG__
2226 _T(" Debug build"),
2227#else
2228 wxEmptyString,
2229#endif
2230 __TDATE__,
2231 __TTIME__,
2232#ifdef __WXGTK__
2233 wxString::Format(_T("\nagainst GTK+ %d.%d.%d. Runtime GTK+ version: %d.%d.%d"), GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION, gtk_major_version, gtk_minor_version, gtk_micro_version).c_str()
2234#else
2235 ""
2236#endif
2237 ),
2238 _T("wxWidgets information"),
2239 wxICON_INFORMATION | wxOK,
2240 (wxWindow *)this);
2241 }
2242 else
2243#endif // wxUSE_MSGDLG
2244 {
2245 event.Skip();
2246 }
2247}
2248
2249// ----------------------------------------------------------------------------
2250// accessibility
2251// ----------------------------------------------------------------------------
2252
2253#if wxUSE_ACCESSIBILITY
2254void wxWindowBase::SetAccessible(wxAccessible* accessible)
2255{
2256 if (m_accessible && (accessible != m_accessible))
2257 delete m_accessible;
2258 m_accessible = accessible;
2259 if (m_accessible)
2260 m_accessible->SetWindow((wxWindow*) this);
2261}
2262
2263// Returns the accessible object, creating if necessary.
2264wxAccessible* wxWindowBase::GetOrCreateAccessible()
2265{
2266 if (!m_accessible)
2267 m_accessible = CreateAccessible();
2268 return m_accessible;
2269}
2270
2271// Override to create a specific accessible object.
2272wxAccessible* wxWindowBase::CreateAccessible()
2273{
2274 return new wxWindowAccessible((wxWindow*) this);
2275}
2276
2277#endif
2278
2279// ----------------------------------------------------------------------------
2280// list classes implementation
2281// ----------------------------------------------------------------------------
2282
2283#if wxUSE_STL
2284
2285#include "wx/listimpl.cpp"
2286WX_DEFINE_LIST(wxWindowList)
2287
2288#else
2289
2290void wxWindowListNode::DeleteData()
2291{
2292 delete (wxWindow *)GetData();
2293}
2294
2295#endif
2296
2297// ----------------------------------------------------------------------------
2298// borders
2299// ----------------------------------------------------------------------------
2300
2301wxBorder wxWindowBase::GetBorder(long flags) const
2302{
2303 wxBorder border = (wxBorder)(flags & wxBORDER_MASK);
2304 if ( border == wxBORDER_DEFAULT )
2305 {
2306 border = GetDefaultBorder();
2307 }
2308
2309 return border;
2310}
2311
2312wxBorder wxWindowBase::GetDefaultBorder() const
2313{
2314 return wxBORDER_NONE;
2315}
2316
2317// ----------------------------------------------------------------------------
2318// hit testing
2319// ----------------------------------------------------------------------------
2320
2321wxHitTest wxWindowBase::DoHitTest(wxCoord x, wxCoord y) const
2322{
2323 // here we just check if the point is inside the window or not
2324
2325 // check the top and left border first
2326 bool outside = x < 0 || y < 0;
2327 if ( !outside )
2328 {
2329 // check the right and bottom borders too
2330 wxSize size = GetSize();
2331 outside = x >= size.x || y >= size.y;
2332 }
2333
2334 return outside ? wxHT_WINDOW_OUTSIDE : wxHT_WINDOW_INSIDE;
2335}
2336
2337// ----------------------------------------------------------------------------
2338// mouse capture
2339// ----------------------------------------------------------------------------
2340
2341struct WXDLLEXPORT wxWindowNext
2342{
2343 wxWindow *win;
2344 wxWindowNext *next;
2345} *wxWindowBase::ms_winCaptureNext = NULL;
2346
2347void wxWindowBase::CaptureMouse()
2348{
2349 wxLogTrace(_T("mousecapture"), _T("CaptureMouse(%p)"), this);
2350
2351 wxWindow *winOld = GetCapture();
2352 if ( winOld )
2353 {
2354 ((wxWindowBase*) winOld)->DoReleaseMouse();
2355
2356 // save it on stack
2357 wxWindowNext *item = new wxWindowNext;
2358 item->win = winOld;
2359 item->next = ms_winCaptureNext;
2360 ms_winCaptureNext = item;
2361 }
2362 //else: no mouse capture to save
2363
2364 DoCaptureMouse();
2365}
2366
2367void wxWindowBase::ReleaseMouse()
2368{
2369 wxLogTrace(_T("mousecapture"), _T("ReleaseMouse(%p)"), this);
2370
2371 wxASSERT_MSG( GetCapture() == this, wxT("attempt to release mouse, but this window hasn't captured it") );
2372
2373 DoReleaseMouse();
2374
2375 if ( ms_winCaptureNext )
2376 {
2377 ((wxWindowBase*)ms_winCaptureNext->win)->DoCaptureMouse();
2378
2379 wxWindowNext *item = ms_winCaptureNext;
2380 ms_winCaptureNext = item->next;
2381 delete item;
2382 }
2383 //else: stack is empty, no previous capture
2384
2385 wxLogTrace(_T("mousecapture"),
2386 (const wxChar *) _T("After ReleaseMouse() mouse is captured by %p"),
2387 GetCapture());
2388}
2389
2390#if wxUSE_HOTKEY
2391
2392bool
2393wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId),
2394 int WXUNUSED(modifiers),
2395 int WXUNUSED(keycode))
2396{
2397 // not implemented
2398 return false;
2399}
2400
2401bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId))
2402{
2403 // not implemented
2404 return false;
2405}
2406
2407#endif // wxUSE_HOTKEY
2408
2409void wxWindowBase::SendDestroyEvent()
2410{
2411 wxWindowDestroyEvent event;
2412 event.SetEventObject(this);
2413 event.SetId(GetId());
2414 GetEventHandler()->ProcessEvent(event);
2415}
2416
2417// ----------------------------------------------------------------------------
2418// event processing
2419// ----------------------------------------------------------------------------
2420
2421bool wxWindowBase::TryValidator(wxEvent& wxVALIDATOR_PARAM(event))
2422{
2423#if wxUSE_VALIDATORS
2424 // Can only use the validator of the window which
2425 // is receiving the event
2426 if ( event.GetEventObject() == this )
2427 {
2428 wxValidator *validator = GetValidator();
2429 if ( validator && validator->ProcessEvent(event) )
2430 {
2431 return true;
2432 }
2433 }
2434#endif // wxUSE_VALIDATORS
2435
2436 return false;
2437}
2438
2439bool wxWindowBase::TryParent(wxEvent& event)
2440{
2441 // carry on up the parent-child hierarchy if the propagation count hasn't
2442 // reached zero yet
2443 if ( event.ShouldPropagate() )
2444 {
2445 // honour the requests to stop propagation at this window: this is
2446 // used by the dialogs, for example, to prevent processing the events
2447 // from the dialog controls in the parent frame which rarely, if ever,
2448 // makes sense
2449 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
2450 {
2451 wxWindow *parent = GetParent();
2452 if ( parent && !parent->IsBeingDeleted() )
2453 {
2454 wxPropagateOnce propagateOnce(event);
2455
2456 return parent->GetEventHandler()->ProcessEvent(event);
2457 }
2458 }
2459 }
2460
2461 return wxEvtHandler::TryParent(event);
2462}
2463
2464// ----------------------------------------------------------------------------
2465// keyboard navigation
2466// ----------------------------------------------------------------------------
2467
2468// Navigates in the specified direction.
2469bool wxWindowBase::Navigate(int flags)
2470{
2471 wxNavigationKeyEvent eventNav;
2472 eventNav.SetFlags(flags);
2473 eventNav.SetEventObject(this);
2474 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
2475 {
2476 return true;
2477 }
2478 return false;
2479}
2480
2481void wxWindowBase::DoMoveInTabOrder(wxWindow *win, MoveKind move)
2482{
2483 // check that we're not a top level window
2484 wxCHECK_RET( GetParent(),
2485 _T("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
2486
2487 // detect the special case when we have nothing to do anyhow and when the
2488 // code below wouldn't work
2489 if ( win == this )
2490 return;
2491
2492 // find the target window in the siblings list
2493 wxWindowList& siblings = GetParent()->GetChildren();
2494 wxWindowList::compatibility_iterator i = siblings.Find(win);
2495 wxCHECK_RET( i, _T("MoveBefore/AfterInTabOrder(): win is not a sibling") );
2496
2497 // unfortunately, when wxUSE_STL == 1 DetachNode() is not implemented so we
2498 // can't just move the node around
2499 wxWindow *self = (wxWindow *)this;
2500 siblings.DeleteObject(self);
2501 if ( move == MoveAfter )
2502 {
2503 i = i->GetNext();
2504 }
2505
2506 if ( i )
2507 {
2508 siblings.Insert(i, self);
2509 }
2510 else // MoveAfter and win was the last sibling
2511 {
2512 siblings.Append(self);
2513 }
2514}
2515
2516// ----------------------------------------------------------------------------
2517// focus handling
2518// ----------------------------------------------------------------------------
2519
2520/*static*/ wxWindow* wxWindowBase::FindFocus()
2521{
2522 wxWindowBase *win = DoFindFocus();
2523 return win ? win->GetMainWindowOfCompositeControl() : NULL;
2524}
2525
2526// ----------------------------------------------------------------------------
2527// global functions
2528// ----------------------------------------------------------------------------
2529
2530wxWindow* wxGetTopLevelParent(wxWindow *win)
2531{
2532 while ( win && !win->IsTopLevel() )
2533 win = win->GetParent();
2534
2535 return win;
2536}
2537
2538#if wxUSE_ACCESSIBILITY
2539// ----------------------------------------------------------------------------
2540// accessible object for windows
2541// ----------------------------------------------------------------------------
2542
2543// Can return either a child object, or an integer
2544// representing the child element, starting from 1.
2545wxAccStatus wxWindowAccessible::HitTest(const wxPoint& WXUNUSED(pt), int* WXUNUSED(childId), wxAccessible** WXUNUSED(childObject))
2546{
2547 wxASSERT( GetWindow() != NULL );
2548 if (!GetWindow())
2549 return wxACC_FAIL;
2550
2551 return wxACC_NOT_IMPLEMENTED;
2552}
2553
2554// Returns the rectangle for this object (id = 0) or a child element (id > 0).
2555wxAccStatus wxWindowAccessible::GetLocation(wxRect& rect, int elementId)
2556{
2557 wxASSERT( GetWindow() != NULL );
2558 if (!GetWindow())
2559 return wxACC_FAIL;
2560
2561 wxWindow* win = NULL;
2562 if (elementId == 0)
2563 {
2564 win = GetWindow();
2565 }
2566 else
2567 {
2568 if (elementId <= (int) GetWindow()->GetChildren().GetCount())
2569 {
2570 win = GetWindow()->GetChildren().Item(elementId-1)->GetData();
2571 }
2572 else
2573 return wxACC_FAIL;
2574 }
2575 if (win)
2576 {
2577 rect = win->GetRect();
2578 if (win->GetParent() && !win->IsKindOf(CLASSINFO(wxTopLevelWindow)))
2579 rect.SetPosition(win->GetParent()->ClientToScreen(rect.GetPosition()));
2580 return wxACC_OK;
2581 }
2582
2583 return wxACC_NOT_IMPLEMENTED;
2584}
2585
2586// Navigates from fromId to toId/toObject.
2587wxAccStatus wxWindowAccessible::Navigate(wxNavDir navDir, int fromId,
2588 int* WXUNUSED(toId), wxAccessible** toObject)
2589{
2590 wxASSERT( GetWindow() != NULL );
2591 if (!GetWindow())
2592 return wxACC_FAIL;
2593
2594 switch (navDir)
2595 {
2596 case wxNAVDIR_FIRSTCHILD:
2597 {
2598 if (GetWindow()->GetChildren().GetCount() == 0)
2599 return wxACC_FALSE;
2600 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetFirst()->GetData();
2601 *toObject = childWindow->GetOrCreateAccessible();
2602
2603 return wxACC_OK;
2604 }
2605 case wxNAVDIR_LASTCHILD:
2606 {
2607 if (GetWindow()->GetChildren().GetCount() == 0)
2608 return wxACC_FALSE;
2609 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetLast()->GetData();
2610 *toObject = childWindow->GetOrCreateAccessible();
2611
2612 return wxACC_OK;
2613 }
2614 case wxNAVDIR_RIGHT:
2615 case wxNAVDIR_DOWN:
2616 case wxNAVDIR_NEXT:
2617 {
2618 wxWindowList::compatibility_iterator node =
2619 wxWindowList::compatibility_iterator();
2620 if (fromId == 0)
2621 {
2622 // Can't navigate to sibling of this window
2623 // if we're a top-level window.
2624 if (!GetWindow()->GetParent())
2625 return wxACC_NOT_IMPLEMENTED;
2626
2627 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2628 }
2629 else
2630 {
2631 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
2632 node = GetWindow()->GetChildren().Item(fromId-1);
2633 }
2634
2635 if (node && node->GetNext())
2636 {
2637 wxWindow* nextWindow = node->GetNext()->GetData();
2638 *toObject = nextWindow->GetOrCreateAccessible();
2639 return wxACC_OK;
2640 }
2641 else
2642 return wxACC_FALSE;
2643 }
2644 case wxNAVDIR_LEFT:
2645 case wxNAVDIR_UP:
2646 case wxNAVDIR_PREVIOUS:
2647 {
2648 wxWindowList::compatibility_iterator node =
2649 wxWindowList::compatibility_iterator();
2650 if (fromId == 0)
2651 {
2652 // Can't navigate to sibling of this window
2653 // if we're a top-level window.
2654 if (!GetWindow()->GetParent())
2655 return wxACC_NOT_IMPLEMENTED;
2656
2657 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
2658 }
2659 else
2660 {
2661 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
2662 node = GetWindow()->GetChildren().Item(fromId-1);
2663 }
2664
2665 if (node && node->GetPrevious())
2666 {
2667 wxWindow* previousWindow = node->GetPrevious()->GetData();
2668 *toObject = previousWindow->GetOrCreateAccessible();
2669 return wxACC_OK;
2670 }
2671 else
2672 return wxACC_FALSE;
2673 }
2674 }
2675
2676 return wxACC_NOT_IMPLEMENTED;
2677}
2678
2679// Gets the name of the specified object.
2680wxAccStatus wxWindowAccessible::GetName(int childId, wxString* name)
2681{
2682 wxASSERT( GetWindow() != NULL );
2683 if (!GetWindow())
2684 return wxACC_FAIL;
2685
2686 wxString title;
2687
2688 // If a child, leave wxWidgets to call the function on the actual
2689 // child object.
2690 if (childId > 0)
2691 return wxACC_NOT_IMPLEMENTED;
2692
2693 // This will eventually be replaced by specialised
2694 // accessible classes, one for each kind of wxWidgets
2695 // control or window.
2696#if wxUSE_BUTTON
2697 if (GetWindow()->IsKindOf(CLASSINFO(wxButton)))
2698 title = ((wxButton*) GetWindow())->GetLabel();
2699 else
2700#endif
2701 title = GetWindow()->GetName();
2702
2703 if (!title.empty())
2704 {
2705 *name = title;
2706 return wxACC_OK;
2707 }
2708 else
2709 return wxACC_NOT_IMPLEMENTED;
2710}
2711
2712// Gets the number of children.
2713wxAccStatus wxWindowAccessible::GetChildCount(int* childId)
2714{
2715 wxASSERT( GetWindow() != NULL );
2716 if (!GetWindow())
2717 return wxACC_FAIL;
2718
2719 *childId = (int) GetWindow()->GetChildren().GetCount();
2720 return wxACC_OK;
2721}
2722
2723// Gets the specified child (starting from 1).
2724// If *child is NULL and return value is wxACC_OK,
2725// this means that the child is a simple element and
2726// not an accessible object.
2727wxAccStatus wxWindowAccessible::GetChild(int childId, wxAccessible** child)
2728{
2729 wxASSERT( GetWindow() != NULL );
2730 if (!GetWindow())
2731 return wxACC_FAIL;
2732
2733 if (childId == 0)
2734 {
2735 *child = this;
2736 return wxACC_OK;
2737 }
2738
2739 if (childId > (int) GetWindow()->GetChildren().GetCount())
2740 return wxACC_FAIL;
2741
2742 wxWindow* childWindow = GetWindow()->GetChildren().Item(childId-1)->GetData();
2743 *child = childWindow->GetOrCreateAccessible();
2744 if (*child)
2745 return wxACC_OK;
2746 else
2747 return wxACC_FAIL;
2748}
2749
2750// Gets the parent, or NULL.
2751wxAccStatus wxWindowAccessible::GetParent(wxAccessible** parent)
2752{
2753 wxASSERT( GetWindow() != NULL );
2754 if (!GetWindow())
2755 return wxACC_FAIL;
2756
2757 wxWindow* parentWindow = GetWindow()->GetParent();
2758 if (!parentWindow)
2759 {
2760 *parent = NULL;
2761 return wxACC_OK;
2762 }
2763 else
2764 {
2765 *parent = parentWindow->GetOrCreateAccessible();
2766 if (*parent)
2767 return wxACC_OK;
2768 else
2769 return wxACC_FAIL;
2770 }
2771}
2772
2773// Performs the default action. childId is 0 (the action for this object)
2774// or > 0 (the action for a child).
2775// Return wxACC_NOT_SUPPORTED if there is no default action for this
2776// window (e.g. an edit control).
2777wxAccStatus wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
2778{
2779 wxASSERT( GetWindow() != NULL );
2780 if (!GetWindow())
2781 return wxACC_FAIL;
2782
2783 return wxACC_NOT_IMPLEMENTED;
2784}
2785
2786// Gets the default action for this object (0) or > 0 (the action for a child).
2787// Return wxACC_OK even if there is no action. actionName is the action, or the empty
2788// string if there is no action.
2789// The retrieved string describes the action that is performed on an object,
2790// not what the object does as a result. For example, a toolbar button that prints
2791// a document has a default action of "Press" rather than "Prints the current document."
2792wxAccStatus wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId), wxString* WXUNUSED(actionName))
2793{
2794 wxASSERT( GetWindow() != NULL );
2795 if (!GetWindow())
2796 return wxACC_FAIL;
2797
2798 return wxACC_NOT_IMPLEMENTED;
2799}
2800
2801// Returns the description for this object or a child.
2802wxAccStatus wxWindowAccessible::GetDescription(int WXUNUSED(childId), wxString* description)
2803{
2804 wxASSERT( GetWindow() != NULL );
2805 if (!GetWindow())
2806 return wxACC_FAIL;
2807
2808 wxString ht(GetWindow()->GetHelpText());
2809 if (!ht.empty())
2810 {
2811 *description = ht;
2812 return wxACC_OK;
2813 }
2814 return wxACC_NOT_IMPLEMENTED;
2815}
2816
2817// Returns help text for this object or a child, similar to tooltip text.
2818wxAccStatus wxWindowAccessible::GetHelpText(int WXUNUSED(childId), wxString* helpText)
2819{
2820 wxASSERT( GetWindow() != NULL );
2821 if (!GetWindow())
2822 return wxACC_FAIL;
2823
2824 wxString ht(GetWindow()->GetHelpText());
2825 if (!ht.empty())
2826 {
2827 *helpText = ht;
2828 return wxACC_OK;
2829 }
2830 return wxACC_NOT_IMPLEMENTED;
2831}
2832
2833// Returns the keyboard shortcut for this object or child.
2834// Return e.g. ALT+K
2835wxAccStatus wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId), wxString* WXUNUSED(shortcut))
2836{
2837 wxASSERT( GetWindow() != NULL );
2838 if (!GetWindow())
2839 return wxACC_FAIL;
2840
2841 return wxACC_NOT_IMPLEMENTED;
2842}
2843
2844// Returns a role constant.
2845wxAccStatus wxWindowAccessible::GetRole(int childId, wxAccRole* role)
2846{
2847 wxASSERT( GetWindow() != NULL );
2848 if (!GetWindow())
2849 return wxACC_FAIL;
2850
2851 // If a child, leave wxWidgets to call the function on the actual
2852 // child object.
2853 if (childId > 0)
2854 return wxACC_NOT_IMPLEMENTED;
2855
2856 if (GetWindow()->IsKindOf(CLASSINFO(wxControl)))
2857 return wxACC_NOT_IMPLEMENTED;
2858#if wxUSE_STATUSBAR
2859 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar)))
2860 return wxACC_NOT_IMPLEMENTED;
2861#endif
2862#if wxUSE_TOOLBAR
2863 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar)))
2864 return wxACC_NOT_IMPLEMENTED;
2865#endif
2866
2867 //*role = wxROLE_SYSTEM_CLIENT;
2868 *role = wxROLE_SYSTEM_CLIENT;
2869 return wxACC_OK;
2870
2871 #if 0
2872 return wxACC_NOT_IMPLEMENTED;
2873 #endif
2874}
2875
2876// Returns a state constant.
2877wxAccStatus wxWindowAccessible::GetState(int childId, long* state)
2878{
2879 wxASSERT( GetWindow() != NULL );
2880 if (!GetWindow())
2881 return wxACC_FAIL;
2882
2883 // If a child, leave wxWidgets to call the function on the actual
2884 // child object.
2885 if (childId > 0)
2886 return wxACC_NOT_IMPLEMENTED;
2887
2888 if (GetWindow()->IsKindOf(CLASSINFO(wxControl)))
2889 return wxACC_NOT_IMPLEMENTED;
2890
2891#if wxUSE_STATUSBAR
2892 if (GetWindow()->IsKindOf(CLASSINFO(wxStatusBar)))
2893 return wxACC_NOT_IMPLEMENTED;
2894#endif
2895#if wxUSE_TOOLBAR
2896 if (GetWindow()->IsKindOf(CLASSINFO(wxToolBar)))
2897 return wxACC_NOT_IMPLEMENTED;
2898#endif
2899
2900 *state = 0;
2901 return wxACC_OK;
2902
2903 #if 0
2904 return wxACC_NOT_IMPLEMENTED;
2905 #endif
2906}
2907
2908// Returns a localized string representing the value for the object
2909// or child.
2910wxAccStatus wxWindowAccessible::GetValue(int WXUNUSED(childId), wxString* WXUNUSED(strValue))
2911{
2912 wxASSERT( GetWindow() != NULL );
2913 if (!GetWindow())
2914 return wxACC_FAIL;
2915
2916 return wxACC_NOT_IMPLEMENTED;
2917}
2918
2919// Selects the object or child.
2920wxAccStatus wxWindowAccessible::Select(int WXUNUSED(childId), wxAccSelectionFlags WXUNUSED(selectFlags))
2921{
2922 wxASSERT( GetWindow() != NULL );
2923 if (!GetWindow())
2924 return wxACC_FAIL;
2925
2926 return wxACC_NOT_IMPLEMENTED;
2927}
2928
2929// Gets the window with the keyboard focus.
2930// If childId is 0 and child is NULL, no object in
2931// this subhierarchy has the focus.
2932// If this object has the focus, child should be 'this'.
2933wxAccStatus wxWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
2934{
2935 wxASSERT( GetWindow() != NULL );
2936 if (!GetWindow())
2937 return wxACC_FAIL;
2938
2939 return wxACC_NOT_IMPLEMENTED;
2940}
2941
2942// Gets a variant representing the selected children
2943// of this object.
2944// Acceptable values:
2945// - a null variant (IsNull() returns true)
2946// - a list variant (GetType() == wxT("list")
2947// - an integer representing the selected child element,
2948// or 0 if this object is selected (GetType() == wxT("long")
2949// - a "void*" pointer to a wxAccessible child object
2950wxAccStatus wxWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
2951{
2952 wxASSERT( GetWindow() != NULL );
2953 if (!GetWindow())
2954 return wxACC_FAIL;
2955
2956 return wxACC_NOT_IMPLEMENTED;
2957}
2958
2959#endif // wxUSE_ACCESSIBILITY
wxWidgets (Impactor)