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