src/common/wincmn.cpp

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