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