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 #include "wx/evtloop.h"
  29
  30 #ifndef WX_PRECOMP
  31     #include "wx/list.h"
  32     #include "wx/log.h"
  33     #include "wx/app.h"
  34     #include "wx/utils.h"
  35     #include "wx/stopwatch.h"
  36     #include "wx/module.h"
  37
  38     #if wxUSE_GUI
  39         #include "wx/window.h"
  40         #include "wx/control.h"
  41         #include "wx/dc.h"
  42         #include "wx/spinbutt.h"
  43         #include "wx/textctrl.h"
  44         #include "wx/validate.h"
  45     #endif // wxUSE_GUI
  46 #endif
  47
  48 #include "wx/thread.h"
  49
  50 #if wxUSE_BASE
  51     #include "wx/scopedptr.h"
  52
  53     wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
  54     wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
  55 #endif // wxUSE_BASE
  56
  57 // ----------------------------------------------------------------------------
  58 // wxWin macros
  59 // ----------------------------------------------------------------------------
  60
  61 #if wxUSE_BASE
  62     IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
  63     IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
  64     IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
  65 #endif // wxUSE_BASE
  66
  67 #if wxUSE_GUI
  68     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
  69     IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxCommandEvent)
  70     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
  71     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
  72     IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
  73     IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
  74     IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
  75     IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
  76     IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
  77     IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
  78     IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
  79     IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
  80     IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
  81     IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
  82     IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
  83     IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
  84     IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
  85     IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
  86     IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
  87     IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
  88     IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
  89     IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
  90     IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
  91     IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
  92     IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
  93     IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
  94     IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
  95     IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
  96     IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
  97     IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
  98     IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
  99     IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
 100     IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
 101     IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
 102     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
 103     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
 104     IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
 105 #endif // wxUSE_GUI
 106
 107 #if wxUSE_BASE
 108
 109 const wxEventTable *wxEvtHandler::GetEventTable() const
 110     { return &wxEvtHandler::sm_eventTable; }
 111
 112 const wxEventTable wxEvtHandler::sm_eventTable =
 113     { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
 114
 115 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
 116     { return wxEvtHandler::sm_eventHashTable; }
 117
 118 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
 119
 120 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
 121     { wxDECLARE_EVENT_TABLE_TERMINATOR() };
 122
 123
 124 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
 125 // leaked, so we need to manually clean up all event tables before checking for
 126 // the memory leaks when using it, however this breaks re-initializing the
 127 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
 128 // event tables won't be rebuilt the next time, so disable this by default
 129 #if wxUSE_MEMORY_TRACING
 130
 131 class wxEventTableEntryModule: public wxModule
 132 {
 133 public:
 134     wxEventTableEntryModule() { }
 135     virtual bool OnInit() { return true; }
 136     virtual void OnExit() { wxEventHashTable::ClearAll(); }
 137
 138     DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
 139 };
 140
 141 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
 142
 143 #endif // wxUSE_MEMORY_TRACING
 144
 145 // ----------------------------------------------------------------------------
 146 // global variables
 147 // ----------------------------------------------------------------------------
 148
 149 // common event types are defined here, other event types are defined by the
 150 // components which use them
 151
 152 const wxEventType wxEVT_FIRST = 10000;
 153 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
 154 const wxEventType wxEVT_NULL = wxNewEventType();
 155
 156 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );
 157
 158 #endif // wxUSE_BASE
 159
 160 #if wxUSE_GUI
 161
 162 wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent );
 163 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent );
 164 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent );
 165 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent );
 166 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent );
 167 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent );
 168 wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent );
 169 wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent );
 170 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent );
 171 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent );
 172 wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent );
 173 wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent );
 174 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent );
 175 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent );
 176 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent );
 177 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent );
 178 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent );
 179 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent );
 180 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent);
 181 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent);
 182
 183 // Mouse event types
 184 wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent );
 185 wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent );
 186 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent );
 187 wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent );
 188 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent );
 189 wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent );
 190 wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent );
 191 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent );
 192 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent );
 193 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent );
 194 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent );
 195 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent );
 196 wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent );
 197 wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent );
 198 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent );
 199 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent );
 200 wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent );
 201 wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent );
 202 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent );
 203 wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent );
 204 wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent );
 205 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent );
 206
 207 // Character input event type
 208 wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent );
 209 wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent );
 210 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent );
 211 wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent );
 212 wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent );
 213 #if wxUSE_HOTKEY
 214 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );
 215 #endif
 216
 217 // Set cursor event
 218 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );
 219
 220 // wxScrollbar and wxSlider event identifiers
 221 wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent );
 222 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent );
 223 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent );
 224 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent );
 225 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent );
 226 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent );
 227 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent );
 228 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent );
 229 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent );
 230
 231 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
 232 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
 233 // with the type-safe events in place, these event types are associated with
 234 // wxScrollEvent. To allow handling of spin events, new event types have been
 235 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
 236 // the spin event types are being initialized with the scroll event types.
 237
 238 #if wxUSE_SPINBTN
 239
 240 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP,   wxSpinEvent, wxEVT_SCROLL_LINEUP );
 241 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN );
 242 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN,      wxSpinEvent, wxEVT_SCROLL_THUMBTRACK );
 243
 244 #endif // wxUSE_SPINBTN
 245
 246 // Scroll events from wxWindow
 247 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent );
 248 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent );
 249 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent );
 250 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent );
 251 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent );
 252 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent );
 253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent );
 254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent );
 255
 256 // System events
 257 wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent );
 258 wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent );
 259 wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent );
 260 wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent );
 261 wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent );
 262 wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent );
 263 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent );
 264 wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent );
 265 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent );
 266 wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent );
 267 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent );
 268 wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent );
 269 wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent );
 270 wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent );
 271 wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent );
 272 wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent );
 273 wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent );
 274 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent );
 275 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent );
 276 wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent );
 277 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent );
 278 wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent );
 279 wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent );
 280 wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent );
 281 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent );
 282 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent );
 283 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent );
 284 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent );
 285 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent );
 286 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent );
 287 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent );
 288 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent );
 289 wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent );
 290 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent );
 291 wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent );
 292 wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent );
 293 wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent );
 294
 295 // Clipboard events
 296 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent );
 297 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent );
 298 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent );
 299
 300 // Generic command events
 301 // Note: a click is a higher-level event than button down/up
 302 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent );
 303 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent );
 304 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent );
 305 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent );
 306 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent );
 307 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent );
 308 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent );
 309
 310 // Help events
 311 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );
 312 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );
 313
 314 // Thread event
 315 wxDEFINE_EVENT( wxEVT_COMMAND_THREAD, wxThreadEvent );
 316
 317 #endif // wxUSE_GUI
 318
 319 #if wxUSE_BASE
 320
 321 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
 322
 323 // ============================================================================
 324 // implementation
 325 // ============================================================================
 326
 327 // ----------------------------------------------------------------------------
 328 // event initialization
 329 // ----------------------------------------------------------------------------
 330
 331 int wxNewEventType()
 332 {
 333     // MT-FIXME
 334     static int s_lastUsedEventType = wxEVT_FIRST;
 335
 336     return s_lastUsedEventType++;
 337 }
 338 // ----------------------------------------------------------------------------
 339 // wxEventFunctor
 340 // ----------------------------------------------------------------------------
 341
 342 wxEventFunctor::~wxEventFunctor()
 343 {
 344 }
 345
 346 // ----------------------------------------------------------------------------
 347 // wxEvent
 348 // ----------------------------------------------------------------------------
 349
 350 /*
 351  * General wxWidgets events, covering all interesting things that might happen
 352  * (button clicking, resizing, setting text in widgets, etc.).
 353  *
 354  * For each completely new event type, derive a new event class.
 355  *
 356  */
 357
 358 wxEvent::wxEvent(int theId, wxEventType commandType)
 359 {
 360     m_eventType = commandType;
 361     m_eventObject = NULL;
 362     m_timeStamp = 0;
 363     m_id = theId;
 364     m_skipped = false;
 365     m_callbackUserData = NULL;
 366     m_handlerToProcessOnlyIn = NULL;
 367     m_isCommandEvent = false;
 368     m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 369     m_wasProcessed = false;
 370 }
 371
 372 wxEvent::wxEvent(const wxEvent& src)
 373     : wxObject(src)
 374     , m_eventObject(src.m_eventObject)
 375     , m_eventType(src.m_eventType)
 376     , m_timeStamp(src.m_timeStamp)
 377     , m_id(src.m_id)
 378     , m_callbackUserData(src.m_callbackUserData)
 379     , m_handlerToProcessOnlyIn(NULL)
 380     , m_propagationLevel(src.m_propagationLevel)
 381     , m_skipped(src.m_skipped)
 382     , m_isCommandEvent(src.m_isCommandEvent)
 383     , m_wasProcessed(false)
 384 {
 385 }
 386
 387 wxEvent& wxEvent::operator=(const wxEvent& src)
 388 {
 389     wxObject::operator=(src);
 390
 391     m_eventObject = src.m_eventObject;
 392     m_eventType = src.m_eventType;
 393     m_timeStamp = src.m_timeStamp;
 394     m_id = src.m_id;
 395     m_callbackUserData = src.m_callbackUserData;
 396     m_handlerToProcessOnlyIn = NULL;
 397     m_propagationLevel = src.m_propagationLevel;
 398     m_skipped = src.m_skipped;
 399     m_isCommandEvent = src.m_isCommandEvent;
 400
 401     // don't change m_wasProcessed
 402
 403     return *this;
 404 }
 405
 406 #endif // wxUSE_BASE
 407
 408 #if wxUSE_GUI
 409
 410 // ----------------------------------------------------------------------------
 411 // wxCommandEvent
 412 // ----------------------------------------------------------------------------
 413
 414 #ifdef __VISUALC__
 415     // 'this' : used in base member initializer list (for m_commandString)
 416     #pragma warning(disable:4355)
 417 #endif
 418
 419 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
 420               : wxEvent(theId, commandType)
 421 {
 422     m_clientData = NULL;
 423     m_clientObject = NULL;
 424     m_extraLong = 0;
 425     m_commandInt = 0;
 426     m_isCommandEvent = true;
 427
 428     // the command events are propagated upwards by default
 429     m_propagationLevel = wxEVENT_PROPAGATE_MAX;
 430 }
 431
 432 #ifdef __VISUALC__
 433     #pragma warning(default:4355)
 434 #endif
 435
 436 wxString wxCommandEvent::GetString() const
 437 {
 438     if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
 439     {
 440         return m_cmdString;
 441     }
 442     else
 443     {
 444 #if wxUSE_TEXTCTRL
 445         wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
 446         if ( txt )
 447             return txt->GetValue();
 448         else
 449 #endif // wxUSE_TEXTCTRL
 450             return m_cmdString;
 451     }
 452 }
 453
 454 // ----------------------------------------------------------------------------
 455 // wxUpdateUIEvent
 456 // ----------------------------------------------------------------------------
 457
 458 #if wxUSE_LONGLONG
 459 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
 460 #endif
 461
 462 long wxUpdateUIEvent::sm_updateInterval = 0;
 463
 464 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
 465
 466 // Can we update?
 467 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
 468 {
 469     // Don't update if we've switched global updating off
 470     // and this window doesn't support updates.
 471     if (win &&
 472        (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
 473        ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
 474         return false;
 475
 476     if (sm_updateInterval == -1)
 477         return false;
 478
 479     if (sm_updateInterval == 0)
 480         return true;
 481
 482 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
 483     wxLongLong now = wxGetLocalTimeMillis();
 484     if (now > (sm_lastUpdate + sm_updateInterval))
 485     {
 486         return true;
 487     }
 488
 489     return false;
 490 #else
 491     // If we don't have wxStopWatch or wxLongLong, we
 492     // should err on the safe side and update now anyway.
 493     return true;
 494 #endif
 495 }
 496
 497 // Reset the update time to provide a delay until the next
 498 // time we should update
 499 void wxUpdateUIEvent::ResetUpdateTime()
 500 {
 501 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
 502     if (sm_updateInterval > 0)
 503     {
 504         wxLongLong now = wxGetLocalTimeMillis();
 505         if (now > (sm_lastUpdate + sm_updateInterval))
 506         {
 507             sm_lastUpdate = now;
 508         }
 509     }
 510 #endif
 511 }
 512
 513 // ----------------------------------------------------------------------------
 514 // wxScrollEvent
 515 // ----------------------------------------------------------------------------
 516
 517 wxScrollEvent::wxScrollEvent(wxEventType commandType,
 518                              int id,
 519                              int pos,
 520                              int orient)
 521     : wxCommandEvent(commandType, id)
 522 {
 523     m_extraLong = orient;
 524     m_commandInt = pos;
 525 }
 526
 527 // ----------------------------------------------------------------------------
 528 // wxScrollWinEvent
 529 // ----------------------------------------------------------------------------
 530
 531 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
 532                                    int pos,
 533                                    int orient)
 534 {
 535     m_eventType = commandType;
 536     m_extraLong = orient;
 537     m_commandInt = pos;
 538 }
 539
 540 // ----------------------------------------------------------------------------
 541 // wxMouseEvent
 542 // ----------------------------------------------------------------------------
 543
 544 wxMouseEvent::wxMouseEvent(wxEventType commandType)
 545 {
 546     m_eventType = commandType;
 547
 548     m_x = 0;
 549     m_y = 0;
 550
 551     m_leftDown = false;
 552     m_middleDown = false;
 553     m_rightDown = false;
 554     m_aux1Down = false;
 555     m_aux2Down = false;
 556
 557     m_clickCount = -1;
 558
 559     m_wheelRotation = 0;
 560     m_wheelDelta = 0;
 561     m_linesPerAction = 0;
 562     m_wheelAxis = 0;
 563 }
 564
 565 void wxMouseEvent::Assign(const wxMouseEvent& event)
 566 {
 567     wxEvent::operator=(event);
 568
 569     // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
 570     // defined operator=() so need to do it this way:
 571     *static_cast<wxMouseState *>(this) = event;
 572
 573     m_x = event.m_x;
 574     m_y = event.m_y;
 575
 576     m_leftDown = event.m_leftDown;
 577     m_middleDown = event.m_middleDown;
 578     m_rightDown = event.m_rightDown;
 579     m_aux1Down = event.m_aux1Down;
 580     m_aux2Down = event.m_aux2Down;
 581
 582     m_wheelRotation = event.m_wheelRotation;
 583     m_wheelDelta = event.m_wheelDelta;
 584     m_linesPerAction = event.m_linesPerAction;
 585     m_wheelAxis = event.m_wheelAxis;
 586 }
 587
 588 // return true if was a button dclick event
 589 bool wxMouseEvent::ButtonDClick(int but) const
 590 {
 591     switch (but)
 592     {
 593         default:
 594             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
 595             // fall through
 596
 597         case wxMOUSE_BTN_ANY:
 598             return (LeftDClick() || MiddleDClick() || RightDClick() ||
 599                     Aux1DClick() || Aux2DClick());
 600
 601         case wxMOUSE_BTN_LEFT:
 602             return LeftDClick();
 603
 604         case wxMOUSE_BTN_MIDDLE:
 605             return MiddleDClick();
 606
 607         case wxMOUSE_BTN_RIGHT:
 608             return RightDClick();
 609
 610         case wxMOUSE_BTN_AUX1:
 611             return Aux1DClick();
 612
 613         case wxMOUSE_BTN_AUX2:
 614             return Aux2DClick();
 615     }
 616 }
 617
 618 // return true if was a button down event
 619 bool wxMouseEvent::ButtonDown(int but) const
 620 {
 621     switch (but)
 622     {
 623         default:
 624             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
 625             // fall through
 626
 627         case wxMOUSE_BTN_ANY:
 628             return (LeftDown() || MiddleDown() || RightDown() ||
 629                     Aux1Down() || Aux2Down());
 630
 631         case wxMOUSE_BTN_LEFT:
 632             return LeftDown();
 633
 634         case wxMOUSE_BTN_MIDDLE:
 635             return MiddleDown();
 636
 637         case wxMOUSE_BTN_RIGHT:
 638             return RightDown();
 639
 640         case wxMOUSE_BTN_AUX1:
 641             return Aux1Down();
 642
 643         case wxMOUSE_BTN_AUX2:
 644             return Aux2Down();
 645     }
 646 }
 647
 648 // return true if was a button up event
 649 bool wxMouseEvent::ButtonUp(int but) const
 650 {
 651     switch (but)
 652     {
 653         default:
 654             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
 655             // fall through
 656
 657         case wxMOUSE_BTN_ANY:
 658             return (LeftUp() || MiddleUp() || RightUp() ||
 659                     Aux1Up() || Aux2Up());
 660
 661         case wxMOUSE_BTN_LEFT:
 662             return LeftUp();
 663
 664         case wxMOUSE_BTN_MIDDLE:
 665             return MiddleUp();
 666
 667         case wxMOUSE_BTN_RIGHT:
 668             return RightUp();
 669
 670         case wxMOUSE_BTN_AUX1:
 671             return Aux1Up();
 672
 673         case wxMOUSE_BTN_AUX2:
 674             return Aux2Up();
 675     }
 676 }
 677
 678 // return true if the given button is currently changing state
 679 bool wxMouseEvent::Button(int but) const
 680 {
 681     switch (but)
 682     {
 683         default:
 684             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
 685             // fall through
 686
 687         case wxMOUSE_BTN_ANY:
 688             return ButtonUp(wxMOUSE_BTN_ANY) ||
 689                     ButtonDown(wxMOUSE_BTN_ANY) ||
 690                         ButtonDClick(wxMOUSE_BTN_ANY);
 691
 692         case wxMOUSE_BTN_LEFT:
 693             return LeftDown() || LeftUp() || LeftDClick();
 694
 695         case wxMOUSE_BTN_MIDDLE:
 696             return MiddleDown() || MiddleUp() || MiddleDClick();
 697
 698         case wxMOUSE_BTN_RIGHT:
 699             return RightDown() || RightUp() || RightDClick();
 700
 701         case wxMOUSE_BTN_AUX1:
 702            return Aux1Down() || Aux1Up() || Aux1DClick();
 703
 704         case wxMOUSE_BTN_AUX2:
 705            return Aux2Down() || Aux2Up() || Aux2DClick();
 706     }
 707 }
 708
 709 int wxMouseEvent::GetButton() const
 710 {
 711     for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
 712     {
 713         if ( Button(i) )
 714         {
 715             return i;
 716         }
 717     }
 718
 719     return wxMOUSE_BTN_NONE;
 720 }
 721
 722 // Find the logical position of the event given the DC
 723 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
 724 {
 725     wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
 726     return pt;
 727 }
 728
 729 // ----------------------------------------------------------------------------
 730 // wxKeyEvent
 731 // ----------------------------------------------------------------------------
 732
 733 wxKeyEvent::wxKeyEvent(wxEventType type)
 734 {
 735     m_eventType = type;
 736     m_keyCode = 0;
 737 #if wxUSE_UNICODE
 738     m_uniChar = 0;
 739 #endif
 740 }
 741
 742 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
 743           : wxEvent(evt),
 744             wxKeyboardState(evt)
 745 {
 746     m_x = evt.m_x;
 747     m_y = evt.m_y;
 748
 749     m_keyCode = evt.m_keyCode;
 750     m_rawCode = evt.m_rawCode;
 751     m_rawFlags = evt.m_rawFlags;
 752
 753 #if wxUSE_UNICODE
 754     m_uniChar = evt.m_uniChar;
 755 #endif
 756 }
 757
 758 bool wxKeyEvent::IsKeyInCategory(int category) const
 759 {
 760     switch ( GetKeyCode() )
 761     {
 762         case WXK_LEFT:
 763         case WXK_RIGHT:
 764         case WXK_UP:
 765         case WXK_DOWN:
 766         case WXK_NUMPAD_LEFT:
 767         case WXK_NUMPAD_RIGHT:
 768         case WXK_NUMPAD_UP:
 769         case WXK_NUMPAD_DOWN:
 770             return (category & WXK_CATEGORY_ARROW) != 0;
 771
 772         case WXK_PAGEDOWN:
 773         case WXK_END:
 774         case WXK_NUMPAD_PAGEUP:
 775         case WXK_NUMPAD_PAGEDOWN:
 776             return (category & WXK_CATEGORY_PAGING) != 0;
 777
 778         case WXK_HOME:
 779         case WXK_PAGEUP:
 780         case WXK_NUMPAD_HOME:
 781         case WXK_NUMPAD_END:
 782             return (category & WXK_CATEGORY_JUMP) != 0;
 783
 784         case WXK_TAB:
 785         case WXK_NUMPAD_TAB:
 786             return (category & WXK_CATEGORY_TAB) != 0;
 787
 788         case WXK_BACK:
 789         case WXK_DELETE:
 790         case WXK_NUMPAD_DELETE:
 791             return (category & WXK_CATEGORY_CUT) != 0;
 792
 793         default:
 794             return false;
 795     }
 796 }
 797
 798 // ----------------------------------------------------------------------------
 799 // wxWindowCreateEvent
 800 // ----------------------------------------------------------------------------
 801
 802 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 803 {
 804     SetEventType(wxEVT_CREATE);
 805     SetEventObject(win);
 806 }
 807
 808 // ----------------------------------------------------------------------------
 809 // wxWindowDestroyEvent
 810 // ----------------------------------------------------------------------------
 811
 812 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
 813 {
 814     SetEventType(wxEVT_DESTROY);
 815     SetEventObject(win);
 816 }
 817
 818 // ----------------------------------------------------------------------------
 819 // wxChildFocusEvent
 820 // ----------------------------------------------------------------------------
 821
 822 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
 823                  : wxCommandEvent(wxEVT_CHILD_FOCUS)
 824 {
 825     SetEventObject(win);
 826 }
 827
 828 // ----------------------------------------------------------------------------
 829 // wxHelpEvent
 830 // ----------------------------------------------------------------------------
 831
 832 /* static */
 833 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
 834 {
 835     if ( origin == Origin_Unknown )
 836     {
 837         // assume that the event comes from the help button if it's not from
 838         // keyboard and that pressing F1 always results in the help event
 839         origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
 840     }
 841
 842     return origin;
 843 }
 844
 845 #endif // wxUSE_GUI
 846
 847
 848 #if wxUSE_BASE
 849
 850 // ----------------------------------------------------------------------------
 851 // wxEventHashTable
 852 // ----------------------------------------------------------------------------
 853
 854 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
 855
 856 wxEventHashTable* wxEventHashTable::sm_first = NULL;
 857
 858 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
 859                 : m_table(table),
 860                   m_rebuildHash(true)
 861 {
 862     AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
 863
 864     m_next = sm_first;
 865     if (m_next)
 866         m_next->m_previous = this;
 867     sm_first = this;
 868 }
 869
 870 wxEventHashTable::~wxEventHashTable()
 871 {
 872     if (m_next)
 873         m_next->m_previous = m_previous;
 874     if (m_previous)
 875         m_previous->m_next = m_next;
 876     if (sm_first == this)
 877         sm_first = m_next;
 878
 879     Clear();
 880 }
 881
 882 void wxEventHashTable::Clear()
 883 {
 884     for ( size_t i = 0; i < m_size; i++ )
 885     {
 886         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];
 887         delete eTTnode;
 888     }
 889
 890     delete[] m_eventTypeTable;
 891     m_eventTypeTable = NULL;
 892
 893     m_size = 0;
 894 }
 895
 896 #if wxUSE_MEMORY_TRACING
 897
 898 // Clear all tables
 899 void wxEventHashTable::ClearAll()
 900 {
 901     wxEventHashTable* table = sm_first;
 902     while (table)
 903     {
 904         table->Clear();
 905         table = table->m_next;
 906     }
 907 }
 908
 909 #endif // wxUSE_MEMORY_TRACING
 910
 911 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
 912 {
 913     if (m_rebuildHash)
 914     {
 915         InitHashTable();
 916         m_rebuildHash = false;
 917     }
 918
 919     if (!m_eventTypeTable)
 920         return false;
 921
 922     // Find all entries for the given event type.
 923     wxEventType eventType = event.GetEventType();
 924     const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
 925     if (eTTnode && eTTnode->eventType == eventType)
 926     {
 927         // Now start the search for an event handler
 928         // that can handle an event with the given ID.
 929         const wxEventTableEntryPointerArray&
 930             eventEntryTable = eTTnode->eventEntryTable;
 931
 932         const size_t count = eventEntryTable.GetCount();
 933         for (size_t n = 0; n < count; n++)
 934         {
 935             const wxEventTableEntry& entry = *eventEntryTable[n];
 936             if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
 937                 return true;
 938         }
 939     }
 940
 941     return false;
 942 }
 943
 944 void wxEventHashTable::InitHashTable()
 945 {
 946     // Loop over the event tables and all its base tables.
 947     const wxEventTable *table = &m_table;
 948     while (table)
 949     {
 950         // Retrieve all valid event handler entries
 951         const wxEventTableEntry *entry = table->entries;
 952         while (entry->m_fn != 0)
 953         {
 954             // Add the event entry in the Hash.
 955             AddEntry(*entry);
 956
 957             entry++;
 958         }
 959
 960         table = table->baseTable;
 961     }
 962
 963     // Lets free some memory.
 964     size_t i;
 965     for(i = 0; i < m_size; i++)
 966     {
 967         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];
 968         if (eTTnode)
 969         {
 970             eTTnode->eventEntryTable.Shrink();
 971         }
 972     }
 973 }
 974
 975 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
 976 {
 977     // This might happen 'accidentally' as the app is exiting
 978     if (!m_eventTypeTable)
 979         return;
 980
 981     EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
 982     EventTypeTablePointer  eTTnode = *peTTnode;
 983
 984     if (eTTnode)
 985     {
 986         if (eTTnode->eventType != entry.m_eventType)
 987         {
 988             // Resize the table!
 989             GrowEventTypeTable();
 990             // Try again to add it.
 991             AddEntry(entry);
 992             return;
 993         }
 994     }
 995     else
 996     {
 997         eTTnode = new EventTypeTable;
 998         eTTnode->eventType = entry.m_eventType;
 999         *peTTnode = eTTnode;
1000     }
1001
1002     // Fill all hash entries between entry.m_id and entry.m_lastId...
1003     eTTnode->eventEntryTable.Add(&entry);
1004 }
1005
1006 void wxEventHashTable::AllocEventTypeTable(size_t size)
1007 {
1008     m_eventTypeTable = new EventTypeTablePointer[size];
1009     memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1010     m_size = size;
1011 }
1012
1013 void wxEventHashTable::GrowEventTypeTable()
1014 {
1015     size_t oldSize = m_size;
1016     EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1017
1018     // TODO: Search the most optimal grow sequence
1019     AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1020
1021     for ( size_t i = 0; i < oldSize; /* */ )
1022     {
1023         EventTypeTablePointer  eTToldNode = oldEventTypeTable[i];
1024         if (eTToldNode)
1025         {
1026             EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1027             EventTypeTablePointer  eTTnode = *peTTnode;
1028
1029             // Check for collision, we don't want any.
1030             if (eTTnode)
1031             {
1032                 GrowEventTypeTable();
1033                 continue; // Don't increment the counter,
1034                           // as we still need to add this element.
1035             }
1036             else
1037             {
1038                 // Get the old value and put it in the new table.
1039                 *peTTnode = oldEventTypeTable[i];
1040             }
1041         }
1042
1043         i++;
1044     }
1045
1046     delete[] oldEventTypeTable;
1047 }
1048
1049 // ----------------------------------------------------------------------------
1050 // wxEvtHandler
1051 // ----------------------------------------------------------------------------
1052
1053 wxEvtHandler::wxEvtHandler()
1054 {
1055     m_nextHandler = NULL;
1056     m_previousHandler = NULL;
1057     m_enabled = true;
1058     m_dynamicEvents = NULL;
1059     m_pendingEvents = NULL;
1060
1061     // no client data (yet)
1062     m_clientData = NULL;
1063     m_clientDataType = wxClientData_None;
1064 }
1065
1066 wxEvtHandler::~wxEvtHandler()
1067 {
1068     Unlink();
1069
1070     if (m_dynamicEvents)
1071     {
1072         for ( wxList::iterator it = m_dynamicEvents->begin(),
1073                                end = m_dynamicEvents->end();
1074               it != end;
1075               ++it )
1076         {
1077             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1078
1079             // Remove ourselves from sink destructor notifications
1080             // (this has usually been done, in wxTrackable destructor)
1081             wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1082             if ( eventSink )
1083             {
1084                 wxEventConnectionRef * const
1085                     evtConnRef = FindRefInTrackerList(eventSink);
1086                 if ( evtConnRef )
1087                 {
1088                     eventSink->RemoveNode(evtConnRef);
1089                     delete evtConnRef;
1090                 }
1091             }
1092
1093             delete entry->m_callbackUserData;
1094             delete entry;
1095         }
1096         delete m_dynamicEvents;
1097     }
1098
1099     // Remove us from the list of the pending events if necessary.
1100     if (wxTheApp)
1101         wxTheApp->RemovePendingEventHandler(this);
1102
1103     DeletePendingEvents();
1104
1105     // we only delete object data, not untyped
1106     if ( m_clientDataType == wxClientData_Object )
1107         delete m_clientObject;
1108 }
1109
1110 void wxEvtHandler::Unlink()
1111 {
1112     // this event handler must take itself out of the chain of handlers:
1113
1114     if (m_previousHandler)
1115         m_previousHandler->SetNextHandler(m_nextHandler);
1116
1117     if (m_nextHandler)
1118         m_nextHandler->SetPreviousHandler(m_previousHandler);
1119
1120     m_nextHandler = NULL;
1121     m_previousHandler = NULL;
1122 }
1123
1124 bool wxEvtHandler::IsUnlinked() const
1125 {
1126     return m_previousHandler == NULL &&
1127            m_nextHandler == NULL;
1128 }
1129
1130 #if wxUSE_THREADS
1131
1132 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1133 {
1134     // check that we are really in a child thread
1135     wxASSERT_MSG( !wxThread::IsMain(),
1136                   wxT("use ProcessEvent() in main thread") );
1137
1138     AddPendingEvent(event);
1139
1140     return true;
1141 }
1142
1143 #endif // wxUSE_THREADS
1144
1145 void wxEvtHandler::QueueEvent(wxEvent *event)
1146 {
1147     wxCHECK_RET( event, "NULL event can't be posted" );
1148
1149     if (!wxTheApp)
1150     {
1151         // we need an event loop which manages the list of event handlers with
1152         // pending events... cannot proceed without it!
1153         wxLogDebug("No application object! Cannot queue this event!");
1154
1155         // anyway delete the given event to avoid memory leaks
1156         delete event;
1157
1158         return;
1159     }
1160
1161     // 1) Add this event to our list of pending events
1162     wxENTER_CRIT_SECT( m_pendingEventsLock );
1163
1164     if ( !m_pendingEvents )
1165         m_pendingEvents = new wxList;
1166
1167     m_pendingEvents->Append(event);
1168
1169     // 2) Add this event handler to list of event handlers that
1170     //    have pending events.
1171
1172     wxTheApp->AppendPendingEventHandler(this);
1173
1174     // only release m_pendingEventsLock now because otherwise there is a race
1175     // condition as described in the ticket #9093: we could process the event
1176     // just added to m_pendingEvents in our ProcessPendingEvents() below before
1177     // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1178     // breaking the invariant that a handler should be in the list iff it has
1179     // any pending events to process
1180     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1181
1182     // 3) Inform the system that new pending events are somewhere,
1183     //    and that these should be processed in idle time.
1184     wxWakeUpIdle();
1185 }
1186
1187 void wxEvtHandler::DeletePendingEvents()
1188 {
1189     if (m_pendingEvents)
1190         m_pendingEvents->DeleteContents(true);
1191     wxDELETE(m_pendingEvents);
1192 }
1193
1194 void wxEvtHandler::ProcessPendingEvents()
1195 {
1196     if (!wxTheApp)
1197     {
1198         // we need an event loop which manages the list of event handlers with
1199         // pending events... cannot proceed without it!
1200         wxLogDebug("No application object! Cannot process pending events!");
1201         return;
1202     }
1203
1204     // we need to process only a single pending event in this call because
1205     // each call to ProcessEvent() could result in the destruction of this
1206     // same event handler (see the comment at the end of this function)
1207
1208     wxENTER_CRIT_SECT( m_pendingEventsLock );
1209
1210     // this method is only called by wxApp if this handler does have
1211     // pending events
1212     wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1213                  "should have pending events if called" );
1214
1215     wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1216     wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1217
1218     // find the first event which can be processed now:
1219     wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1220     if (evtLoop && evtLoop->IsYielding())
1221     {
1222         while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1223         {
1224             node = node->GetNext();
1225             pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1226         }
1227
1228         if (!node)
1229         {
1230             // all our events are NOT processable now... signal this:
1231             wxTheApp->DelayPendingEventHandler(this);
1232
1233             // see the comment at the beginning of evtloop.h header for the
1234             // logic behind YieldFor() and behind DelayPendingEventHandler()
1235
1236             wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1237
1238             return;
1239         }
1240     }
1241
1242     wxEventPtr event(pEvent);
1243
1244     // it's important we remove event from list before processing it, else a
1245     // nested event loop, for example from a modal dialog, might process the
1246     // same event again.
1247     m_pendingEvents->Erase(node);
1248
1249     if ( m_pendingEvents->IsEmpty() )
1250     {
1251         // if there are no more pending events left, we don't need to
1252         // stay in this list
1253         wxTheApp->RemovePendingEventHandler(this);
1254     }
1255
1256     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1257
1258     ProcessEvent(*event);
1259
1260     // careful: this object could have been deleted by the event handler
1261     // executed by the above ProcessEvent() call, so we can't access any fields
1262     // of this object any more
1263 }
1264
1265 /* static */
1266 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1267                                            wxEvtHandler *handler,
1268                                            wxEvent& event)
1269 {
1270     int tableId1 = entry.m_id,
1271         tableId2 = entry.m_lastId;
1272
1273     // match only if the event type is the same and the id is either -1 in
1274     // the event table (meaning "any") or the event id matches the id
1275     // specified in the event table either exactly or by falling into
1276     // range between first and last
1277     if ((tableId1 == wxID_ANY) ||
1278         (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1279         (tableId2 != wxID_ANY &&
1280          (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1281     {
1282         event.Skip(false);
1283         event.m_callbackUserData = entry.m_callbackUserData;
1284
1285 #if wxUSE_EXCEPTIONS
1286         if ( wxTheApp )
1287         {
1288             // call the handler via wxApp method which allows the user to catch
1289             // any exceptions which may be thrown by any handler in the program
1290             // in one place
1291             wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1292         }
1293         else
1294 #endif // wxUSE_EXCEPTIONS
1295         {
1296             (*entry.m_fn)(handler, event);
1297         }
1298
1299         if (!event.GetSkipped())
1300             return true;
1301     }
1302
1303     return false;
1304 }
1305
1306 bool wxEvtHandler::DoTryApp(wxEvent& event)
1307 {
1308     if ( wxTheApp && (this != wxTheApp) )
1309     {
1310         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1311         // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1312         // processed appropriately via SearchEventTable.
1313         if ( event.GetEventType() != wxEVT_IDLE )
1314         {
1315             if ( wxTheApp->ProcessEvent(event) )
1316                 return true;
1317         }
1318     }
1319
1320     return false;
1321 }
1322
1323 bool wxEvtHandler::TryBefore(wxEvent& event)
1324 {
1325 #if WXWIN_COMPATIBILITY_2_8
1326     // call the old virtual function to keep the code overriding it working
1327     return TryValidator(event);
1328 #else
1329     wxUnusedVar(event);
1330     return false;
1331 #endif
1332 }
1333
1334 bool wxEvtHandler::TryAfter(wxEvent& event)
1335 {
1336     // We only want to pass the window to the application object once even if
1337     // there are several chained handlers. Ensure that this is what happens by
1338     // only calling DoTryApp() if there is no next handler (which would do it).
1339     //
1340     // Notice that, unlike simply calling TryAfter() on the last handler in the
1341     // chain only from ProcessEvent(), this also works with wxWindow object in
1342     // the middle of the chain: its overridden TryAfter() will still be called
1343     // and propagate the event upwards the window hierarchy even if it's not
1344     // the last one in the chain (which, admittedly, shouldn't happen often).
1345     if ( GetNextHandler() )
1346         return GetNextHandler()->TryAfter(event);
1347
1348 #if WXWIN_COMPATIBILITY_2_8
1349     // as above, call the old virtual function for compatibility
1350     return TryParent(event);
1351 #else
1352     return DoTryApp(event);
1353 #endif
1354 }
1355
1356 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1357 {
1358     // The very first thing we do is to allow the application to hook into
1359     // event processing in order to globally pre-process all events.
1360     //
1361     // Note that we should only do it if we're the first event handler called
1362     // to avoid calling FilterEvent() multiple times as the event goes through
1363     // the event handler chain and possibly upwards the window hierarchy.
1364     if ( !event.WasProcessed() )
1365     {
1366         if ( wxTheApp )
1367         {
1368             int rc = wxTheApp->FilterEvent(event);
1369             if ( rc != -1 )
1370             {
1371                 wxASSERT_MSG( rc == 1 || rc == 0,
1372                               "unexpected wxApp::FilterEvent return value" );
1373
1374                 return rc != 0;
1375             }
1376             //else: proceed normally
1377         }
1378     }
1379
1380     // Short circuit the event processing logic if we're requested to process
1381     // this event in this handler only, see DoTryChain() for more details.
1382     if ( event.ShouldProcessOnlyIn(this) )
1383         return TryHere(event);
1384
1385
1386     // Try to process the event in this handler itself.
1387     if ( ProcessEventLocally(event) )
1388     {
1389         // It is possible that DoTryChain() called from ProcessEventLocally()
1390         // returned true but the event was not really processed: this happens
1391         // if a custom handler ignores the request to process the event in this
1392         // handler only and in this case we should skip the post processing
1393         // done in TryAfter() but still return the correct value ourselves to
1394         // indicate whether we did or did not find a handler for this event.
1395         return !event.GetSkipped();
1396     }
1397
1398     // If we still didn't find a handler, propagate the event upwards the
1399     // window chain and/or to the application object.
1400     if ( TryAfter(event) )
1401         return true;
1402
1403
1404     // No handler found anywhere, bail out.
1405     return false;
1406 }
1407
1408 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1409 {
1410     // First try the hooks which should be called before our own handlers
1411     if ( TryBefore(event) )
1412         return true;
1413
1414     // Then try this handler itself, notice that we should not call
1415     // ProcessEvent() on this one as we're already called from it, which
1416     // explains why we do it here and not in DoTryChain()
1417     if ( TryHere(event) )
1418         return true;
1419
1420     // Finally try the event handlers chained to this one,
1421     if ( DoTryChain(event) )
1422         return true;
1423
1424     // And return false to indicate that we didn't find any handler at this
1425     // level.
1426     return false;
1427 }
1428
1429 bool wxEvtHandler::DoTryChain(wxEvent& event)
1430 {
1431     for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1432     {
1433         // We need to process this event at the level of this handler only
1434         // right now, the pre-/post-processing was either already done by
1435         // ProcessEvent() from which we were called or will be done by it when
1436         // we return.
1437         //
1438         // However we must call ProcessEvent() and not TryHere() because the
1439         // existing code (including some in wxWidgets itself) expects the
1440         // overridden ProcessEvent() in its custom event handlers pushed on a
1441         // window to be called.
1442         //
1443         // So we must call ProcessEvent() but it must not do what it usually
1444         // does. To resolve this paradox we set up a special flag inside the
1445         // object itself to let ProcessEvent() know that it shouldn't do any
1446         // pre/post-processing for this event if it gets it. Note that this
1447         // only applies to this handler, if the event is passed to another one
1448         // by explicitly calling its ProcessEvent(), pre/post-processing should
1449         // be done as usual.
1450         //
1451         // Final complication is that if the implementation of ProcessEvent()
1452         // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1453         // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1454         // request to process event in this handler only, we have to compensate
1455         // for it by not processing the event further because this was already
1456         // done by that rogue event handler.
1457         wxEventProcessInHandlerOnly processInHandlerOnly(event, h);
1458         if ( h->ProcessEvent(event) )
1459         {
1460             // Make sure "skipped" flag is not set as the event was really
1461             // processed in this case. Normally it shouldn't be set anyhow but
1462             // make sure just in case the user code does something strange.
1463             event.Skip(false);
1464
1465             return true;
1466         }
1467
1468         if ( !event.ShouldProcessOnlyIn(h) )
1469         {
1470             // Still return true to indicate that no further processing should
1471             // be undertaken but ensure that "skipped" flag is set so that the
1472             // caller knows that the event was not really processed.
1473             event.Skip();
1474
1475             return true;
1476         }
1477     }
1478
1479     return false;
1480 }
1481
1482 bool wxEvtHandler::TryHere(wxEvent& event)
1483 {
1484     // If the event handler is disabled it doesn't process any events
1485     if ( !GetEvtHandlerEnabled() )
1486         return false;
1487
1488     // Handle per-instance dynamic event tables first
1489     if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1490         return true;
1491
1492     // Then static per-class event tables
1493     if ( GetEventHashTable().HandleEvent(event, this) )
1494         return true;
1495
1496     // We don't have a handler for this event.
1497     return false;
1498 }
1499
1500 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1501 {
1502 #if wxUSE_EXCEPTIONS
1503     try
1504     {
1505 #endif
1506         return ProcessEvent(event);
1507 #if wxUSE_EXCEPTIONS
1508     }
1509     catch ( ... )
1510     {
1511         // notice that we do it in 2 steps to avoid warnings about possibly
1512         // uninitialized loop variable from some versions of g++ which are not
1513         // smart enough to figure out that GetActive() doesn't throw and so
1514         // that loop will always be initialized
1515         wxEventLoopBase *loop = NULL;
1516         try
1517         {
1518             loop = wxEventLoopBase::GetActive();
1519
1520             if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1521             {
1522                 if ( loop )
1523                     loop->Exit();
1524             }
1525             //else: continue running current event loop
1526
1527             return false;
1528         }
1529         catch ( ... )
1530         {
1531             // OnExceptionInMainLoop() threw, possibly rethrowing the same
1532             // exception again: very good, but we still need Exit() to
1533             // be called
1534             if ( loop )
1535                 loop->Exit();
1536             throw;
1537         }
1538     }
1539 #endif // wxUSE_EXCEPTIONS
1540 }
1541
1542 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1543 {
1544     const wxEventType eventType = event.GetEventType();
1545     for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1546     {
1547         const wxEventTableEntry& entry = table.entries[i];
1548         if ( eventType == entry.m_eventType )
1549         {
1550             if ( ProcessEventIfMatchesId(entry, this, event) )
1551                 return true;
1552         }
1553     }
1554
1555     return false;
1556 }
1557
1558 void wxEvtHandler::DoBind(int id,
1559                           int lastId,
1560                           wxEventType eventType,
1561                           wxEventFunctor *func,
1562                           wxObject *userData)
1563 {
1564     wxDynamicEventTableEntry *entry =
1565         new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1566
1567     if (!m_dynamicEvents)
1568         m_dynamicEvents = new wxList;
1569
1570     // Insert at the front of the list so most recent additions are found first
1571     m_dynamicEvents->Insert( (wxObject*) entry );
1572
1573     // Make sure we get to know when a sink is destroyed
1574     wxEvtHandler *eventSink = func->GetEvtHandler();
1575     if ( eventSink && eventSink != this )
1576     {
1577         wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1578         if ( evtConnRef )
1579             evtConnRef->IncRef( );
1580         else
1581             new wxEventConnectionRef(this, eventSink);
1582     }
1583 }
1584
1585 bool
1586 wxEvtHandler::DoUnbind(int id,
1587                        int lastId,
1588                        wxEventType eventType,
1589                        const wxEventFunctor& func,
1590                        wxObject *userData)
1591 {
1592     if (!m_dynamicEvents)
1593         return false;
1594
1595     // Remove connection from tracker node (wxEventConnectionRef)
1596     wxEvtHandler *eventSink = func.GetEvtHandler();
1597     if ( eventSink && eventSink != this )
1598     {
1599         wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1600         if ( evtConnRef )
1601             evtConnRef->DecRef();
1602     }
1603
1604     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1605     while (node)
1606     {
1607         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1608
1609         if ((entry->m_id == id) &&
1610             ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1611             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1612             entry->m_fn->IsMatching(func) &&
1613             ((entry->m_callbackUserData == userData) || !userData))
1614         {
1615             delete entry->m_callbackUserData;
1616             m_dynamicEvents->Erase( node );
1617             delete entry;
1618             return true;
1619         }
1620         node = node->GetNext();
1621     }
1622     return false;
1623 }
1624
1625 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1626 {
1627     wxCHECK_MSG( m_dynamicEvents, false,
1628                  wxT("caller should check that we have dynamic events") );
1629
1630     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1631     while (node)
1632     {
1633         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1634
1635         // get next node before (maybe) calling the event handler as it could
1636         // call Disconnect() invalidating the current node
1637         node = node->GetNext();
1638
1639         if ( event.GetEventType() == entry->m_eventType )
1640         {
1641             wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1642             if ( !handler )
1643                handler = this;
1644             if ( ProcessEventIfMatchesId(*entry, handler, event) )
1645                 return true;
1646         }
1647     }
1648
1649     return false;
1650 }
1651
1652 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1653 {
1654     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1655                   wxT("can't have both object and void client data") );
1656
1657     if ( m_clientObject )
1658         delete m_clientObject;
1659
1660     m_clientObject = data;
1661     m_clientDataType = wxClientData_Object;
1662 }
1663
1664 wxClientData *wxEvtHandler::DoGetClientObject() const
1665 {
1666     // it's not an error to call GetClientObject() on a window which doesn't
1667     // have client data at all - NULL will be returned
1668     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1669                   wxT("this window doesn't have object client data") );
1670
1671     return m_clientObject;
1672 }
1673
1674 void wxEvtHandler::DoSetClientData( void *data )
1675 {
1676     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1677                   wxT("can't have both object and void client data") );
1678
1679     m_clientData = data;
1680     m_clientDataType = wxClientData_Void;
1681 }
1682
1683 void *wxEvtHandler::DoGetClientData() const
1684 {
1685     // it's not an error to call GetClientData() on a window which doesn't have
1686     // client data at all - NULL will be returned
1687     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1688                   wxT("this window doesn't have void client data") );
1689
1690     return m_clientData;
1691 }
1692
1693 // A helper to find an wxEventConnectionRef object
1694 wxEventConnectionRef *
1695 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1696 {
1697     for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1698     {
1699         // we only want wxEventConnectionRef nodes here
1700         wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1701         if ( evtConnRef && evtConnRef->m_src == this )
1702         {
1703             wxASSERT( evtConnRef->m_sink==eventSink );
1704             return evtConnRef;
1705         }
1706     }
1707
1708     return NULL;
1709 }
1710
1711 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1712 {
1713     wxASSERT(m_dynamicEvents);
1714
1715     // remove all connections with this sink
1716     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1717     while (node)
1718     {
1719         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1720         node_nxt = node->GetNext();
1721
1722         if ( entry->m_fn->GetEvtHandler() == sink )
1723         {
1724             delete entry->m_callbackUserData;
1725             m_dynamicEvents->Erase( node );
1726             delete entry;
1727         }
1728         node = node_nxt;
1729     }
1730 }
1731
1732 #endif // wxUSE_BASE
1733
1734 #if wxUSE_GUI
1735
1736 // Find a window with the focus, that is also a descendant of the given window.
1737 // This is used to determine the window to initially send commands to.
1738 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1739 {
1740     // Process events starting with the window with the focus, if any.
1741     wxWindow* focusWin = wxWindow::FindFocus();
1742     wxWindow* win = focusWin;
1743
1744     // Check if this is a descendant of this frame.
1745     // If not, win will be set to NULL.
1746     while (win)
1747     {
1748         if (win == ancestor)
1749             break;
1750         else
1751             win = win->GetParent();
1752     }
1753     if (win == NULL)
1754         focusWin = NULL;
1755
1756     return focusWin;
1757 }
1758
1759 // ----------------------------------------------------------------------------
1760 // wxEventBlocker
1761 // ----------------------------------------------------------------------------
1762
1763 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1764 {
1765     wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1766
1767     m_window = win;
1768
1769     Block(type);
1770     m_window->PushEventHandler(this);
1771 }
1772
1773 wxEventBlocker::~wxEventBlocker()
1774 {
1775     wxEvtHandler *popped = m_window->PopEventHandler(false);
1776     wxCHECK_RET(popped == this,
1777         wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1778 }
1779
1780 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1781 {
1782     // should this event be blocked?
1783     for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1784     {
1785         wxEventType t = (wxEventType)m_eventsToBlock[i];
1786         if ( t == wxEVT_ANY || t == event.GetEventType() )
1787             return true;   // yes, it should: mark this event as processed
1788     }
1789
1790     return false;
1791 }
1792
1793 #endif // wxUSE_GUI
1794