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