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