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