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