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