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