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