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         res = child->FindWindow( id );
1844     }
1845
1846     return (wxWindow *)res;
1847 }
1848
1849 wxWindow *wxWindowBase::FindWindow(const wxString& name) const
1850 {
1851     if ( name == m_windowName )
1852         return (wxWindow *)this;
1853
1854     wxWindowBase *res = NULL;
1855     wxWindowList::compatibility_iterator node;
1856     for ( node = m_children.GetFirst(); node && !res; node = node->GetNext() )
1857     {
1858         wxWindow *child = node->GetData();
1859         res = child->FindWindow(name);
1860     }
1861
1862     return (wxWindow *)res;
1863 }
1864
1865
1866 // find any window by id or name or label: If parent is non-NULL, look through
1867 // children for a label or title matching the specified string. If NULL, look
1868 // through all top-level windows.
1869 //
1870 // to avoid duplicating code we reuse the same helper function but with
1871 // different comparators
1872
1873 typedef bool (*wxFindWindowCmp)(const wxWindow *win,
1874                                 const wxString& label, long id);
1875
1876 static
1877 bool wxFindWindowCmpLabels(const wxWindow *win, const wxString& label,
1878                            long WXUNUSED(id))
1879 {
1880     return win->GetLabel() == label;
1881 }
1882
1883 static
1884 bool wxFindWindowCmpNames(const wxWindow *win, const wxString& label,
1885                           long WXUNUSED(id))
1886 {
1887     return win->GetName() == label;
1888 }
1889
1890 static
1891 bool wxFindWindowCmpIds(const wxWindow *win, const wxString& WXUNUSED(label),
1892                         long id)
1893 {
1894     return win->GetId() == id;
1895 }
1896
1897 // recursive helper for the FindWindowByXXX() functions
1898 static
1899 wxWindow *wxFindWindowRecursively(const wxWindow *parent,
1900                                   const wxString& label,
1901                                   long id,
1902                                   wxFindWindowCmp cmp)
1903 {
1904     if ( parent )
1905     {
1906         // see if this is the one we're looking for
1907         if ( (*cmp)(parent, label, id) )
1908             return (wxWindow *)parent;
1909
1910         // It wasn't, so check all its children
1911         for ( wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
1912               node;
1913               node = node->GetNext() )
1914         {
1915             // recursively check each child
1916             wxWindow *win = (wxWindow *)node->GetData();
1917             wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1918             if (retwin)
1919                 return retwin;
1920         }
1921     }
1922
1923     // Not found
1924     return NULL;
1925 }
1926
1927 // helper for FindWindowByXXX()
1928 static
1929 wxWindow *wxFindWindowHelper(const wxWindow *parent,
1930                              const wxString& label,
1931                              long id,
1932                              wxFindWindowCmp cmp)
1933 {
1934     if ( parent )
1935     {
1936         // just check parent and all its children
1937         return wxFindWindowRecursively(parent, label, id, cmp);
1938     }
1939
1940     // start at very top of wx's windows
1941     for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1942           node;
1943           node = node->GetNext() )
1944     {
1945         // recursively check each window & its children
1946         wxWindow *win = node->GetData();
1947         wxWindow *retwin = wxFindWindowRecursively(win, label, id, cmp);
1948         if (retwin)
1949             return retwin;
1950     }
1951
1952     return NULL;
1953 }
1954
1955 /* static */
1956 wxWindow *
1957 wxWindowBase::FindWindowByLabel(const wxString& title, const wxWindow *parent)
1958 {
1959     return wxFindWindowHelper(parent, title, 0, wxFindWindowCmpLabels);
1960 }
1961
1962 /* static */
1963 wxWindow *
1964 wxWindowBase::FindWindowByName(const wxString& title, const wxWindow *parent)
1965 {
1966     wxWindow *win = wxFindWindowHelper(parent, title, 0, wxFindWindowCmpNames);
1967
1968     if ( !win )
1969     {
1970         // fall back to the label
1971         win = FindWindowByLabel(title, parent);
1972     }
1973
1974     return win;
1975 }
1976
1977 /* static */
1978 wxWindow *
1979 wxWindowBase::FindWindowById( long id, const wxWindow* parent )
1980 {
1981     return wxFindWindowHelper(parent, wxEmptyString, id, wxFindWindowCmpIds);
1982 }
1983
1984 // ----------------------------------------------------------------------------
1985 // dialog oriented functions
1986 // ----------------------------------------------------------------------------
1987
1988 #if WXWIN_COMPATIBILITY_2_8
1989 void wxWindowBase::MakeModal(bool modal)
1990 {
1991     // Disable all other windows
1992     if ( IsTopLevel() )
1993     {
1994         wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
1995         while (node)
1996         {
1997             wxWindow *win = node->GetData();
1998             if (win != this)
1999                 win->Enable(!modal);
2000
2001             node = node->GetNext();
2002         }
2003     }
2004 }
2005 #endif // WXWIN_COMPATIBILITY_2_8
2006
2007 #if wxUSE_VALIDATORS
2008
2009 namespace
2010 {
2011
2012 // This class encapsulates possibly recursive iteration on window children done
2013 // by Validate() and TransferData{To,From}Window() and allows to avoid code
2014 // duplication in all three functions.
2015 class ValidationTraverserBase
2016 {
2017 public:
2018     wxEXPLICIT ValidationTraverserBase(wxWindowBase* win)
2019         : m_win(static_cast<wxWindow*>(win))
2020     {
2021     }
2022
2023     // Traverse all the direct children calling OnDo() on them and also all
2024     // grandchildren if wxWS_EX_VALIDATE_RECURSIVELY is used, calling
2025     // OnRecurse() for them.
2026     bool DoForAllChildren()
2027     {
2028         const bool recurse = m_win->HasExtraStyle(wxWS_EX_VALIDATE_RECURSIVELY);
2029
2030         wxWindowList& children = m_win->GetChildren();
2031         for ( wxWindowList::iterator i = children.begin();
2032               i != children.end();
2033               ++i )
2034         {
2035             wxWindow* const child = static_cast<wxWindow*>(*i);
2036             wxValidator* const validator = child->GetValidator();
2037             if ( validator && !OnDo(validator) )
2038             {
2039                 return false;
2040             }
2041
2042             // Notice that validation should never recurse into top level
2043             // children, e.g. some other dialog which might happen to be
2044             // currently shown.
2045             if ( recurse && !child->IsTopLevel() && !OnRecurse(child) )
2046             {
2047                 return false;
2048             }
2049         }
2050
2051         return true;
2052     }
2053
2054     // Give it a virtual dtor just to suppress gcc warnings about a class with
2055     // virtual methods but non-virtual dtor -- even if this is completely safe
2056     // here as we never use the objects of this class polymorphically.
2057     virtual ~ValidationTraverserBase() { }
2058
2059 protected:
2060     // Called for each child, validator is guaranteed to be non-NULL.
2061     virtual bool OnDo(wxValidator* validator) = 0;
2062
2063     // Called for each child if we need to recurse into its children.
2064     virtual bool OnRecurse(wxWindow* child) = 0;
2065
2066
2067     // The window whose children we're traversing.
2068     wxWindow* const m_win;
2069
2070     wxDECLARE_NO_COPY_CLASS(ValidationTraverserBase);
2071 };
2072
2073 } // anonymous namespace
2074
2075 #endif // wxUSE_VALIDATORS
2076
2077 bool wxWindowBase::Validate()
2078 {
2079 #if wxUSE_VALIDATORS
2080     class ValidateTraverser : public ValidationTraverserBase
2081     {
2082     public:
2083         wxEXPLICIT ValidateTraverser(wxWindowBase* win)
2084             : ValidationTraverserBase(win)
2085         {
2086         }
2087
2088         virtual bool OnDo(wxValidator* validator)
2089         {
2090             return validator->Validate(m_win);
2091         }
2092
2093         virtual bool OnRecurse(wxWindow* child)
2094         {
2095             return child->Validate();
2096         }
2097     };
2098
2099     return ValidateTraverser(this).DoForAllChildren();
2100 #else // !wxUSE_VALIDATORS
2101     return true;
2102 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
2103 }
2104
2105 bool wxWindowBase::TransferDataToWindow()
2106 {
2107 #if wxUSE_VALIDATORS
2108     class DataToWindowTraverser : public ValidationTraverserBase
2109     {
2110     public:
2111         wxEXPLICIT DataToWindowTraverser(wxWindowBase* win)
2112             : ValidationTraverserBase(win)
2113         {
2114         }
2115
2116         virtual bool OnDo(wxValidator* validator)
2117         {
2118             if ( !validator->TransferToWindow() )
2119             {
2120                 wxLogWarning(_("Could not transfer data to window"));
2121 #if wxUSE_LOG
2122                 wxLog::FlushActive();
2123 #endif // wxUSE_LOG
2124
2125                 return false;
2126             }
2127
2128             return true;
2129         }
2130
2131         virtual bool OnRecurse(wxWindow* child)
2132         {
2133             return child->TransferDataToWindow();
2134         }
2135     };
2136
2137     return DataToWindowTraverser(this).DoForAllChildren();
2138 #else // !wxUSE_VALIDATORS
2139     return true;
2140 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
2141 }
2142
2143 bool wxWindowBase::TransferDataFromWindow()
2144 {
2145 #if wxUSE_VALIDATORS
2146     class DataFromWindowTraverser : public ValidationTraverserBase
2147     {
2148     public:
2149         DataFromWindowTraverser(wxWindowBase* win)
2150             : ValidationTraverserBase(win)
2151         {
2152         }
2153
2154         virtual bool OnDo(wxValidator* validator)
2155         {
2156             return validator->TransferFromWindow();
2157         }
2158
2159         virtual bool OnRecurse(wxWindow* child)
2160         {
2161             return child->TransferDataFromWindow();
2162         }
2163     };
2164
2165     return DataFromWindowTraverser(this).DoForAllChildren();
2166 #else // !wxUSE_VALIDATORS
2167     return true;
2168 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
2169 }
2170
2171 void wxWindowBase::InitDialog()
2172 {
2173     wxInitDialogEvent event(GetId());
2174     event.SetEventObject( this );
2175     GetEventHandler()->ProcessEvent(event);
2176 }
2177
2178 // ----------------------------------------------------------------------------
2179 // context-sensitive help support
2180 // ----------------------------------------------------------------------------
2181
2182 #if wxUSE_HELP
2183
2184 // associate this help text with this window
2185 void wxWindowBase::SetHelpText(const wxString& text)
2186 {
2187     wxHelpProvider *helpProvider = wxHelpProvider::Get();
2188     if ( helpProvider )
2189     {
2190         helpProvider->AddHelp(this, text);
2191     }
2192 }
2193
2194 #if WXWIN_COMPATIBILITY_2_8
2195 // associate this help text with all windows with the same id as this
2196 // one
2197 void wxWindowBase::SetHelpTextForId(const wxString& text)
2198 {
2199     wxHelpProvider *helpProvider = wxHelpProvider::Get();
2200     if ( helpProvider )
2201     {
2202         helpProvider->AddHelp(GetId(), text);
2203     }
2204 }
2205 #endif // WXWIN_COMPATIBILITY_2_8
2206
2207 // get the help string associated with this window (may be empty)
2208 // default implementation forwards calls to the help provider
2209 wxString
2210 wxWindowBase::GetHelpTextAtPoint(const wxPoint & WXUNUSED(pt),
2211                                  wxHelpEvent::Origin WXUNUSED(origin)) const
2212 {
2213     wxString text;
2214     wxHelpProvider *helpProvider = wxHelpProvider::Get();
2215     if ( helpProvider )
2216     {
2217         text = helpProvider->GetHelp(this);
2218     }
2219
2220     return text;
2221 }
2222
2223 // show help for this window
2224 void wxWindowBase::OnHelp(wxHelpEvent& event)
2225 {
2226     wxHelpProvider *helpProvider = wxHelpProvider::Get();
2227     if ( helpProvider )
2228     {
2229         wxPoint pos = event.GetPosition();
2230         const wxHelpEvent::Origin origin = event.GetOrigin();
2231         if ( origin == wxHelpEvent::Origin_Keyboard )
2232         {
2233             // if the help event was generated from keyboard it shouldn't
2234             // appear at the mouse position (which is still the only position
2235             // associated with help event) if the mouse is far away, although
2236             // we still do use the mouse position if it's over the window
2237             // because we suppose the user looks approximately at the mouse
2238             // already and so it would be more convenient than showing tooltip
2239             // at some arbitrary position which can be quite far from it
2240             const wxRect rectClient = GetClientRect();
2241             if ( !rectClient.Contains(ScreenToClient(pos)) )
2242             {
2243                 // position help slightly under and to the right of this window
2244                 pos = ClientToScreen(wxPoint(
2245                         2*GetCharWidth(),
2246                         rectClient.height + GetCharHeight()
2247                       ));
2248             }
2249         }
2250
2251         if ( helpProvider->ShowHelpAtPoint(this, pos, origin) )
2252         {
2253             // skip the event.Skip() below
2254             return;
2255         }
2256     }
2257
2258     event.Skip();
2259 }
2260
2261 #endif // wxUSE_HELP
2262
2263 // ----------------------------------------------------------------------------
2264 // tooltips
2265 // ----------------------------------------------------------------------------
2266
2267 #if wxUSE_TOOLTIPS
2268
2269 wxString wxWindowBase::GetToolTipText() const
2270 {
2271     return m_tooltip ? m_tooltip->GetTip() : wxString();
2272 }
2273
2274 void wxWindowBase::SetToolTip( const wxString &tip )
2275 {
2276     // don't create the new tooltip if we already have one
2277     if ( m_tooltip )
2278     {
2279         m_tooltip->SetTip( tip );
2280     }
2281     else
2282     {
2283         SetToolTip( new wxToolTip( tip ) );
2284     }
2285
2286     // setting empty tooltip text does not remove the tooltip any more - use
2287     // SetToolTip(NULL) for this
2288 }
2289
2290 void wxWindowBase::DoSetToolTip(wxToolTip *tooltip)
2291 {
2292     if ( m_tooltip != tooltip )
2293     {
2294         if ( m_tooltip )
2295             delete m_tooltip;
2296
2297         m_tooltip = tooltip;
2298     }
2299 }
2300
2301 bool wxWindowBase::CopyToolTip(wxToolTip *tip)
2302 {
2303     SetToolTip(tip ? new wxToolTip(tip->GetTip()) : NULL);
2304
2305     return tip != NULL;
2306 }
2307
2308 #endif // wxUSE_TOOLTIPS
2309
2310 // ----------------------------------------------------------------------------
2311 // constraints and sizers
2312 // ----------------------------------------------------------------------------
2313
2314 #if wxUSE_CONSTRAINTS
2315
2316 void wxWindowBase::SetConstraints( wxLayoutConstraints *constraints )
2317 {
2318     if ( m_constraints )
2319     {
2320         UnsetConstraints(m_constraints);
2321         delete m_constraints;
2322     }
2323     m_constraints = constraints;
2324     if ( m_constraints )
2325     {
2326         // Make sure other windows know they're part of a 'meaningful relationship'
2327         if ( m_constraints->left.GetOtherWindow() && (m_constraints->left.GetOtherWindow() != this) )
2328             m_constraints->left.GetOtherWindow()->AddConstraintReference(this);
2329         if ( m_constraints->top.GetOtherWindow() && (m_constraints->top.GetOtherWindow() != this) )
2330             m_constraints->top.GetOtherWindow()->AddConstraintReference(this);
2331         if ( m_constraints->right.GetOtherWindow() && (m_constraints->right.GetOtherWindow() != this) )
2332             m_constraints->right.GetOtherWindow()->AddConstraintReference(this);
2333         if ( m_constraints->bottom.GetOtherWindow() && (m_constraints->bottom.GetOtherWindow() != this) )
2334             m_constraints->bottom.GetOtherWindow()->AddConstraintReference(this);
2335         if ( m_constraints->width.GetOtherWindow() && (m_constraints->width.GetOtherWindow() != this) )
2336             m_constraints->width.GetOtherWindow()->AddConstraintReference(this);
2337         if ( m_constraints->height.GetOtherWindow() && (m_constraints->height.GetOtherWindow() != this) )
2338             m_constraints->height.GetOtherWindow()->AddConstraintReference(this);
2339         if ( m_constraints->centreX.GetOtherWindow() && (m_constraints->centreX.GetOtherWindow() != this) )
2340             m_constraints->centreX.GetOtherWindow()->AddConstraintReference(this);
2341         if ( m_constraints->centreY.GetOtherWindow() && (m_constraints->centreY.GetOtherWindow() != this) )
2342             m_constraints->centreY.GetOtherWindow()->AddConstraintReference(this);
2343     }
2344 }
2345
2346 // This removes any dangling pointers to this window in other windows'
2347 // constraintsInvolvedIn lists.
2348 void wxWindowBase::UnsetConstraints(wxLayoutConstraints *c)
2349 {
2350     if ( c )
2351     {
2352         if ( c->left.GetOtherWindow() && (c->left.GetOtherWindow() != this) )
2353             c->left.GetOtherWindow()->RemoveConstraintReference(this);
2354         if ( c->top.GetOtherWindow() && (c->top.GetOtherWindow() != this) )
2355             c->top.GetOtherWindow()->RemoveConstraintReference(this);
2356         if ( c->right.GetOtherWindow() && (c->right.GetOtherWindow() != this) )
2357             c->right.GetOtherWindow()->RemoveConstraintReference(this);
2358         if ( c->bottom.GetOtherWindow() && (c->bottom.GetOtherWindow() != this) )
2359             c->bottom.GetOtherWindow()->RemoveConstraintReference(this);
2360         if ( c->width.GetOtherWindow() && (c->width.GetOtherWindow() != this) )
2361             c->width.GetOtherWindow()->RemoveConstraintReference(this);
2362         if ( c->height.GetOtherWindow() && (c->height.GetOtherWindow() != this) )
2363             c->height.GetOtherWindow()->RemoveConstraintReference(this);
2364         if ( c->centreX.GetOtherWindow() && (c->centreX.GetOtherWindow() != this) )
2365             c->centreX.GetOtherWindow()->RemoveConstraintReference(this);
2366         if ( c->centreY.GetOtherWindow() && (c->centreY.GetOtherWindow() != this) )
2367             c->centreY.GetOtherWindow()->RemoveConstraintReference(this);
2368     }
2369 }
2370
2371 // Back-pointer to other windows we're involved with, so if we delete this
2372 // window, we must delete any constraints we're involved with.
2373 void wxWindowBase::AddConstraintReference(wxWindowBase *otherWin)
2374 {
2375     if ( !m_constraintsInvolvedIn )
2376         m_constraintsInvolvedIn = new wxWindowList;
2377     if ( !m_constraintsInvolvedIn->Find((wxWindow *)otherWin) )
2378         m_constraintsInvolvedIn->Append((wxWindow *)otherWin);
2379 }
2380
2381 // REMOVE back-pointer to other windows we're involved with.
2382 void wxWindowBase::RemoveConstraintReference(wxWindowBase *otherWin)
2383 {
2384     if ( m_constraintsInvolvedIn )
2385         m_constraintsInvolvedIn->DeleteObject((wxWindow *)otherWin);
2386 }
2387
2388 // Reset any constraints that mention this window
2389 void wxWindowBase::DeleteRelatedConstraints()
2390 {
2391     if ( m_constraintsInvolvedIn )
2392     {
2393         wxWindowList::compatibility_iterator node = m_constraintsInvolvedIn->GetFirst();
2394         while (node)
2395         {
2396             wxWindow *win = node->GetData();
2397             wxLayoutConstraints *constr = win->GetConstraints();
2398
2399             // Reset any constraints involving this window
2400             if ( constr )
2401             {
2402                 constr->left.ResetIfWin(this);
2403                 constr->top.ResetIfWin(this);
2404                 constr->right.ResetIfWin(this);
2405                 constr->bottom.ResetIfWin(this);
2406                 constr->width.ResetIfWin(this);
2407                 constr->height.ResetIfWin(this);
2408                 constr->centreX.ResetIfWin(this);
2409                 constr->centreY.ResetIfWin(this);
2410             }
2411
2412             wxWindowList::compatibility_iterator next = node->GetNext();
2413             m_constraintsInvolvedIn->Erase(node);
2414             node = next;
2415         }
2416
2417         wxDELETE(m_constraintsInvolvedIn);
2418     }
2419 }
2420
2421 #endif // wxUSE_CONSTRAINTS
2422
2423 void wxWindowBase::SetSizer(wxSizer *sizer, bool deleteOld)
2424 {
2425     if ( sizer == m_windowSizer)
2426         return;
2427
2428     if ( m_windowSizer )
2429     {
2430         m_windowSizer->SetContainingWindow(NULL);
2431
2432         if ( deleteOld )
2433             delete m_windowSizer;
2434     }
2435
2436     m_windowSizer = sizer;
2437     if ( m_windowSizer )
2438     {
2439         m_windowSizer->SetContainingWindow((wxWindow *)this);
2440     }
2441
2442     SetAutoLayout(m_windowSizer != NULL);
2443 }
2444
2445 void wxWindowBase::SetSizerAndFit(wxSizer *sizer, bool deleteOld)
2446 {
2447     SetSizer( sizer, deleteOld );
2448     sizer->SetSizeHints( (wxWindow*) this );
2449 }
2450
2451
2452 void wxWindowBase::SetContainingSizer(wxSizer* sizer)
2453 {
2454     // adding a window to a sizer twice is going to result in fatal and
2455     // hard to debug problems later because when deleting the second
2456     // associated wxSizerItem we're going to dereference a dangling
2457     // pointer; so try to detect this as early as possible
2458     wxASSERT_MSG( !sizer || m_containingSizer != sizer,
2459                   wxT("Adding a window to the same sizer twice?") );
2460
2461     m_containingSizer = sizer;
2462 }
2463
2464 #if wxUSE_CONSTRAINTS
2465
2466 void wxWindowBase::SatisfyConstraints()
2467 {
2468     wxLayoutConstraints *constr = GetConstraints();
2469     bool wasOk = constr && constr->AreSatisfied();
2470
2471     ResetConstraints();   // Mark all constraints as unevaluated
2472
2473     int noChanges = 1;
2474
2475     // if we're a top level panel (i.e. our parent is frame/dialog), our
2476     // own constraints will never be satisfied any more unless we do it
2477     // here
2478     if ( wasOk )
2479     {
2480         while ( noChanges > 0 )
2481         {
2482             LayoutPhase1(&noChanges);
2483         }
2484     }
2485
2486     LayoutPhase2(&noChanges);
2487 }
2488
2489 #endif // wxUSE_CONSTRAINTS
2490
2491 bool wxWindowBase::Layout()
2492 {
2493     // If there is a sizer, use it instead of the constraints
2494     if ( GetSizer() )
2495     {
2496         int w = 0, h = 0;
2497         GetVirtualSize(&w, &h);
2498         GetSizer()->SetDimension( 0, 0, w, h );
2499     }
2500 #if wxUSE_CONSTRAINTS
2501     else
2502     {
2503         SatisfyConstraints(); // Find the right constraints values
2504         SetConstraintSizes(); // Recursively set the real window sizes
2505     }
2506 #endif
2507
2508     return true;
2509 }
2510
2511 void wxWindowBase::InternalOnSize(wxSizeEvent& event)
2512 {
2513     if ( GetAutoLayout() )
2514         Layout();
2515
2516     event.Skip();
2517 }
2518
2519 #if wxUSE_CONSTRAINTS
2520
2521 // first phase of the constraints evaluation: set our own constraints
2522 bool wxWindowBase::LayoutPhase1(int *noChanges)
2523 {
2524     wxLayoutConstraints *constr = GetConstraints();
2525
2526     return !constr || constr->SatisfyConstraints(this, noChanges);
2527 }
2528
2529 // second phase: set the constraints for our children
2530 bool wxWindowBase::LayoutPhase2(int *noChanges)
2531 {
2532     *noChanges = 0;
2533
2534     // Layout children
2535     DoPhase(1);
2536
2537     // Layout grand children
2538     DoPhase(2);
2539
2540     return true;
2541 }
2542
2543 // Do a phase of evaluating child constraints
2544 bool wxWindowBase::DoPhase(int phase)
2545 {
2546     // the list containing the children for which the constraints are already
2547     // set correctly
2548     wxWindowList succeeded;
2549
2550     // the max number of iterations we loop before concluding that we can't set
2551     // the constraints
2552     static const int maxIterations = 500;
2553
2554     for ( int noIterations = 0; noIterations < maxIterations; noIterations++ )
2555     {
2556         int noChanges = 0;
2557
2558         // loop over all children setting their constraints
2559         for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2560               node;
2561               node = node->GetNext() )
2562         {
2563             wxWindow *child = node->GetData();
2564             if ( child->IsTopLevel() )
2565             {
2566                 // top level children are not inside our client area
2567                 continue;
2568             }
2569
2570             if ( !child->GetConstraints() || succeeded.Find(child) )
2571             {
2572                 // this one is either already ok or nothing we can do about it
2573                 continue;
2574             }
2575
2576             int tempNoChanges = 0;
2577             bool success = phase == 1 ? child->LayoutPhase1(&tempNoChanges)
2578                                       : child->LayoutPhase2(&tempNoChanges);
2579             noChanges += tempNoChanges;
2580
2581             if ( success )
2582             {
2583                 succeeded.Append(child);
2584             }
2585         }
2586
2587         if ( !noChanges )
2588         {
2589             // constraints are set
2590             break;
2591         }
2592     }
2593
2594     return true;
2595 }
2596
2597 void wxWindowBase::ResetConstraints()
2598 {
2599     wxLayoutConstraints *constr = GetConstraints();
2600     if ( constr )
2601     {
2602         constr->left.SetDone(false);
2603         constr->top.SetDone(false);
2604         constr->right.SetDone(false);
2605         constr->bottom.SetDone(false);
2606         constr->width.SetDone(false);
2607         constr->height.SetDone(false);
2608         constr->centreX.SetDone(false);
2609         constr->centreY.SetDone(false);
2610     }
2611
2612     wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2613     while (node)
2614     {
2615         wxWindow *win = node->GetData();
2616         if ( !win->IsTopLevel() )
2617             win->ResetConstraints();
2618         node = node->GetNext();
2619     }
2620 }
2621
2622 // Need to distinguish between setting the 'fake' size for windows and sizers,
2623 // and setting the real values.
2624 void wxWindowBase::SetConstraintSizes(bool recurse)
2625 {
2626     wxLayoutConstraints *constr = GetConstraints();
2627     if ( constr && constr->AreSatisfied() )
2628     {
2629         ChildrenRepositioningGuard repositionGuard(this);
2630
2631         int x = constr->left.GetValue();
2632         int y = constr->top.GetValue();
2633         int w = constr->width.GetValue();
2634         int h = constr->height.GetValue();
2635
2636         if ( (constr->width.GetRelationship() != wxAsIs ) ||
2637              (constr->height.GetRelationship() != wxAsIs) )
2638         {
2639             // We really shouldn't set negative sizes for the windows so make
2640             // them at least of 1*1 size
2641             SetSize(x, y, w > 0 ? w : 1, h > 0 ? h : 1);
2642         }
2643         else
2644         {
2645             // If we don't want to resize this window, just move it...
2646             Move(x, y);
2647         }
2648     }
2649     else if ( constr )
2650     {
2651         wxLogDebug(wxT("Constraints not satisfied for %s named '%s'."),
2652                    GetClassInfo()->GetClassName(),
2653                    GetName().c_str());
2654     }
2655
2656     if ( recurse )
2657     {
2658         wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2659         while (node)
2660         {
2661             wxWindow *win = node->GetData();
2662             if ( !win->IsTopLevel() && win->GetConstraints() )
2663                 win->SetConstraintSizes();
2664             node = node->GetNext();
2665         }
2666     }
2667 }
2668
2669 // Only set the size/position of the constraint (if any)
2670 void wxWindowBase::SetSizeConstraint(int x, int y, int w, int h)
2671 {
2672     wxLayoutConstraints *constr = GetConstraints();
2673     if ( constr )
2674     {
2675         if ( x != wxDefaultCoord )
2676         {
2677             constr->left.SetValue(x);
2678             constr->left.SetDone(true);
2679         }
2680         if ( y != wxDefaultCoord )
2681         {
2682             constr->top.SetValue(y);
2683             constr->top.SetDone(true);
2684         }
2685         if ( w != wxDefaultCoord )
2686         {
2687             constr->width.SetValue(w);
2688             constr->width.SetDone(true);
2689         }
2690         if ( h != wxDefaultCoord )
2691         {
2692             constr->height.SetValue(h);
2693             constr->height.SetDone(true);
2694         }
2695     }
2696 }
2697
2698 void wxWindowBase::MoveConstraint(int x, int y)
2699 {
2700     wxLayoutConstraints *constr = GetConstraints();
2701     if ( constr )
2702     {
2703         if ( x != wxDefaultCoord )
2704         {
2705             constr->left.SetValue(x);
2706             constr->left.SetDone(true);
2707         }
2708         if ( y != wxDefaultCoord )
2709         {
2710             constr->top.SetValue(y);
2711             constr->top.SetDone(true);
2712         }
2713     }
2714 }
2715
2716 void wxWindowBase::GetSizeConstraint(int *w, int *h) const
2717 {
2718     wxLayoutConstraints *constr = GetConstraints();
2719     if ( constr )
2720     {
2721         *w = constr->width.GetValue();
2722         *h = constr->height.GetValue();
2723     }
2724     else
2725         GetSize(w, h);
2726 }
2727
2728 void wxWindowBase::GetClientSizeConstraint(int *w, int *h) const
2729 {
2730     wxLayoutConstraints *constr = GetConstraints();
2731     if ( constr )
2732     {
2733         *w = constr->width.GetValue();
2734         *h = constr->height.GetValue();
2735     }
2736     else
2737         GetClientSize(w, h);
2738 }
2739
2740 void wxWindowBase::GetPositionConstraint(int *x, int *y) const
2741 {
2742     wxLayoutConstraints *constr = GetConstraints();
2743     if ( constr )
2744     {
2745         *x = constr->left.GetValue();
2746         *y = constr->top.GetValue();
2747     }
2748     else
2749         GetPosition(x, y);
2750 }
2751
2752 #endif // wxUSE_CONSTRAINTS
2753
2754 void wxWindowBase::AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const
2755 {
2756     wxWindow *parent = GetParent();
2757     if ( !(sizeFlags & wxSIZE_NO_ADJUSTMENTS) && parent )
2758     {
2759         wxPoint pt(parent->GetClientAreaOrigin());
2760         x += pt.x;
2761         y += pt.y;
2762     }
2763 }
2764
2765 // ----------------------------------------------------------------------------
2766 // Update UI processing
2767 // ----------------------------------------------------------------------------
2768
2769 void wxWindowBase::UpdateWindowUI(long flags)
2770 {
2771     wxUpdateUIEvent event(GetId());
2772     event.SetEventObject(this);
2773
2774     if ( GetEventHandler()->ProcessEvent(event) )
2775     {
2776         DoUpdateWindowUI(event);
2777     }
2778
2779     if (flags & wxUPDATE_UI_RECURSE)
2780     {
2781         wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2782         while (node)
2783         {
2784             wxWindow* child = (wxWindow*) node->GetData();
2785             child->UpdateWindowUI(flags);
2786             node = node->GetNext();
2787         }
2788     }
2789 }
2790
2791 // do the window-specific processing after processing the update event
2792 void wxWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
2793 {
2794     if ( event.GetSetEnabled() )
2795         Enable(event.GetEnabled());
2796
2797     if ( event.GetSetShown() )
2798         Show(event.GetShown());
2799 }
2800
2801 // ----------------------------------------------------------------------------
2802 // Idle processing
2803 // ----------------------------------------------------------------------------
2804
2805 // Send idle event to window and all subwindows
2806 bool wxWindowBase::SendIdleEvents(wxIdleEvent& event)
2807 {
2808     bool needMore = false;
2809
2810     OnInternalIdle();
2811
2812     // should we send idle event to this window?
2813     if (wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
2814         HasExtraStyle(wxWS_EX_PROCESS_IDLE))
2815     {
2816         event.SetEventObject(this);
2817         HandleWindowEvent(event);
2818
2819         if (event.MoreRequested())
2820             needMore = true;
2821     }
2822     wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2823     for (; node; node = node->GetNext())
2824     {
2825         wxWindow* child = node->GetData();
2826         if (child->SendIdleEvents(event))
2827             needMore = true;
2828     }
2829
2830     return needMore;
2831 }
2832
2833 void wxWindowBase::OnInternalIdle()
2834 {
2835     if ( wxUpdateUIEvent::CanUpdate(this) )
2836         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
2837 }
2838
2839 // ----------------------------------------------------------------------------
2840 // dialog units translations
2841 // ----------------------------------------------------------------------------
2842
2843 // Windows' computes dialog units using average character width over upper-
2844 // and lower-case ASCII alphabet and not using the average character width
2845 // metadata stored in the font; see
2846 // http://support.microsoft.com/default.aspx/kb/145994 for detailed discussion.
2847 // It's important that we perform the conversion in identical way, because
2848 // dialog units natively exist only on Windows and Windows HIG is expressed
2849 // using them.
2850 wxSize wxWindowBase::GetDlgUnitBase() const
2851 {
2852     const wxWindowBase * const parent = wxGetTopLevelParent((wxWindow*)this);
2853
2854     wxCHECK_MSG( parent, wxDefaultSize, wxS("Must have TLW parent") );
2855
2856     if ( !parent->m_font.IsOk() )
2857     {
2858         // Default GUI font is used. This is the most common case, so
2859         // cache the results.
2860         static wxSize s_defFontSize;
2861         if ( s_defFontSize.x == 0 )
2862             s_defFontSize = wxPrivate::GetAverageASCIILetterSize(*parent);
2863         return s_defFontSize;
2864     }
2865     else
2866     {
2867         // Custom font, we always need to compute the result
2868         return wxPrivate::GetAverageASCIILetterSize(*parent);
2869     }
2870 }
2871
2872 wxPoint wxWindowBase::ConvertPixelsToDialog(const wxPoint& pt) const
2873 {
2874     const wxSize base = GetDlgUnitBase();
2875
2876     // NB: wxMulDivInt32() is used, because it correctly rounds the result
2877
2878     wxPoint pt2 = wxDefaultPosition;
2879     if (pt.x != wxDefaultCoord)
2880         pt2.x = wxMulDivInt32(pt.x, 4, base.x);
2881     if (pt.y != wxDefaultCoord)
2882         pt2.y = wxMulDivInt32(pt.y, 8, base.y);
2883
2884     return pt2;
2885 }
2886
2887 wxPoint wxWindowBase::ConvertDialogToPixels(const wxPoint& pt) const
2888 {
2889     const wxSize base = GetDlgUnitBase();
2890
2891     wxPoint pt2 = wxDefaultPosition;
2892     if (pt.x != wxDefaultCoord)
2893         pt2.x = wxMulDivInt32(pt.x, base.x, 4);
2894     if (pt.y != wxDefaultCoord)
2895         pt2.y = wxMulDivInt32(pt.y, base.y, 8);
2896
2897     return pt2;
2898 }
2899
2900 // ----------------------------------------------------------------------------
2901 // event handlers
2902 // ----------------------------------------------------------------------------
2903
2904 // propagate the colour change event to the subwindows
2905 void wxWindowBase::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
2906 {
2907     wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
2908     while ( node )
2909     {
2910         // Only propagate to non-top-level windows
2911         wxWindow *win = node->GetData();
2912         if ( !win->IsTopLevel() )
2913         {
2914             wxSysColourChangedEvent event2;
2915             event2.SetEventObject(win);
2916             win->GetEventHandler()->ProcessEvent(event2);
2917         }
2918
2919         node = node->GetNext();
2920     }
2921
2922     Refresh();
2923 }
2924
2925 // the default action is to populate dialog with data when it's created,
2926 // and nudge the UI into displaying itself correctly in case
2927 // we've turned the wxUpdateUIEvents frequency down low.
2928 void wxWindowBase::OnInitDialog( wxInitDialogEvent &WXUNUSED(event) )
2929 {
2930     TransferDataToWindow();
2931
2932     // Update the UI at this point
2933     UpdateWindowUI(wxUPDATE_UI_RECURSE);
2934 }
2935
2936 // ----------------------------------------------------------------------------
2937 // menu-related functions
2938 // ----------------------------------------------------------------------------
2939
2940 #if wxUSE_MENUS
2941
2942 bool wxWindowBase::PopupMenu(wxMenu *menu, int x, int y)
2943 {
2944     wxCHECK_MSG( menu, false, "can't popup NULL menu" );
2945
2946     wxMenuInvokingWindowSetter
2947         setInvokingWin(*menu, static_cast<wxWindow *>(this));
2948
2949     wxCurrentPopupMenu = menu;
2950     const bool rc = DoPopupMenu(menu, x, y);
2951     wxCurrentPopupMenu = NULL;
2952
2953     return rc;
2954 }
2955
2956 // this is used to pass the id of the selected item from the menu event handler
2957 // to the main function itself
2958 //
2959 // it's ok to use a global here as there can be at most one popup menu shown at
2960 // any time
2961 static int gs_popupMenuSelection = wxID_NONE;
2962
2963 void wxWindowBase::InternalOnPopupMenu(wxCommandEvent& event)
2964 {
2965     // store the id in a global variable where we'll retrieve it from later
2966     gs_popupMenuSelection = event.GetId();
2967 }
2968
2969 void wxWindowBase::InternalOnPopupMenuUpdate(wxUpdateUIEvent& WXUNUSED(event))
2970 {
2971     // nothing to do but do not skip it
2972 }
2973
2974 int
2975 wxWindowBase::DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y)
2976 {
2977     gs_popupMenuSelection = wxID_NONE;
2978
2979     Connect(wxEVT_MENU,
2980             wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
2981             NULL,
2982             this);
2983
2984     // it is common to construct the menu passed to this function dynamically
2985     // using some fixed range of ids which could clash with the ids used
2986     // elsewhere in the program, which could result in some menu items being
2987     // unintentionally disabled or otherwise modified by update UI handlers
2988     // elsewhere in the program code and this is difficult to avoid in the
2989     // program itself, so instead we just temporarily suspend UI updating while
2990     // this menu is shown
2991     Connect(wxEVT_UPDATE_UI,
2992             wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
2993             NULL,
2994             this);
2995
2996     PopupMenu(&menu, x, y);
2997
2998     Disconnect(wxEVT_UPDATE_UI,
2999                wxUpdateUIEventHandler(wxWindowBase::InternalOnPopupMenuUpdate),
3000                NULL,
3001                this);
3002     Disconnect(wxEVT_MENU,
3003                wxCommandEventHandler(wxWindowBase::InternalOnPopupMenu),
3004                NULL,
3005                this);
3006
3007     return gs_popupMenuSelection;
3008 }
3009
3010 #endif // wxUSE_MENUS
3011
3012 // methods for drawing the sizers in a visible way: this is currently only
3013 // enabled for "full debug" builds with wxDEBUG_LEVEL==2 as it doesn't work
3014 // that well and also because we don't want to leave it enabled in default
3015 // builds used for production
3016 #if wxDEBUG_LEVEL > 1
3017
3018 static void DrawSizers(wxWindowBase *win);
3019
3020 static void DrawBorder(wxWindowBase *win, const wxRect& rect, bool fill, const wxPen* pen)
3021 {
3022     wxClientDC dc((wxWindow *)win);
3023     dc.SetPen(*pen);
3024     dc.SetBrush(fill ? wxBrush(pen->GetColour(), wxBRUSHSTYLE_CROSSDIAG_HATCH) :
3025                        *wxTRANSPARENT_BRUSH);
3026     dc.DrawRectangle(rect.Deflate(1, 1));
3027 }
3028
3029 static void DrawSizer(wxWindowBase *win, wxSizer *sizer)
3030 {
3031     const wxSizerItemList& items = sizer->GetChildren();
3032     for ( wxSizerItemList::const_iterator i = items.begin(),
3033                                         end = items.end();
3034           i != end;
3035           ++i )
3036     {
3037         wxSizerItem *item = *i;
3038         if ( item->IsSizer() )
3039         {
3040             DrawBorder(win, item->GetRect().Deflate(2), false, wxRED_PEN);
3041             DrawSizer(win, item->GetSizer());
3042         }
3043         else if ( item->IsSpacer() )
3044         {
3045             DrawBorder(win, item->GetRect().Deflate(2), true, wxBLUE_PEN);
3046         }
3047         else if ( item->IsWindow() )
3048         {
3049             DrawSizers(item->GetWindow());
3050         }
3051         else
3052             wxFAIL_MSG("inconsistent wxSizerItem status!");
3053     }
3054 }
3055
3056 static void DrawSizers(wxWindowBase *win)
3057 {
3058     DrawBorder(win, win->GetClientSize(), false, wxGREEN_PEN);
3059
3060     wxSizer *sizer = win->GetSizer();
3061     if ( sizer )
3062     {
3063         DrawSizer(win, sizer);
3064     }
3065     else // no sizer, still recurse into the children
3066     {
3067         const wxWindowList& children = win->GetChildren();
3068         for ( wxWindowList::const_iterator i = children.begin(),
3069                                          end = children.end();
3070               i != end;
3071               ++i )
3072         {
3073             DrawSizers(*i);
3074         }
3075
3076         // show all kind of sizes of this window; see the "window sizing" topic
3077         // overview for more info about the various differences:
3078         wxSize fullSz = win->GetSize();
3079         wxSize clientSz = win->GetClientSize();
3080         wxSize bestSz = win->GetBestSize();
3081         wxSize minSz = win->GetMinSize();
3082         wxSize maxSz = win->GetMaxSize();
3083         wxSize virtualSz = win->GetVirtualSize();
3084
3085         wxMessageOutputDebug dbgout;
3086         dbgout.Printf(
3087             "%-10s => fullsz=%4d;%-4d  clientsz=%4d;%-4d  bestsz=%4d;%-4d  minsz=%4d;%-4d  maxsz=%4d;%-4d virtualsz=%4d;%-4d\n",
3088             win->GetName(),
3089             fullSz.x, fullSz.y,
3090             clientSz.x, clientSz.y,
3091             bestSz.x, bestSz.y,
3092             minSz.x, minSz.y,
3093             maxSz.x, maxSz.y,
3094             virtualSz.x, virtualSz.y);
3095     }
3096 }
3097
3098 #endif // wxDEBUG_LEVEL
3099
3100 // process special middle clicks
3101 void wxWindowBase::OnMiddleClick( wxMouseEvent& event )
3102 {
3103     if ( event.ControlDown() && event.AltDown() )
3104     {
3105 #if wxDEBUG_LEVEL > 1
3106         // Ctrl-Alt-Shift-mclick makes the sizers visible in debug builds
3107         if ( event.ShiftDown() )
3108         {
3109             DrawSizers(this);
3110         }
3111         else
3112 #endif // __WXDEBUG__
3113         {
3114 #if wxUSE_MSGDLG
3115             // just Ctrl-Alt-middle click shows information about wx version
3116             ::wxInfoMessageBox((wxWindow*)this);
3117 #endif // wxUSE_MSGDLG
3118         }
3119     }
3120     else
3121     {
3122         event.Skip();
3123     }
3124 }
3125
3126 // ----------------------------------------------------------------------------
3127 // accessibility
3128 // ----------------------------------------------------------------------------
3129
3130 #if wxUSE_ACCESSIBILITY
3131 void wxWindowBase::SetAccessible(wxAccessible* accessible)
3132 {
3133     if (m_accessible && (accessible != m_accessible))
3134         delete m_accessible;
3135     m_accessible = accessible;
3136     if (m_accessible)
3137         m_accessible->SetWindow((wxWindow*) this);
3138 }
3139
3140 // Returns the accessible object, creating if necessary.
3141 wxAccessible* wxWindowBase::GetOrCreateAccessible()
3142 {
3143     if (!m_accessible)
3144         m_accessible = CreateAccessible();
3145     return m_accessible;
3146 }
3147
3148 // Override to create a specific accessible object.
3149 wxAccessible* wxWindowBase::CreateAccessible()
3150 {
3151     return new wxWindowAccessible((wxWindow*) this);
3152 }
3153
3154 #endif
3155
3156 // ----------------------------------------------------------------------------
3157 // list classes implementation
3158 // ----------------------------------------------------------------------------
3159
3160 #if wxUSE_STD_CONTAINERS
3161
3162 #include "wx/listimpl.cpp"
3163 WX_DEFINE_LIST(wxWindowList)
3164
3165 #else // !wxUSE_STD_CONTAINERS
3166
3167 void wxWindowListNode::DeleteData()
3168 {
3169     delete (wxWindow *)GetData();
3170 }
3171
3172 #endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS
3173
3174 // ----------------------------------------------------------------------------
3175 // borders
3176 // ----------------------------------------------------------------------------
3177
3178 wxBorder wxWindowBase::GetBorder(long flags) const
3179 {
3180     wxBorder border = (wxBorder)(flags & wxBORDER_MASK);
3181     if ( border == wxBORDER_DEFAULT )
3182     {
3183         border = GetDefaultBorder();
3184     }
3185     else if ( border == wxBORDER_THEME )
3186     {
3187         border = GetDefaultBorderForControl();
3188     }
3189
3190     return border;
3191 }
3192
3193 wxBorder wxWindowBase::GetDefaultBorder() const
3194 {
3195     return wxBORDER_NONE;
3196 }
3197
3198 // ----------------------------------------------------------------------------
3199 // hit testing
3200 // ----------------------------------------------------------------------------
3201
3202 wxHitTest wxWindowBase::DoHitTest(wxCoord x, wxCoord y) const
3203 {
3204     // here we just check if the point is inside the window or not
3205
3206     // check the top and left border first
3207     bool outside = x < 0 || y < 0;
3208     if ( !outside )
3209     {
3210         // check the right and bottom borders too
3211         wxSize size = GetSize();
3212         outside = x >= size.x || y >= size.y;
3213     }
3214
3215     return outside ? wxHT_WINDOW_OUTSIDE : wxHT_WINDOW_INSIDE;
3216 }
3217
3218 // ----------------------------------------------------------------------------
3219 // mouse capture
3220 // ----------------------------------------------------------------------------
3221
3222 // Private data used for mouse capture tracking.
3223 namespace wxMouseCapture
3224 {
3225
3226 // Stack of the windows which previously had the capture, the top most element
3227 // is the window that has the mouse capture now.
3228 //
3229 // NB: We use wxVector and not wxStack to be able to examine all of the stack
3230 //     elements for debug checks, but only the stack operations should be
3231 //     performed with this vector.
3232 wxVector<wxWindow*> stack;
3233
3234 // Flag preventing reentrancy in {Capture,Release}Mouse().
3235 wxRecursionGuardFlag changing;
3236
3237 bool IsInCaptureStack(wxWindowBase* win)
3238 {
3239     for ( wxVector<wxWindow*>::const_iterator it = stack.begin();
3240           it != stack.end();
3241           ++it )
3242     {
3243         if ( *it == win )
3244             return true;
3245     }
3246
3247     return false;
3248 }
3249
3250 } // wxMouseCapture
3251
3252 void wxWindowBase::CaptureMouse()
3253 {
3254     wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p)"), static_cast<void*>(this));
3255
3256     wxRecursionGuard guard(wxMouseCapture::changing);
3257     wxASSERT_MSG( !guard.IsInside(), wxT("recursive CaptureMouse call?") );
3258
3259     wxASSERT_MSG( !wxMouseCapture::IsInCaptureStack(this),
3260                     "Recapturing the mouse in the same window?" );
3261
3262     wxWindow *winOld = GetCapture();
3263     if ( winOld )
3264         ((wxWindowBase*) winOld)->DoReleaseMouse();
3265
3266     DoCaptureMouse();
3267
3268     wxMouseCapture::stack.push_back(static_cast<wxWindow*>(this));
3269 }
3270
3271 void wxWindowBase::ReleaseMouse()
3272 {
3273     wxLogTrace(wxT("mousecapture"), wxT("ReleaseMouse(%p)"), static_cast<void*>(this));
3274
3275     wxRecursionGuard guard(wxMouseCapture::changing);
3276     wxASSERT_MSG( !guard.IsInside(), wxT("recursive ReleaseMouse call?") );
3277
3278 #if wxDEBUG_LEVEL
3279     wxWindow* const winCapture = GetCapture();
3280     if ( !winCapture )
3281     {
3282         wxFAIL_MSG
3283         (
3284           wxString::Format
3285           (
3286             "Releasing mouse in %p(%s) but it is not captured",
3287             this, GetClassInfo()->GetClassName()
3288           )
3289         );
3290     }
3291     else if ( winCapture != this )
3292     {
3293         wxFAIL_MSG
3294         (
3295           wxString::Format
3296           (
3297             "Releasing mouse in %p(%s) but it is captured by %p(%s)",
3298             this, GetClassInfo()->GetClassName(),
3299             winCapture, winCapture->GetClassInfo()->GetClassName()
3300           )
3301         );
3302     }
3303 #endif // wxDEBUG_LEVEL
3304
3305     DoReleaseMouse();
3306
3307     wxCHECK_RET( !wxMouseCapture::stack.empty(),
3308                     "Releasing mouse capture but capture stack empty?" );
3309     wxCHECK_RET( wxMouseCapture::stack.back() == this,
3310                     "Window releasing mouse capture not top of capture stack?" );
3311
3312     wxMouseCapture::stack.pop_back();
3313
3314     // Restore the capture to the previous window, if any.
3315     if ( !wxMouseCapture::stack.empty() )
3316     {
3317         ((wxWindowBase*)wxMouseCapture::stack.back())->DoCaptureMouse();
3318     }
3319
3320     wxLogTrace(wxT("mousecapture"),
3321         wxT("After ReleaseMouse() mouse is captured by %p"),
3322         static_cast<void*>(GetCapture()));
3323 }
3324
3325 static void DoNotifyWindowAboutCaptureLost(wxWindow *win)
3326 {
3327     wxMouseCaptureLostEvent event(win->GetId());
3328     event.SetEventObject(win);
3329     if ( !win->GetEventHandler()->ProcessEvent(event) )
3330     {
3331         // windows must handle this event, otherwise the app wouldn't behave
3332         // correctly if it loses capture unexpectedly; see the discussion here:
3333         // http://sourceforge.net/tracker/index.php?func=detail&aid=1153662&group_id=9863&atid=109863
3334         // http://article.gmane.org/gmane.comp.lib.wxwidgets.devel/82376
3335         wxFAIL_MSG( wxT("window that captured the mouse didn't process wxEVT_MOUSE_CAPTURE_LOST") );
3336     }
3337 }
3338
3339 /* static */
3340 void wxWindowBase::NotifyCaptureLost()
3341 {
3342     // don't do anything if capture lost was expected, i.e. resulted from
3343     // a wx call to ReleaseMouse or CaptureMouse:
3344     wxRecursionGuard guard(wxMouseCapture::changing);
3345     if ( guard.IsInside() )
3346         return;
3347
3348     // if the capture was lost unexpectedly, notify every window that has
3349     // capture (on stack or current) about it and clear the stack:
3350     while ( !wxMouseCapture::stack.empty() )
3351     {
3352         DoNotifyWindowAboutCaptureLost(wxMouseCapture::stack.back());
3353
3354         wxMouseCapture::stack.pop_back();
3355     }
3356 }
3357
3358 #if wxUSE_HOTKEY
3359
3360 bool
3361 wxWindowBase::RegisterHotKey(int WXUNUSED(hotkeyId),
3362                              int WXUNUSED(modifiers),
3363                              int WXUNUSED(keycode))
3364 {
3365     // not implemented
3366     return false;
3367 }
3368
3369 bool wxWindowBase::UnregisterHotKey(int WXUNUSED(hotkeyId))
3370 {
3371     // not implemented
3372     return false;
3373 }
3374
3375 #endif // wxUSE_HOTKEY
3376
3377 // ----------------------------------------------------------------------------
3378 // event processing
3379 // ----------------------------------------------------------------------------
3380
3381 bool wxWindowBase::TryBefore(wxEvent& event)
3382 {
3383 #if wxUSE_VALIDATORS
3384     // Can only use the validator of the window which
3385     // is receiving the event
3386     if ( event.GetEventObject() == this )
3387     {
3388         wxValidator * const validator = GetValidator();
3389         if ( validator && validator->ProcessEventLocally(event) )
3390         {
3391             return true;
3392         }
3393     }
3394 #endif // wxUSE_VALIDATORS
3395
3396     return wxEvtHandler::TryBefore(event);
3397 }
3398
3399 bool wxWindowBase::TryAfter(wxEvent& event)
3400 {
3401     // carry on up the parent-child hierarchy if the propagation count hasn't
3402     // reached zero yet
3403     if ( event.ShouldPropagate() )
3404     {
3405         // honour the requests to stop propagation at this window: this is
3406         // used by the dialogs, for example, to prevent processing the events
3407         // from the dialog controls in the parent frame which rarely, if ever,
3408         // makes sense
3409         if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
3410         {
3411             wxWindow *parent = GetParent();
3412             if ( parent && !parent->IsBeingDeleted() )
3413             {
3414                 wxPropagateOnce propagateOnce(event, this);
3415
3416                 return parent->GetEventHandler()->ProcessEvent(event);
3417             }
3418         }
3419     }
3420
3421     return wxEvtHandler::TryAfter(event);
3422 }
3423
3424 // ----------------------------------------------------------------------------
3425 // window relationships
3426 // ----------------------------------------------------------------------------
3427
3428 wxWindow *wxWindowBase::DoGetSibling(WindowOrder order) const
3429 {
3430     wxCHECK_MSG( GetParent(), NULL,
3431                     wxT("GetPrev/NextSibling() don't work for TLWs!") );
3432
3433     wxWindowList& siblings = GetParent()->GetChildren();
3434     wxWindowList::compatibility_iterator i = siblings.Find((wxWindow *)this);
3435     wxCHECK_MSG( i, NULL, wxT("window not a child of its parent?") );
3436
3437     if ( order == OrderBefore )
3438         i = i->GetPrevious();
3439     else // OrderAfter
3440         i = i->GetNext();
3441
3442     return i ? i->GetData() : NULL;
3443 }
3444
3445 // ----------------------------------------------------------------------------
3446 // keyboard navigation
3447 // ----------------------------------------------------------------------------
3448
3449 // Navigates in the specified direction inside this window
3450 bool wxWindowBase::DoNavigateIn(int flags)
3451 {
3452 #ifdef wxHAS_NATIVE_TAB_TRAVERSAL
3453     // native code doesn't process our wxNavigationKeyEvents anyhow
3454     wxUnusedVar(flags);
3455     return false;
3456 #else // !wxHAS_NATIVE_TAB_TRAVERSAL
3457     wxNavigationKeyEvent eventNav;
3458     wxWindow *focused = FindFocus();
3459     eventNav.SetCurrentFocus(focused);
3460     eventNav.SetEventObject(focused);
3461     eventNav.SetFlags(flags);
3462     return GetEventHandler()->ProcessEvent(eventNav);
3463 #endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
3464 }
3465
3466 bool wxWindowBase::HandleAsNavigationKey(const wxKeyEvent& event)
3467 {
3468     if ( event.GetKeyCode() != WXK_TAB )
3469         return false;
3470
3471     int flags = wxNavigationKeyEvent::FromTab;
3472
3473     if ( event.ShiftDown() )
3474         flags |= wxNavigationKeyEvent::IsBackward;
3475     else
3476         flags |= wxNavigationKeyEvent::IsForward;
3477
3478     if ( event.ControlDown() )
3479         flags |= wxNavigationKeyEvent::WinChange;
3480
3481     Navigate(flags);
3482     return true;
3483 }
3484
3485 void wxWindowBase::DoMoveInTabOrder(wxWindow *win, WindowOrder move)
3486 {
3487     // check that we're not a top level window
3488     wxCHECK_RET( GetParent(),
3489                     wxT("MoveBefore/AfterInTabOrder() don't work for TLWs!") );
3490
3491     // detect the special case when we have nothing to do anyhow and when the
3492     // code below wouldn't work
3493     if ( win == this )
3494         return;
3495
3496     // find the target window in the siblings list
3497     wxWindowList& siblings = GetParent()->GetChildren();
3498     wxWindowList::compatibility_iterator i = siblings.Find(win);
3499     wxCHECK_RET( i, wxT("MoveBefore/AfterInTabOrder(): win is not a sibling") );
3500
3501     // unfortunately, when wxUSE_STD_CONTAINERS == 1 DetachNode() is not
3502     // implemented so we can't just move the node around
3503     wxWindow *self = (wxWindow *)this;
3504     siblings.DeleteObject(self);
3505     if ( move == OrderAfter )
3506     {
3507         i = i->GetNext();
3508     }
3509
3510     if ( i )
3511     {
3512         siblings.Insert(i, self);
3513     }
3514     else // OrderAfter and win was the last sibling
3515     {
3516         siblings.Append(self);
3517     }
3518 }
3519
3520 // ----------------------------------------------------------------------------
3521 // focus handling
3522 // ----------------------------------------------------------------------------
3523
3524 /*static*/ wxWindow* wxWindowBase::FindFocus()
3525 {
3526     wxWindowBase *win = DoFindFocus();
3527     return win ? win->GetMainWindowOfCompositeControl() : NULL;
3528 }
3529
3530 bool wxWindowBase::HasFocus() const
3531 {
3532     wxWindowBase* const win = DoFindFocus();
3533     return win &&
3534             (this == win || this == win->GetMainWindowOfCompositeControl());
3535 }
3536
3537 // ----------------------------------------------------------------------------
3538 // drag and drop
3539 // ----------------------------------------------------------------------------
3540
3541 #if wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3542
3543 namespace
3544 {
3545
3546 class DragAcceptFilesTarget : public wxFileDropTarget
3547 {
3548 public:
3549     DragAcceptFilesTarget(wxWindowBase *win) : m_win(win) {}
3550
3551     virtual bool OnDropFiles(wxCoord x, wxCoord y,
3552                              const wxArrayString& filenames)
3553     {
3554         wxDropFilesEvent event(wxEVT_DROP_FILES,
3555                                filenames.size(),
3556                                wxCArrayString(filenames).Release());
3557         event.SetEventObject(m_win);
3558         event.m_pos.x = x;
3559         event.m_pos.y = y;
3560
3561         return m_win->HandleWindowEvent(event);
3562     }
3563
3564 private:
3565     wxWindowBase * const m_win;
3566
3567     wxDECLARE_NO_COPY_CLASS(DragAcceptFilesTarget);
3568 };
3569
3570
3571 } // anonymous namespace
3572
3573 // Generic version of DragAcceptFiles(). It works by installing a simple
3574 // wxFileDropTarget-to-EVT_DROP_FILES adaptor and therefore cannot be used
3575 // together with explicit SetDropTarget() calls.
3576 void wxWindowBase::DragAcceptFiles(bool accept)
3577 {
3578     if ( accept )
3579     {
3580         wxASSERT_MSG( !GetDropTarget(),
3581                       "cannot use DragAcceptFiles() and SetDropTarget() together" );
3582         SetDropTarget(new DragAcceptFilesTarget(this));
3583     }
3584     else
3585     {
3586         SetDropTarget(NULL);
3587     }
3588 }
3589
3590 #endif // wxUSE_DRAG_AND_DROP && !defined(__WXMSW__)
3591
3592 // ----------------------------------------------------------------------------
3593 // global functions
3594 // ----------------------------------------------------------------------------
3595
3596 wxWindow* wxGetTopLevelParent(wxWindow *win)
3597 {
3598     while ( win && !win->IsTopLevel() )
3599          win = win->GetParent();
3600
3601     return win;
3602 }
3603
3604 #if wxUSE_ACCESSIBILITY
3605 // ----------------------------------------------------------------------------
3606 // accessible object for windows
3607 // ----------------------------------------------------------------------------
3608
3609 // Can return either a child object, or an integer
3610 // representing the child element, starting from 1.
3611 wxAccStatus wxWindowAccessible::HitTest(const wxPoint& WXUNUSED(pt), int* WXUNUSED(childId), wxAccessible** WXUNUSED(childObject))
3612 {
3613     wxASSERT( GetWindow() != NULL );
3614     if (!GetWindow())
3615         return wxACC_FAIL;
3616
3617     return wxACC_NOT_IMPLEMENTED;
3618 }
3619
3620 // Returns the rectangle for this object (id = 0) or a child element (id > 0).
3621 wxAccStatus wxWindowAccessible::GetLocation(wxRect& rect, int elementId)
3622 {
3623     wxASSERT( GetWindow() != NULL );
3624     if (!GetWindow())
3625         return wxACC_FAIL;
3626
3627     wxWindow* win = NULL;
3628     if (elementId == 0)
3629     {
3630         win = GetWindow();
3631     }
3632     else
3633     {
3634         if (elementId <= (int) GetWindow()->GetChildren().GetCount())
3635         {
3636             win = GetWindow()->GetChildren().Item(elementId-1)->GetData();
3637         }
3638         else
3639             return wxACC_FAIL;
3640     }
3641     if (win)
3642     {
3643         rect = win->GetRect();
3644         if (win->GetParent() && !wxDynamicCast(win, wxTopLevelWindow))
3645             rect.SetPosition(win->GetParent()->ClientToScreen(rect.GetPosition()));
3646         return wxACC_OK;
3647     }
3648
3649     return wxACC_NOT_IMPLEMENTED;
3650 }
3651
3652 // Navigates from fromId to toId/toObject.
3653 wxAccStatus wxWindowAccessible::Navigate(wxNavDir navDir, int fromId,
3654                              int* WXUNUSED(toId), wxAccessible** toObject)
3655 {
3656     wxASSERT( GetWindow() != NULL );
3657     if (!GetWindow())
3658         return wxACC_FAIL;
3659
3660     switch (navDir)
3661     {
3662     case wxNAVDIR_FIRSTCHILD:
3663         {
3664             if (GetWindow()->GetChildren().GetCount() == 0)
3665                 return wxACC_FALSE;
3666             wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetFirst()->GetData();
3667             *toObject = childWindow->GetOrCreateAccessible();
3668
3669             return wxACC_OK;
3670         }
3671     case wxNAVDIR_LASTCHILD:
3672         {
3673             if (GetWindow()->GetChildren().GetCount() == 0)
3674                 return wxACC_FALSE;
3675             wxWindow* childWindow = (wxWindow*) GetWindow()->GetChildren().GetLast()->GetData();
3676             *toObject = childWindow->GetOrCreateAccessible();
3677
3678             return wxACC_OK;
3679         }
3680     case wxNAVDIR_RIGHT:
3681     case wxNAVDIR_DOWN:
3682     case wxNAVDIR_NEXT:
3683         {
3684             wxWindowList::compatibility_iterator node =
3685                 wxWindowList::compatibility_iterator();
3686             if (fromId == 0)
3687             {
3688                 // Can't navigate to sibling of this window
3689                 // if we're a top-level window.
3690                 if (!GetWindow()->GetParent())
3691                     return wxACC_NOT_IMPLEMENTED;
3692
3693                 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3694             }
3695             else
3696             {
3697                 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3698                     node = GetWindow()->GetChildren().Item(fromId-1);
3699             }
3700
3701             if (node && node->GetNext())
3702             {
3703                 wxWindow* nextWindow = node->GetNext()->GetData();
3704                 *toObject = nextWindow->GetOrCreateAccessible();
3705                 return wxACC_OK;
3706             }
3707             else
3708                 return wxACC_FALSE;
3709         }
3710     case wxNAVDIR_LEFT:
3711     case wxNAVDIR_UP:
3712     case wxNAVDIR_PREVIOUS:
3713         {
3714             wxWindowList::compatibility_iterator node =
3715                 wxWindowList::compatibility_iterator();
3716             if (fromId == 0)
3717             {
3718                 // Can't navigate to sibling of this window
3719                 // if we're a top-level window.
3720                 if (!GetWindow()->GetParent())
3721                     return wxACC_NOT_IMPLEMENTED;
3722
3723                 node = GetWindow()->GetParent()->GetChildren().Find(GetWindow());
3724             }
3725             else
3726             {
3727                 if (fromId <= (int) GetWindow()->GetChildren().GetCount())
3728                     node = GetWindow()->GetChildren().Item(fromId-1);
3729             }
3730
3731             if (node && node->GetPrevious())
3732             {
3733                 wxWindow* previousWindow = node->GetPrevious()->GetData();
3734                 *toObject = previousWindow->GetOrCreateAccessible();
3735                 return wxACC_OK;
3736             }
3737             else
3738                 return wxACC_FALSE;
3739         }
3740     }
3741
3742     return wxACC_NOT_IMPLEMENTED;
3743 }
3744
3745 // Gets the name of the specified object.
3746 wxAccStatus wxWindowAccessible::GetName(int childId, wxString* name)
3747 {
3748     wxASSERT( GetWindow() != NULL );
3749     if (!GetWindow())
3750         return wxACC_FAIL;
3751
3752     wxString title;
3753
3754     // If a child, leave wxWidgets to call the function on the actual
3755     // child object.
3756     if (childId > 0)
3757         return wxACC_NOT_IMPLEMENTED;
3758
3759     // This will eventually be replaced by specialised
3760     // accessible classes, one for each kind of wxWidgets
3761     // control or window.
3762 #if wxUSE_BUTTON
3763     if (wxDynamicCast(GetWindow(), wxButton))
3764         title = ((wxButton*) GetWindow())->GetLabel();
3765     else
3766 #endif
3767         title = GetWindow()->GetName();
3768
3769     if (!title.empty())
3770     {
3771         *name = title;
3772         return wxACC_OK;
3773     }
3774     else
3775         return wxACC_NOT_IMPLEMENTED;
3776 }
3777
3778 // Gets the number of children.
3779 wxAccStatus wxWindowAccessible::GetChildCount(int* childId)
3780 {
3781     wxASSERT( GetWindow() != NULL );
3782     if (!GetWindow())
3783         return wxACC_FAIL;
3784
3785     *childId = (int) GetWindow()->GetChildren().GetCount();
3786     return wxACC_OK;
3787 }
3788
3789 // Gets the specified child (starting from 1).
3790 // If *child is NULL and return value is wxACC_OK,
3791 // this means that the child is a simple element and
3792 // not an accessible object.
3793 wxAccStatus wxWindowAccessible::GetChild(int childId, wxAccessible** child)
3794 {
3795     wxASSERT( GetWindow() != NULL );
3796     if (!GetWindow())
3797         return wxACC_FAIL;
3798
3799     if (childId == 0)
3800     {
3801         *child = this;
3802         return wxACC_OK;
3803     }
3804
3805     if (childId > (int) GetWindow()->GetChildren().GetCount())
3806         return wxACC_FAIL;
3807
3808     wxWindow* childWindow = GetWindow()->GetChildren().Item(childId-1)->GetData();
3809     *child = childWindow->GetOrCreateAccessible();
3810     if (*child)
3811         return wxACC_OK;
3812     else
3813         return wxACC_FAIL;
3814 }
3815
3816 // Gets the parent, or NULL.
3817 wxAccStatus wxWindowAccessible::GetParent(wxAccessible** parent)
3818 {
3819     wxASSERT( GetWindow() != NULL );
3820     if (!GetWindow())
3821         return wxACC_FAIL;
3822
3823     wxWindow* parentWindow = GetWindow()->GetParent();
3824     if (!parentWindow)
3825     {
3826         *parent = NULL;
3827         return wxACC_OK;
3828     }
3829     else
3830     {
3831         *parent = parentWindow->GetOrCreateAccessible();
3832         if (*parent)
3833             return wxACC_OK;
3834         else
3835             return wxACC_FAIL;
3836     }
3837 }
3838
3839 // Performs the default action. childId is 0 (the action for this object)
3840 // or > 0 (the action for a child).
3841 // Return wxACC_NOT_SUPPORTED if there is no default action for this
3842 // window (e.g. an edit control).
3843 wxAccStatus wxWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
3844 {
3845     wxASSERT( GetWindow() != NULL );
3846     if (!GetWindow())
3847         return wxACC_FAIL;
3848
3849     return wxACC_NOT_IMPLEMENTED;
3850 }
3851
3852 // Gets the default action for this object (0) or > 0 (the action for a child).
3853 // Return wxACC_OK even if there is no action. actionName is the action, or the empty
3854 // string if there is no action.
3855 // The retrieved string describes the action that is performed on an object,
3856 // not what the object does as a result. For example, a toolbar button that prints
3857 // a document has a default action of "Press" rather than "Prints the current document."
3858 wxAccStatus wxWindowAccessible::GetDefaultAction(int WXUNUSED(childId), wxString* WXUNUSED(actionName))
3859 {
3860     wxASSERT( GetWindow() != NULL );
3861     if (!GetWindow())
3862         return wxACC_FAIL;
3863
3864     return wxACC_NOT_IMPLEMENTED;
3865 }
3866
3867 // Returns the description for this object or a child.
3868 wxAccStatus wxWindowAccessible::GetDescription(int WXUNUSED(childId), wxString* description)
3869 {
3870     wxASSERT( GetWindow() != NULL );
3871     if (!GetWindow())
3872         return wxACC_FAIL;
3873
3874     wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3875     if (!ht.empty())
3876     {
3877         *description = ht;
3878         return wxACC_OK;
3879     }
3880     return wxACC_NOT_IMPLEMENTED;
3881 }
3882
3883 // Returns help text for this object or a child, similar to tooltip text.
3884 wxAccStatus wxWindowAccessible::GetHelpText(int WXUNUSED(childId), wxString* helpText)
3885 {
3886     wxASSERT( GetWindow() != NULL );
3887     if (!GetWindow())
3888         return wxACC_FAIL;
3889
3890     wxString ht(GetWindow()->GetHelpTextAtPoint(wxDefaultPosition, wxHelpEvent::Origin_Keyboard));
3891     if (!ht.empty())
3892     {
3893         *helpText = ht;
3894         return wxACC_OK;
3895     }
3896     return wxACC_NOT_IMPLEMENTED;
3897 }
3898
3899 // Returns the keyboard shortcut for this object or child.
3900 // Return e.g. ALT+K
3901 wxAccStatus wxWindowAccessible::GetKeyboardShortcut(int WXUNUSED(childId), wxString* WXUNUSED(shortcut))
3902 {
3903     wxASSERT( GetWindow() != NULL );
3904     if (!GetWindow())
3905         return wxACC_FAIL;
3906
3907     return wxACC_NOT_IMPLEMENTED;
3908 }
3909
3910 // Returns a role constant.
3911 wxAccStatus wxWindowAccessible::GetRole(int childId, wxAccRole* role)
3912 {
3913     wxASSERT( GetWindow() != NULL );
3914     if (!GetWindow())
3915         return wxACC_FAIL;
3916
3917     // If a child, leave wxWidgets to call the function on the actual
3918     // child object.
3919     if (childId > 0)
3920         return wxACC_NOT_IMPLEMENTED;
3921
3922     if (wxDynamicCast(GetWindow(), wxControl))
3923         return wxACC_NOT_IMPLEMENTED;
3924 #if wxUSE_STATUSBAR
3925     if (wxDynamicCast(GetWindow(), wxStatusBar))
3926         return wxACC_NOT_IMPLEMENTED;
3927 #endif
3928 #if wxUSE_TOOLBAR
3929     if (wxDynamicCast(GetWindow(), wxToolBar))
3930         return wxACC_NOT_IMPLEMENTED;
3931 #endif
3932
3933     //*role = wxROLE_SYSTEM_CLIENT;
3934     *role = wxROLE_SYSTEM_CLIENT;
3935     return wxACC_OK;
3936
3937     #if 0
3938     return wxACC_NOT_IMPLEMENTED;
3939     #endif
3940 }
3941
3942 // Returns a state constant.
3943 wxAccStatus wxWindowAccessible::GetState(int childId, long* state)
3944 {
3945     wxASSERT( GetWindow() != NULL );
3946     if (!GetWindow())
3947         return wxACC_FAIL;
3948
3949     // If a child, leave wxWidgets to call the function on the actual
3950     // child object.
3951     if (childId > 0)
3952         return wxACC_NOT_IMPLEMENTED;
3953
3954     if (wxDynamicCast(GetWindow(), wxControl))
3955         return wxACC_NOT_IMPLEMENTED;
3956
3957 #if wxUSE_STATUSBAR
3958     if (wxDynamicCast(GetWindow(), wxStatusBar))
3959         return wxACC_NOT_IMPLEMENTED;
3960 #endif
3961 #if wxUSE_TOOLBAR
3962     if (wxDynamicCast(GetWindow(), wxToolBar))
3963         return wxACC_NOT_IMPLEMENTED;
3964 #endif
3965
3966     *state = 0;
3967     return wxACC_OK;
3968
3969     #if 0
3970     return wxACC_NOT_IMPLEMENTED;
3971     #endif
3972 }
3973
3974 // Returns a localized string representing the value for the object
3975 // or child.
3976 wxAccStatus wxWindowAccessible::GetValue(int WXUNUSED(childId), wxString* WXUNUSED(strValue))
3977 {
3978     wxASSERT( GetWindow() != NULL );
3979     if (!GetWindow())
3980         return wxACC_FAIL;
3981
3982     return wxACC_NOT_IMPLEMENTED;
3983 }
3984
3985 // Selects the object or child.
3986 wxAccStatus wxWindowAccessible::Select(int WXUNUSED(childId), wxAccSelectionFlags WXUNUSED(selectFlags))
3987 {
3988     wxASSERT( GetWindow() != NULL );
3989     if (!GetWindow())
3990         return wxACC_FAIL;
3991
3992     return wxACC_NOT_IMPLEMENTED;
3993 }
3994
3995 // Gets the window with the keyboard focus.
3996 // If childId is 0 and child is NULL, no object in
3997 // this subhierarchy has the focus.
3998 // If this object has the focus, child should be 'this'.
3999 wxAccStatus wxWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
4000 {
4001     wxASSERT( GetWindow() != NULL );
4002     if (!GetWindow())
4003         return wxACC_FAIL;
4004
4005     return wxACC_NOT_IMPLEMENTED;
4006 }
4007
4008 #if wxUSE_VARIANT
4009 // Gets a variant representing the selected children
4010 // of this object.
4011 // Acceptable values:
4012 // - a null variant (IsNull() returns true)
4013 // - a list variant (GetType() == wxT("list")
4014 // - an integer representing the selected child element,
4015 //   or 0 if this object is selected (GetType() == wxT("long")
4016 // - a "void*" pointer to a wxAccessible child object
4017 wxAccStatus wxWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
4018 {
4019     wxASSERT( GetWindow() != NULL );
4020     if (!GetWindow())
4021         return wxACC_FAIL;
4022
4023     return wxACC_NOT_IMPLEMENTED;
4024 }
4025 #endif // wxUSE_VARIANT
4026
4027 #endif // wxUSE_ACCESSIBILITY
4028
4029 // ----------------------------------------------------------------------------
4030 // RTL support
4031 // ----------------------------------------------------------------------------
4032
4033 wxCoord
4034 wxWindowBase::AdjustForLayoutDirection(wxCoord x,
4035                                        wxCoord width,
4036                                        wxCoord widthTotal) const
4037 {
4038     if ( GetLayoutDirection() == wxLayout_RightToLeft )
4039     {
4040         x = widthTotal - x - width;
4041     }
4042
4043     return x;
4044 }
4045
4046