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