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