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 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 575 {
 576     SetEventType(wxEVT_CREATE);
 577     SetEventObject(win);
 578 }
 579
 580 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
 581 {
 582     SetEventType(wxEVT_DESTROY);
 583     SetEventObject(win);
 584 }
 585
 586 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
 587                  : wxCommandEvent(wxEVT_CHILD_FOCUS)
 588 {
 589     SetEventObject(win);
 590 }
 591
 592 #endif // wxUSE_GUI
 593
 594 // ----------------------------------------------------------------------------
 595 // wxEvtHandler
 596 // ----------------------------------------------------------------------------
 597
 598 /*
 599  * Event handler
 600  */
 601
 602 wxEvtHandler::wxEvtHandler()
 603 {
 604     m_nextHandler = (wxEvtHandler *) NULL;
 605     m_previousHandler = (wxEvtHandler *) NULL;
 606     m_enabled = TRUE;
 607     m_dynamicEvents = (wxList *) NULL;
 608     m_isWindow = FALSE;
 609     m_pendingEvents = (wxList *) NULL;
 610 #if wxUSE_THREADS
 611 #  if !defined(__VISAGECPP__)
 612     m_eventsLocker = new wxCriticalSection;
 613 #  endif
 614 #endif
 615     // no client data (yet)
 616     m_clientData = NULL;
 617     m_clientDataType = wxClientData_None;
 618 }
 619
 620 wxEvtHandler::~wxEvtHandler()
 621 {
 622     // Takes itself out of the list of handlers
 623     if (m_previousHandler)
 624         m_previousHandler->m_nextHandler = m_nextHandler;
 625
 626     if (m_nextHandler)
 627         m_nextHandler->m_previousHandler = m_previousHandler;
 628
 629     if (m_dynamicEvents)
 630     {
 631         wxNode *node = m_dynamicEvents->First();
 632         while (node)
 633         {
 634 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 635             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
 636 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 637             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
 638 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 639
 640             if (entry->m_callbackUserData)
 641                 delete entry->m_callbackUserData;
 642             delete entry;
 643             node = node->Next();
 644         }
 645         delete m_dynamicEvents;
 646     };
 647
 648     delete m_pendingEvents;
 649
 650 #if wxUSE_THREADS
 651 #  if !defined(__VISAGECPP__)
 652     delete m_eventsLocker;
 653 #  endif
 654 #endif
 655
 656     // we only delete object data, not untyped
 657     if ( m_clientDataType == wxClientData_Object )
 658         delete m_clientObject;
 659 }
 660
 661 #if wxUSE_THREADS
 662
 663 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
 664 {
 665     // check that we are really in a child thread
 666     wxASSERT_MSG( !wxThread::IsMain(),
 667                   wxT("use ProcessEvent() in main thread") );
 668
 669     AddPendingEvent(event);
 670
 671     return TRUE;
 672 }
 673
 674 #endif // wxUSE_THREADS
 675
 676 void wxEvtHandler::AddPendingEvent(wxEvent& event)
 677 {
 678     // 1) Add event to list of pending events of this event handler
 679
 680     wxEvent *eventCopy = event.Clone();
 681
 682     // we must be able to copy the events here so the event class must
 683     // implement Clone() properly instead of just providing a NULL stab for it
 684     wxCHECK_RET( eventCopy,
 685                  _T("events of this type aren't supposed to be posted") );
 686
 687 #if defined(__VISAGECPP__)
 688     wxENTER_CRIT_SECT( m_eventsLocker);
 689 #else
 690     wxENTER_CRIT_SECT( *m_eventsLocker);
 691 #endif
 692
 693     if ( !m_pendingEvents )
 694       m_pendingEvents = new wxList;
 695
 696     m_pendingEvents->Append(eventCopy);
 697
 698 #if defined(__VISAGECPP__)
 699     wxLEAVE_CRIT_SECT( m_eventsLocker);
 700 #else
 701     wxLEAVE_CRIT_SECT( *m_eventsLocker);
 702 #endif
 703
 704     // 2) Add this event handler to list of event handlers that
 705     //    have pending events.
 706
 707     wxENTER_CRIT_SECT(*wxPendingEventsLocker);
 708
 709     if ( !wxPendingEvents )
 710         wxPendingEvents = new wxList;
 711     wxPendingEvents->Append(this);
 712
 713     wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
 714
 715     // 3) Inform the system that new pending events are somwehere,
 716     //    and that these should be processed in idle time.
 717     wxWakeUpIdle();
 718 }
 719
 720 void wxEvtHandler::ProcessPendingEvents()
 721 {
 722 #if defined(__VISAGECPP__)
 723     wxENTER_CRIT_SECT( m_eventsLocker);
 724 #else
 725     wxENTER_CRIT_SECT( *m_eventsLocker);
 726 #endif
 727
 728     wxNode *node = m_pendingEvents->First();
 729     while ( node )
 730     {
 731         wxEvent *event = (wxEvent *)node->Data();
 732         delete node;
 733
 734         // In ProcessEvent, new events might get added and
 735         // we can safely leave the crtical section here.
 736 #if defined(__VISAGECPP__)
 737         wxLEAVE_CRIT_SECT( m_eventsLocker);
 738 #else
 739         wxLEAVE_CRIT_SECT( *m_eventsLocker);
 740 #endif
 741         ProcessEvent(*event);
 742         delete event;
 743 #if defined(__VISAGECPP__)
 744         wxENTER_CRIT_SECT( m_eventsLocker);
 745 #else
 746         wxENTER_CRIT_SECT( *m_eventsLocker);
 747 #endif
 748
 749         node = m_pendingEvents->First();
 750     }
 751
 752 #if defined(__VISAGECPP__)
 753     wxLEAVE_CRIT_SECT( m_eventsLocker);
 754 #else
 755     wxLEAVE_CRIT_SECT( *m_eventsLocker);
 756 #endif
 757 }
 758
 759 /*
 760  * Event table stuff
 761  */
 762
 763 bool wxEvtHandler::ProcessEvent(wxEvent& event)
 764 {
 765 #if wxUSE_GUI
 766
 767     // We have to use the actual window or processing events from
 768     // wxWindowNative destructor won't work (we don't see the wxWindow class)
 769 #ifdef __WXDEBUG__
 770     // check that our flag corresponds to reality
 771     wxClassInfo* info = NULL;
 772 #ifdef __WXUNIVERSAL__
 773 #  if defined(__WXMSW__)
 774     info = CLASSINFO(wxWindowMSW);
 775 #  elif defined(__WXGTK__)
 776     info = CLASSINFO(wxWindowGTK);
 777 #  elif defined(__WXX11__)
 778     info = CLASSINFO(wxWindowX11);
 779 #  elif defined(__WXMGL__)
 780     info = CLASSINFO(wxWindowMGL);
 781 #  elif defined(__WXPM__)
 782     info = CLASSINFO(wxWindowOS2);
 783 #  elif defined(__WXMAC__)
 784     info = CLASSINFO(wxWindowMac);
 785 #  elif defined(__WXMOTIF__)
 786     info = CLASSINFO(wxWindowMotif);
 787 #  endif
 788 #else
 789     info = CLASSINFO(wxWindow);
 790 #endif
 791
 792     if ( m_isWindow != IsKindOf(info) )
 793     {
 794         wxString msg = GetClassInfo()->GetClassName();
 795         msg += _T(" should [not] be a window but it is [not]");
 796
 797         wxFAIL_MSG( msg );
 798     }
 799
 800 #endif // __WXDEBUG__
 801
 802 #endif // wxUSE_GUI
 803
 804     // allow the application to hook into event processing
 805     if ( wxTheApp )
 806     {
 807         int rc = wxTheApp->FilterEvent(event);
 808         if ( rc != -1 )
 809         {
 810             wxASSERT_MSG( rc == 1 || rc == 0,
 811                           _T("unexpected wxApp::FilterEvent return value") );
 812
 813             return rc != 0;
 814         }
 815         //else: proceed normally
 816     }
 817
 818     // An event handler can be enabled or disabled
 819     if ( GetEvtHandlerEnabled() )
 820     {
 821
 822 #if 0
 823 /*
 824         What is this? When using GUI threads, a non main
 825         threads can send an event and process it itself.
 826         This breaks GTK's GUI threads, so please explain.
 827 */
 828
 829         // Check whether we are in a child thread.
 830         if ( !wxThread::IsMain() )
 831           return ProcessThreadEvent(event);
 832 #endif
 833
 834         // Handle per-instance dynamic event tables first
 835         if ( m_dynamicEvents && SearchDynamicEventTable(event) )
 836             return TRUE;
 837
 838         // Then static per-class event tables
 839         const wxEventTable *table = GetEventTable();
 840
 841 #if wxUSE_GUI && wxUSE_VALIDATORS
 842         // Try the associated validator first, if this is a window.
 843         // Problem: if the event handler of the window has been replaced,
 844         // this wxEvtHandler may no longer be a window.
 845         // Therefore validators won't be processed if the handler
 846         // has been replaced with SetEventHandler.
 847         // THIS CAN BE CURED if PushEventHandler is used instead of
 848         // SetEventHandler, and then processing will be passed down the
 849         // chain of event handlers.
 850         if (m_isWindow)
 851         {
 852             wxWindow *win = (wxWindow *)this;
 853
 854             // Can only use the validator of the window which
 855             // is receiving the event
 856             if ( win == event.GetEventObject() )
 857             {
 858                 wxValidator *validator = win->GetValidator();
 859                 if ( validator && validator->ProcessEvent(event) )
 860                 {
 861                     return TRUE;
 862                 }
 863             }
 864         }
 865 #endif
 866
 867         // Search upwards through the inheritance hierarchy
 868         while (table)
 869         {
 870             if ( SearchEventTable((wxEventTable&)*table, event) )
 871                 return TRUE;
 872             table = table->baseTable;
 873         }
 874     }
 875
 876     // Try going down the event handler chain
 877     if ( GetNextHandler() )
 878     {
 879         if ( GetNextHandler()->ProcessEvent(event) )
 880             return TRUE;
 881     }
 882
 883 #if wxUSE_GUI
 884     // Carry on up the parent-child hierarchy, but only if event is a command
 885     // event: it wouldn't make sense for a parent to receive a child's size
 886     // event, for example
 887     if ( m_isWindow && event.IsCommandEvent() )
 888     {
 889         wxWindow *win = (wxWindow *)this;
 890
 891         // honour the requests to stop propagation at this window: this is
 892         // used by the dialogs, for example, to prevent processing the events
 893         // from the dialog controls in the parent frame which rarely, if ever,
 894         // makes sense
 895         if ( !(win->GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
 896         {
 897             wxWindow *parent = win->GetParent();
 898             if ( parent && !parent->IsBeingDeleted() )
 899                 return parent->GetEventHandler()->ProcessEvent(event);
 900         }
 901     }
 902 #endif // wxUSE_GUI
 903
 904     // Last try - application object.
 905     if ( wxTheApp && (this != wxTheApp) )
 906     {
 907         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
 908         // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
 909         // processed appropriately via SearchEventTable.
 910         if ( event.GetEventType() != wxEVT_IDLE )
 911         {
 912             if ( wxTheApp->ProcessEvent(event) )
 913                 return TRUE;
 914         }
 915     }
 916
 917     return FALSE;
 918 }
 919
 920 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
 921 {
 922     wxEventType eventType = event.GetEventType();
 923     int eventId = event.GetId();
 924
 925     // BC++ doesn't like testing for m_fn without != 0
 926     for ( int i = 0; table.entries[i].m_fn != 0; i++ )
 927     {
 928         // the line using reference exposes a bug in gcc: although it _seems_
 929         // to work, it leads to weird crashes later on during program
 930         // execution
 931 #ifdef __GNUG__
 932         wxEventTableEntry entry = table.entries[i];
 933 #else
 934         const wxEventTableEntry& entry = table.entries[i];
 935 #endif
 936
 937         // match only if the event type is the same and the id is either -1 in
 938         // the event table (meaning "any") or the event id matches the id
 939         // specified in the event table either exactly or by falling into
 940         // range between first and last
 941         if ( eventType == entry.m_eventType )
 942         {
 943             int tableId1 = entry.m_id,
 944                 tableId2 = entry.m_lastId;
 945
 946             if ( (tableId1 == -1) ||
 947                  (tableId2 == -1 && eventId == tableId1) ||
 948                  (tableId2 != -1 &&
 949                     (eventId >= tableId1 && eventId <= tableId2)) )
 950             {
 951                 event.Skip(FALSE);
 952                 event.m_callbackUserData = entry.m_callbackUserData;
 953
 954                 (this->*((wxEventFunction) (entry.m_fn)))(event);
 955
 956                 return !event.GetSkipped();
 957             }
 958         }
 959     }
 960
 961     return FALSE;
 962 }
 963
 964 void wxEvtHandler::Connect( int id, int lastId,
 965                             int eventType,
 966                             wxObjectEventFunction func,
 967                             wxObject *userData )
 968 {
 969 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 970     wxEventTableEntry *entry = new wxEventTableEntry;
 971     entry->m_eventType = eventType;
 972     entry->m_id = id;
 973     entry->m_lastId = lastId;
 974     entry->m_fn = func;
 975     entry->m_callbackUserData = userData;
 976 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
 977     wxDynamicEventTableEntry *entry =
 978         new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
 979 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 980
 981     if (!m_dynamicEvents)
 982         m_dynamicEvents = new wxList;
 983
 984     m_dynamicEvents->Append( (wxObject*) entry );
 985 }
 986
 987 bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
 988                   wxObjectEventFunction func,
 989                   wxObject *userData )
 990 {
 991     if (!m_dynamicEvents)
 992         return FALSE;
 993
 994     wxNode *node = m_dynamicEvents->First();
 995     while (node)
 996     {
 997 #if WXWIN_COMPATIBILITY_EVENT_TYPES
 998             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
 999 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1000             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
1001 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1002
1003         if ((entry->m_id == id) &&
1004             ((entry->m_lastId == lastId) || (lastId == -1)) &&
1005             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1006             ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
1007             ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
1008         {
1009             if (entry->m_callbackUserData)
1010                 delete entry->m_callbackUserData;
1011             m_dynamicEvents->DeleteNode( node );
1012             delete entry;
1013             return TRUE;
1014         }
1015         node = node->Next();
1016     }
1017     return FALSE;
1018 }
1019
1020 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1021 {
1022     wxCHECK_MSG( m_dynamicEvents, FALSE,
1023                  wxT("caller should check that we have dynamic events") );
1024
1025     int commandId = event.GetId();
1026
1027     wxNode *node = m_dynamicEvents->First();
1028     while (node)
1029     {
1030 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1031             wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
1032 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1033             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
1034 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1035
1036         if (entry->m_fn)
1037         {
1038             // Match, if event spec says any id will do (id == -1)
1039             if ( (event.GetEventType() == entry->m_eventType) &&
1040                  (entry->m_id == -1 ||
1041                   (entry->m_lastId == -1 && commandId == entry->m_id) ||
1042                   (entry->m_lastId != -1 &&
1043                   (commandId >= entry->m_id && commandId <= entry->m_lastId))) )
1044             {
1045                 event.Skip(FALSE);
1046                 event.m_callbackUserData = entry->m_callbackUserData;
1047
1048                 (this->*((wxEventFunction) (entry->m_fn)))(event);
1049
1050                 if (event.GetSkipped())
1051                     return FALSE;
1052                 else
1053                     return TRUE;
1054             }
1055         }
1056         node = node->Next();
1057     }
1058     return FALSE;
1059 };
1060
1061 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1062 {
1063     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1064                   wxT("can't have both object and void client data") );
1065
1066     if ( m_clientObject )
1067         delete m_clientObject;
1068
1069     m_clientObject = data;
1070     m_clientDataType = wxClientData_Object;
1071 }
1072
1073 wxClientData *wxEvtHandler::DoGetClientObject() const
1074 {
1075     // it's not an error to call GetClientObject() on a window which doesn't
1076     // have client data at all - NULL will be returned
1077     wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1078                   wxT("this window doesn't have object client data") );
1079
1080     return m_clientObject;
1081 }
1082
1083 void wxEvtHandler::DoSetClientData( void *data )
1084 {
1085     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1086                   wxT("can't have both object and void client data") );
1087
1088     m_clientData = data;
1089     m_clientDataType = wxClientData_Void;
1090 }
1091
1092 void *wxEvtHandler::DoGetClientData() const
1093 {
1094     // it's not an error to call GetClientData() on a window which doesn't have
1095     // client data at all - NULL will be returned
1096     wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1097                   wxT("this window doesn't have void client data") );
1098
1099     return m_clientData;
1100 }
1101
1102
1103 #if WXWIN_COMPATIBILITY
1104 bool wxEvtHandler::OnClose()
1105 {
1106     if (GetNextHandler())
1107         return GetNextHandler()->OnClose();
1108     else
1109         return FALSE;
1110 }
1111 #endif // WXWIN_COMPATIBILITY
1112
1113 #if wxUSE_GUI
1114
1115 // Find a window with the focus, that is also a descendant of the given window.
1116 // This is used to determine the window to initially send commands to.
1117 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1118 {
1119     // Process events starting with the window with the focus, if any.
1120     wxWindow* focusWin = wxWindow::FindFocus();
1121     wxWindow* win = focusWin;
1122
1123     // Check if this is a descendant of this frame.
1124     // If not, win will be set to NULL.
1125     while (win)
1126     {
1127         if (win == ancestor)
1128             break;
1129         else
1130             win = win->GetParent();
1131     }
1132     if (win == (wxWindow*) NULL)
1133         focusWin = (wxWindow*) NULL;
1134
1135     return focusWin;
1136 }
1137
1138 #endif // wxUSE_GUI