src/common/wincmn.cpp

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