]> git.saurik.com Git - wxWidgets.git/blob - src/common/wincmn.cpp
projects / wxWidgets.git / blob
? search:


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