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