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