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