src/common/event.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/event.cpp
   3 // Purpose:     Event classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   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 #include "wx/event.h"
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/list.h"
  31     #include "wx/app.h"
  32     #include "wx/utils.h"
  33     #include "wx/stopwatch.h"
  34     #include "wx/module.h"
  35
  36     #if wxUSE_GUI
  37         #include "wx/control.h"
  38         #include "wx/dc.h"
  39         #include "wx/textctrl.h"
  40         #include "wx/validate.h"
  41     #endif // wxUSE_GUI
  42 #endif
  43
  44 // ----------------------------------------------------------------------------
  45 // wxWin macros
  46 // ----------------------------------------------------------------------------
  47
  48 #if wxUSE_BASE
  49     IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
  50     IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
  51 #endif // wxUSE_BASE
  52
  53 #if wxUSE_GUI
  54     IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
  55     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
  56     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
  57     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
  58     IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
  59     IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
  60     IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
  61     IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
  62     IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
  63     IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
  64     IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
  65     IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
  66     IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
  67     IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
  68     IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
  69     IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
  70     IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
  71     IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
  72     IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
  73     IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
  74     IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
  75     IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
  76     IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
  77     IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
  78     IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
  79     IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
  80     IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
  81     IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
  82     IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
  83     IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
  84     IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
  85     IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
  86     IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
  87     IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
  88     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
  89     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
  90     IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
  91 #endif // wxUSE_GUI
  92
  93 #if wxUSE_BASE
  94
  95 const wxEventTable *wxEvtHandler::GetEventTable() const
  96     { return &wxEvtHandler::sm_eventTable; }
  97
  98 const wxEventTable wxEvtHandler::sm_eventTable =
  99     { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
 100
 101 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
 102     { return wxEvtHandler::sm_eventHashTable; }
 103
 104 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
 105
 106 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
 107     { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
 108
 109
 110 #ifdef __WXDEBUG__
 111 // Clear up event hash table contents or we can get problems
 112 // when C++ is cleaning up the static object
 113 class wxEventTableEntryModule: public wxModule
 114 {
 115 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
 116 public:
 117     wxEventTableEntryModule() {}
 118     bool OnInit() { return true; }
 119     void OnExit()
 120     {
 121         wxEventHashTable::ClearAll();
 122     }
 123 };
 124 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
 125 #endif
 126
 127 // ----------------------------------------------------------------------------
 128 // global variables
 129 // ----------------------------------------------------------------------------
 130
 131 // To put pending event handlers
 132 wxList *wxPendingEvents = (wxList *)NULL;
 133
 134 #if wxUSE_THREADS
 135     // protects wxPendingEvents list
 136     wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
 137 #endif
 138
 139 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 140
 141 // common event types are defined here, other event types are defined by the
 142 // components which use them
 143
 144 const wxEventType wxEVT_FIRST = 10000;
 145 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
 146
 147 DEFINE_EVENT_TYPE(wxEVT_NULL)
 148 DEFINE_EVENT_TYPE(wxEVT_IDLE)
 149 DEFINE_EVENT_TYPE(wxEVT_SOCKET)
 150
 151 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 152
 153 #endif // wxUSE_BASE
 154
 155 #if wxUSE_GUI
 156
 157 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 158
 159 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED)
 160 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED)
 161 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED)
 162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED)
 163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED)
 164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED)
 165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED)
 166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED)
 167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED)
 168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED)
 169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED)
 170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED)
 171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED)
 172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
 173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
 174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
 175
 176 // Sockets and timers send events, too
 177 DEFINE_EVENT_TYPE(wxEVT_TIMER)
 178
 179 // Mouse event types
 180 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
 181 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP)
 182 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN)
 183 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP)
 184 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN)
 185 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP)
 186 DEFINE_EVENT_TYPE(wxEVT_MOTION)
 187 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW)
 188 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW)
 189 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK)
 190 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK)
 191 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK)
 192 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS)
 193 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS)
 194 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS)
 195 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL)
 196
 197 // Non-client mouse events
 198 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN)
 199 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP)
 200 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN)
 201 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP)
 202 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN)
 203 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP)
 204 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION)
 205 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW)
 206 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW)
 207 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK)
 208 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK)
 209 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK)
 210
 211 // Character input event type
 212 DEFINE_EVENT_TYPE(wxEVT_CHAR)
 213 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK)
 214 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY)
 215 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN)
 216 DEFINE_EVENT_TYPE(wxEVT_KEY_UP)
 217 #if wxUSE_HOTKEY
 218 DEFINE_EVENT_TYPE(wxEVT_HOTKEY)
 219 #endif
 220
 221 // Set cursor event
 222 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR)
 223
 224 // wxScrollbar and wxSlider event identifiers
 225 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP)
 226 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM)
 227 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP)
 228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN)
 229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP)
 230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN)
 231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK)
 232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE)
 233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED)
 234
 235 // Scroll events from wxWindow
 236 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP)
 237 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM)
 238 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP)
 239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN)
 240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP)
 241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN)
 242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK)
 243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE)
 244
 245 // System events
 246 DEFINE_EVENT_TYPE(wxEVT_SIZE)
 247 DEFINE_EVENT_TYPE(wxEVT_SIZING)
 248 DEFINE_EVENT_TYPE(wxEVT_MOVE)
 249 DEFINE_EVENT_TYPE(wxEVT_MOVING)
 250 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
 251 DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
 252 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
 253 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE)
 254 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
 255 DEFINE_EVENT_TYPE(wxEVT_POWER)
 256 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
 257 DEFINE_EVENT_TYPE(wxEVT_CREATE)
 258 DEFINE_EVENT_TYPE(wxEVT_DESTROY)
 259 DEFINE_EVENT_TYPE(wxEVT_SHOW)
 260 DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
 261 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
 262 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
 263 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST)
 264 DEFINE_EVENT_TYPE(wxEVT_PAINT)
 265 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
 266 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
 267 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON)
 268 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN)
 269 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE)
 270 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT)
 271 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU)
 272 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED)
 273 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED)
 274 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED)
 275 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE)
 276 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED)
 277 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN)
 278 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP)
 279 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE)
 280 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE)
 281 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES)
 282 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM)
 283 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM)
 284 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM)
 285 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
 286 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
 287
 288 // Clipboard events
 289 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY)
 290 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT)
 291 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE)
 292
 293 // Generic command events
 294 // Note: a click is a higher-level event than button down/up
 295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
 296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK)
 297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK)
 298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK)
 299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS)
 300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS)
 301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER)
 302
 303 // Help events
 304 DEFINE_EVENT_TYPE(wxEVT_HELP)
 305 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
 306
 307 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 308
 309 #endif // wxUSE_GUI
 310
 311 #if wxUSE_BASE
 312
 313 // ============================================================================
 314 // implementation
 315 // ============================================================================
 316
 317 // ----------------------------------------------------------------------------
 318 // event initialization
 319 // ----------------------------------------------------------------------------
 320
 321 int wxNewEventType()
 322 {
 323     // MT-FIXME
 324     static int s_lastUsedEventType = wxEVT_FIRST;
 325
 326     return s_lastUsedEventType++;
 327 }
 328
 329 // ----------------------------------------------------------------------------
 330 // wxEvent
 331 // ----------------------------------------------------------------------------
 332
 333 /*
 334  * General wxWidgets events, covering
 335  * all interesting things that might happen (button clicking, resizing,
 336  * setting text in widgets, etc.).
 337  *
 338  * For each completely new event type, derive a new event class.
 339  *
 340  */
 341
 342 wxEvent::wxEvent(int theId, wxEventType commandType )
 343 {
 344     m_eventType = commandType;
 345     m_eventObject = (wxObject *) NULL;
 346     m_timeStamp = 0;
 347     m_id = theId;
 348     m_skipped = false;
 349     m_callbackUserData = (wxObject *) NULL;
 350     m_isCommandEvent = false;
 351     m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 352 }
 353
 354 wxEvent::wxEvent(const wxEvent &src)
 355     : wxObject()
 356     , m_eventObject(src.m_eventObject)
 357     , m_eventType(src.m_eventType)
 358     , m_timeStamp(src.m_timeStamp)
 359     , m_id(src.m_id)
 360     , m_callbackUserData(src.m_callbackUserData)
 361     , m_propagationLevel(src.m_propagationLevel)
 362     , m_skipped(src.m_skipped)
 363     , m_isCommandEvent(src.m_isCommandEvent)
 364 {
 365 }
 366
 367 #endif // wxUSE_BASE
 368
 369 #if wxUSE_GUI
 370
 371 /*
 372  * Command events
 373  *
 374  */
 375
 376 #ifdef __VISUALC__
 377     // 'this' : used in base member initializer list (for m_commandString)
 378     #pragma warning(disable:4355)
 379 #endif
 380
 381 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
 382               : wxEvent(theId, commandType)
 383 #if WXWIN_COMPATIBILITY_2_4
 384               , m_commandString(this)
 385 #endif
 386 {
 387     m_clientData = (char *) NULL;
 388     m_clientObject = (wxClientData *) NULL;
 389     m_extraLong = 0;
 390     m_commandInt = 0;
 391     m_isCommandEvent = true;
 392
 393     // the command events are propagated upwards by default
 394     m_propagationLevel = wxEVENT_PROPAGATE_MAX;
 395 }
 396
 397 #ifdef __VISUALC__
 398     #pragma warning(default:4355)
 399 #endif
 400
 401 wxString wxCommandEvent::GetString() const
 402 {
 403     if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
 404         return m_cmdString;
 405     else
 406     {
 407 #if wxUSE_TEXTCTRL
 408         wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
 409         if(txt)
 410             return txt->GetValue();
 411         else
 412 #endif // wxUSE_TEXTCTRL
 413             return m_cmdString;
 414     }
 415 }
 416
 417 /*
 418  * UI update events
 419  */
 420
 421 #if wxUSE_LONGLONG
 422 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
 423 #endif
 424
 425 long wxUpdateUIEvent::sm_updateInterval = 0;
 426
 427 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
 428
 429 // Can we update?
 430 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
 431 {
 432     // Don't update if we've switched global updating off
 433     // and this window doesn't support updates.
 434     if (win &&
 435        (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
 436        ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
 437         return false;
 438
 439     if (sm_updateInterval == -1)
 440         return false;
 441
 442     if (sm_updateInterval == 0)
 443         return true;
 444
 445 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
 446     wxLongLong now = wxGetLocalTimeMillis();
 447     if (now > (sm_lastUpdate + sm_updateInterval))
 448     {
 449         return true;
 450     }
 451
 452     return false;
 453 #else
 454     // If we don't have wxStopWatch or wxLongLong, we
 455     // should err on the safe side and update now anyway.
 456     return true;
 457 #endif
 458 }
 459
 460 // Reset the update time to provide a delay until the next
 461 // time we should update
 462 void wxUpdateUIEvent::ResetUpdateTime()
 463 {
 464 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
 465     if (sm_updateInterval > 0)
 466     {
 467         wxLongLong now = wxGetLocalTimeMillis();
 468         if (now > (sm_lastUpdate + sm_updateInterval))
 469         {
 470             sm_lastUpdate = now;
 471         }
 472     }
 473 #endif
 474 }
 475
 476 /*
 477  * Idle events
 478  */
 479
 480 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
 481
 482 // Can we send an idle event?
 483 bool wxIdleEvent::CanSend(wxWindow* win)
 484 {
 485     // Don't update if we've switched global updating off
 486     // and this window doesn't support updates.
 487     if (win &&
 488        (GetMode() == wxIDLE_PROCESS_SPECIFIED &&
 489        ((win->GetExtraStyle() & wxWS_EX_PROCESS_IDLE) == 0)))
 490         return false;
 491
 492     return true;
 493 }
 494
 495 /*
 496  * Scroll events
 497  */
 498
 499 wxScrollEvent::wxScrollEvent(wxEventType commandType,
 500                              int id,
 501                              int pos,
 502                              int orient)
 503     : wxCommandEvent(commandType, id)
 504 {
 505     m_extraLong = orient;
 506     m_commandInt = pos;
 507 }
 508
 509 /*
 510  * ScrollWin events
 511  */
 512
 513 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
 514                                    int pos,
 515                                    int orient)
 516 {
 517     m_eventType = commandType;
 518     m_extraLong = orient;
 519     m_commandInt = pos;
 520 }
 521
 522 /*
 523  * Mouse events
 524  *
 525  */
 526
 527 wxMouseEvent::wxMouseEvent(wxEventType commandType)
 528 {
 529     m_eventType = commandType;
 530     m_metaDown = false;
 531     m_altDown = false;
 532     m_controlDown = false;
 533     m_shiftDown = false;
 534     m_leftDown = false;
 535     m_rightDown = false;
 536     m_middleDown = false;
 537     m_x = 0;
 538     m_y = 0;
 539     m_wheelRotation = 0;
 540     m_wheelDelta = 0;
 541     m_linesPerAction = 0;
 542 }
 543
 544 void wxMouseEvent::Assign(const wxMouseEvent& event)
 545 {
 546     m_eventType = event.m_eventType;
 547
 548     m_x = event.m_x;
 549     m_y = event.m_y;
 550
 551     m_leftDown = event.m_leftDown;
 552     m_middleDown = event.m_middleDown;
 553     m_rightDown = event.m_rightDown;
 554
 555     m_controlDown = event.m_controlDown;
 556     m_shiftDown = event.m_shiftDown;
 557     m_altDown = event.m_altDown;
 558     m_metaDown = event.m_metaDown;
 559
 560     m_wheelRotation = event.m_wheelRotation;
 561     m_wheelDelta = event.m_wheelDelta;
 562     m_linesPerAction = event.m_linesPerAction;
 563 }
 564
 565 // return true if was a button dclick event
 566 bool wxMouseEvent::ButtonDClick(int but) const
 567 {
 568     switch (but)
 569     {
 570         default:
 571             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
 572             // fall through
 573
 574         case wxMOUSE_BTN_ANY:
 575             return (LeftDClick() || MiddleDClick() || RightDClick());
 576
 577         case wxMOUSE_BTN_LEFT:
 578             return LeftDClick();
 579
 580         case wxMOUSE_BTN_MIDDLE:
 581             return MiddleDClick();
 582
 583         case wxMOUSE_BTN_RIGHT:
 584             return RightDClick();
 585     }
 586 }
 587
 588 // return true if was a button down event
 589 bool wxMouseEvent::ButtonDown(int but) const
 590 {
 591     switch (but)
 592     {
 593         default:
 594             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
 595             // fall through
 596
 597         case wxMOUSE_BTN_ANY:
 598             return (LeftDown() || MiddleDown() || RightDown());
 599
 600         case wxMOUSE_BTN_LEFT:
 601             return LeftDown();
 602
 603         case wxMOUSE_BTN_MIDDLE:
 604             return MiddleDown();
 605
 606         case wxMOUSE_BTN_RIGHT:
 607             return RightDown();
 608     }
 609 }
 610
 611 // return true if was a button up event
 612 bool wxMouseEvent::ButtonUp(int but) const
 613 {
 614     switch (but)
 615     {
 616         default:
 617             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
 618             // fall through
 619
 620         case wxMOUSE_BTN_ANY:
 621             return (LeftUp() || MiddleUp() || RightUp());
 622
 623         case wxMOUSE_BTN_LEFT:
 624             return LeftUp();
 625
 626         case wxMOUSE_BTN_MIDDLE:
 627             return MiddleUp();
 628
 629         case wxMOUSE_BTN_RIGHT:
 630             return RightUp();
 631     }
 632 }
 633
 634 // return true if the given button is currently changing state
 635 bool wxMouseEvent::Button(int but) const
 636 {
 637     switch (but)
 638     {
 639         default:
 640             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
 641             // fall through
 642
 643         case wxMOUSE_BTN_ANY:
 644             return ButtonUp(wxMOUSE_BTN_ANY) ||
 645                     ButtonDown(wxMOUSE_BTN_ANY) ||
 646                         ButtonDClick(wxMOUSE_BTN_ANY);
 647
 648         case wxMOUSE_BTN_LEFT:
 649             return LeftDown() || LeftUp() || LeftDClick();
 650
 651         case wxMOUSE_BTN_MIDDLE:
 652             return MiddleDown() || MiddleUp() || MiddleDClick();
 653
 654         case wxMOUSE_BTN_RIGHT:
 655             return RightDown() || RightUp() || RightDClick();
 656     }
 657 }
 658
 659 bool wxMouseEvent::ButtonIsDown(int but) const
 660 {
 661     switch (but)
 662     {
 663         default:
 664             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
 665             // fall through
 666
 667         case wxMOUSE_BTN_ANY:
 668             return LeftIsDown() || MiddleIsDown() || RightIsDown();
 669
 670         case wxMOUSE_BTN_LEFT:
 671             return LeftIsDown();
 672
 673         case wxMOUSE_BTN_MIDDLE:
 674             return MiddleIsDown();
 675
 676         case wxMOUSE_BTN_RIGHT:
 677             return RightIsDown();
 678     }
 679 }
 680
 681 int wxMouseEvent::GetButton() const
 682 {
 683     for ( int i = 1; i <= 3; i++ )
 684     {
 685         if ( Button(i) )
 686         {
 687             return i;
 688         }
 689     }
 690
 691     return wxMOUSE_BTN_NONE;
 692 }
 693
 694 // Find the logical position of the event given the DC
 695 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
 696 {
 697     wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
 698     return pt;
 699 }
 700
 701
 702 /*
 703  * Keyboard event
 704  *
 705  */
 706
 707 wxKeyEvent::wxKeyEvent(wxEventType type)
 708 {
 709     m_eventType = type;
 710     m_shiftDown = false;
 711     m_controlDown = false;
 712     m_metaDown = false;
 713     m_altDown = false;
 714     m_keyCode = 0;
 715     m_scanCode = 0;
 716 #if wxUSE_UNICODE
 717     m_uniChar = 0;
 718 #endif
 719 }
 720
 721 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
 722     : wxEvent(evt)
 723 {
 724     m_x = evt.m_x;
 725     m_y = evt.m_y;
 726
 727     m_keyCode = evt.m_keyCode;
 728
 729     m_controlDown = evt.m_controlDown;
 730     m_shiftDown = evt.m_shiftDown;
 731     m_altDown = evt.m_altDown;
 732     m_metaDown = evt.m_metaDown;
 733     m_scanCode = evt.m_scanCode;
 734     m_rawCode = evt.m_rawCode;
 735     m_rawFlags = evt.m_rawFlags;
 736
 737 #if wxUSE_UNICODE
 738     m_uniChar = evt.m_uniChar;
 739 #endif
 740 }
 741
 742 #if WXWIN_COMPATIBILITY_2_6
 743 long wxKeyEvent::KeyCode() const
 744 {
 745     return m_keyCode;
 746 }
 747 #endif // WXWIN_COMPATIBILITY_2_6
 748
 749 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 750 {
 751     SetEventType(wxEVT_CREATE);
 752     SetEventObject(win);
 753 }
 754
 755 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
 756 {
 757     SetEventType(wxEVT_DESTROY);
 758     SetEventObject(win);
 759 }
 760
 761 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
 762                  : wxCommandEvent(wxEVT_CHILD_FOCUS)
 763 {
 764     SetEventObject(win);
 765 }
 766
 767 // ----------------------------------------------------------------------------
 768 // wxHelpEvent
 769 // ----------------------------------------------------------------------------
 770
 771 /* static */
 772 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
 773 {
 774     if ( origin == Origin_Unknown )
 775     {
 776         // assume that the event comes from the help button if it's not from
 777         // keyboard and that pressing F1 always results in the help event
 778         origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
 779     }
 780
 781     return origin;
 782 }
 783
 784 #endif // wxUSE_GUI
 785
 786
 787 #if wxUSE_BASE
 788
 789 // ----------------------------------------------------------------------------
 790 // wxEventHashTable
 791 // ----------------------------------------------------------------------------
 792
 793 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
 794
 795 wxEventHashTable* wxEventHashTable::sm_first = NULL;
 796
 797 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
 798                 : m_table(table),
 799                   m_rebuildHash(true)
 800 {
 801     AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
 802
 803     m_next = sm_first;
 804     if (m_next)
 805         m_next->m_previous = this;
 806     sm_first = this;
 807 }
 808
 809 wxEventHashTable::~wxEventHashTable()
 810 {
 811     if (m_next)
 812         m_next->m_previous = m_previous;
 813     if (m_previous)
 814         m_previous->m_next = m_next;
 815     if (sm_first == this)
 816         sm_first = m_next;
 817
 818     Clear();
 819 }
 820
 821 void wxEventHashTable::Clear()
 822 {
 823     size_t i;
 824     for(i = 0; i < m_size; i++)
 825     {
 826         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];
 827         if (eTTnode)
 828         {
 829             delete eTTnode;
 830         }
 831     }
 832
 833     // Necessary in order to not invoke the
 834     // overloaded delete operator when statics are cleaned up
 835     if (m_eventTypeTable)
 836         delete[] m_eventTypeTable;
 837
 838     m_eventTypeTable = NULL;
 839     m_size = 0;
 840 }
 841
 842 // Clear all tables
 843 void wxEventHashTable::ClearAll()
 844 {
 845     wxEventHashTable* table = sm_first;
 846     while (table)
 847     {
 848         table->Clear();
 849         table = table->m_next;
 850     }
 851 }
 852
 853 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
 854 {
 855     if (m_rebuildHash)
 856     {
 857         InitHashTable();
 858         m_rebuildHash = false;
 859     }
 860
 861     if (!m_eventTypeTable)
 862         return false;
 863
 864     // Find all entries for the given event type.
 865     wxEventType eventType = event.GetEventType();
 866     const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
 867     if (eTTnode && eTTnode->eventType == eventType)
 868     {
 869         // Now start the search for an event handler
 870         // that can handle an event with the given ID.
 871         const wxEventTableEntryPointerArray&
 872             eventEntryTable = eTTnode->eventEntryTable;
 873
 874         const size_t count = eventEntryTable.GetCount();
 875         for (size_t n = 0; n < count; n++)
 876         {
 877             if ( wxEvtHandler::
 878                     ProcessEventIfMatches(*eventEntryTable[n], self, event) )
 879             {
 880                 return true;
 881             }
 882         }
 883     }
 884
 885     return false;
 886 }
 887
 888 void wxEventHashTable::InitHashTable()
 889 {
 890     // Loop over the event tables and all its base tables.
 891     const wxEventTable *table = &m_table;
 892     while (table)
 893     {
 894         // Retrieve all valid event handler entries
 895         const wxEventTableEntry *entry = table->entries;
 896         while (entry->m_fn != 0)
 897         {
 898             // Add the event entry in the Hash.
 899             AddEntry(*entry);
 900
 901             entry++;
 902         }
 903
 904         table = table->baseTable;
 905     }
 906
 907     // Lets free some memory.
 908     size_t i;
 909     for(i = 0; i < m_size; i++)
 910     {
 911         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];
 912         if (eTTnode)
 913         {
 914             eTTnode->eventEntryTable.Shrink();
 915         }
 916     }
 917 }
 918
 919 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
 920 {
 921     // This might happen 'accidentally' as the app is exiting
 922     if (!m_eventTypeTable)
 923         return;
 924
 925     EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
 926     EventTypeTablePointer  eTTnode = *peTTnode;
 927
 928     if (eTTnode)
 929     {
 930         if (eTTnode->eventType != entry.m_eventType)
 931         {
 932             // Resize the table!
 933             GrowEventTypeTable();
 934             // Try again to add it.
 935             AddEntry(entry);
 936             return;
 937         }
 938     }
 939     else
 940     {
 941         eTTnode = new EventTypeTable;
 942         eTTnode->eventType = entry.m_eventType;
 943         *peTTnode = eTTnode;
 944     }
 945
 946     // Fill all hash entries between entry.m_id and entry.m_lastId...
 947     eTTnode->eventEntryTable.Add(&entry);
 948 }
 949
 950 void wxEventHashTable::AllocEventTypeTable(size_t size)
 951 {
 952     m_eventTypeTable = new EventTypeTablePointer[size];
 953     memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
 954     m_size = size;
 955 }
 956
 957 void wxEventHashTable::GrowEventTypeTable()
 958 {
 959     size_t oldSize = m_size;
 960     EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
 961
 962     // TODO: Search the most optimal grow sequence
 963     AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
 964
 965     for ( size_t i = 0; i < oldSize; /* */ )
 966     {
 967         EventTypeTablePointer  eTToldNode = oldEventTypeTable[i];
 968         if (eTToldNode)
 969         {
 970             EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
 971             EventTypeTablePointer  eTTnode = *peTTnode;
 972
 973             // Check for collision, we don't want any.
 974             if (eTTnode)
 975             {
 976                 GrowEventTypeTable();
 977                 continue; // Don't increment the counter,
 978                           // as we still need to add this element.
 979             }
 980             else
 981             {
 982                 // Get the old value and put it in the new table.
 983                 *peTTnode = oldEventTypeTable[i];
 984             }
 985         }
 986
 987         i++;
 988     }
 989
 990     delete[] oldEventTypeTable;
 991 }
 992
 993
 994 // ----------------------------------------------------------------------------
 995 // wxEvtHandler
 996 // ----------------------------------------------------------------------------
 997
 998 /*
 999  * Event handler
1000  */
1001
1002 wxEvtHandler::wxEvtHandler()
1003 {
1004     m_nextHandler = (wxEvtHandler *) NULL;
1005     m_previousHandler = (wxEvtHandler *) NULL;
1006     m_enabled = true;
1007     m_dynamicEvents = (wxList *) NULL;
1008     m_pendingEvents = (wxList *) NULL;
1009 #if wxUSE_THREADS
1010 #  if !defined(__VISAGECPP__)
1011     m_eventsLocker = new wxCriticalSection;
1012 #  endif
1013 #endif
1014
1015     // no client data (yet)
1016     m_clientData = NULL;
1017     m_clientDataType = wxClientData_None;
1018 }
1019
1020 wxEvtHandler::~wxEvtHandler()
1021 {
1022     // Takes itself out of the list of handlers
1023     if (m_previousHandler)
1024         m_previousHandler->m_nextHandler = m_nextHandler;
1025
1026     if (m_nextHandler)
1027         m_nextHandler->m_previousHandler = m_previousHandler;
1028
1029     if (m_dynamicEvents)
1030     {
1031         wxList::iterator it = m_dynamicEvents->begin(),
1032                          en = m_dynamicEvents->end();
1033         for (;it != en; ++it)
1034         {
1035 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1036             wxEventTableEntry *entry = (wxEventTableEntry*)*it;
1037 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1038             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1039 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1040
1041             if (entry->m_callbackUserData)
1042                 delete entry->m_callbackUserData;
1043             delete entry;
1044         }
1045         delete m_dynamicEvents;
1046     };
1047
1048     if (m_pendingEvents)
1049         m_pendingEvents->DeleteContents(true);
1050     delete m_pendingEvents;
1051
1052 #if wxUSE_THREADS
1053 #  if !defined(__VISAGECPP__)
1054     delete m_eventsLocker;
1055 #  endif
1056
1057     // Remove us from wxPendingEvents if necessary.
1058     if(wxPendingEventsLocker)
1059         wxENTER_CRIT_SECT(*wxPendingEventsLocker);
1060     if ( wxPendingEvents )
1061     {
1062         // Delete all occurences of this from the list of pending events
1063         while (wxPendingEvents->DeleteObject(this)) { } // Do nothing
1064     }
1065     if(wxPendingEventsLocker)
1066         wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
1067 #endif
1068
1069     // we only delete object data, not untyped
1070     if ( m_clientDataType == wxClientData_Object )
1071         delete m_clientObject;
1072 }
1073
1074 #if wxUSE_THREADS
1075
1076 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
1077 {
1078     // check that we are really in a child thread
1079     wxASSERT_MSG( !wxThread::IsMain(),
1080                   wxT("use ProcessEvent() in main thread") );
1081
1082     AddPendingEvent(event);
1083
1084     return true;
1085 }
1086
1087 void wxEvtHandler::ClearEventLocker()
1088 {
1089 #if !defined(__VISAGECPP__)
1090     delete m_eventsLocker;
1091     m_eventsLocker = NULL;
1092 #endif
1093 }
1094
1095 #endif // wxUSE_THREADS
1096
1097 void wxEvtHandler::AddPendingEvent(wxEvent& event)
1098 {
1099     // 1) Add event to list of pending events of this event handler
1100
1101     wxEvent *eventCopy = event.Clone();
1102
1103     // we must be able to copy the events here so the event class must
1104     // implement Clone() properly instead of just providing a NULL stab for it
1105     wxCHECK_RET( eventCopy,
1106                  _T("events of this type aren't supposed to be posted") );
1107
1108     wxENTER_CRIT_SECT( Lock() );
1109
1110     if ( !m_pendingEvents )
1111       m_pendingEvents = new wxList;
1112
1113     m_pendingEvents->Append(eventCopy);
1114
1115     wxLEAVE_CRIT_SECT( Lock() );
1116
1117     // 2) Add this event handler to list of event handlers that
1118     //    have pending events.
1119
1120     wxENTER_CRIT_SECT(*wxPendingEventsLocker);
1121
1122     if ( !wxPendingEvents )
1123         wxPendingEvents = new wxList;
1124     wxPendingEvents->Append(this);
1125
1126     wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
1127
1128     // 3) Inform the system that new pending events are somewhere,
1129     //    and that these should be processed in idle time.
1130     wxWakeUpIdle();
1131 }
1132
1133 void wxEvtHandler::ProcessPendingEvents()
1134 {
1135     // this method is only called by wxApp if this handler does have
1136     // pending events
1137     wxCHECK_RET( m_pendingEvents,
1138                  wxT("Please call wxApp::ProcessPendingEvents() instead") );
1139
1140     wxENTER_CRIT_SECT( Lock() );
1141
1142     // we leave the loop once we have processed all events that were present at
1143     // the start of ProcessPendingEvents because otherwise we could get into
1144     // infinite loop if the pending event handler execution resulted in another
1145     // event being posted
1146     size_t n = m_pendingEvents->size();
1147     for ( wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1148           node;
1149           node = m_pendingEvents->GetFirst() )
1150     {
1151         wxEvent *event = (wxEvent *)node->GetData();
1152
1153         // It's importan we remove event from list before processing it.
1154         // Else a nested event loop, for example from a modal dialog, might
1155         // process the same event again.
1156
1157         m_pendingEvents->Erase(node);
1158
1159         wxLEAVE_CRIT_SECT( Lock() );
1160
1161         ProcessEvent(*event);
1162
1163         delete event;
1164
1165         wxENTER_CRIT_SECT( Lock() );
1166
1167         if ( --n == 0 )
1168             break;
1169     }
1170
1171     wxLEAVE_CRIT_SECT( Lock() );
1172 }
1173
1174 /*
1175  * Event table stuff
1176  */
1177 /* static */ bool
1178 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry,
1179                                     wxEvtHandler *handler,
1180                                     wxEvent& event)
1181 {
1182     int tableId1 = entry.m_id,
1183         tableId2 = entry.m_lastId;
1184
1185     // match only if the event type is the same and the id is either -1 in
1186     // the event table (meaning "any") or the event id matches the id
1187     // specified in the event table either exactly or by falling into
1188     // range between first and last
1189     if ((tableId1 == wxID_ANY) ||
1190         (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1191         (tableId2 != wxID_ANY &&
1192          (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1193     {
1194         event.Skip(false);
1195         event.m_callbackUserData = entry.m_callbackUserData;
1196
1197 #if wxUSE_EXCEPTIONS
1198         if ( wxTheApp )
1199         {
1200             // call the handler via wxApp method which allows the user to catch
1201             // any exceptions which may be thrown by any handler in the program
1202             // in one place
1203             wxTheApp->HandleEvent(handler, (wxEventFunction)entry.m_fn, event);
1204         }
1205         else
1206 #endif // wxUSE_EXCEPTIONS
1207         {
1208             // no need for an extra virtual function call
1209             (handler->*((wxEventFunction) (entry.m_fn)))(event);
1210         }
1211
1212         if (!event.GetSkipped())
1213             return true;
1214     }
1215
1216     return false;
1217 }
1218
1219 bool wxEvtHandler::TryParent(wxEvent& event)
1220 {
1221     if ( wxTheApp && (this != wxTheApp) )
1222     {
1223         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1224         // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1225         // processed appropriately via SearchEventTable.
1226         if ( event.GetEventType() != wxEVT_IDLE )
1227         {
1228             if ( wxTheApp->ProcessEvent(event) )
1229                 return true;
1230         }
1231     }
1232
1233     return false;
1234 }
1235
1236 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1237 {
1238     // allow the application to hook into event processing
1239     if ( wxTheApp )
1240     {
1241         int rc = wxTheApp->FilterEvent(event);
1242         if ( rc != -1 )
1243         {
1244             wxASSERT_MSG( rc == 1 || rc == 0,
1245                           _T("unexpected wxApp::FilterEvent return value") );
1246
1247             return rc != 0;
1248         }
1249         //else: proceed normally
1250     }
1251
1252     // An event handler can be enabled or disabled
1253     if ( GetEvtHandlerEnabled() )
1254     {
1255         // if we have a validator, it has higher priority than our own event
1256         // table
1257         if ( TryValidator(event) )
1258             return true;
1259
1260         // Handle per-instance dynamic event tables first
1261         if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1262             return true;
1263
1264         // Then static per-class event tables
1265         if ( GetEventHashTable().HandleEvent(event, this) )
1266             return true;
1267     }
1268
1269     // Try going down the event handler chain
1270     if ( GetNextHandler() )
1271     {
1272         if ( GetNextHandler()->ProcessEvent(event) )
1273             return true;
1274     }
1275
1276     // Finally propagate the event upwards the window chain and/or to the
1277     // application object as necessary
1278     return TryParent(event);
1279 }
1280
1281
1282 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1283 {
1284     const wxEventType eventType = event.GetEventType();
1285     for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1286     {
1287         const wxEventTableEntry& entry = table.entries[i];
1288         if ( eventType == entry.m_eventType )
1289         {
1290             if ( ProcessEventIfMatches(entry, this, event) )
1291                 return true;
1292         }
1293     }
1294
1295     return false;
1296 }
1297
1298 void wxEvtHandler::Connect( int id, int lastId,
1299                             int eventType,
1300                             wxObjectEventFunction func,
1301                             wxObject *userData,
1302                             wxEvtHandler* eventSink )
1303 {
1304 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1305     wxEventTableEntry *entry = new wxEventTableEntry;
1306     entry->m_eventType = eventType;
1307     entry->m_id = id;
1308     entry->m_lastId = lastId;
1309     entry->m_fn = func;
1310     entry->m_callbackUserData = userData;
1311 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1312     wxDynamicEventTableEntry *entry =
1313         new wxDynamicEventTableEntry(eventType, id, lastId, func, userData, eventSink);
1314 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1315
1316     if (!m_dynamicEvents)
1317         m_dynamicEvents = new wxList;
1318
1319     // Insert at the front of the list so most recent additions are found first
1320     m_dynamicEvents->Insert( (wxObject*) entry );
1321 }
1322
1323 bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
1324                   wxObjectEventFunction func,
1325                   wxObject *userData,
1326                   wxEvtHandler* eventSink )
1327 {
1328     if (!m_dynamicEvents)
1329         return false;
1330
1331     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1332     while (node)
1333     {
1334 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1335             wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
1336 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1337             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1338 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1339
1340         if ((entry->m_id == id) &&
1341             ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1342             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1343             ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
1344             ((entry->m_eventSink == eventSink) || (eventSink == (wxEvtHandler*)NULL)) &&
1345             ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
1346         {
1347             if (entry->m_callbackUserData)
1348                 delete entry->m_callbackUserData;
1349             m_dynamicEvents->Erase( node );
1350             delete entry;
1351             return true;
1352         }
1353         node = node->GetNext();
1354     }
1355     return false;
1356 }
1357
1358 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1359 {
1360     wxCHECK_MSG( m_dynamicEvents, false,
1361                  wxT("caller should check that we have dynamic events") );
1362
1363     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1364     while (node)
1365     {
1366 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1367         wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
1368 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1369         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1370 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1371
1372         // get next node before (maybe) calling the event handler as it could
1373         // call Disconnect() invalidating the current node
1374         node = node->GetNext();
1375
1376         if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
1377         {
1378             wxEvtHandler *handler =
1379 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1380                                     entry->m_eventSink ? entry->m_eventSink
1381                                                        :
1382 #endif
1383                                                          this;
1384
1385             if ( ProcessEventIfMatches(*entry, handler, event) )
1386             {
1387                 return true;
1388             }
1389         }
1390     }
1391
1392     return false;
1393 }
1394
1395 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1396 {
1397     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1398                   wxT("can't have both object and void client data") );
1399
1400     if ( m_clientObject )
1401         delete m_clientObject;
1402
1403     m_clientObject = data;
1404     m_clientDataType = wxClientData_Object;
1405 }
1406
1407 wxClientData *wxEvtHandler::DoGetClientObject() const
1408 {
1409     // it's not an error to call GetClientObject() on a window which doesn't
1410     // have client data at all - NULL will be returned
1411     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1412                   wxT("this window doesn't have object client data") );
1413
1414     return m_clientObject;
1415 }
1416
1417 void wxEvtHandler::DoSetClientData( void *data )
1418 {
1419     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1420                   wxT("can't have both object and void client data") );
1421
1422     m_clientData = data;
1423     m_clientDataType = wxClientData_Void;
1424 }
1425
1426 void *wxEvtHandler::DoGetClientData() const
1427 {
1428     // it's not an error to call GetClientData() on a window which doesn't have
1429     // client data at all - NULL will be returned
1430     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1431                   wxT("this window doesn't have void client data") );
1432
1433     return m_clientData;
1434 }
1435
1436 #endif // wxUSE_BASE
1437
1438 #if wxUSE_GUI
1439
1440 // Find a window with the focus, that is also a descendant of the given window.
1441 // This is used to determine the window to initially send commands to.
1442 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1443 {
1444     // Process events starting with the window with the focus, if any.
1445     wxWindow* focusWin = wxWindow::FindFocus();
1446     wxWindow* win = focusWin;
1447
1448     // Check if this is a descendant of this frame.
1449     // If not, win will be set to NULL.
1450     while (win)
1451     {
1452         if (win == ancestor)
1453             break;
1454         else
1455             win = win->GetParent();
1456     }
1457     if (win == (wxWindow*) NULL)
1458         focusWin = (wxWindow*) NULL;
1459
1460     return focusWin;
1461 }
1462
1463 #endif // wxUSE_GUI