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