src/common/event.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "event.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/defs.h"
  33     #include "wx/app.h"
  34     #include "wx/list.h"
  35
  36     #if wxUSE_GUI
  37         #include "wx/control.h"
  38         #include "wx/utils.h"
  39         #include "wx/dc.h"
  40     #endif // wxUSE_GUI
  41 #endif
  42
  43 #include "wx/event.h"
  44
  45 #if wxUSE_GUI
  46     #include "wx/validate.h"
  47 #endif // wxUSE_GUI
  48
  49 // ----------------------------------------------------------------------------
  50 // wxWin macros
  51 // ----------------------------------------------------------------------------
  52
  53 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
  54 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
  55
  56 #if wxUSE_GUI
  57     IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
  58     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
  59     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
  60     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
  61     IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
  62     IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
  63     IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
  64     IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
  65     IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
  66     IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
  67     IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
  68     IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
  69     IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
  70     IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
  71     IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
  72     IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
  73     IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
  74     IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
  75     IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
  76     IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
  77     IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
  78     IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
  79     IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
  80     IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
  81     IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
  82     IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
  83     IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
  84     IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
  85     IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
  86     IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
  87     IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
  88     IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
  89     IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
  90     IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
  91     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
  92 #endif // wxUSE_GUI
  93
  94 const wxEventTable *wxEvtHandler::GetEventTable() const
  95     { return &wxEvtHandler::sm_eventTable; }
  96
  97 const wxEventTable wxEvtHandler::sm_eventTable =
  98     { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
  99
 100 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
 101     { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
 102
 103 // ----------------------------------------------------------------------------
 104 // global variables
 105 // ----------------------------------------------------------------------------
 106
 107 // To put pending event handlers
 108 wxList *wxPendingEvents = (wxList *)NULL;
 109
 110 #if wxUSE_THREADS
 111     // protects wxPendingEvents list
 112     wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
 113 #endif
 114
 115 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 116
 117 // common event types are defined here, other event types are defined by the
 118 // components which use them
 119
 120 DEFINE_EVENT_TYPE(wxEVT_NULL)
 121 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED)
 122 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED)
 123 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED)
 124 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED)
 125 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED)
 126 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED)
 127 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED)
 128 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED)
 129 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED)
 130 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED)
 131 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED)
 132 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED)
 133 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED)
 134 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
 135 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
 136 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
 137
 138 // Sockets and timers send events, too
 139 DEFINE_EVENT_TYPE(wxEVT_SOCKET)
 140 DEFINE_EVENT_TYPE(wxEVT_TIMER)
 141
 142 // Mouse event types
 143 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
 144 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP)
 145 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN)
 146 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP)
 147 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN)
 148 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP)
 149 DEFINE_EVENT_TYPE(wxEVT_MOTION)
 150 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW)
 151 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW)
 152 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK)
 153 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK)
 154 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK)
 155 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS)
 156 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS)
 157 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS)
 158 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL)
 159
 160 // Non-client mouse events
 161 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN)
 162 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP)
 163 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN)
 164 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP)
 165 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN)
 166 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP)
 167 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION)
 168 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW)
 169 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW)
 170 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK)
 171 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK)
 172 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK)
 173
 174 // Character input event type
 175 DEFINE_EVENT_TYPE(wxEVT_CHAR)
 176 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK)
 177 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY)
 178 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN)
 179 DEFINE_EVENT_TYPE(wxEVT_KEY_UP)
 180
 181 // Set cursor event
 182 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR)
 183
 184 // wxScrollbar and wxSlider event identifiers
 185 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP)
 186 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM)
 187 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP)
 188 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN)
 189 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP)
 190 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN)
 191 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK)
 192 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE)
 193
 194 // Scroll events from wxWindow
 195 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP)
 196 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM)
 197 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP)
 198 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN)
 199 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP)
 200 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN)
 201 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK)
 202 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE)
 203
 204 // System events
 205 DEFINE_EVENT_TYPE(wxEVT_SIZE)
 206 DEFINE_EVENT_TYPE(wxEVT_MOVE)
 207 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
 208 DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
 209 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
 210 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
 211 DEFINE_EVENT_TYPE(wxEVT_POWER)
 212 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
 213 DEFINE_EVENT_TYPE(wxEVT_CREATE)
 214 DEFINE_EVENT_TYPE(wxEVT_DESTROY)
 215 DEFINE_EVENT_TYPE(wxEVT_SHOW)
 216 DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
 217 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
 218 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
 219 DEFINE_EVENT_TYPE(wxEVT_PAINT)
 220 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
 221 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
 222 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON)
 223 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN)
 224 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE)
 225 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT)
 226 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU)
 227 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED)
 228 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED)
 229 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED)
 230 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE)
 231 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED)
 232 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN)
 233 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP)
 234 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE)
 235 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE)
 236 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES)
 237 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM)
 238 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM)
 239 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM)
 240 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
 241 DEFINE_EVENT_TYPE(wxEVT_IDLE)
 242 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
 243
 244 // Generic command events
 245 // Note: a click is a higher-level event than button down/up
 246 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
 247 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK)
 248 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK)
 249 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK)
 250 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS)
 251 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS)
 252 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER)
 253
 254 // Help events
 255 DEFINE_EVENT_TYPE(wxEVT_HELP)
 256 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
 257
 258 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 259
 260 // ============================================================================
 261 // implementation
 262 // ============================================================================
 263
 264 // ----------------------------------------------------------------------------
 265 // event initialization
 266 // ----------------------------------------------------------------------------
 267
 268 int wxNewEventType()
 269 {
 270     // MT-FIXME
 271     static int s_lastUsedEventType = wxEVT_FIRST;
 272
 273 #if WXWIN_COMPATIBILITY_2
 274     // check that we don't overlap with the user-defined types: if it does
 275     // happen, the best solution is probably to update the existing code to
 276     // use wxNewEventType() instead of wxEVT_USER_FIRST
 277     //
 278     // due to the uncertainty
 279     wxASSERT_MSG( s_lastUsedEventType < wxEVT_USER_FIRST - 1,
 280                   _T("possible event type conflict") );
 281 #endif // WXWIN_COMPATIBILITY_2
 282
 283     return s_lastUsedEventType++;
 284 }
 285
 286 // ----------------------------------------------------------------------------
 287 // wxEvent
 288 // ----------------------------------------------------------------------------
 289
 290 /*
 291  * General wxWindows events, covering
 292  * all interesting things that might happen (button clicking, resizing,
 293  * setting text in widgets, etc.).
 294  *
 295  * For each completely new event type, derive a new event class.
 296  *
 297  */
 298
 299 wxEvent::wxEvent(int theId, wxEventType commandType )
 300 {
 301     m_eventType = commandType;
 302     m_eventObject = (wxObject *) NULL;
 303     m_timeStamp = 0;
 304     m_id = theId;
 305     m_skipped = FALSE;
 306     m_callbackUserData = (wxObject *) NULL;
 307     m_isCommandEvent = FALSE;
 308 }
 309
 310 wxEvent::wxEvent(const wxEvent &src)
 311     : wxObject()
 312     , m_eventObject(src.m_eventObject)
 313     , m_eventType(src.m_eventType)
 314     , m_timeStamp(src.m_timeStamp)
 315     , m_id(src.m_id)
 316     , m_callbackUserData(src.m_callbackUserData)
 317     , m_skipped(src.m_skipped)
 318     , m_isCommandEvent(src.m_isCommandEvent)
 319 {
 320 }
 321
 322 #if wxUSE_GUI
 323
 324 /*
 325  * Command events
 326  *
 327  */
 328
 329 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
 330   : wxEvent(theId, commandType)
 331 {
 332     m_clientData = (char *) NULL;
 333     m_clientObject = (wxClientData *) NULL;
 334     m_extraLong = 0;
 335     m_commandInt = 0;
 336     m_commandString = wxEmptyString;
 337     m_isCommandEvent = TRUE;
 338 }
 339
 340 /*
 341  * Scroll events
 342  */
 343
 344 wxScrollEvent::wxScrollEvent(wxEventType commandType,
 345                              int id,
 346                              int pos,
 347                              int orient)
 348     : wxCommandEvent(commandType, id)
 349 {
 350     m_extraLong = orient;
 351     m_commandInt = pos;
 352 }
 353
 354 /*
 355  * ScrollWin events
 356  */
 357
 358 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
 359                                    int pos,
 360                                    int orient)
 361 {
 362     m_eventType = commandType;
 363     m_extraLong = orient;
 364     m_commandInt = pos;
 365 }
 366
 367 /*
 368  * Mouse events
 369  *
 370  */
 371
 372 wxMouseEvent::wxMouseEvent(wxEventType commandType)
 373 {
 374     m_eventType = commandType;
 375     m_metaDown = FALSE;
 376     m_altDown = FALSE;
 377     m_controlDown = FALSE;
 378     m_shiftDown = FALSE;
 379     m_leftDown = FALSE;
 380     m_rightDown = FALSE;
 381     m_middleDown = FALSE;
 382     m_x = 0;
 383     m_y = 0;
 384     m_wheelRotation = 0;
 385     m_wheelDelta = 0;
 386     m_linesPerAction = 0;
 387 }
 388
 389 void wxMouseEvent::Assign(const wxMouseEvent& event)
 390 {
 391     m_x = event.m_x;
 392     m_y = event.m_y;
 393
 394     m_leftDown = event.m_leftDown;
 395     m_middleDown = event.m_middleDown;
 396     m_rightDown = event.m_rightDown;
 397
 398     m_controlDown = event.m_controlDown;
 399     m_shiftDown = event.m_shiftDown;
 400     m_altDown = event.m_altDown;
 401     m_metaDown = event.m_metaDown;
 402
 403     m_wheelRotation = event.m_wheelRotation;
 404     m_wheelDelta = event.m_wheelDelta;
 405     m_linesPerAction = event.m_linesPerAction;
 406 }
 407
 408 // True if was a button dclick event (1 = left, 2 = middle, 3 = right)
 409 // or any button dclick event (but = -1)
 410 bool wxMouseEvent::ButtonDClick(int but) const
 411 {
 412     switch (but)
 413     {
 414         case -1:
 415             return (LeftDClick() || MiddleDClick() || RightDClick());
 416         case 1:
 417             return LeftDClick();
 418         case 2:
 419             return MiddleDClick();
 420         case 3:
 421             return RightDClick();
 422         default:
 423             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
 424     }
 425
 426     return FALSE;
 427 }
 428
 429 // True if was a button down event (1 = left, 2 = middle, 3 = right)
 430 // or any button down event (but = -1)
 431 bool wxMouseEvent::ButtonDown(int but) const
 432 {
 433     switch (but)
 434     {
 435         case -1:
 436             return (LeftDown() || MiddleDown() || RightDown());
 437         case 1:
 438             return LeftDown();
 439         case 2:
 440             return MiddleDown();
 441         case 3:
 442             return RightDown();
 443         default:
 444             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
 445     }
 446
 447     return FALSE;
 448 }
 449
 450 // True if was a button up event (1 = left, 2 = middle, 3 = right)
 451 // or any button up event (but = -1)
 452 bool wxMouseEvent::ButtonUp(int but) const
 453 {
 454     switch (but)
 455     {
 456         case -1:
 457             return (LeftUp() || MiddleUp() || RightUp());
 458         case 1:
 459             return LeftUp();
 460         case 2:
 461             return MiddleUp();
 462         case 3:
 463             return RightUp();
 464         default:
 465             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
 466     }
 467
 468     return FALSE;
 469 }
 470
 471 // True if the given button is currently changing state
 472 bool wxMouseEvent::Button(int but) const
 473 {
 474     switch (but)
 475     {
 476         case -1:
 477             return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
 478         case 1:
 479             return (LeftDown() || LeftUp() || LeftDClick());
 480         case 2:
 481             return (MiddleDown() || MiddleUp() || MiddleDClick());
 482         case 3:
 483             return (RightDown() || RightUp() || RightDClick());
 484         default:
 485             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
 486     }
 487
 488     return FALSE;
 489 }
 490
 491 bool wxMouseEvent::ButtonIsDown(int but) const
 492 {
 493     switch (but)
 494     {
 495         case -1:
 496             return (LeftIsDown() || MiddleIsDown() || RightIsDown());
 497         case 1:
 498             return LeftIsDown();
 499         case 2:
 500             return MiddleIsDown();
 501         case 3:
 502             return RightIsDown();
 503         default:
 504             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
 505     }
 506
 507     return FALSE;
 508 }
 509
 510 int wxMouseEvent::GetButton() const
 511 {
 512     for ( int i = 1; i <= 3; i++ )
 513     {
 514         if ( Button(i) )
 515         {
 516             return i;
 517         }
 518     }
 519
 520     return -1;
 521 }
 522
 523 // Find the logical position of the event given the DC
 524 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
 525 {
 526     wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
 527     return pt;
 528 }
 529
 530
 531 /*
 532  * Keyboard event
 533  *
 534  */
 535
 536 wxKeyEvent::wxKeyEvent(wxEventType type)
 537 {
 538     m_eventType = type;
 539     m_shiftDown = FALSE;
 540     m_controlDown = FALSE;
 541     m_metaDown = FALSE;
 542     m_altDown = FALSE;
 543     m_keyCode = 0;
 544     m_scanCode = 0;
 545 }
 546
 547
 548 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 549 {
 550     SetEventType(wxEVT_CREATE);
 551     SetEventObject(win);
 552 }
 553
 554 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
 555 {
 556     SetEventType(wxEVT_DESTROY);
 557     SetEventObject(win);
 558 }
 559
 560 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
 561                  : wxCommandEvent(wxEVT_CHILD_FOCUS)
 562 {
 563     SetEventObject(win);
 564 }
 565
 566 #endif // wxUSE_GUI
 567
 568 // ----------------------------------------------------------------------------
 569 // wxEvtHandler
 570 // ----------------------------------------------------------------------------
 571
 572 /*
 573  * Event handler
 574  */
 575
 576 wxEvtHandler::wxEvtHandler()
 577 {
 578     m_nextHandler = (wxEvtHandler *) NULL;
 579     m_previousHandler = (wxEvtHandler *) NULL;
 580     m_enabled = TRUE;
 581     m_dynamicEvents = (wxList *) NULL;
 582     m_isWindow = FALSE;
 583     m_pendingEvents = (wxList *) NULL;
 584 #if wxUSE_THREADS
 585 #  if !defined(__VISAGECPP__)
 586     m_eventsLocker = new wxCriticalSection;
 587 #  endif
 588 #endif
 589     // no client data (yet)
 590     m_clientData = NULL;
 591     m_clientDataType = wxClientData_None;
 592 }
 593
 594 wxEvtHandler::~wxEvtHandler()
 595 {
 596     // Takes itself out of the list of handlers
 597     if (m_previousHandler)
 598         m_previousHandler->m_nextHandler = m_nextHandler;
 599
 600     if (m_nextHandler)
 601         m_nextHandler->m_previousHandler = m_previousHandler;
 602
 603     if (m_dynamicEvents)
 604     {
 605         wxNode *node = m_dynamicEvents->First();
 606         while (node)
 607         {
 608 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 609             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
 610 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 611             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
 612 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 613
 614             if (entry->m_callbackUserData)
 615                 delete entry->m_callbackUserData;
 616             delete entry;
 617             node = node->Next();
 618         }
 619         delete m_dynamicEvents;
 620     };
 621
 622     delete m_pendingEvents;
 623
 624 #if wxUSE_THREADS
 625 #  if !defined(__VISAGECPP__)
 626     delete m_eventsLocker;
 627 #  endif
 628 #endif
 629
 630     // we only delete object data, not untyped
 631     if ( m_clientDataType == wxClientData_Object )
 632         delete m_clientObject;
 633 }
 634
 635 #if wxUSE_THREADS
 636
 637 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
 638 {
 639     // check that we are really in a child thread
 640     wxASSERT_MSG( !wxThread::IsMain(),
 641                   wxT("use ProcessEvent() in main thread") );
 642
 643     AddPendingEvent(event);
 644
 645     return TRUE;
 646 }
 647
 648 #endif // wxUSE_THREADS
 649
 650 void wxEvtHandler::AddPendingEvent(wxEvent& event)
 651 {
 652     // 1) Add event to list of pending events of this event handler
 653
 654     wxEvent *eventCopy = event.Clone();
 655
 656     // we must be able to copy the events here so the event class must
 657     // implement Clone() properly instead of just providing a NULL stab for it
 658     wxCHECK_RET( eventCopy,
 659                  _T("events of this type aren't supposed to be posted") );
 660
 661 #if defined(__VISAGECPP__)
 662     wxENTER_CRIT_SECT( m_eventsLocker);
 663 #else
 664     wxENTER_CRIT_SECT( *m_eventsLocker);
 665 #endif
 666
 667     if ( !m_pendingEvents )
 668       m_pendingEvents = new wxList;
 669
 670     m_pendingEvents->Append(eventCopy);
 671
 672 #if defined(__VISAGECPP__)
 673     wxLEAVE_CRIT_SECT( m_eventsLocker);
 674 #else
 675     wxLEAVE_CRIT_SECT( *m_eventsLocker);
 676 #endif
 677
 678     // 2) Add this event handler to list of event handlers that
 679     //    have pending events.
 680
 681     wxENTER_CRIT_SECT(*wxPendingEventsLocker);
 682
 683     if ( !wxPendingEvents )
 684         wxPendingEvents = new wxList;
 685     wxPendingEvents->Append(this);
 686
 687     wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
 688
 689     // 3) Inform the system that new pending events are somwehere,
 690     //    and that these should be processed in idle time.
 691     wxWakeUpIdle();
 692 }
 693
 694 void wxEvtHandler::ProcessPendingEvents()
 695 {
 696 #if defined(__VISAGECPP__)
 697     wxENTER_CRIT_SECT( m_eventsLocker);
 698 #else
 699     wxENTER_CRIT_SECT( *m_eventsLocker);
 700 #endif
 701
 702     wxNode *node = m_pendingEvents->First();
 703     while ( node )
 704     {
 705         wxEvent *event = (wxEvent *)node->Data();
 706         delete node;
 707
 708         // In ProcessEvent, new events might get added and
 709         // we can safely leave the crtical section here.
 710 #if defined(__VISAGECPP__)
 711         wxLEAVE_CRIT_SECT( m_eventsLocker);
 712 #else
 713         wxLEAVE_CRIT_SECT( *m_eventsLocker);
 714 #endif
 715         ProcessEvent(*event);
 716         delete event;
 717 #if defined(__VISAGECPP__)
 718         wxENTER_CRIT_SECT( m_eventsLocker);
 719 #else
 720         wxENTER_CRIT_SECT( *m_eventsLocker);
 721 #endif
 722
 723         node = m_pendingEvents->First();
 724     }
 725
 726 #if defined(__VISAGECPP__)
 727     wxLEAVE_CRIT_SECT( m_eventsLocker);
 728 #else
 729     wxLEAVE_CRIT_SECT( *m_eventsLocker);
 730 #endif
 731 }
 732
 733 /*
 734  * Event table stuff
 735  */
 736
 737 bool wxEvtHandler::ProcessEvent(wxEvent& event)
 738 {
 739 #if wxUSE_GUI
 740
 741     // We have to use the actual window or processing events from
 742     // wxWindowNative destructor won't work (we don't see the wxWindow class)
 743 #ifdef __WXDEBUG__
 744     // check that our flag corresponds to reality
 745     wxClassInfo* info = NULL;
 746 #ifdef __WXUNIVERSAL__
 747 #  if defined(__WXMSW__)
 748     info = CLASSINFO(wxWindowMSW);
 749 #  elif defined(__WXGTK__)
 750     info = CLASSINFO(wxWindowGTK);
 751 #  elif defined(__WXX11__)
 752     info = CLASSINFO(wxWindowX11);
 753 #  elif defined(__WXMGL__)
 754     info = CLASSINFO(wxWindowMGL);
 755 #  elif defined(__WXPM__)
 756     info = CLASSINFO(wxWindowOS2);
 757 #  elif defined(__WXMAC__)
 758     info = CLASSINFO(wxWindowMac);
 759 #  elif defined(__WXMOTIF__)
 760     info = CLASSINFO(wxWindowMotif);
 761 #  endif
 762 #else
 763     info = CLASSINFO(wxWindow);
 764 #endif
 765
 766     if ( m_isWindow != IsKindOf(info) )
 767     {
 768         wxString msg = GetClassInfo()->GetClassName();
 769         msg += _T(" should [not] be a window but it is [not]");
 770
 771         wxFAIL_MSG( msg );
 772     }
 773
 774 #endif // __WXDEBUG__
 775
 776 #endif // wxUSE_GUI
 777
 778     // allow the application to hook into event processing
 779     if ( wxTheApp )
 780     {
 781         int rc = wxTheApp->FilterEvent(event);
 782         if ( rc != -1 )
 783         {
 784             wxASSERT_MSG( rc == 1 || rc == 0,
 785                           _T("unexpected wxApp::FilterEvent return value") );
 786
 787             return rc != 0;
 788         }
 789         //else: proceed normally
 790     }
 791
 792     // An event handler can be enabled or disabled
 793     if ( GetEvtHandlerEnabled() )
 794     {
 795
 796 #if 0
 797 /*
 798         What is this? When using GUI threads, a non main
 799         threads can send an event and process it itself.
 800         This breaks GTK's GUI threads, so please explain.
 801 */
 802
 803         // Check whether we are in a child thread.
 804         if ( !wxThread::IsMain() )
 805           return ProcessThreadEvent(event);
 806 #endif
 807
 808         // Handle per-instance dynamic event tables first
 809         if ( m_dynamicEvents && SearchDynamicEventTable(event) )
 810             return TRUE;
 811
 812         // Then static per-class event tables
 813         const wxEventTable *table = GetEventTable();
 814
 815 #if wxUSE_GUI && wxUSE_VALIDATORS
 816         // Try the associated validator first, if this is a window.
 817         // Problem: if the event handler of the window has been replaced,
 818         // this wxEvtHandler may no longer be a window.
 819         // Therefore validators won't be processed if the handler
 820         // has been replaced with SetEventHandler.
 821         // THIS CAN BE CURED if PushEventHandler is used instead of
 822         // SetEventHandler, and then processing will be passed down the
 823         // chain of event handlers.
 824         if (m_isWindow)
 825         {
 826             wxWindow *win = (wxWindow *)this;
 827
 828             // Can only use the validator of the window which
 829             // is receiving the event
 830             if ( win == event.GetEventObject() )
 831             {
 832                 wxValidator *validator = win->GetValidator();
 833                 if ( validator && validator->ProcessEvent(event) )
 834                 {
 835                     return TRUE;
 836                 }
 837             }
 838         }
 839 #endif
 840
 841         // Search upwards through the inheritance hierarchy
 842         while (table)
 843         {
 844             if ( SearchEventTable((wxEventTable&)*table, event) )
 845                 return TRUE;
 846             table = table->baseTable;
 847         }
 848     }
 849
 850     // Try going down the event handler chain
 851     if ( GetNextHandler() )
 852     {
 853         if ( GetNextHandler()->ProcessEvent(event) )
 854             return TRUE;
 855     }
 856
 857 #if wxUSE_GUI
 858     // Carry on up the parent-child hierarchy, but only if event is a command
 859     // event: it wouldn't make sense for a parent to receive a child's size
 860     // event, for example
 861     if ( m_isWindow && event.IsCommandEvent() )
 862     {
 863         wxWindow *win = (wxWindow *)this;
 864
 865         // honour the requests to stop propagation at this window: this is
 866         // used by the dialogs, for example, to prevent processing the events
 867         // from the dialog controls in the parent frame which rarely, if ever,
 868         // makes sense
 869         if ( !(win->GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
 870         {
 871             wxWindow *parent = win->GetParent();
 872             if ( parent && !parent->IsBeingDeleted() )
 873                 return parent->GetEventHandler()->ProcessEvent(event);
 874         }
 875     }
 876 #endif // wxUSE_GUI
 877
 878     // Last try - application object.
 879     if ( wxTheApp && (this != wxTheApp) )
 880     {
 881         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
 882         // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
 883         // processed appropriately via SearchEventTable.
 884         if ( event.GetEventType() != wxEVT_IDLE )
 885         {
 886             if ( wxTheApp->ProcessEvent(event) )
 887                 return TRUE;
 888         }
 889     }
 890
 891     return FALSE;
 892 }
 893
 894 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
 895 {
 896     wxEventType eventType = event.GetEventType();
 897     int eventId = event.GetId();
 898
 899     // BC++ doesn't like testing for m_fn without != 0
 900     for ( int i = 0; table.entries[i].m_fn != 0; i++ )
 901     {
 902         // the line using reference exposes a bug in gcc: although it _seems_
 903         // to work, it leads to weird crashes later on during program
 904         // execution
 905 #ifdef __GNUG__
 906         wxEventTableEntry entry = table.entries[i];
 907 #else
 908         const wxEventTableEntry& entry = table.entries[i];
 909 #endif
 910
 911         // match only if the event type is the same and the id is either -1 in
 912         // the event table (meaning "any") or the event id matches the id
 913         // specified in the event table either exactly or by falling into
 914         // range between first and last
 915         if ( eventType == entry.m_eventType )
 916         {
 917             int tableId1 = entry.m_id,
 918                 tableId2 = entry.m_lastId;
 919
 920             if ( (tableId1 == -1) ||
 921                  (tableId2 == -1 && eventId == tableId1) ||
 922                  (tableId2 != -1 &&
 923                     (eventId >= tableId1 && eventId <= tableId2)) )
 924             {
 925                 event.Skip(FALSE);
 926                 event.m_callbackUserData = entry.m_callbackUserData;
 927
 928                 (this->*((wxEventFunction) (entry.m_fn)))(event);
 929
 930                 return !event.GetSkipped();
 931             }
 932         }
 933     }
 934
 935     return FALSE;
 936 }
 937
 938 void wxEvtHandler::Connect( int id, int lastId,
 939                             int eventType,
 940                             wxObjectEventFunction func,
 941                             wxObject *userData )
 942 {
 943 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 944     wxEventTableEntry *entry = new wxEventTableEntry;
 945     entry->m_eventType = eventType;
 946     entry->m_id = id;
 947     entry->m_lastId = lastId;
 948     entry->m_fn = func;
 949     entry->m_callbackUserData = userData;
 950 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 951     wxDynamicEventTableEntry *entry =
 952         new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
 953 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 954
 955     if (!m_dynamicEvents)
 956         m_dynamicEvents = new wxList;
 957
 958     m_dynamicEvents->Append( (wxObject*) entry );
 959 }
 960
 961 bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
 962                   wxObjectEventFunction func,
 963                   wxObject *userData )
 964 {
 965     if (!m_dynamicEvents)
 966         return FALSE;
 967
 968     wxNode *node = m_dynamicEvents->First();
 969     while (node)
 970     {
 971 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 972             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
 973 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 974             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
 975 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 976
 977         if ((entry->m_id == id) &&
 978             ((entry->m_lastId == lastId) || (lastId == -1)) &&
 979             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
 980             ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
 981             ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
 982         {
 983             if (entry->m_callbackUserData)
 984                 delete entry->m_callbackUserData;
 985             m_dynamicEvents->DeleteNode( node );
 986             delete entry;
 987             return TRUE;
 988         }
 989         node = node->Next();
 990     }
 991     return FALSE;
 992 }
 993
 994 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
 995 {
 996     wxCHECK_MSG( m_dynamicEvents, FALSE,
 997                  wxT("caller should check that we have dynamic events") );
 998
 999     int commandId = event.GetId();
1000
1001     wxNode *node = m_dynamicEvents->First();
1002     while (node)
1003     {
1004 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1005             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
1006 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1007             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
1008 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1009
1010         if (entry->m_fn)
1011         {
1012             // Match, if event spec says any id will do (id == -1)
1013             if ( (event.GetEventType() == entry->m_eventType) &&
1014                  (entry->m_id == -1 ||
1015                   (entry->m_lastId == -1 && commandId == entry->m_id) ||
1016                   (entry->m_lastId != -1 &&
1017                   (commandId >= entry->m_id && commandId <= entry->m_lastId))) )
1018             {
1019                 event.Skip(FALSE);
1020                 event.m_callbackUserData = entry->m_callbackUserData;
1021
1022                 (this->*((wxEventFunction) (entry->m_fn)))(event);
1023
1024                 if (event.GetSkipped())
1025                     return FALSE;
1026                 else
1027                     return TRUE;
1028             }
1029         }
1030         node = node->Next();
1031     }
1032     return FALSE;
1033 };
1034
1035 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1036 {
1037     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1038                   wxT("can't have both object and void client data") );
1039
1040     if ( m_clientObject )
1041         delete m_clientObject;
1042
1043     m_clientObject = data;
1044     m_clientDataType = wxClientData_Object;
1045 }
1046
1047 wxClientData *wxEvtHandler::DoGetClientObject() const
1048 {
1049     // it's not an error to call GetClientObject() on a window which doesn't
1050     // have client data at all - NULL will be returned
1051     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1052                   wxT("this window doesn't have object client data") );
1053
1054     return m_clientObject;
1055 }
1056
1057 void wxEvtHandler::DoSetClientData( void *data )
1058 {
1059     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1060                   wxT("can't have both object and void client data") );
1061
1062     m_clientData = data;
1063     m_clientDataType = wxClientData_Void;
1064 }
1065
1066 void *wxEvtHandler::DoGetClientData() const
1067 {
1068     // it's not an error to call GetClientData() on a window which doesn't have
1069     // client data at all - NULL will be returned
1070     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1071                   wxT("this window doesn't have void client data") );
1072
1073     return m_clientData;
1074 }
1075
1076
1077 #if WXWIN_COMPATIBILITY
1078 bool wxEvtHandler::OnClose()
1079 {
1080     if (GetNextHandler())
1081         return GetNextHandler()->OnClose();
1082     else
1083         return FALSE;
1084 }
1085 #endif // WXWIN_COMPATIBILITY
1086
1087 #if wxUSE_GUI
1088
1089 // Find a window with the focus, that is also a descendant of the given window.
1090 // This is used to determine the window to initially send commands to.
1091 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1092 {
1093     // Process events starting with the window with the focus, if any.
1094     wxWindow* focusWin = wxWindow::FindFocus();
1095     wxWindow* win = focusWin;
1096
1097     // Check if this is a descendant of this frame.
1098     // If not, win will be set to NULL.
1099     while (win)
1100     {
1101         if (win == ancestor)
1102             break;
1103         else
1104             win = win->GetParent();
1105     }
1106     if (win == (wxWindow*) NULL)
1107         focusWin = (wxWindow*) NULL;
1108
1109     return focusWin;
1110 }
1111
1112 #endif // wxUSE_GUI