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