src/common/wincmn.cpp

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