src/common/wincmn.cpp

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