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