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