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