]> git.saurik.com Git - wxWidgets.git/blame - src/common/wincmn.cpp
Standardize on using "Added" instead of "Add" in the change log.
[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
a0fe7703
VZ
1152 // Disabling a top level window is typically done when showing a modal
1153 // dialog and we don't need to disable its children in this case, they will
1154 // be logically disabled anyhow (i.e. their IsEnabled() will return false)
1155 // and the TLW won't accept any input for them. Moreover, explicitly
1156 // disabling them would look ugly as the entire TLW would be greyed out
1157 // whenever a modal dialog is shown and no native applications under any
1158 // platform behave like this.
1159 if ( IsTopLevel() && !enabled )
47a8a4d5
VZ
1160 return;
1161
a0fe7703
VZ
1162 // When disabling (or enabling back) a non-TLW window we need to
1163 // recursively propagate the change of the state to its children, otherwise
1164 // they would still show as enabled even though they wouldn't actually
1165 // accept any input (at least under MSW where children don't accept input
1166 // if any of the windows in their parent chain is enabled).
00a399c0 1167#ifndef wxHAS_NATIVE_ENABLED_MANAGEMENT
47a8a4d5
VZ
1168 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1169 node;
1170 node = node->GetNext() )
f03fc89f 1171 {
47a8a4d5
VZ
1172 wxWindowBase * const child = node->GetData();
1173 if ( !child->IsTopLevel() && child->IsThisEnabled() )
1174 child->NotifyWindowOnEnableChange(enabled);
1175 }
00a399c0 1176#endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
47a8a4d5
VZ
1177}
1178
1179bool wxWindowBase::Enable(bool enable)
1180{
1181 if ( enable == IsThisEnabled() )
e11f4636 1182 return false;
47a8a4d5
VZ
1183
1184 m_isEnabled = enable;
1185
a0fe7703
VZ
1186 // If we call DoEnable() from NotifyWindowOnEnableChange(), we don't need
1187 // to do it from here.
47a8a4d5
VZ
1188#ifdef wxHAS_NATIVE_ENABLED_MANAGEMENT
1189 DoEnable(enable);
47a8a4d5
VZ
1190#endif // !defined(wxHAS_NATIVE_ENABLED_MANAGEMENT)
1191
1192 NotifyWindowOnEnableChange(enable);
1193
1194 return true;
f03fc89f 1195}
9c72cf76 1196
865a74c7 1197bool wxWindowBase::IsShownOnScreen() const
9c72cf76 1198{
8a6a997f
VS
1199 // A window is shown on screen if it itself is shown and so are all its
1200 // parents. But if a window is toplevel one, then its always visible on
1201 // screen if IsShown() returns true, even if it has a hidden parent.
865a74c7 1202 return IsShown() &&
8a6a997f 1203 (IsTopLevel() || GetParent() == NULL || GetParent()->IsShownOnScreen());
9c72cf76
VS
1204}
1205
34636400
VZ
1206// ----------------------------------------------------------------------------
1207// RTTI
1208// ----------------------------------------------------------------------------
1209
1210bool wxWindowBase::IsTopLevel() const
1211{
e11f4636 1212 return false;
34636400 1213}
f03fc89f 1214
1c8e5c51
VS
1215// ----------------------------------------------------------------------------
1216// Freeze/Thaw
1217// ----------------------------------------------------------------------------
1218
1219void wxWindowBase::Freeze()
1220{
1221 if ( !m_freezeCount++ )
1222 {
1223 // physically freeze this window:
1224 DoFreeze();
1225
1226 // and recursively freeze all children:
1227 for ( wxWindowList::iterator i = GetChildren().begin();
1228 i != GetChildren().end(); ++i )
1229 {
1230 wxWindow *child = *i;
1231 if ( child->IsTopLevel() )
1232 continue;
1233
1234 child->Freeze();
1235 }
1236 }
1237}
1238
1239void wxWindowBase::Thaw()
1240{
1241 wxASSERT_MSG( m_freezeCount, "Thaw() without matching Freeze()" );
1242
1243 if ( !--m_freezeCount )
1244 {
1245 // recursively thaw all children:
1246 for ( wxWindowList::iterator i = GetChildren().begin();
1247 i != GetChildren().end(); ++i )
1248 {
1249 wxWindow *child = *i;
1250 if ( child->IsTopLevel() )
1251 continue;
1252
1253 child->Thaw();
1254 }
1255
1256 // physically thaw this window:
1257 DoThaw();
1258 }
1259}
1260
f03fc89f 1261// ----------------------------------------------------------------------------
8b2f64c6 1262// Dealing with parents and children.
f03fc89f
VZ
1263// ----------------------------------------------------------------------------
1264
8b2f64c6
VZ
1265bool wxWindowBase::IsDescendant(wxWindowBase* win) const
1266{
1267 // Iterate until we find this window in the parent chain or exhaust it.
1268 while ( win )
1269 {
fd20ceff 1270 if ( win == this )
8b2f64c6
VZ
1271 return true;
1272
1273 // Stop iterating on reaching the top level window boundary.
fd20ceff 1274 if ( win->IsTopLevel() )
8b2f64c6
VZ
1275 break;
1276
fd20ceff 1277 win = win->GetParent();
8b2f64c6
VZ
1278 }
1279
1280 return false;
1281}
1282
f03fc89f
VZ
1283void wxWindowBase::AddChild(wxWindowBase *child)
1284{
223d09f6 1285 wxCHECK_RET( child, wxT("can't add a NULL child") );
f03fc89f 1286
f6bcfd97
BP
1287 // this should never happen and it will lead to a crash later if it does
1288 // because RemoveChild() will remove only one node from the children list
1289 // and the other(s) one(s) will be left with dangling pointers in them
9a83f860 1290 wxASSERT_MSG( !GetChildren().Find((wxWindow*)child), wxT("AddChild() called twice") );
f6bcfd97 1291
222ed1d6 1292 GetChildren().Append((wxWindow*)child);
f03fc89f 1293 child->SetParent(this);
1c8e5c51 1294
76be36e4 1295 // adding a child while frozen will assert when thawed, so freeze it as if
1c8e5c51
VS
1296 // it had been already present when we were frozen
1297 if ( IsFrozen() && !child->IsTopLevel() )
1298 child->Freeze();
f03fc89f
VZ
1299}
1300
1301void wxWindowBase::RemoveChild(wxWindowBase *child)
1302{
223d09f6 1303 wxCHECK_RET( child, wxT("can't remove a NULL child") );
f03fc89f 1304
1c8e5c51
VS
1305 // removing a child while frozen may result in permanently frozen window
1306 // if used e.g. from Reparent(), so thaw it
76be36e4
VZ
1307 //
1308 // NB: IsTopLevel() doesn't return true any more when a TLW child is being
1309 // removed from its ~wxWindowBase, so check for IsBeingDeleted() too
1310 if ( IsFrozen() && !child->IsBeingDeleted() && !child->IsTopLevel() )
1c8e5c51
VS
1311 child->Thaw();
1312
222ed1d6
MB
1313 GetChildren().DeleteObject((wxWindow *)child);
1314 child->SetParent(NULL);
f03fc89f 1315}
439b3bf1 1316
e0fddcef
VZ
1317void wxWindowBase::SetParent(wxWindowBase *parent)
1318{
1319 // This assert catches typos which may result in using "this" instead of
1320 // "parent" when creating the window. This doesn't happen often but when it
1321 // does the results are unpleasant because the program typically just
1322 // crashes when due to a stack overflow or something similar and this
1323 // assert doesn't cost much (OTOH doing a more general check that the
1324 // parent is not one of our children would be more expensive and probably
1325 // not worth it).
1326 wxASSERT_MSG( parent != this, wxS("Can't use window as its own parent") );
1327
1328 m_parent = (wxWindow *)parent;
1329}
1330
f03fc89f
VZ
1331bool wxWindowBase::Reparent(wxWindowBase *newParent)
1332{
1333 wxWindow *oldParent = GetParent();
1334 if ( newParent == oldParent )
1335 {
1336 // nothing done
e11f4636 1337 return false;
f03fc89f
VZ
1338 }
1339
47a8a4d5
VZ
1340 const bool oldEnabledState = IsEnabled();
1341
f03fc89f
VZ
1342 // unlink this window from the existing parent.
1343 if ( oldParent )
1344 {
1345 oldParent->RemoveChild(this);
1346 }
1347 else
1348 {
222ed1d6 1349 wxTopLevelWindows.DeleteObject((wxWindow *)this);
f03fc89f
VZ
1350 }
1351
1352 // add it to the new one
1353 if ( newParent )
1354 {
1355 newParent->AddChild(this);
1356 }
1357 else
1358 {
222ed1d6 1359 wxTopLevelWindows.Append((wxWindow *)this);
f03fc89f
VZ
1360 }
1361
47a8a4d5
VZ
1362 // We need to notify window (and its subwindows) if by changing the parent
1363 // we also change our enabled/disabled status.
1364 const bool newEnabledState = IsEnabled();
1365 if ( newEnabledState != oldEnabledState )
1366 {
1367 NotifyWindowOnEnableChange(newEnabledState);
1368 }
1369
e11f4636 1370 return true;
f03fc89f
VZ
1371}
1372
1373// ----------------------------------------------------------------------------
1374// event handler stuff
1375// ----------------------------------------------------------------------------
1376
7f853dd0 1377void wxWindowBase::SetEventHandler(wxEvtHandler *handler)
f03fc89f 1378{
7f853dd0
FM
1379 wxCHECK_RET(handler != NULL, "SetEventHandler(NULL) called");
1380
1381 m_eventHandler = handler;
1382}
1383
1384void wxWindowBase::SetNextHandler(wxEvtHandler *WXUNUSED(handler))
1385{
1386 // disable wxEvtHandler chain mechanism for wxWindows:
1387 // wxWindow uses its own stack mechanism which doesn't mix well with wxEvtHandler's one
1388
1389 wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1390}
1391void wxWindowBase::SetPreviousHandler(wxEvtHandler *WXUNUSED(handler))
1392{
1393 // we can't simply wxFAIL here as in SetNextHandler: in fact the last
1394 // handler of our stack when is destroyed will be Unlink()ed and thus
1395 // will call this function to update the pointer of this window...
1396
1397 //wxFAIL_MSG("wxWindow cannot be part of a wxEvtHandler chain");
1398}
1399
1400void wxWindowBase::PushEventHandler(wxEvtHandler *handlerToPush)
1401{
1402 wxCHECK_RET( handlerToPush != NULL, "PushEventHandler(NULL) called" );
1403
1404 // the new handler is going to be part of the wxWindow stack of event handlers:
1405 // it can't be part also of an event handler double-linked chain:
1406 wxASSERT_MSG(handlerToPush->IsUnlinked(),
1407 "The handler being pushed in the wxWindow stack shouldn't be part of "
1408 "a wxEvtHandler chain; call Unlink() on it first");
1409
3a074ba8 1410 wxEvtHandler *handlerOld = GetEventHandler();
7f853dd0
FM
1411 wxCHECK_RET( handlerOld, "an old event handler is NULL?" );
1412
1413 // now use wxEvtHandler double-linked list to implement a stack:
1414 handlerToPush->SetNextHandler(handlerOld);
3a074ba8 1415
7f853dd0
FM
1416 if (handlerOld != this)
1417 handlerOld->SetPreviousHandler(handlerToPush);
3a074ba8 1418
7f853dd0 1419 SetEventHandler(handlerToPush);
3a074ba8 1420
4b6a582b 1421#if wxDEBUG_LEVEL
7f853dd0
FM
1422 // final checks of the operations done above:
1423 wxASSERT_MSG( handlerToPush->GetPreviousHandler() == NULL,
4b6a582b
VZ
1424 "the first handler of the wxWindow stack should "
1425 "have no previous handlers set" );
7f853dd0 1426 wxASSERT_MSG( handlerToPush->GetNextHandler() != NULL,
4b6a582b
VZ
1427 "the first handler of the wxWindow stack should "
1428 "have non-NULL next handler" );
7f853dd0
FM
1429
1430 wxEvtHandler* pLast = handlerToPush;
4b6a582b 1431 while ( pLast && pLast != this )
7f853dd0
FM
1432 pLast = pLast->GetNextHandler();
1433 wxASSERT_MSG( pLast->GetNextHandler() == NULL,
4b6a582b
VZ
1434 "the last handler of the wxWindow stack should "
1435 "have this window as next handler" );
1436#endif // wxDEBUG_LEVEL
f03fc89f
VZ
1437}
1438
1439wxEvtHandler *wxWindowBase::PopEventHandler(bool deleteHandler)
1440{
7f853dd0 1441 // we need to pop the wxWindow stack, i.e. we need to remove the first handler
3a074ba8 1442
7f853dd0
FM
1443 wxEvtHandler *firstHandler = GetEventHandler();
1444 wxCHECK_MSG( firstHandler != NULL, NULL, "wxWindow cannot have a NULL event handler" );
1445 wxCHECK_MSG( firstHandler != this, NULL, "cannot pop the wxWindow itself" );
1446 wxCHECK_MSG( firstHandler->GetPreviousHandler() == NULL, NULL,
1447 "the first handler of the wxWindow stack should have no previous handlers set" );
3a074ba8 1448
7f853dd0
FM
1449 wxEvtHandler *secondHandler = firstHandler->GetNextHandler();
1450 wxCHECK_MSG( secondHandler != NULL, NULL,
1451 "the first handler of the wxWindow stack should have non-NULL next handler" );
1452
1453 firstHandler->SetNextHandler(NULL);
0cafb078
VZ
1454
1455 // It is harmless but useless to unset the previous handler of the window
1456 // itself as it's always NULL anyhow, so don't do this.
1457 if ( secondHandler != this )
1458 secondHandler->SetPreviousHandler(NULL);
7f853dd0
FM
1459
1460 // now firstHandler is completely unlinked; set secondHandler as the new window event handler
1461 SetEventHandler(secondHandler);
1462
1463 if ( deleteHandler )
1464 {
5276b0a5 1465 wxDELETE(firstHandler);
f03fc89f
VZ
1466 }
1467
7f853dd0 1468 return firstHandler;
f03fc89f
VZ
1469}
1470
7f853dd0 1471bool wxWindowBase::RemoveEventHandler(wxEvtHandler *handlerToRemove)
2e36d5cf 1472{
7f853dd0
FM
1473 wxCHECK_MSG( handlerToRemove != NULL, false, "RemoveEventHandler(NULL) called" );
1474 wxCHECK_MSG( handlerToRemove != this, false, "Cannot remove the window itself" );
1475
1476 if (handlerToRemove == GetEventHandler())
1477 {
1478 // removing the first event handler is equivalent to "popping" the stack
1479 PopEventHandler(false);
1480 return true;
1481 }
2e36d5cf 1482
7f853dd0
FM
1483 // NOTE: the wxWindow event handler list is always terminated with "this" handler
1484 wxEvtHandler *handlerCur = GetEventHandler()->GetNextHandler();
9e96e16f 1485 while ( handlerCur != this && handlerCur )
2e36d5cf
VZ
1486 {
1487 wxEvtHandler *handlerNext = handlerCur->GetNextHandler();
1488
7f853dd0 1489 if ( handlerCur == handlerToRemove )
2e36d5cf 1490 {
7f853dd0 1491 handlerCur->Unlink();
2e36d5cf 1492
7f853dd0
FM
1493 wxASSERT_MSG( handlerCur != GetEventHandler(),
1494 "the case Remove == Pop should was already handled" );
e11f4636 1495 return true;
2e36d5cf
VZ
1496 }
1497
2e36d5cf
VZ
1498 handlerCur = handlerNext;
1499 }
1500
9a83f860 1501 wxFAIL_MSG( wxT("where has the event handler gone?") );
2e36d5cf 1502
e11f4636 1503 return false;
2e36d5cf
VZ
1504}
1505
937013e0
VS
1506bool wxWindowBase::HandleWindowEvent(wxEvent& event) const
1507{
7f853dd0 1508 // SafelyProcessEvent() will handle exceptions nicely
937013e0
VS
1509 return GetEventHandler()->SafelyProcessEvent(event);
1510}
1511
f03fc89f 1512// ----------------------------------------------------------------------------
1b69c815 1513// colours, fonts &c
f03fc89f
VZ
1514// ----------------------------------------------------------------------------
1515
b8e7b673
VZ
1516void wxWindowBase::InheritAttributes()
1517{
8afef133 1518 const wxWindowBase * const parent = GetParent();
b8e7b673
VZ
1519 if ( !parent )
1520 return;
1521
1522 // we only inherit attributes which had been explicitly set for the parent
1523 // which ensures that this only happens if the user really wants it and
1524 // not by default which wouldn't make any sense in modern GUIs where the
1525 // controls don't all use the same fonts (nor colours)
f8ff87ed 1526 if ( parent->m_inheritFont && !m_hasFont )
b8e7b673
VZ
1527 SetFont(parent->GetFont());
1528
1529 // in addition, there is a possibility to explicitly forbid inheriting
1530 // colours at each class level by overriding ShouldInheritColours()
1531 if ( ShouldInheritColours() )
1532 {
f8ff87ed 1533 if ( parent->m_inheritFgCol && !m_hasFgCol )
b8e7b673
VZ
1534 SetForegroundColour(parent->GetForegroundColour());
1535
eb96212b
VZ
1536 // inheriting (solid) background colour is wrong as it totally breaks
1537 // any kind of themed backgrounds
1538 //
1539 // instead, the controls should use the same background as their parent
1540 // (ideally by not drawing it at all)
1541#if 0
f8ff87ed 1542 if ( parent->m_inheritBgCol && !m_hasBgCol )
b8e7b673 1543 SetBackgroundColour(parent->GetBackgroundColour());
eb96212b 1544#endif // 0
b8e7b673
VZ
1545 }
1546}
1547
1b69c815
VZ
1548/* static */ wxVisualAttributes
1549wxWindowBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1550{
1551 // it is important to return valid values for all attributes from here,
1552 // GetXXX() below rely on this
1553 wxVisualAttributes attrs;
1554 attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
1555 attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
1b69c815 1556
0477a857
JS
1557 // On Smartphone/PocketPC, wxSYS_COLOUR_WINDOW is a better reflection of
1558 // the usual background colour than wxSYS_COLOUR_BTNFACE.
1559 // It's a pity that wxSYS_COLOUR_WINDOW isn't always a suitable background
1560 // colour on other platforms.
1561
1562#if defined(__WXWINCE__) && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
1563 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
1564#else
1565 attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
1566#endif
1b69c815
VZ
1567 return attrs;
1568}
1569
1570wxColour wxWindowBase::GetBackgroundColour() const
1571{
1117d56f 1572 if ( !m_backgroundColour.IsOk() )
1b69c815 1573 {
9a83f860 1574 wxASSERT_MSG( !m_hasBgCol, wxT("we have invalid explicit bg colour?") );
1b69c815
VZ
1575
1576 // get our default background colour
1577 wxColour colBg = GetDefaultAttributes().colBg;
1578
1579 // we must return some valid colour to avoid redoing this every time
cbab1556 1580 // and also to avoid surprising the applications written for older
77ffb593 1581 // wxWidgets versions where GetBackgroundColour() always returned
1b69c815
VZ
1582 // something -- so give them something even if it doesn't make sense
1583 // for this window (e.g. it has a themed background)
a1b806b9 1584 if ( !colBg.IsOk() )
1b69c815
VZ
1585 colBg = GetClassDefaultAttributes().colBg;
1586
f604c658 1587 return colBg;
1b69c815 1588 }
f604c658
VS
1589 else
1590 return m_backgroundColour;
1b69c815
VZ
1591}
1592
1593wxColour wxWindowBase::GetForegroundColour() const
1594{
1595 // logic is the same as above
a1b806b9 1596 if ( !m_hasFgCol && !m_foregroundColour.IsOk() )
1b69c815 1597 {
1b69c815
VZ
1598 wxColour colFg = GetDefaultAttributes().colFg;
1599
1117d56f 1600 if ( !colFg.IsOk() )
1b69c815
VZ
1601 colFg = GetClassDefaultAttributes().colFg;
1602
f604c658 1603 return colFg;
1b69c815 1604 }
f604c658
VS
1605 else
1606 return m_foregroundColour;
1b69c815
VZ
1607}
1608
14421681
VZ
1609bool wxWindowBase::SetBackgroundStyle(wxBackgroundStyle style)
1610{
1611 // The checks below shouldn't be triggered if we're not really changing the
1612 // style.
1613 if ( style == m_backgroundStyle )
1614 return true;
1615
1616 // Transparent background style can be only set before creation because of
1617 // wxGTK limitation.
1618 wxCHECK_MSG( (style != wxBG_STYLE_TRANSPARENT) || !GetHandle(),
1619 false,
1620 "wxBG_STYLE_TRANSPARENT style can only be set before "
1621 "Create()-ing the window." );
1622
1623 // And once it is set, wxBG_STYLE_TRANSPARENT can't be unset.
1624 wxCHECK_MSG( (m_backgroundStyle != wxBG_STYLE_TRANSPARENT) ||
1625 (style == wxBG_STYLE_TRANSPARENT),
1626 false,
1627 "wxBG_STYLE_TRANSPARENT can't be unset once it was set." );
1628
1629 m_backgroundStyle = style;
1630
1631 return true;
1632}
1633
1634bool wxWindowBase::IsTransparentBackgroundSupported(wxString *reason) const
1635{
1636 if ( reason )
1637 *reason = _("This platform does not support background transparency.");
1638
1639 return false;
1640}
1641
f03fc89f
VZ
1642bool wxWindowBase::SetBackgroundColour( const wxColour &colour )
1643{
cab1a605 1644 if ( colour == m_backgroundColour )
e11f4636 1645 return false;
f03fc89f 1646
1117d56f 1647 m_hasBgCol = colour.IsOk();
17bcd9a6 1648
f8ff87ed 1649 m_inheritBgCol = m_hasBgCol;
f03fc89f 1650 m_backgroundColour = colour;
a1b806b9 1651 SetThemeEnabled( !m_hasBgCol && !m_foregroundColour.IsOk() );
e11f4636 1652 return true;
f03fc89f
VZ
1653}
1654
1655bool wxWindowBase::SetForegroundColour( const wxColour &colour )
1656{
44dfb5ce 1657 if (colour == m_foregroundColour )
e11f4636 1658 return false;
f03fc89f 1659
1117d56f 1660 m_hasFgCol = colour.IsOk();
f8ff87ed 1661 m_inheritFgCol = m_hasFgCol;
f03fc89f 1662 m_foregroundColour = colour;
a1b806b9 1663 SetThemeEnabled( !m_hasFgCol && !m_backgroundColour.IsOk() );
e11f4636 1664 return true;
f03fc89f
VZ
1665}
1666
1667bool wxWindowBase::SetCursor(const wxCursor& cursor)
1668{
8a9c2246
VZ
1669 // setting an invalid cursor is ok, it means that we don't have any special
1670 // cursor
a3ab1c18 1671 if ( m_cursor.IsSameAs(cursor) )
f03fc89f
VZ
1672 {
1673 // no change
e11f4636 1674 return false;
f03fc89f
VZ
1675 }
1676
8a9c2246 1677 m_cursor = cursor;
f03fc89f 1678
e11f4636 1679 return true;
f03fc89f
VZ
1680}
1681
f604c658 1682wxFont wxWindowBase::GetFont() const
1b69c815
VZ
1683{
1684 // logic is the same as in GetBackgroundColour()
1117d56f 1685 if ( !m_font.IsOk() )
1b69c815 1686 {
9a83f860 1687 wxASSERT_MSG( !m_hasFont, wxT("we have invalid explicit font?") );
1b69c815
VZ
1688
1689 wxFont font = GetDefaultAttributes().font;
1117d56f 1690 if ( !font.IsOk() )
1b69c815
VZ
1691 font = GetClassDefaultAttributes().font;
1692
f604c658 1693 return font;
1b69c815 1694 }
f604c658
VS
1695 else
1696 return m_font;
1b69c815
VZ
1697}
1698
f03fc89f
VZ
1699bool wxWindowBase::SetFont(const wxFont& font)
1700{
1b69c815 1701 if ( font == m_font )
f03fc89f
VZ
1702 {
1703 // no change
e11f4636 1704 return false;
f03fc89f
VZ
1705 }
1706
1b69c815 1707 m_font = font;
1117d56f 1708 m_hasFont = font.IsOk();
f8ff87ed 1709 m_inheritFont = m_hasFont;
23895080 1710
583d7e55
VS
1711 InvalidateBestSize();
1712
e11f4636 1713 return true;
f03fc89f
VZ
1714}
1715
b95edd47
VZ
1716#if wxUSE_PALETTE
1717
1718void wxWindowBase::SetPalette(const wxPalette& pal)
1719{
e11f4636 1720 m_hasCustomPalette = true;
b95edd47
VZ
1721 m_palette = pal;
1722
1723 // VZ: can anyone explain me what do we do here?
1724 wxWindowDC d((wxWindow *) this);
1725 d.SetPalette(pal);
1726}
1727
1728wxWindow *wxWindowBase::GetAncestorWithCustomPalette() const
1729{
1730 wxWindow *win = (wxWindow *)this;
1731 while ( win && !win->HasCustomPalette() )
1732 {
1733 win = win->GetParent();
1734 }
1735
1736 return win;
1737}
1738
1739#endif // wxUSE_PALETTE
1740
789295bf
VZ
1741#if wxUSE_CARET
1742void wxWindowBase::SetCaret(wxCaret *caret)
1743{
1744 if ( m_caret )
1745 {
1746 delete m_caret;
1747 }
1748
1749 m_caret = caret;
1750
1751 if ( m_caret )
1752 {
1753 wxASSERT_MSG( m_caret->GetWindow() == this,
223d09f6 1754 wxT("caret should be created associated to this window") );
789295bf
VZ
1755 }
1756}
1757#endif // wxUSE_CARET
1758
88ac883a 1759#if wxUSE_VALIDATORS
f03fc89f
VZ
1760// ----------------------------------------------------------------------------
1761// validators
1762// ----------------------------------------------------------------------------
1763
1764void wxWindowBase::SetValidator(const wxValidator& validator)
1765{
1766 if ( m_windowValidator )
1767 delete m_windowValidator;
1768
1769 m_windowValidator = (wxValidator *)validator.Clone();
1770
1771 if ( m_windowValidator )
1b69c815 1772 m_windowValidator->SetWindow(this);
f03fc89f 1773}
88ac883a 1774#endif // wxUSE_VALIDATORS
f03fc89f
VZ
1775
1776// ----------------------------------------------------------------------------
1e6feb95 1777// update region stuff
f03fc89f
VZ
1778// ----------------------------------------------------------------------------
1779
1e6feb95
VZ
1780wxRect wxWindowBase::GetUpdateClientRect() const
1781{
1782 wxRegion rgnUpdate = GetUpdateRegion();
1783 rgnUpdate.Intersect(GetClientRect());
1784 wxRect rectUpdate = rgnUpdate.GetBox();
1785 wxPoint ptOrigin = GetClientAreaOrigin();
1786 rectUpdate.x -= ptOrigin.x;
1787 rectUpdate.y -= ptOrigin.y;
1788
1789 return rectUpdate;
1790}
1791
657b4fd4 1792bool wxWindowBase::DoIsExposed(int x, int y) const
f03fc89f
VZ
1793{
1794 return m_updateRegion.Contains(x, y) != wxOutRegion;
1795}
1796
657b4fd4 1797bool wxWindowBase::DoIsExposed(int x, int y, int w, int h) const
f03fc89f
VZ
1798{
1799 return m_updateRegion.Contains(x, y, w, h) != wxOutRegion;
1800}
1801
5da0803c
VZ
1802void wxWindowBase::ClearBackground()
1803{
1804 // wxGTK uses its own version, no need to add never used code
1805#ifndef __WXGTK__
1806 wxClientDC dc((wxWindow *)this);
cb129171 1807 wxBrush brush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID);
5da0803c
VZ
1808 dc.SetBackground(brush);
1809 dc.Clear();
1810#endif // __WXGTK__
1811}
1812
f03fc89f 1813// ----------------------------------------------------------------------------
146ba0fe 1814// find child window by id or name
f03fc89f
VZ
1815// ----------------------------------------------------------------------------
1816
6b73af79 1817wxWindow *wxWindowBase::FindWindow(long id) const
f03fc89f
VZ
1818{
1819 if ( id == m_windowId )
1820 return (wxWindow *)this;
1821
d3b9f782 1822 wxWindowBase *res = NULL;
222ed1d6 1823 wxWindowList::compatibility_iterator node;
f03fc89f
VZ
1824 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1825 {
1826 wxWindowBase *child = node->GetData();
1827 res = child->FindWindow( id );
1828 }
1829
1830 return (wxWindow *)res;
1831}
1832
6b73af79 1833wxWindow *wxWindowBase::FindWindow(const wxString& name) const
f03fc89f
VZ
1834{
1835 if ( name == m_windowName )
1836 return (wxWindow *)this;
1837
d3b9f782 1838 wxWindowBase *res = NULL;
222ed1d6 1839 wxWindowList::compatibility_iterator node;
f03fc89f
VZ
1840 for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1841 {
1842 wxWindow *child = node->GetData();
1843 res = child->FindWindow(name);
1844 }
1845
1846 return (wxWindow *)res;
1847}
1848
146ba0fe
VZ
1849
1850// find any window by id or name or label: If parent is non-NULL, look through
1851// children for a label or title matching the specified string. If NULL, look
1852// through all top-level windows.
1853//
1854// to avoid duplicating code we reuse the same helper function but with
1855// different comparators
1856
1857typedef bool (*wxFindWindowCmp)(const wxWindow *win,
1858 const wxString& label, long id);
1859
1860static
1861bool wxFindWindowCmpLabels(const wxWindow *win, const wxString& label,
1862 long WXUNUSED(id))
1863{
1864 return win->GetLabel() == label;
1865}
1866
1867static
1868bool wxFindWindowCmpNames(const wxWindow *win, const wxString& label,
1869 long WXUNUSED(id))
1870{
1871 return win->GetName() == label;
1872}
1873
1874static
1875bool wxFindWindowCmpIds(const wxWindow *win, const wxString& WXUNUSED(label),
1876 long id)
1877{
1878 return win->GetId() == id;
1879}
1880
1881// recursive helper for the FindWindowByXXX() functions
1882static
1883wxWindow *wxFindWindowRecursively(const wxWindow *parent,
1884 const wxString& label,
1885 long id,
1886 wxFindWindowCmp cmp)
1887{
1888 if ( parent )
1889 {
1890 // see if this is the one we're looking for
1891 if ( (*cmp)(parent, label, id) )
1892 return (wxWindow *)parent;
1893
1894 // It wasn't, so check all its children
222ed1d6 1895 for ( wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
146ba0fe
VZ
1896 node;
1897 node = node->GetNext() )
1898 {
1899 // recursively check each child
1900 wxWindow *win = (wxWindow *)node->GetData();
1901 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1902 if (retwin)
1903 return retwin;
1904 }
1905 }
1906
1907 // Not found
1908 return NULL;
1909}
1910
1911// helper for FindWindowByXXX()
1912static
1913wxWindow *wxFindWindowHelper(const wxWindow *parent,
1914 const wxString& label,
1915 long id,
1916 wxFindWindowCmp cmp)
1917{
1918 if ( parent )
1919 {
1920 // just check parent and all its children
1921 return wxFindWindowRecursively(parent, label, id, cmp);
1922 }
1923
1924 // start at very top of wx's windows
222ed1d6 1925 for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
146ba0fe
VZ
1926 node;
1927 node = node->GetNext() )
1928 {
1929 // recursively check each window & its children
1930 wxWindow *win = node->GetData();
1931 wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1932 if (retwin)
1933 return retwin;
1934 }
1935
1936 return NULL;
1937}
1938
1939/* static */
1940wxWindow *
1941wxWindowBase::FindWindowByLabel(const wxString& title, const wxWindow *parent)
1942{
1943 return wxFindWindowHelper(parent, title, 0, wxFindWindowCmpLabels);
1944}
1945
1946/* static */
1947wxWindow *
1948wxWindowBase::FindWindowByName(const wxString& title, const wxWindow *parent)
1949{
1950 wxWindow *win = wxFindWindowHelper(parent, title, 0, wxFindWindowCmpNames);
1951
1952 if ( !win )
1953 {
1954 // fall back to the label
1955 win = FindWindowByLabel(title, parent);
1956 }
1957
1958 return win;
1959}
1960
1961/* static */
1962wxWindow *
1963wxWindowBase::FindWindowById( long id, const wxWindow* parent )
1964{
525d8583 1965 return wxFindWindowHelper(parent, wxEmptyString, id, wxFindWindowCmpIds);
146ba0fe
VZ
1966}
1967
f03fc89f
VZ
1968// ----------------------------------------------------------------------------
1969// dialog oriented functions
1970// ----------------------------------------------------------------------------
1971
e94f3031 1972#if WXWIN_COMPATIBILITY_2_8
34636400 1973void wxWindowBase::MakeModal(bool modal)
f03fc89f 1974{
34636400
VZ
1975 // Disable all other windows
1976 if ( IsTopLevel() )
1977 {
222ed1d6 1978 wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
34636400
VZ
1979 while (node)
1980 {
1981 wxWindow *win = node->GetData();
1982 if (win != this)
1983 win->Enable(!modal);
1984
1985 node = node->GetNext();
1986 }
1987 }
f03fc89f 1988}
e94f3031 1989#endif // WXWIN_COMPATIBILITY_2_8
f03fc89f 1990
5abc0d21
VZ
1991#if wxUSE_VALIDATORS
1992
1993namespace
1994{
1995
1996// This class encapsulates possibly recursive iteration on window children done
1997// by Validate() and TransferData{To,From}Window() and allows to avoid code
1998// duplication in all three functions.
1999class ValidationTraverserBase
2000{
2001public:
2002 wxEXPLICIT ValidationTraverserBase(wxWindowBase* win)
2003 : m_win(static_cast<wxWindow*>(win))
2004 {
2005 }
2006
2007 // Traverse all the direct children calling OnDo() on them and also all
2008 // grandchildren if wxWS_EX_VALIDATE_RECURSIVELY is used, calling
2009 // OnRecurse() for them.
2010 bool DoForAllChildren()
2011 {
2012 const bool recurse = m_win->HasExtraStyle(wxWS_EX_VALIDATE_RECURSIVELY);
2013
2014 wxWindowList& children = m_win->GetChildren();
2015 for ( wxWindowList::iterator i = children.begin();
2016 i != children.end();
2017 ++i )
2018 {
2019 wxWindow* const child = static_cast<wxWindow*>(*i);
2020 wxValidator* const validator = child->GetValidator();
2021 if ( validator && !OnDo(validator) )
2022 {
2023 return false;
2024 }
2025
e949d38c
VZ
2026 // Notice that validation should never recurse into top level
2027 // children, e.g. some other dialog which might happen to be
2028 // currently shown.
2029 if ( recurse && !child->IsTopLevel() && !OnRecurse(child) )
5abc0d21
VZ
2030 {
2031 return false;
2032 }
2033 }
2034
2035 return true;
2036 }
2037
2038protected:
2039 // Called for each child, validator is guaranteed to be non-NULL.
2040 virtual bool OnDo(wxValidator* validator) = 0;
2041
2042 // Called for each child if we need to recurse into its children.
2043 virtual bool OnRecurse(wxWindow* child) = 0;
2044
2045
2046 // The window whose children we're traversing.
2047 wxWindow* const m_win;
2048
2049 wxDECLARE_NO_COPY_CLASS(ValidationTraverserBase);
2050};
2051
2052} // anonymous namespace
2053
2054#endif // wxUSE_VALIDATORS
2055
f03fc89f
VZ
2056bool wxWindowBase::Validate()
2057{
88ac883a 2058#if wxUSE_VALIDATORS
5abc0d21 2059 class ValidateTraverser : public ValidationTraverserBase
f03fc89f 2060 {
5abc0d21
VZ
2061 public:
2062 wxEXPLICIT ValidateTraverser(wxWindowBase* win)
2063 : ValidationTraverserBase(win)
f03fc89f 2064 {
f03fc89f 2065 }
d80cd92a 2066
5abc0d21 2067 virtual bool OnDo(wxValidator* validator)
d80cd92a 2068 {
5abc0d21 2069 return validator->Validate(m_win);
d80cd92a 2070 }
f03fc89f 2071
5abc0d21
VZ
2072 virtual bool OnRecurse(wxWindow* child)
2073 {
2074 return child->Validate();
2075 }
2076 };
2077
2078 return ValidateTraverser(this).DoForAllChildren();
2079#else // !wxUSE_VALIDATORS
e11f4636 2080 return true;
5abc0d21 2081#endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
f03fc89f
VZ
2082}
2083
2084bool wxWindowBase::TransferDataToWindow()
2085{
88ac883a 2086#if wxUSE_VALIDATORS
5abc0d21 2087 class DataToWindowTraverser : public ValidationTraverserBase
f03fc89f 2088 {
5abc0d21
VZ
2089 public:
2090 wxEXPLICIT DataToWindowTraverser(wxWindowBase* win)
2091 : ValidationTraverserBase(win)
f03fc89f 2092 {
f03fc89f 2093 }
d80cd92a 2094
5abc0d21 2095 virtual bool OnDo(wxValidator* validator)
d80cd92a 2096 {
5abc0d21 2097 if ( !validator->TransferToWindow() )
d80cd92a 2098 {
5abc0d21
VZ
2099 wxLogWarning(_("Could not transfer data to window"));
2100#if wxUSE_LOG
2101 wxLog::FlushActive();
2102#endif // wxUSE_LOG
2103
e11f4636 2104 return false;
d80cd92a 2105 }
5abc0d21
VZ
2106
2107 return true;
d80cd92a 2108 }
f03fc89f 2109
5abc0d21
VZ
2110 virtual bool OnRecurse(wxWindow* child)
2111 {
2112 return child->TransferDataToWindow();
2113 }
2114 };
2115
2116 return DataToWindowTraverser(this).DoForAllChildren();
2117#else // !wxUSE_VALIDATORS
e11f4636 2118 return true;
5abc0d21 2119#endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
f03fc89f
VZ
2120}
2121
2122bool wxWindowBase::TransferDataFromWindow()
2123{
88ac883a 2124#if wxUSE_VALIDATORS
5abc0d21 2125 class DataFromWindowTraverser : public ValidationTraverserBase
f03fc89f 2126 {
5abc0d21
VZ
2127 public:
2128 DataFromWindowTraverser(wxWindowBase* win)
2129 : ValidationTraverserBase(win)
f03fc89f 2130 {
5abc0d21 2131 }
d80cd92a 2132
5abc0d21
VZ
2133 virtual bool OnDo(wxValidator* validator)
2134 {
2135 return validator->TransferFromWindow();
f03fc89f 2136 }
d80cd92a 2137
5abc0d21 2138 virtual bool OnRecurse(wxWindow* child)
d80cd92a 2139 {
5abc0d21 2140 return child->TransferDataFromWindow();
d80cd92a 2141 }
5abc0d21 2142 };
f03fc89f 2143
5abc0d21
VZ
2144 return DataFromWindowTraverser(this).DoForAllChildren();
2145#else // !wxUSE_VALIDATORS
e11f4636 2146 return true;
5abc0d21 2147#endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
f03fc89f
VZ
2148}
2149
2150void wxWindowBase::InitDialog()
2151{
2152 wxInitDialogEvent event(GetId());
2153 event.SetEventObject( this );
2154 GetEventHandler()->ProcessEvent(event);
2155}
2156
2157// ----------------------------------------------------------------------------
bd83cb56
VZ
2158// context-sensitive help support
2159// ----------------------------------------------------------------------------
2160
2161#if wxUSE_HELP
2162
2163// associate this help text with this window
2164void wxWindowBase::SetHelpText(const wxString& text)
2165{
2166 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2167 if ( helpProvider )
2168 {
2169 helpProvider->AddHelp(this, text);
2170 }
2171}
2172
520746ac 2173#if WXWIN_COMPATIBILITY_2_8
bd83cb56
VZ
2174// associate this help text with all windows with the same id as this
2175// one
2176void wxWindowBase::SetHelpTextForId(const wxString& text)
2177{
2178 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2179 if ( helpProvider )
2180 {
2181 helpProvider->AddHelp(GetId(), text);
2182 }
2183}
520746ac 2184#endif // WXWIN_COMPATIBILITY_2_8
bd83cb56
VZ
2185
2186// get the help string associated with this window (may be empty)
dc6588e7
VZ
2187// default implementation forwards calls to the help provider
2188wxString
2189wxWindowBase::GetHelpTextAtPoint(const wxPoint & WXUNUSED(pt),
2190 wxHelpEvent::Origin WXUNUSED(origin)) const
bd83cb56
VZ
2191{
2192 wxString text;
2193 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2194 if ( helpProvider )
2195 {
2196 text = helpProvider->GetHelp(this);
2197 }
2198
2199 return text;
2200}
2201
2202// show help for this window
2203void wxWindowBase::OnHelp(wxHelpEvent& event)
2204{
2205 wxHelpProvider *helpProvider = wxHelpProvider::Get();
2206 if ( helpProvider )
2207 {
95d3881f
VZ
2208 wxPoint pos = event.GetPosition();
2209 const wxHelpEvent::Origin origin = event.GetOrigin();
2210 if ( origin == wxHelpEvent::Origin_Keyboard )
2211 {
2212 // if the help event was generated from keyboard it shouldn't
2213 // appear at the mouse position (which is still the only position
2214 // associated with help event) if the mouse is far away, although
2215 // we still do use the mouse position if it's over the window
2216 // because we suppose the user looks approximately at the mouse
2217 // already and so it would be more convenient than showing tooltip
2218 // at some arbitrary position which can be quite far from it
2219 const wxRect rectClient = GetClientRect();
2220 if ( !rectClient.Contains(ScreenToClient(pos)) )
2221 {
2222 // position help slightly under and to the right of this window
2223 pos = ClientToScreen(wxPoint(
2224 2*GetCharWidth(),
2225 rectClient.height + GetCharHeight()
2226 ));
2227 }
2228 }
2229
2230 if ( helpProvider->ShowHelpAtPoint(this, pos, origin) )
bd83cb56
VZ
2231 {
2232 // skip the event.Skip() below
2233 return;
2234 }
2235 }
2236
2237 event.Skip();
2238}
2239
2240#endif // wxUSE_HELP
2241
2242// ----------------------------------------------------------------------------
602a2e02 2243// tooltips
f03fc89f
VZ
2244// ----------------------------------------------------------------------------
2245
2246#if wxUSE_TOOLTIPS
2247
a16a2338
VZ
2248wxString wxWindowBase::GetToolTipText() const
2249{
2250 return m_tooltip ? m_tooltip->GetTip() : wxString();
2251}
2252
f03fc89f
VZ
2253void wxWindowBase::SetToolTip( const wxString &tip )
2254{
2255 // don't create the new tooltip if we already have one
2256 if ( m_tooltip )
2257 {
2258 m_tooltip->SetTip( tip );
2259 }
2260 else
2261 {
2262 SetToolTip( new wxToolTip( tip ) );
2263 }
2264
2265 // setting empty tooltip text does not remove the tooltip any more - use
d3b9f782 2266 // SetToolTip(NULL) for this
f03fc89f
VZ
2267}
2268
2269void wxWindowBase::DoSetToolTip(wxToolTip *tooltip)
2270{
0cb57187
VZ
2271 if ( m_tooltip != tooltip )
2272 {
2273 if ( m_tooltip )
2274 delete m_tooltip;
f03fc89f 2275
0cb57187
VZ
2276 m_tooltip = tooltip;
2277 }
f03fc89f
VZ
2278}
2279
2039dd91
VZ
2280bool wxWindowBase::CopyToolTip(wxToolTip *tip)
2281{
2282 SetToolTip(tip ? new wxToolTip(tip->GetTip()) : NULL);
2283
2284 return tip != NULL;
2285}
2286
f03fc89f
VZ
2287#endif // wxUSE_TOOLTIPS
2288
2289// ----------------------------------------------------------------------------
2290// constraints and sizers
2291// ----------------------------------------------------------------------------
2292
2293#if wxUSE_CONSTRAINTS
2294
2295void wxWindowBase::SetConstraints( wxLayoutConstraints *constraints )
2296{
2297 if ( m_constraints )
2298 {
2299 UnsetConstraints(m_constraints);
2300 delete m_constraints;
2301 }
2302 m_constraints = constraints;
2303 if ( m_constraints )
2304 {
2305 // Make sure other windows know they're part of a 'meaningful relationship'
2306 if ( m_constraints->left.GetOtherWindow() && (m_constraints->left.GetOtherWindow() != this) )
2307 m_constraints->left.GetOtherWindow()->AddConstraintReference(this);
2308 if ( m_constraints->top.GetOtherWindow() && (m_constraints->top.GetOtherWindow() != this) )
2309 m_constraints->top.GetOtherWindow()->AddConstraintReference(this);
2310 if ( m_constraints->right.GetOtherWindow() && (m_constraints->right.GetOtherWindow() != this) )
2311 m_constraints->right.GetOtherWindow()->AddConstraintReference(this);
2312 if ( m_constraints->bottom.GetOtherWindow() && (m_constraints->bottom.GetOtherWindow() != this) )
2313 m_constraints->bottom.GetOtherWindow()->AddConstraintReference(this);
2314 if ( m_constraints->width.GetOtherWindow() && (m_constraints->width.GetOtherWindow() != this) )
2315 m_constraints->width.GetOtherWindow()->AddConstraintReference(this);
2316 if ( m_constraints->height.GetOtherWindow() && (m_constraints->height.GetOtherWindow() != this) )
2317 m_constraints->height.GetOtherWindow()->AddConstraintReference(this);
2318 if ( m_constraints->centreX.GetOtherWindow() && (m_constraints->centreX.GetOtherWindow() != this) )
2319 m_constraints->centreX.GetOtherWindow()->AddConstraintReference(this);
2320 if ( m_constraints->centreY.GetOtherWindow() && (m_constraints->centreY.GetOtherWindow() != this) )
2321 m_constraints->centreY.GetOtherWindow()->AddConstraintReference(this);
2322 }
2323}
2324
2325// This removes any dangling pointers to this window in other windows'
2326// constraintsInvolvedIn lists.
2327void wxWindowBase::UnsetConstraints(wxLayoutConstraints *c)
2328{
2329 if ( c )
2330 {
30915cf2 2331 if ( c->left.GetOtherWindow() && (c->left.GetOtherWindow() != this) )
f03fc89f
VZ
2332 c->left.GetOtherWindow()->RemoveConstraintReference(this);
2333 if ( c->top.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2334 c->top.GetOtherWindow()->RemoveConstraintReference(this);
2335 if ( c->right.GetOtherWindow() && (c->right.GetOtherWindow() != this) )
2336 c->right.GetOtherWindow()->RemoveConstraintReference(this);
2337 if ( c->bottom.GetOtherWindow() && (c->bottom.GetOtherWindow() != this) )
2338 c->bottom.GetOtherWindow()->RemoveConstraintReference(this);
2339 if ( c->width.GetOtherWindow() && (c->width.GetOtherWindow() != this) )
2340 c->width.GetOtherWindow()->RemoveConstraintReference(this);
2341 if ( c->height.GetOtherWindow() && (c->height.GetOtherWindow() != this) )
2342 c->height.GetOtherWindow()->RemoveConstraintReference(this);
2343 if ( c->centreX.GetOtherWindow() && (c->centreX.GetOtherWindow() != this) )
2344 c->centreX.GetOtherWindow()->RemoveConstraintReference(this);
2345 if ( c->centreY.GetOtherWindow() && (c->centreY.GetOtherWindow() != this) )
2346 c->centreY.GetOtherWindow()->RemoveConstraintReference(this);
2347 }
2348}
2349
2350// Back-pointer to other windows we're involved with, so if we delete this
2351// window, we must delete any constraints we're involved with.
2352void wxWindowBase::AddConstraintReference(wxWindowBase *otherWin)
2353{
2354 if ( !m_constraintsInvolvedIn )
2355 m_constraintsInvolvedIn = new wxWindowList;
222ed1d6
MB
2356 if ( !m_constraintsInvolvedIn->Find((wxWindow *)otherWin) )
2357 m_constraintsInvolvedIn->Append((wxWindow *)otherWin);
f03fc89f
VZ
2358}
2359
2360// REMOVE back-pointer to other windows we're involved with.
2361void wxWindowBase::RemoveConstraintReference(wxWindowBase *otherWin)
2362{
2363 if ( m_constraintsInvolvedIn )
222ed1d6 2364 m_constraintsInvolvedIn->DeleteObject((wxWindow *)otherWin);
f03fc89f
VZ
2365}
2366
2367// Reset any constraints that mention this window
2368void wxWindowBase::DeleteRelatedConstraints()
2369{
2370 if ( m_constraintsInvolvedIn )
2371 {
222ed1d6 2372 wxWindowList::compatibility_iterator node = m_constraintsInvolvedIn->GetFirst();
f03fc89f
VZ
2373 while (node)
2374 {
2375 wxWindow *win = node->GetData();
2376 wxLayoutConstraints *constr = win->GetConstraints();
2377
2378 // Reset any constraints involving this window
2379 if ( constr )
2380 {
2381 constr->left.ResetIfWin(this);
2382 constr->top.ResetIfWin(this);
2383 constr->right.ResetIfWin(this);
2384 constr->bottom.ResetIfWin(this);
2385 constr->width.ResetIfWin(this);
2386 constr->height.ResetIfWin(this);
2387 constr->centreX.ResetIfWin(this);
2388 constr->centreY.ResetIfWin(this);
2389 }
2390
222ed1d6
MB
2391 wxWindowList::compatibility_iterator next = node->GetNext();
2392 m_constraintsInvolvedIn->Erase(node);
f03fc89f
VZ
2393 node = next;
2394 }
2395
5276b0a5 2396 wxDELETE(m_constraintsInvolvedIn);
f03fc89f
VZ
2397 }
2398}
ec5bb70d
VZ
2399
2400#endif // wxUSE_CONSTRAINTS
f03fc89f 2401
3aa5d532 2402void wxWindowBase::SetSizer(wxSizer *sizer, bool deleteOld)
f03fc89f 2403{
fb89cfc5
RD
2404 if ( sizer == m_windowSizer)
2405 return;
1b69c815 2406
e8cfff87
VZ
2407 if ( m_windowSizer )
2408 {
2409 m_windowSizer->SetContainingWindow(NULL);
2410
2411 if ( deleteOld )
2412 delete m_windowSizer;
2413 }
3417c2cd 2414
f03fc89f 2415 m_windowSizer = sizer;
e8cfff87
VZ
2416 if ( m_windowSizer )
2417 {
2418 m_windowSizer->SetContainingWindow((wxWindow *)this);
2419 }
566d84a7 2420
e8cfff87 2421 SetAutoLayout(m_windowSizer != NULL);
566d84a7
RL
2422}
2423
2424void wxWindowBase::SetSizerAndFit(wxSizer *sizer, bool deleteOld)
2425{
2426 SetSizer( sizer, deleteOld );
2427 sizer->SetSizeHints( (wxWindow*) this );
f03fc89f
VZ
2428}
2429
400a9e41 2430
1ebfafde
RD
2431void wxWindowBase::SetContainingSizer(wxSizer* sizer)
2432{
2433 // adding a window to a sizer twice is going to result in fatal and
2434 // hard to debug problems later because when deleting the second
2435 // associated wxSizerItem we're going to dereference a dangling
2436 // pointer; so try to detect this as early as possible
2437 wxASSERT_MSG( !sizer || m_containingSizer != sizer,
9a83f860 2438 wxT("Adding a window to the same sizer twice?") );
1ebfafde 2439
400a9e41 2440 m_containingSizer = sizer;
1ebfafde 2441}
400a9e41 2442
ec5bb70d
VZ
2443#if wxUSE_CONSTRAINTS
2444
2445void wxWindowBase::SatisfyConstraints()
2446{
2447 wxLayoutConstraints *constr = GetConstraints();
2448 bool wasOk = constr && constr->AreSatisfied();
2449
2450 ResetConstraints(); // Mark all constraints as unevaluated
2451
2452 int noChanges = 1;
2453
2454 // if we're a top level panel (i.e. our parent is frame/dialog), our
2455 // own constraints will never be satisfied any more unless we do it
2456 // here
2457 if ( wasOk )
2458 {
2459 while ( noChanges > 0 )
2460 {
2461 LayoutPhase1(&noChanges);
2462 }
2463 }
2464
2465 LayoutPhase2(&noChanges);
2466}
2467
2468#endif // wxUSE_CONSTRAINTS
2469
f03fc89f
VZ
2470bool wxWindowBase::Layout()
2471{
3417c2cd 2472 // If there is a sizer, use it instead of the constraints
f03fc89f
VZ
2473 if ( GetSizer() )
2474 {
8d7eaf91 2475 int w = 0, h = 0;
566d84a7 2476 GetVirtualSize(&w, &h);
3417c2cd 2477 GetSizer()->SetDimension( 0, 0, w, h );
f03fc89f 2478 }
461e93f9 2479#if wxUSE_CONSTRAINTS
f1df0927 2480 else
f03fc89f 2481 {
ec5bb70d 2482 SatisfyConstraints(); // Find the right constraints values
f1df0927 2483 SetConstraintSizes(); // Recursively set the real window sizes
f03fc89f 2484 }
461e93f9 2485#endif
5d4b632b 2486
e11f4636 2487 return true;
f03fc89f
VZ
2488}
2489
6528a7f1
VZ
2490void wxWindowBase::InternalOnSize(wxSizeEvent& event)
2491{
2492 if ( GetAutoLayout() )
2493 Layout();
2494
2495 event.Skip();
2496}
2497
461e93f9 2498#if wxUSE_CONSTRAINTS
ec5bb70d
VZ
2499
2500// first phase of the constraints evaluation: set our own constraints
f03fc89f
VZ
2501bool wxWindowBase::LayoutPhase1(int *noChanges)
2502{
2503 wxLayoutConstraints *constr = GetConstraints();
ec5bb70d
VZ
2504
2505 return !constr || constr->SatisfyConstraints(this, noChanges);
f03fc89f
VZ
2506}
2507
ec5bb70d 2508// second phase: set the constraints for our children
f03fc89f
VZ
2509bool wxWindowBase::LayoutPhase2(int *noChanges)
2510{
2511 *noChanges = 0;
2512
2513 // Layout children
2514 DoPhase(1);
ec5bb70d
VZ
2515
2516 // Layout grand children
f03fc89f 2517 DoPhase(2);
ec5bb70d 2518
e11f4636 2519 return true;
f03fc89f
VZ
2520}
2521
2522// Do a phase of evaluating child constraints
2523bool wxWindowBase::DoPhase(int phase)
2524{
ec5bb70d
VZ
2525 // the list containing the children for which the constraints are already
2526 // set correctly
f03fc89f 2527 wxWindowList succeeded;
ec5bb70d
VZ
2528
2529 // the max number of iterations we loop before concluding that we can't set
2530 // the constraints
2531 static const int maxIterations = 500;
2532
2533 for ( int noIterations = 0; noIterations < maxIterations; noIterations++ )
f03fc89f 2534 {
ec5bb70d
VZ
2535 int noChanges = 0;
2536
2537 // loop over all children setting their constraints
222ed1d6 2538 for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
ec5bb70d
VZ
2539 node;
2540 node = node->GetNext() )
f03fc89f
VZ
2541 {
2542 wxWindow *child = node->GetData();
ec5bb70d 2543 if ( child->IsTopLevel() )
f03fc89f 2544 {
ec5bb70d
VZ
2545 // top level children are not inside our client area
2546 continue;
2547 }
2548
2549 if ( !child->GetConstraints() || succeeded.Find(child) )
2550 {
2551 // this one is either already ok or nothing we can do about it
2552 continue;
2553 }
2554
2555 int tempNoChanges = 0;
2556 bool success = phase == 1 ? child->LayoutPhase1(&tempNoChanges)
2557 : child->LayoutPhase2(&tempNoChanges);
2558 noChanges += tempNoChanges;
2559
2560 if ( success )
2561 {
2562 succeeded.Append(child);
f03fc89f 2563 }
f03fc89f
VZ
2564 }
2565
ec5bb70d
VZ
2566 if ( !noChanges )
2567 {
2568 // constraints are set
2569 break;
2570 }
f03fc89f
VZ
2571 }
2572
e11f4636 2573 return true;
f03fc89f
VZ
2574}
2575
2576void wxWindowBase::ResetConstraints()
2577{
2578 wxLayoutConstraints *constr = GetConstraints();
2579 if ( constr )
2580 {
e11f4636
DS
2581 constr->left.SetDone(false);
2582 constr->top.SetDone(false);
2583 constr->right.SetDone(false);
2584 constr->bottom.SetDone(false);
2585 constr->width.SetDone(false);
2586 constr->height.SetDone(false);
2587 constr->centreX.SetDone(false);
2588 constr->centreY.SetDone(false);
f03fc89f 2589 }
f1df0927 2590
222ed1d6 2591 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
f03fc89f
VZ
2592 while (node)
2593 {
2594 wxWindow *win = node->GetData();
34636400 2595 if ( !win->IsTopLevel() )
f03fc89f
VZ
2596 win->ResetConstraints();
2597 node = node->GetNext();
2598 }
2599}
2600
2601// Need to distinguish between setting the 'fake' size for windows and sizers,
2602// and setting the real values.
2603void wxWindowBase::SetConstraintSizes(bool recurse)
2604{
2605 wxLayoutConstraints *constr = GetConstraints();
4b7f2165 2606 if ( constr && constr->AreSatisfied() )
f03fc89f
VZ
2607 {
2608 int x = constr->left.GetValue();
2609 int y = constr->top.GetValue();
2610 int w = constr->width.GetValue();
2611 int h = constr->height.GetValue();
2612
f03fc89f 2613 if ( (constr->width.GetRelationship() != wxAsIs ) ||
3417c2cd 2614 (constr->height.GetRelationship() != wxAsIs) )
f03fc89f 2615 {
7e843c0e
VZ
2616 // We really shouldn't set negative sizes for the windows so make
2617 // them at least of 1*1 size
2618 SetSize(x, y, w > 0 ? w : 1, h > 0 ? h : 1);
f03fc89f
VZ
2619 }
2620 else
2621 {
3417c2cd
RR
2622 // If we don't want to resize this window, just move it...
2623 Move(x, y);
f03fc89f
VZ
2624 }
2625 }
2626 else if ( constr )
2627 {
4b7f2165 2628 wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
f1df0927 2629 GetClassInfo()->GetClassName(),
4b7f2165 2630 GetName().c_str());
f03fc89f
VZ
2631 }
2632
2633 if ( recurse )
2634 {
222ed1d6 2635 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
f03fc89f
VZ
2636 while (node)
2637 {
2638 wxWindow *win = node->GetData();
e2f9212c 2639 if ( !win->IsTopLevel() && win->GetConstraints() )
f03fc89f
VZ
2640 win->SetConstraintSizes();
2641 node = node->GetNext();
2642 }
2643 }
2644}
2645
f03fc89f
VZ
2646// Only set the size/position of the constraint (if any)
2647void wxWindowBase::SetSizeConstraint(int x, int y, int w, int h)
2648{
2649 wxLayoutConstraints *constr = GetConstraints();
2650 if ( constr )
2651 {
422d0ff0 2652 if ( x != wxDefaultCoord )
f03fc89f
VZ
2653 {
2654 constr->left.SetValue(x);
e11f4636 2655 constr->left.SetDone(true);
f03fc89f 2656 }
422d0ff0 2657 if ( y != wxDefaultCoord )
f03fc89f
VZ
2658 {
2659 constr->top.SetValue(y);
e11f4636 2660 constr->top.SetDone(true);
f03fc89f 2661 }
422d0ff0 2662 if ( w != wxDefaultCoord )
f03fc89f
VZ
2663 {
2664 constr->width.SetValue(w);
e11f4636 2665 constr->width.SetDone(true);
f03fc89f 2666 }
422d0ff0 2667 if ( h != wxDefaultCoord )
f03fc89f
VZ
2668 {
2669 constr->height.SetValue(h);
e11f4636 2670 constr->height.SetDone(true);
f03fc89f
VZ
2671 }
2672 }
2673}
2674
2675void wxWindowBase::MoveConstraint(int x, int y)
2676{
2677 wxLayoutConstraints *constr = GetConstraints();
2678 if ( constr )
2679 {
422d0ff0 2680 if ( x != wxDefaultCoord )
f03fc89f
VZ
2681 {
2682 constr->left.SetValue(x);
e11f4636 2683 constr->left.SetDone(true);
f03fc89f 2684 }
422d0ff0 2685 if ( y != wxDefaultCoord )
f03fc89f
VZ
2686 {
2687 constr->top.SetValue(y);
e11f4636 2688 constr->top.SetDone(true);
f03fc89f
VZ
2689 }
2690 }
2691}
2692
2693void wxWindowBase::GetSizeConstraint(int *w, int *h) const
2694{
2695 wxLayoutConstraints *constr = GetConstraints();
2696 if ( constr )
2697 {
2698 *w = constr->width.GetValue();
2699 *h = constr->height.GetValue();
2700 }
2701 else
2702 GetSize(w, h);
2703}
2704
2705void wxWindowBase::GetClientSizeConstraint(int *w, int *h) const
2706{
2707 wxLayoutConstraints *constr = GetConstraints();
2708 if ( constr )
2709 {
2710 *w = constr->width.GetValue();
2711 *h = constr->height.GetValue();
2712 }
2713 else
2714 GetClientSize(w, h);
2715}
2716
461e93f9
JS
2717void wxWindowBase::GetPositionConstraint(int *x, int *y) const
2718{
2719 wxLayoutConstraints *constr = GetConstraints();
2720 if ( constr )
2721 {
2722 *x = constr->left.GetValue();
2723 *y = constr->top.GetValue();
2724 }
2725 else
2726 GetPosition(x, y);
2727}
2728
2729#endif // wxUSE_CONSTRAINTS
2730
20a1eea1 2731void wxWindowBase::AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const
a200c35e 2732{
bddea8d1
VZ
2733 wxWindow *parent = GetParent();
2734 if ( !(sizeFlags & wxSIZE_NO_ADJUSTMENTS) && parent )
a200c35e 2735 {
bddea8d1
VZ
2736 wxPoint pt(parent->GetClientAreaOrigin());
2737 x += pt.x;
2738 y += pt.y;
a200c35e
VS
2739 }
2740}
2741
f03fc89f 2742// ----------------------------------------------------------------------------
602a2e02 2743// Update UI processing
f03fc89f 2744// ----------------------------------------------------------------------------
7ec1983b 2745
e39af974 2746void wxWindowBase::UpdateWindowUI(long flags)
7ec1983b 2747{
26bf1ce0 2748 wxUpdateUIEvent event(GetId());
687706f5 2749 event.SetEventObject(this);
26bf1ce0
VZ
2750
2751 if ( GetEventHandler()->ProcessEvent(event) )
7ec1983b 2752 {
e39af974
JS
2753 DoUpdateWindowUI(event);
2754 }
7ec1983b 2755
e39af974
JS
2756 if (flags & wxUPDATE_UI_RECURSE)
2757 {
222ed1d6 2758 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
e39af974 2759 while (node)
f03fc89f 2760 {
e39af974
JS
2761 wxWindow* child = (wxWindow*) node->GetData();
2762 child->UpdateWindowUI(flags);
2763 node = node->GetNext();
26bf1ce0 2764 }
e39af974
JS
2765 }
2766}
f03fc89f 2767
e39af974 2768// do the window-specific processing after processing the update event
e39af974
JS
2769void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
2770{
2771 if ( event.GetSetEnabled() )
2772 Enable(event.GetEnabled());
e11f4636 2773
a3a4105d
VZ
2774 if ( event.GetSetShown() )
2775 Show(event.GetShown());
e39af974 2776}
6a50a2c4
PC
2777
2778// ----------------------------------------------------------------------------
2779// Idle processing
2780// ----------------------------------------------------------------------------
2781
0c3e2a5b
PC
2782// Send idle event to window and all subwindows
2783bool wxWindowBase::SendIdleEvents(wxIdleEvent& event)
2784{
2785 bool needMore = false;
2786
2787 OnInternalIdle();
2788
2789 // should we send idle event to this window?
2790 if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
2791 HasExtraStyle(wxWS_EX_PROCESS_IDLE))
2792 {
2793 event.SetEventObject(this);
2794 HandleWindowEvent(event);
2795
2796 if (event.MoreRequested())
2797 needMore = true;
2798 }
2799 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2800 for (; node; node = node->GetNext())
2801 {
2802 wxWindow* child = node->GetData();
2803 if (child->SendIdleEvents(event))
2804 needMore = true;
2805 }
2806
2807 return needMore;
2808}
2809
6a50a2c4
PC
2810void wxWindowBase::OnInternalIdle()
2811{
6d075845 2812 if ( wxUpdateUIEvent::CanUpdate(this) )
6a50a2c4
PC
2813 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
2814}
e39af974 2815
f03fc89f
VZ
2816// ----------------------------------------------------------------------------
2817// dialog units translations
2818// ----------------------------------------------------------------------------
2819
5c3c1372
VS
2820// Windows' computes dialog units using average character width over upper-
2821// and lower-case ASCII alphabet and not using the average character width
2822// metadata stored in the font; see
2823// http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2824// It's important that we perform the conversion in identical way, because
2825// dialog units natively exist only on Windows and Windows HIG is expressed
2826// using them.
2827wxSize wxWindowBase::GetDlgUnitBase() const
2828{
2d4dcfe1 2829 const wxWindowBase * const parent = wxGetTopLevelParent((wxWindow*)this);
5c3c1372 2830
e14e0b2f
VZ
2831 wxCHECK_MSG( parent, wxDefaultSize, wxS("Must have TLW parent") );
2832
5c3c1372
VS
2833 if ( !parent->m_font.IsOk() )
2834 {
2835 // Default GUI font is used. This is the most common case, so
2836 // cache the results.
2837 static wxSize s_defFontSize;
2838 if ( s_defFontSize.x == 0 )
2839 s_defFontSize = wxPrivate::GetAverageASCIILetterSize(*parent);
2840 return s_defFontSize;
2841 }
2842 else
2843 {
2844 // Custom font, we always need to compute the result
2845 return wxPrivate::GetAverageASCIILetterSize(*parent);
2846 }
2847}
2848
0e7f59ab 2849wxPoint wxWindowBase::ConvertPixelsToDialog(const wxPoint& pt) const
fd71308f 2850{
5c3c1372
VS
2851 const wxSize base = GetDlgUnitBase();
2852
2853 // NB: wxMulDivInt32() is used, because it correctly rounds the result
2854
cab1a605
WS
2855 wxPoint pt2 = wxDefaultPosition;
2856 if (pt.x != wxDefaultCoord)
5c3c1372 2857 pt2.x = wxMulDivInt32(pt.x, 4, base.x);
cab1a605 2858 if (pt.y != wxDefaultCoord)
5c3c1372 2859 pt2.y = wxMulDivInt32(pt.y, 8, base.y);
fd71308f
JS
2860
2861 return pt2;
2862}
2863
0e7f59ab 2864wxPoint wxWindowBase::ConvertDialogToPixels(const wxPoint& pt) const
fd71308f 2865{
5c3c1372
VS
2866 const wxSize base = GetDlgUnitBase();
2867
cab1a605
WS
2868 wxPoint pt2 = wxDefaultPosition;
2869 if (pt.x != wxDefaultCoord)
5c3c1372 2870 pt2.x = wxMulDivInt32(pt.x, base.x, 4);
cab1a605 2871 if (pt.y != wxDefaultCoord)
5c3c1372 2872 pt2.y = wxMulDivInt32(pt.y, base.y, 8);
fd71308f
JS
2873
2874 return pt2;
2875}
2876
f03fc89f
VZ
2877// ----------------------------------------------------------------------------
2878// event handlers
2879// ----------------------------------------------------------------------------
2880
2881// propagate the colour change event to the subwindows
efc88372 2882void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
f03fc89f 2883{
222ed1d6 2884 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
f03fc89f
VZ
2885 while ( node )
2886 {
2887 // Only propagate to non-top-level windows
2888 wxWindow *win = node->GetData();
2889 if ( !win->IsTopLevel() )
2890 {
2891 wxSysColourChangedEvent event2;
6f34fcb3 2892 event2.SetEventObject(win);
f03fc89f
VZ
2893 win->GetEventHandler()->ProcessEvent(event2);
2894 }
2895
2896 node = node->GetNext();
2897 }
9a8477e1
VS
2898
2899 Refresh();
f03fc89f
VZ
2900}
2901
e39af974
JS
2902// the default action is to populate dialog with data when it's created,
2903// and nudge the UI into displaying itself correctly in case
2904// we've turned the wxUpdateUIEvents frequency down low.
f03fc89f
VZ
2905void wxWindowBase::OnInitDialog( wxInitDialogEvent &WXUNUSED(event) )
2906{
2907 TransferDataToWindow();
e11f4636 2908
e39af974
JS
2909 // Update the UI at this point
2910 UpdateWindowUI(wxUPDATE_UI_RECURSE);
f03fc89f
VZ
2911}
2912
00a77b7c
VZ
2913// ----------------------------------------------------------------------------
2914// menu-related functions
2915// ----------------------------------------------------------------------------
2916
2917#if wxUSE_MENUS
2918
eeb0bee1
VZ
2919bool wxWindowBase::PopupMenu(wxMenu *menu, int x, int y)
2920{
2921 wxCHECK_MSG( menu, false, "can't popup NULL menu" );
2922
c59aa14a
VZ
2923 wxMenuInvokingWindowSetter
2924 setInvokingWin(*menu, static_cast<wxWindow *>(this));
2925
eeb0bee1
VZ
2926 wxCurrentPopupMenu = menu;
2927 const bool rc = DoPopupMenu(menu, x, y);
2928 wxCurrentPopupMenu = NULL;
2929
2930 return rc;
2931}
2932
00a77b7c
VZ
2933// this is used to pass the id of the selected item from the menu event handler
2934// to the main function itself
2935//
2936// it's ok to use a global here as there can be at most one popup menu shown at
2937// any time
2938static int gs_popupMenuSelection = wxID_NONE;
2939
2940void wxWindowBase::InternalOnPopupMenu(wxCommandEvent& event)
2941{
2942 // store the id in a global variable where we'll retrieve it from later
2943 gs_popupMenuSelection = event.GetId();
2944}
2945
565382de
VZ
2946void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent& WXUNUSED(event))
2947{
2948 // nothing to do but do not skip it
2949}
2950
00a77b7c
VZ
2951int
2952wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y)
2953{
2954 gs_popupMenuSelection = wxID_NONE;
2955
2956 Connect(wxEVT_COMMAND_MENU_SELECTED,
2957 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2958 NULL,
2959 this);
2960
565382de
VZ
2961 // it is common to construct the menu passed to this function dynamically
2962 // using some fixed range of ids which could clash with the ids used
2963 // elsewhere in the program, which could result in some menu items being
2964 // unintentionally disabled or otherwise modified by update UI handlers
2965 // elsewhere in the program code and this is difficult to avoid in the
2966 // program itself, so instead we just temporarily suspend UI updating while
2967 // this menu is shown
2968 Connect(wxEVT_UPDATE_UI,
2969 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2970 NULL,
2971 this);
2972
00a77b7c
VZ
2973 PopupMenu(&menu, x, y);
2974
565382de
VZ
2975 Disconnect(wxEVT_UPDATE_UI,
2976 wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2977 NULL,
2978 this);
00a77b7c
VZ
2979 Disconnect(wxEVT_COMMAND_MENU_SELECTED,
2980 wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2981 NULL,
2982 this);
2983
2984 return gs_popupMenuSelection;
2985}
2986
2987#endif // wxUSE_MENUS
2988
32be10a4
VZ
2989// methods for drawing the sizers in a visible way: this is currently only
2990// enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
2991// that well and also because we don't want to leave it enabled in default
2992// builds used for production
2993#if wxDEBUG_LEVEL > 1
dddd1f21
VZ
2994
2995static void DrawSizers(wxWindowBase *win);
2996
a721fd82 2997static void DrawBorder(wxWindowBase *win, const wxRect& rect, bool fill, const wxPen* pen)
dddd1f21
VZ
2998{
2999 wxClientDC dc((wxWindow *)win);
a721fd82 3000 dc.SetPen(*pen);
1b942d5f 3001 dc.SetBrush(fill ? wxBrush(pen->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH) :
a721fd82 3002 *wxTRANSPARENT_BRUSH);
dddd1f21
VZ
3003 dc.DrawRectangle(rect.Deflate(1, 1));
3004}
3005
3006static void DrawSizer(wxWindowBase *win, wxSizer *sizer)
3007{
3008 const wxSizerItemList& items = sizer->GetChildren();
3009 for ( wxSizerItemList::const_iterator i = items.begin(),
3010 end = items.end();
3011 i != end;
3012 ++i )
3013 {
3014 wxSizerItem *item = *i;
3015 if ( item->IsSizer() )
3016 {
a721fd82 3017 DrawBorder(win, item->GetRect().Deflate(2), false, wxRED_PEN);
dddd1f21
VZ
3018 DrawSizer(win, item->GetSizer());
3019 }
3020 else if ( item->IsSpacer() )
3021 {
a721fd82 3022 DrawBorder(win, item->GetRect().Deflate(2), true, wxBLUE_PEN);
dddd1f21
VZ
3023 }
3024 else if ( item->IsWindow() )
3025 {
3026 DrawSizers(item->GetWindow());
3027 }
1b942d5f
FM
3028 else
3029 wxFAIL_MSG("inconsistent wxSizerItem status!");
dddd1f21
VZ
3030 }
3031}
3032
3033static void DrawSizers(wxWindowBase *win)
3034{
a721fd82
FM
3035 DrawBorder(win, win->GetClientSize(), false, wxGREEN_PEN);
3036
dddd1f21
VZ
3037 wxSizer *sizer = win->GetSizer();
3038 if ( sizer )
3039 {
dddd1f21
VZ
3040 DrawSizer(win, sizer);
3041 }
3042 else // no sizer, still recurse into the children
3043 {
3044 const wxWindowList& children = win->GetChildren();
3045 for ( wxWindowList::const_iterator i = children.begin(),
3046 end = children.end();
3047 i != end;
3048 ++i )
3049 {
3050 DrawSizers(*i);
3051 }
1b942d5f
FM
3052
3053 // show all kind of sizes of this window; see the "window sizing" topic
3054 // overview for more info about the various differences:
3055 wxSize fullSz = win->GetSize();
3056 wxSize clientSz = win->GetClientSize();
3057 wxSize bestSz = win->GetBestSize();
3058 wxSize minSz = win->GetMinSize();
3059 wxSize maxSz = win->GetMaxSize();
3060 wxSize virtualSz = win->GetVirtualSize();
3061
3062 wxMessageOutputDebug dbgout;
3063 dbgout.Printf(
3064 "%-10s => fullsz=%4d;%-4d clientsz=%4d;%-4d bestsz=%4d;%-4d minsz=%4d;%-4d maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
79cb759d 3065 win->GetName(),
1b942d5f
FM
3066 fullSz.x, fullSz.y,
3067 clientSz.x, clientSz.y,
3068 bestSz.x, bestSz.y,
3069 minSz.x, minSz.y,
3070 maxSz.x, maxSz.y,
3071 virtualSz.x, virtualSz.y);
dddd1f21
VZ
3072 }
3073}
3074
32be10a4 3075#endif // wxDEBUG_LEVEL
dddd1f21
VZ
3076
3077// process special middle clicks
a02dc3e3
VZ
3078void wxWindowBase::OnMiddleClick( wxMouseEvent& event )
3079{
3080 if ( event.ControlDown() && event.AltDown() )
3081 {
32be10a4 3082#if wxDEBUG_LEVEL > 1
dddd1f21
VZ
3083 // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3084 if ( event.ShiftDown() )
3085 {
3086 DrawSizers(this);
dddd1f21 3087 }
32be10a4 3088 else
dddd1f21 3089#endif // __WXDEBUG__
32be10a4 3090 {
7822ffb1 3091#if wxUSE_MSGDLG
32be10a4
VZ
3092 // just Ctrl-Alt-middle click shows information about wx version
3093 ::wxInfoMessageBox((wxWindow*)this);
7822ffb1 3094#endif // wxUSE_MSGDLG
32be10a4 3095 }
a02dc3e3
VZ
3096 }
3097 else
3098 {
3099 event.Skip();
3100 }
3101}
3102
ed5317e5
JS
3103// ----------------------------------------------------------------------------
3104// accessibility
3105// ----------------------------------------------------------------------------
3106
3107#if wxUSE_ACCESSIBILITY
3108void wxWindowBase::SetAccessible(wxAccessible* accessible)
3109{
2aefc528 3110 if (m_accessible && (accessible != m_accessible))
ed5317e5
JS
3111 delete m_accessible;
3112 m_accessible = accessible;
3113 if (m_accessible)
3114 m_accessible->SetWindow((wxWindow*) this);
3115}
3116
3117// Returns the accessible object, creating if necessary.
3118wxAccessible* wxWindowBase::GetOrCreateAccessible()
3119{
3120 if (!m_accessible)
3121 m_accessible = CreateAccessible();
3122 return m_accessible;
3123}
3124
3125// Override to create a specific accessible object.
3126wxAccessible* wxWindowBase::CreateAccessible()
3127{
3128 return new wxWindowAccessible((wxWindow*) this);
3129}
3130
3131#endif
3132
f03fc89f
VZ
3133// ----------------------------------------------------------------------------
3134// list classes implementation
3135// ----------------------------------------------------------------------------
3136
01871bf6 3137#if wxUSE_STD_CONTAINERS
ed1288c1 3138
7ec69821 3139#include "wx/listimpl.cpp"
412e0d47 3140WX_DEFINE_LIST(wxWindowList)
ed1288c1 3141
01871bf6 3142#else // !wxUSE_STD_CONTAINERS
ed1288c1 3143
f03fc89f
VZ
3144void wxWindowListNode::DeleteData()
3145{
3146 delete (wxWindow *)GetData();
3147}
ed1288c1 3148
01871bf6 3149#endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
f03fc89f 3150
1e6feb95
VZ
3151// ----------------------------------------------------------------------------
3152// borders
3153// ----------------------------------------------------------------------------
3154
aede4ebb 3155wxBorder wxWindowBase::GetBorder(long flags) const
1e6feb95 3156{
aede4ebb 3157 wxBorder border = (wxBorder)(flags & wxBORDER_MASK);
1e6feb95
VZ
3158 if ( border == wxBORDER_DEFAULT )
3159 {
3160 border = GetDefaultBorder();
3161 }
78cd9c69
JS
3162 else if ( border == wxBORDER_THEME )
3163 {
3164 border = GetDefaultBorderForControl();
3165 }
1e6feb95
VZ
3166
3167 return border;
3168}
3169
3170wxBorder wxWindowBase::GetDefaultBorder() const
3171{
3172 return wxBORDER_NONE;
3173}
3174
3175// ----------------------------------------------------------------------------
3176// hit testing
3177// ----------------------------------------------------------------------------
3178
3179wxHitTest wxWindowBase::DoHitTest(wxCoord x, wxCoord y) const
3180{
3181 // here we just check if the point is inside the window or not
3182
3183 // check the top and left border first
3184 bool outside = x < 0 || y < 0;
3185 if ( !outside )
3186 {
3187 // check the right and bottom borders too
3188 wxSize size = GetSize();
3189 outside = x >= size.x || y >= size.y;
3190 }
3191
3192 return outside ? wxHT_WINDOW_OUTSIDE : wxHT_WINDOW_INSIDE;
3193}
3194
94633ad9
VZ
3195// ----------------------------------------------------------------------------
3196// mouse capture
3197// ----------------------------------------------------------------------------
3198
3199struct WXDLLEXPORT wxWindowNext
3200{
3201 wxWindow *win;
3202 wxWindowNext *next;
786646f3 3203} *wxWindowBase::ms_winCaptureNext = NULL;
63e819f2
VS
3204wxWindow *wxWindowBase::ms_winCaptureCurrent = NULL;
3205bool wxWindowBase::ms_winCaptureChanging = false;
94633ad9 3206
a83e1475 3207void wxWindowBase::CaptureMouse()
94633ad9 3208{
9a83f860 3209 wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
45e0dc94 3210
9a83f860 3211 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive CaptureMouse call?") );
63e819f2
VS
3212
3213 ms_winCaptureChanging = true;
3214
94633ad9
VZ
3215 wxWindow *winOld = GetCapture();
3216 if ( winOld )
3217 {
df2f507b 3218 ((wxWindowBase*) winOld)->DoReleaseMouse();
edd802c6 3219
94633ad9
VZ
3220 // save it on stack
3221 wxWindowNext *item = new wxWindowNext;
3222 item->win = winOld;
3223 item->next = ms_winCaptureNext;
3224 ms_winCaptureNext = item;
3225 }
3226 //else: no mouse capture to save
3227
3228 DoCaptureMouse();
63e819f2
VS
3229 ms_winCaptureCurrent = (wxWindow*)this;
3230
3231 ms_winCaptureChanging = false;
94633ad9
VZ
3232}
3233
a83e1475 3234void wxWindowBase::ReleaseMouse()
94633ad9 3235{
9a83f860 3236 wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
349d1942 3237
9a83f860 3238 wxASSERT_MSG( !ms_winCaptureChanging, wxT("recursive ReleaseMouse call?") );
63e819f2 3239
31b9d29f
VS
3240 wxASSERT_MSG( GetCapture() == this,
3241 "attempt to release mouse, but this window hasn't captured it" );
3242 wxASSERT_MSG( ms_winCaptureCurrent == this,
3243 "attempt to release mouse, but this window hasn't captured it" );
a7b09001 3244
63e819f2
VS
3245 ms_winCaptureChanging = true;
3246
94633ad9 3247 DoReleaseMouse();
63e819f2 3248 ms_winCaptureCurrent = NULL;
94633ad9
VZ
3249
3250 if ( ms_winCaptureNext )
3251 {
44f8caa7 3252 ((wxWindowBase*)ms_winCaptureNext->win)->DoCaptureMouse();
63e819f2 3253 ms_winCaptureCurrent = ms_winCaptureNext->win;
edd802c6 3254
94633ad9
VZ
3255 wxWindowNext *item = ms_winCaptureNext;
3256 ms_winCaptureNext = item->next;
3257 delete item;
3258 }
3259 //else: stack is empty, no previous capture
3260
63e819f2
VS
3261 ms_winCaptureChanging = false;
3262
9a83f860
VZ
3263 wxLogTrace(wxT("mousecapture"),
3264 (const wxChar *) wxT("After ReleaseMouse() mouse is captured by %p"),
5c33522f 3265 static_cast<void*>(GetCapture()));
94633ad9
VZ
3266}
3267
63e819f2
VS
3268static void DoNotifyWindowAboutCaptureLost(wxWindow *win)
3269{
3270 wxMouseCaptureLostEvent event(win->GetId());
3271 event.SetEventObject(win);
40bdc5d6
VZ
3272 if ( !win->GetEventHandler()->ProcessEvent(event) )
3273 {
44038f9a
VS
3274 // windows must handle this event, otherwise the app wouldn't behave
3275 // correctly if it loses capture unexpectedly; see the discussion here:
3276 // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3277 // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
9a83f860 3278 wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
40bdc5d6 3279 }
63e819f2
VS
3280}
3281
3282/* static */
72f8c792 3283void wxWindowBase::NotifyCaptureLost()
63e819f2
VS
3284{
3285 // don't do anything if capture lost was expected, i.e. resulted from
3286 // a wx call to ReleaseMouse or CaptureMouse:
3287 if ( ms_winCaptureChanging )
3288 return;
3289
3290 // if the capture was lost unexpectedly, notify every window that has
3291 // capture (on stack or current) about it and clear the stack:
3292
3293 if ( ms_winCaptureCurrent )
3294 {
3295 DoNotifyWindowAboutCaptureLost(ms_winCaptureCurrent);
3296 ms_winCaptureCurrent = NULL;
3297 }
3298
3299 while ( ms_winCaptureNext )
3300 {
3301 wxWindowNext *item = ms_winCaptureNext;
3302 ms_winCaptureNext = item->next;
3303
3304 DoNotifyWindowAboutCaptureLost(item->win);
3305
3306 delete item;
3307 }
3308}
3309
5048c832 3310#if wxUSE_HOTKEY
540b6b09
VZ
3311
3312bool
3313wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId),
3314 int WXUNUSED(modifiers),
3315 int WXUNUSED(keycode))
5048c832
JS
3316{
3317 // not implemented
3318 return false;
3319}
3320
540b6b09 3321bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId))
5048c832
JS
3322{
3323 // not implemented
3324 return false;
3325}
540b6b09
VZ
3326
3327#endif // wxUSE_HOTKEY
7de59551 3328
4caf847c
VZ
3329// ----------------------------------------------------------------------------
3330// event processing
3331// ----------------------------------------------------------------------------
3332
8cc208e3 3333bool wxWindowBase::TryBefore(wxEvent& event)
4caf847c 3334{
6eabf58c 3335#if wxUSE_VALIDATORS
4caf847c
VZ
3336 // Can only use the validator of the window which
3337 // is receiving the event
3338 if ( event.GetEventObject() == this )
3339 {
92089d00 3340 wxValidator * const validator = GetValidator();
512220b6 3341 if ( validator && validator->ProcessEventLocally(event) )
4caf847c 3342 {
6eabf58c 3343 return true;
4caf847c
VZ
3344 }
3345 }
6eabf58c 3346#endif // wxUSE_VALIDATORS
4caf847c 3347
8cc208e3 3348 return wxEvtHandler::TryBefore(event);
4caf847c
VZ
3349}
3350
8cc208e3 3351bool wxWindowBase::TryAfter(wxEvent& event)
4caf847c 3352{
90e572f1 3353 // carry on up the parent-child hierarchy if the propagation count hasn't
040e234d
VZ
3354 // reached zero yet
3355 if ( event.ShouldPropagate() )
4caf847c
VZ
3356 {
3357 // honour the requests to stop propagation at this window: this is
3358 // used by the dialogs, for example, to prevent processing the events
3359 // from the dialog controls in the parent frame which rarely, if ever,
3360 // makes sense
3361 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
3362 {
3363 wxWindow *parent = GetParent();
3364 if ( parent && !parent->IsBeingDeleted() )
040e234d
VZ
3365 {
3366 wxPropagateOnce propagateOnce(event);
3367
4caf847c 3368 return parent->GetEventHandler()->ProcessEvent(event);
040e234d 3369 }
4caf847c
VZ
3370 }
3371 }
3372
8cc208e3 3373 return wxEvtHandler::TryAfter(event);
4caf847c
VZ
3374}
3375
c944775f
VZ
3376// ----------------------------------------------------------------------------
3377// window relationships
3378// ----------------------------------------------------------------------------
3379
3380wxWindow *wxWindowBase::DoGetSibling(WindowOrder order) const
3381{
3382 wxCHECK_MSG( GetParent(), NULL,
9a83f860 3383 wxT("GetPrev/NextSibling() don't work for TLWs!") );
c944775f
VZ
3384
3385 wxWindowList& siblings = GetParent()->GetChildren();
c52b9635 3386 wxWindowList::compatibility_iterator i = siblings.Find((wxWindow *)this);
9a83f860 3387 wxCHECK_MSG( i, NULL, wxT("window not a child of its parent?") );
c944775f
VZ
3388
3389 if ( order == OrderBefore )
3390 i = i->GetPrevious();
3391 else // OrderAfter
3392 i = i->GetNext();
3393
3394 return i ? i->GetData() : NULL;
3395}
3396
5f6cfda7 3397// ----------------------------------------------------------------------------
a24de76b 3398// keyboard navigation
5f6cfda7
JS
3399// ----------------------------------------------------------------------------
3400
5644933f 3401// Navigates in the specified direction inside this window
553d2d7d 3402bool wxWindowBase::DoNavigateIn(int flags)
5f6cfda7 3403{
5644933f
VZ
3404#ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3405 // native code doesn't process our wxNavigationKeyEvents anyhow
553d2d7d 3406 wxUnusedVar(flags);
5644933f
VZ
3407 return false;
3408#else // !wxHAS_NATIVE_TAB_TRAVERSAL
5f6cfda7 3409 wxNavigationKeyEvent eventNav;
f029f1d1
VS
3410 wxWindow *focused = FindFocus();
3411 eventNav.SetCurrentFocus(focused);
3412 eventNav.SetEventObject(focused);
eedc82f4 3413 eventNav.SetFlags(flags);
5644933f
VZ
3414 return GetEventHandler()->ProcessEvent(eventNav);
3415#endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
5f6cfda7
JS
3416}
3417
f029f1d1
VS
3418bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent& event)
3419{
3420 if ( event.GetKeyCode() != WXK_TAB )
3421 return false;
3422
3423 int flags = wxNavigationKeyEvent::FromTab;
3424
3425 if ( event.ShiftDown() )
3426 flags |= wxNavigationKeyEvent::IsBackward;
3427 else
3428 flags |= wxNavigationKeyEvent::IsForward;
3429
3430 if ( event.ControlDown() )
3431 flags |= wxNavigationKeyEvent::WinChange;
3432
3433 Navigate(flags);
3434 return true;
3435}
3436
c944775f 3437void wxWindowBase::DoMoveInTabOrder(wxWindow *win, WindowOrder move)
a24de76b
VZ
3438{
3439 // check that we're not a top level window
3440 wxCHECK_RET( GetParent(),
9a83f860 3441 wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
a24de76b 3442
ef6816ef
VZ
3443 // detect the special case when we have nothing to do anyhow and when the
3444 // code below wouldn't work
3445 if ( win == this )
3446 return;
3447
a24de76b
VZ
3448 // find the target window in the siblings list
3449 wxWindowList& siblings = GetParent()->GetChildren();
3450 wxWindowList::compatibility_iterator i = siblings.Find(win);
9a83f860 3451 wxCHECK_RET( i, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
a24de76b 3452
01871bf6
VZ
3453 // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3454 // implemented so we can't just move the node around
feef1ecf
VZ
3455 wxWindow *self = (wxWindow *)this;
3456 siblings.DeleteObject(self);
c944775f 3457 if ( move == OrderAfter )
9e9300c4
VZ
3458 {
3459 i = i->GetNext();
3460 }
3461
3462 if ( i )
a24de76b 3463 {
feef1ecf 3464 siblings.Insert(i, self);
a24de76b 3465 }
c944775f 3466 else // OrderAfter and win was the last sibling
a24de76b 3467 {
feef1ecf 3468 siblings.Append(self);
a24de76b
VZ
3469 }
3470}
3471
0fe02759
VS
3472// ----------------------------------------------------------------------------
3473// focus handling
3474// ----------------------------------------------------------------------------
3475
3476/*static*/ wxWindow* wxWindowBase::FindFocus()
3477{
9c52a429 3478 wxWindowBase *win = DoFindFocus();
0fe02759
VS
3479 return win ? win->GetMainWindowOfCompositeControl() : NULL;
3480}
3481
3358af0f
VS
3482bool wxWindowBase::HasFocus() const
3483{
202388d3
VZ
3484 wxWindowBase* const win = DoFindFocus();
3485 return win &&
3486 (this == win || this == win->GetMainWindowOfCompositeControl());
3358af0f
VS
3487}
3488
4f24cbbd
VS
3489// ----------------------------------------------------------------------------
3490// drag and drop
3491// ----------------------------------------------------------------------------
3492
3493#if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3494
3495namespace
3496{
3497
3498class DragAcceptFilesTarget : public wxFileDropTarget
3499{
3500public:
3501 DragAcceptFilesTarget(wxWindowBase *win) : m_win(win) {}
3502
3503 virtual bool OnDropFiles(wxCoord x, wxCoord y,
3504 const wxArrayString& filenames)
3505 {
3506 wxDropFilesEvent event(wxEVT_DROP_FILES,
3507 filenames.size(),
3508 wxCArrayString(filenames).Release());
3509 event.SetEventObject(m_win);
3510 event.m_pos.x = x;
3511 event.m_pos.y = y;
3512
3513 return m_win->HandleWindowEvent(event);
3514 }
3515
3516private:
3517 wxWindowBase * const m_win;
3518
c0c133e1 3519 wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget);
4f24cbbd
VS
3520};
3521
3522
3523} // anonymous namespace
3524
3525// Generic version of DragAcceptFiles(). It works by installing a simple
3526// wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3527// together with explicit SetDropTarget() calls.
3528void wxWindowBase::DragAcceptFiles(bool accept)
3529{
3530 if ( accept )
3531 {
3532 wxASSERT_MSG( !GetDropTarget(),
3533 "cannot use DragAcceptFiles() and SetDropTarget() together" );
3534 SetDropTarget(new DragAcceptFilesTarget(this));
3535 }
3536 else
3537 {
3538 SetDropTarget(NULL);
3539 }
3540}
3541
3542#endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3543
33b494d6
VZ
3544// ----------------------------------------------------------------------------
3545// global functions
3546// ----------------------------------------------------------------------------
3547
3548wxWindow* wxGetTopLevelParent(wxWindow *win)
3549{
3550 while ( win && !win->IsTopLevel() )
3551 win = win->GetParent();
3552
3553 return win;
3554}
3555
ed5317e5
JS
3556#if wxUSE_ACCESSIBILITY
3557// ----------------------------------------------------------------------------
3558// accessible object for windows
3559// ----------------------------------------------------------------------------
3560
3561// Can return either a child object, or an integer
3562// representing the child element, starting from 1.
66b9ec3d 3563wxAccStatus wxWindowAccessible::HitTest(const wxPoint& WXUNUSED(pt), int* WXUNUSED(childId), wxAccessible** WXUNUSED(childObject))
ed5317e5
JS
3564{
3565 wxASSERT( GetWindow() != NULL );
3566 if (!GetWindow())
3567 return wxACC_FAIL;
3568
3569 return wxACC_NOT_IMPLEMENTED;
3570}
3571
3572// Returns the rectangle for this object (id = 0) or a child element (id > 0).
3573wxAccStatus wxWindowAccessible::GetLocation(wxRect& rect, int elementId)
3574{
3575 wxASSERT( GetWindow() != NULL );
3576 if (!GetWindow())
3577 return wxACC_FAIL;
3578
c6e2af45
JS
3579 wxWindow* win = NULL;
3580 if (elementId == 0)
3581 {
3582 win = GetWindow();
3583 }
3584 else
3585 {
3586 if (elementId <= (int) GetWindow()->GetChildren().GetCount())
3587 {
ee6eb8d8 3588 win = GetWindow()->GetChildren().Item(elementId-1)->GetData();
c6e2af45
JS
3589 }
3590 else
3591 return wxACC_FAIL;
3592 }
3593 if (win)
3594 {
3595 rect = win->GetRect();
345c78ca 3596 if (win->GetParent() && !wxDynamicCast(win, wxTopLevelWindow))
c6e2af45
JS
3597 rect.SetPosition(win->GetParent()->ClientToScreen(rect.GetPosition()));
3598 return wxACC_OK;
3599 }
3600
ed5317e5
JS
3601 return wxACC_NOT_IMPLEMENTED;
3602}
3603
3604// Navigates from fromId to toId/toObject.
3605wxAccStatus wxWindowAccessible::Navigate(wxNavDir navDir, int fromId,
66b9ec3d 3606 int* WXUNUSED(toId), wxAccessible** toObject)
ed5317e5
JS
3607{
3608 wxASSERT( GetWindow() != NULL );
3609 if (!GetWindow())
3610 return wxACC_FAIL;
3611
c6e2af45
JS
3612 switch (navDir)
3613 {
3614 case wxNAVDIR_FIRSTCHILD:
3615 {
3616 if (GetWindow()->GetChildren().GetCount() == 0)
3617 return wxACC_FALSE;
3618 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetFirst()->GetData();
3619 *toObject = childWindow->GetOrCreateAccessible();
3620
3621 return wxACC_OK;
3622 }
3623 case wxNAVDIR_LASTCHILD:
3624 {
3625 if (GetWindow()->GetChildren().GetCount() == 0)
3626 return wxACC_FALSE;
3627 wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetLast()->GetData();
3628 *toObject = childWindow->GetOrCreateAccessible();
3629
3630 return wxACC_OK;
3631 }
3632 case wxNAVDIR_RIGHT:
3633 case wxNAVDIR_DOWN:
3634 case wxNAVDIR_NEXT:
3635 {
ee6eb8d8
MB
3636 wxWindowList::compatibility_iterator node =
3637 wxWindowList::compatibility_iterator();
c6e2af45
JS
3638 if (fromId == 0)
3639 {
3640 // Can't navigate to sibling of this window
3641 // if we're a top-level window.
3642 if (!GetWindow()->GetParent())
3643 return wxACC_NOT_IMPLEMENTED;
3644
3645 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3646 }
3647 else
3648 {
3649 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
33b3f7c3 3650 node = GetWindow()->GetChildren().Item(fromId-1);
c6e2af45
JS
3651 }
3652
3653 if (node && node->GetNext())
3654 {
ee6eb8d8 3655 wxWindow* nextWindow = node->GetNext()->GetData();
c6e2af45
JS
3656 *toObject = nextWindow->GetOrCreateAccessible();
3657 return wxACC_OK;
3658 }
3659 else
3660 return wxACC_FALSE;
3661 }
3662 case wxNAVDIR_LEFT:
3663 case wxNAVDIR_UP:
3664 case wxNAVDIR_PREVIOUS:
3665 {
ee6eb8d8
MB
3666 wxWindowList::compatibility_iterator node =
3667 wxWindowList::compatibility_iterator();
c6e2af45
JS
3668 if (fromId == 0)
3669 {
3670 // Can't navigate to sibling of this window
3671 // if we're a top-level window.
3672 if (!GetWindow()->GetParent())
3673 return wxACC_NOT_IMPLEMENTED;
3674
3675 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3676 }
3677 else
3678 {
3679 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
33b3f7c3 3680 node = GetWindow()->GetChildren().Item(fromId-1);
c6e2af45
JS
3681 }
3682
3683 if (node && node->GetPrevious())
3684 {
ee6eb8d8 3685 wxWindow* previousWindow = node->GetPrevious()->GetData();
c6e2af45
JS
3686 *toObject = previousWindow->GetOrCreateAccessible();
3687 return wxACC_OK;
3688 }
3689 else
3690 return wxACC_FALSE;
3691 }
3692 }
3693
ed5317e5
JS
3694 return wxACC_NOT_IMPLEMENTED;
3695}
3696
3697// Gets the name of the specified object.
3698wxAccStatus wxWindowAccessible::GetName(int childId, wxString* name)
3699{
3700 wxASSERT( GetWindow() != NULL );
3701 if (!GetWindow())
3702 return wxACC_FAIL;
3703
2aefc528
JS
3704 wxString title;
3705
77ffb593 3706 // If a child, leave wxWidgets to call the function on the actual
2aefc528
JS
3707 // child object.
3708 if (childId > 0)
3709 return wxACC_NOT_IMPLEMENTED;
3710
3711 // This will eventually be replaced by specialised
77ffb593 3712 // accessible classes, one for each kind of wxWidgets
2aefc528 3713 // control or window.
0b4f47a3 3714#if wxUSE_BUTTON
345c78ca 3715 if (wxDynamicCast(GetWindow(), wxButton))
2aefc528
JS
3716 title = ((wxButton*) GetWindow())->GetLabel();
3717 else
0b4f47a3 3718#endif
2aefc528 3719 title = GetWindow()->GetName();
e11f4636 3720
ba889513 3721 if (!title.empty())
ed5317e5
JS
3722 {
3723 *name = title;
3724 return wxACC_OK;
3725 }
3726 else
3727 return wxACC_NOT_IMPLEMENTED;
3728}
3729
3730// Gets the number of children.
3731wxAccStatus wxWindowAccessible::GetChildCount(int* childId)
3732{
3733 wxASSERT( GetWindow() != NULL );
3734 if (!GetWindow())
3735 return wxACC_FAIL;
3736
3737 *childId = (int) GetWindow()->GetChildren().GetCount();
3738 return wxACC_OK;
3739}
3740
3741// Gets the specified child (starting from 1).
3742// If *child is NULL and return value is wxACC_OK,
3743// this means that the child is a simple element and
3744// not an accessible object.
3745wxAccStatus wxWindowAccessible::GetChild(int childId, wxAccessible** child)
3746{
3747 wxASSERT( GetWindow() != NULL );
3748 if (!GetWindow())
3749 return wxACC_FAIL;
3750
3751 if (childId == 0)
3752 {
3753 *child = this;
3754 return wxACC_OK;
3755 }
3756
3757 if (childId > (int) GetWindow()->GetChildren().GetCount())
3758 return wxACC_FAIL;
3759
ee6eb8d8 3760 wxWindow* childWindow = GetWindow()->GetChildren().Item(childId-1)->GetData();
ed5317e5
JS
3761 *child = childWindow->GetOrCreateAccessible();
3762 if (*child)
3763 return wxACC_OK;
3764 else
3765 return wxACC_FAIL;
3766}
3767
3768// Gets the parent, or NULL.
3769wxAccStatus wxWindowAccessible::GetParent(wxAccessible** parent)
3770{
3771 wxASSERT( GetWindow() != NULL );
3772 if (!GetWindow())
3773 return wxACC_FAIL;
3774
3775 wxWindow* parentWindow = GetWindow()->GetParent();
c6e2af45 3776 if (!parentWindow)
ed5317e5
JS
3777 {
3778 *parent = NULL;
3779 return wxACC_OK;
3780 }
3781 else
3782 {
3783 *parent = parentWindow->GetOrCreateAccessible();
3784 if (*parent)
3785 return wxACC_OK;
3786 else
3787 return wxACC_FAIL;
3788 }
3789}
3790
3791// Performs the default action. childId is 0 (the action for this object)
3792// or > 0 (the action for a child).
3793// Return wxACC_NOT_SUPPORTED if there is no default action for this
3794// window (e.g. an edit control).
66b9ec3d 3795wxAccStatus wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
ed5317e5
JS
3796{
3797 wxASSERT( GetWindow() != NULL );
3798 if (!GetWindow())
3799 return wxACC_FAIL;
3800
3801 return wxACC_NOT_IMPLEMENTED;
3802}
3803
3804// Gets the default action for this object (0) or > 0 (the action for a child).
3805// Return wxACC_OK even if there is no action. actionName is the action, or the empty
3806// string if there is no action.
3807// The retrieved string describes the action that is performed on an object,
3808// not what the object does as a result. For example, a toolbar button that prints
3809// a document has a default action of "Press" rather than "Prints the current document."
66b9ec3d 3810wxAccStatus wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId), wxString* WXUNUSED(actionName))
ed5317e5
JS
3811{
3812 wxASSERT( GetWindow() != NULL );
3813 if (!GetWindow())
3814 return wxACC_FAIL;
3815
3816 return wxACC_NOT_IMPLEMENTED;
3817}
3818
3819// Returns the description for this object or a child.
66b9ec3d 3820wxAccStatus wxWindowAccessible::GetDescription(int WXUNUSED(childId), wxString* description)
ed5317e5
JS
3821{
3822 wxASSERT( GetWindow() != NULL );
3823 if (!GetWindow())
3824 return wxACC_FAIL;
3825
dc6588e7 3826 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
ba889513 3827 if (!ht.empty())
2aefc528
JS
3828 {
3829 *description = ht;
3830 return wxACC_OK;
3831 }
ed5317e5
JS
3832 return wxACC_NOT_IMPLEMENTED;
3833}
3834
3835// Returns help text for this object or a child, similar to tooltip text.
66b9ec3d 3836wxAccStatus wxWindowAccessible::GetHelpText(int WXUNUSED(childId), wxString* helpText)
ed5317e5
JS
3837{
3838 wxASSERT( GetWindow() != NULL );
3839 if (!GetWindow())
3840 return wxACC_FAIL;
3841
dc6588e7 3842 wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
ba889513 3843 if (!ht.empty())
ed5317e5
JS
3844 {
3845 *helpText = ht;
3846 return wxACC_OK;
3847 }
3848 return wxACC_NOT_IMPLEMENTED;
3849}
3850
3851// Returns the keyboard shortcut for this object or child.
3852// Return e.g. ALT+K
66b9ec3d 3853wxAccStatus wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId), wxString* WXUNUSED(shortcut))
ed5317e5
JS
3854{
3855 wxASSERT( GetWindow() != NULL );
3856 if (!GetWindow())
3857 return wxACC_FAIL;
3858
3859 return wxACC_NOT_IMPLEMENTED;
3860}
3861
3862// Returns a role constant.
3863wxAccStatus wxWindowAccessible::GetRole(int childId, wxAccRole* role)
3864{
3865 wxASSERT( GetWindow() != NULL );
3866 if (!GetWindow())
3867 return wxACC_FAIL;
3868
77ffb593 3869 // If a child, leave wxWidgets to call the function on the actual
2aefc528
JS
3870 // child object.
3871 if (childId > 0)
3872 return wxACC_NOT_IMPLEMENTED;
3873
345c78ca 3874 if (wxDynamicCast(GetWindow(), wxControl))
2aefc528
JS
3875 return wxACC_NOT_IMPLEMENTED;
3876#if wxUSE_STATUSBAR
345c78ca 3877 if (wxDynamicCast(GetWindow(), wxStatusBar))
2aefc528
JS
3878 return wxACC_NOT_IMPLEMENTED;
3879#endif
3880#if wxUSE_TOOLBAR
345c78ca 3881 if (wxDynamicCast(GetWindow(), wxToolBar))
2aefc528
JS
3882 return wxACC_NOT_IMPLEMENTED;
3883#endif
3884
3885 //*role = wxROLE_SYSTEM_CLIENT;
3886 *role = wxROLE_SYSTEM_CLIENT;
3887 return wxACC_OK;
3888
66b9ec3d 3889 #if 0
ed5317e5 3890 return wxACC_NOT_IMPLEMENTED;
66b9ec3d 3891 #endif
ed5317e5
JS
3892}
3893
3894// Returns a state constant.
3895wxAccStatus wxWindowAccessible::GetState(int childId, long* state)
3896{
3897 wxASSERT( GetWindow() != NULL );
3898 if (!GetWindow())
3899 return wxACC_FAIL;
3900
77ffb593 3901 // If a child, leave wxWidgets to call the function on the actual
2aefc528
JS
3902 // child object.
3903 if (childId > 0)
3904 return wxACC_NOT_IMPLEMENTED;
3905
345c78ca 3906 if (wxDynamicCast(GetWindow(), wxControl))
2aefc528
JS
3907 return wxACC_NOT_IMPLEMENTED;
3908
3909#if wxUSE_STATUSBAR
345c78ca 3910 if (wxDynamicCast(GetWindow(), wxStatusBar))
2aefc528
JS
3911 return wxACC_NOT_IMPLEMENTED;
3912#endif
3913#if wxUSE_TOOLBAR
345c78ca 3914 if (wxDynamicCast(GetWindow(), wxToolBar))
2aefc528
JS
3915 return wxACC_NOT_IMPLEMENTED;
3916#endif
3917
3918 *state = 0;
3919 return wxACC_OK;
3920
66b9ec3d 3921 #if 0
ed5317e5 3922 return wxACC_NOT_IMPLEMENTED;
66b9ec3d 3923 #endif
ed5317e5
JS
3924}
3925
3926// Returns a localized string representing the value for the object
3927// or child.
66b9ec3d 3928wxAccStatus wxWindowAccessible::GetValue(int WXUNUSED(childId), wxString* WXUNUSED(strValue))
ed5317e5
JS
3929{
3930 wxASSERT( GetWindow() != NULL );
3931 if (!GetWindow())
3932 return wxACC_FAIL;
3933
3934 return wxACC_NOT_IMPLEMENTED;
3935}
3936
3937// Selects the object or child.
66b9ec3d 3938wxAccStatus wxWindowAccessible::Select(int WXUNUSED(childId), wxAccSelectionFlags WXUNUSED(selectFlags))
ed5317e5
JS
3939{
3940 wxASSERT( GetWindow() != NULL );
3941 if (!GetWindow())
3942 return wxACC_FAIL;
3943
3944 return wxACC_NOT_IMPLEMENTED;
3945}
3946
3947// Gets the window with the keyboard focus.
3948// If childId is 0 and child is NULL, no object in
3949// this subhierarchy has the focus.
3950// If this object has the focus, child should be 'this'.
66b9ec3d 3951wxAccStatus wxWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
ed5317e5
JS
3952{
3953 wxASSERT( GetWindow() != NULL );
3954 if (!GetWindow())
3955 return wxACC_FAIL;
3956
3957 return wxACC_NOT_IMPLEMENTED;
3958}
3959
ca5c6ac3 3960#if wxUSE_VARIANT
ed5317e5
JS
3961// Gets a variant representing the selected children
3962// of this object.
3963// Acceptable values:
cab1a605 3964// - a null variant (IsNull() returns true)
ed5317e5
JS
3965// - a list variant (GetType() == wxT("list")
3966// - an integer representing the selected child element,
3967// or 0 if this object is selected (GetType() == wxT("long")
3968// - a "void*" pointer to a wxAccessible child object
66b9ec3d 3969wxAccStatus wxWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
ed5317e5
JS
3970{
3971 wxASSERT( GetWindow() != NULL );
3972 if (!GetWindow())
3973 return wxACC_FAIL;
3974
3975 return wxACC_NOT_IMPLEMENTED;
3976}
ca5c6ac3 3977#endif // wxUSE_VARIANT
ed5317e5
JS
3978
3979#endif // wxUSE_ACCESSIBILITY
978af864
VZ
3980
3981// ----------------------------------------------------------------------------
3982// RTL support
3983// ----------------------------------------------------------------------------
3984
3985wxCoord
3986wxWindowBase::AdjustForLayoutDirection(wxCoord x,
3987 wxCoord width,
3988 wxCoord widthTotal) const
3989{
3990 if ( GetLayoutDirection() == wxLayout_RightToLeft )
3991 {
3992 x = widthTotal - x - width;
3993 }
3994
3995 return x;
3996}
3997
f35fdf7e 3998