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