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