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