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