Rework the wxCusor ctor taking wx stock number to provide as many cursors as

[wxWidgets.git] / src / common / event.cpp

diff --git a/src/common/event.cpp b/src/common/event.cpp
index 8b74ef2a817b5f275b1561070a5894c5a18df4d1..d0c22a72d1f226f6a5dc890a5bc0a4c574ea064e 100644 (file)
--- a/src/common/event.cpp
+++ b/src/common/event.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        event.cpp
+// Name:        src/common/event.cpp

 // Purpose:     Event classes
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     Event classes
 // Author:      Julian Smart
 // Modified by:


@@ -24,29 +24,23 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/event.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/defs.h"
-    #include "wx/app.h"

     #include "wx/list.h"
     #include "wx/list.h"

+    #include "wx/app.h"
+    #include "wx/utils.h"
+    #include "wx/stopwatch.h"
+    #include "wx/module.h"

 
     #if wxUSE_GUI
         #include "wx/control.h"
 
     #if wxUSE_GUI
         #include "wx/control.h"

-        #include "wx/utils.h"

         #include "wx/dc.h"
         #include "wx/textctrl.h"
         #include "wx/dc.h"
         #include "wx/textctrl.h"

+        #include "wx/validate.h"

     #endif // wxUSE_GUI
 #endif
 
     #endif // wxUSE_GUI
 #endif
 

-#include "wx/event.h"
-#include "wx/module.h"
-
-#if wxUSE_GUI
-    #include "wx/validate.h"
-#if wxUSE_STOPWATCH
-    #include "wx/stopwatch.h"
-#endif
-#endif // wxUSE_GUI
-

 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------


@@ -54,10 +48,10 @@
 #if wxUSE_BASE
     IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
     IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
 #if wxUSE_BASE
     IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
     IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)

+    IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)

 #endif // wxUSE_BASE
 
 #if wxUSE_GUI
 #endif // wxUSE_BASE
 
 #if wxUSE_GUI

-    IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)

     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)


@@ -92,6 +86,8 @@
     IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)

+    IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)

 #endif // wxUSE_GUI
 
 #if wxUSE_BASE
 #endif // wxUSE_GUI
 
 #if wxUSE_BASE


@@ -111,22 +107,26 @@ const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
     { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
 
 
     { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
 
 

-#ifdef __WXDEBUG__
-// Clear up event hash table contents or we can get problems
-// when C++ is cleaning up the static object
+// wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
+// leaked, so we need to manually clean up all event tables before checking for
+// the memory leaks when using it, however this breaks re-initializing the
+// library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
+// event tables won't be rebuilt the next time, so disable this by default
+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING 
+

 class wxEventTableEntryModule: public wxModule
 {
 class wxEventTableEntryModule: public wxModule
 {

-DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)

 public:
 public:

-    wxEventTableEntryModule() {}
-    bool OnInit() { return true; }
-    void OnExit()
-    {
-        wxEventHashTable::ClearAll();
-    }
+    wxEventTableEntryModule() { }
+    virtual bool OnInit() { return true; }
+    virtual void OnExit() { wxEventHashTable::ClearAll(); }
+
+    DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)

 };
 };

+

 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)

-#endif
+
+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING

 
 // ----------------------------------------------------------------------------
 // global variables
 
 // ----------------------------------------------------------------------------
 // global variables


@@ -151,6 +151,7 @@ const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
 DEFINE_EVENT_TYPE(wxEVT_NULL)
 DEFINE_EVENT_TYPE(wxEVT_IDLE)
 DEFINE_EVENT_TYPE(wxEVT_SOCKET)
 DEFINE_EVENT_TYPE(wxEVT_NULL)
 DEFINE_EVENT_TYPE(wxEVT_IDLE)
 DEFINE_EVENT_TYPE(wxEVT_SOCKET)

+DEFINE_EVENT_TYPE(wxEVT_TIMER)

 
 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 
 
 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 


@@ -176,9 +177,7 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)

-
-// Sockets and timers send events, too
-DEFINE_EVENT_TYPE(wxEVT_TIMER)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED)

 
 // Mouse event types
 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
 
 // Mouse event types
 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)


@@ -264,6 +263,7 @@ DEFINE_EVENT_TYPE(wxEVT_SHOW)
 DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
 DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)

+DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST)

 DEFINE_EVENT_TYPE(wxEVT_PAINT)
 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
 DEFINE_EVENT_TYPE(wxEVT_PAINT)
 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)


@@ -288,6 +288,11 @@ DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM)
 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
 
 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
 

+// Clipboard events
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE)
+

 // Generic command events
 // Note: a click is a higher-level event than button down/up
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
 // Generic command events
 // Note: a click is a higher-level event than button down/up
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)


@@ -308,6 +313,8 @@ DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
 
 #if wxUSE_BASE
 
 
 #if wxUSE_BASE
 

+wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -350,7 +357,7 @@ wxEvent::wxEvent(int theId, wxEventType commandType )
 }
 
 wxEvent::wxEvent(const wxEvent &src)
 }
 
 wxEvent::wxEvent(const wxEvent &src)

-    : wxObject()
+    : wxObject(src)

     , m_eventObject(src.m_eventObject)
     , m_eventType(src.m_eventType)
     , m_timeStamp(src.m_timeStamp)
     , m_eventObject(src.m_eventObject)
     , m_eventType(src.m_eventType)
     , m_timeStamp(src.m_timeStamp)


@@ -378,9 +385,6 @@ wxEvent::wxEvent(const wxEvent &src)
 
 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
               : wxEvent(theId, commandType)
 
 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
               : wxEvent(theId, commandType)

-#if WXWIN_COMPATIBILITY_2_4
-              , m_commandString(this)
-#endif

 {
     m_clientData = (char *) NULL;
     m_clientObject = (wxClientData *) NULL;
 {
     m_clientData = (char *) NULL;
     m_clientObject = (wxClientData *) NULL;


@@ -471,25 +475,6 @@ void wxUpdateUIEvent::ResetUpdateTime()
 #endif
 }
 
 #endif
 }
 

-/*
- * Idle events
- */
-
-wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
-
-// Can we send an idle event?
-bool wxIdleEvent::CanSend(wxWindow* win)
-{
-    // Don't update if we've switched global updating off
-    // and this window doesn't support updates.
-    if (win &&
-       (GetMode() == wxIDLE_PROCESS_SPECIFIED &&
-       ((win->GetExtraStyle() & wxWS_EX_PROCESS_IDLE) == 0)))
-        return false;
-
-    return true;
-}
-

 /*
  * Scroll events
  */
 /*
  * Scroll events
  */


@@ -537,6 +522,7 @@ wxMouseEvent::wxMouseEvent(wxEventType commandType)
     m_wheelRotation = 0;
     m_wheelDelta = 0;
     m_linesPerAction = 0;
     m_wheelRotation = 0;
     m_wheelDelta = 0;
     m_linesPerAction = 0;

+    m_wheelAxis = 0;

 }
 
 void wxMouseEvent::Assign(const wxMouseEvent& event)
 }
 
 void wxMouseEvent::Assign(const wxMouseEvent& event)


@@ -558,6 +544,7 @@ void wxMouseEvent::Assign(const wxMouseEvent& event)
     m_wheelRotation = event.m_wheelRotation;
     m_wheelDelta = event.m_wheelDelta;
     m_linesPerAction = event.m_linesPerAction;
     m_wheelRotation = event.m_wheelRotation;
     m_wheelDelta = event.m_wheelDelta;
     m_linesPerAction = event.m_linesPerAction;

+    m_wheelAxis = event.m_wheelAxis;

 }
 
 // return true if was a button dclick event
 }
 
 // return true if was a button dclick event


@@ -737,10 +724,12 @@ wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
 #endif
 }
 
 #endif
 }
 

+#if WXWIN_COMPATIBILITY_2_6

 long wxKeyEvent::KeyCode() const
 {
     return m_keyCode;
 }
 long wxKeyEvent::KeyCode() const
 {
     return m_keyCode;
 }

+#endif // WXWIN_COMPATIBILITY_2_6

 
 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 {
 
 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
 {


@@ -760,6 +749,23 @@ wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
     SetEventObject(win);
 }
 
     SetEventObject(win);
 }
 

+// ----------------------------------------------------------------------------
+// wxHelpEvent
+// ----------------------------------------------------------------------------
+
+/* static */
+wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
+{
+    if ( origin == Origin_Unknown )
+    {
+        // assume that the event comes from the help button if it's not from
+        // keyboard and that pressing F1 always results in the help event
+        origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
+    }
+
+    return origin;
+}
+

 #endif // wxUSE_GUI
 
 
 #endif // wxUSE_GUI
 
 


@@ -799,25 +805,20 @@ wxEventHashTable::~wxEventHashTable()
 
 void wxEventHashTable::Clear()
 {
 
 void wxEventHashTable::Clear()
 {

-    size_t i;
-    for(i = 0; i < m_size; i++)
+    for ( size_t i = 0; i < m_size; i++ )

     {
         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];
     {
         EventTypeTablePointer  eTTnode = m_eventTypeTable[i];

-        if (eTTnode)
-        {
-            delete eTTnode;
-        }
+        delete eTTnode;

     }
 
     }
 

-    // Necessary in order to not invoke the
-    // overloaded delete operator when statics are cleaned up
-    if (m_eventTypeTable)
-        delete[] m_eventTypeTable;
-
+    delete[] m_eventTypeTable;

     m_eventTypeTable = NULL;
     m_eventTypeTable = NULL;

+

     m_size = 0;
 }
 
     m_size = 0;
 }
 

+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING 
+

 // Clear all tables
 void wxEventHashTable::ClearAll()
 {
 // Clear all tables
 void wxEventHashTable::ClearAll()
 {


@@ -829,6 +830,8 @@ void wxEventHashTable::ClearAll()
     }
 }
 
     }
 }
 

+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
+

 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
 {
     if (m_rebuildHash)
 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
 {
     if (m_rebuildHash)


@@ -990,6 +993,7 @@ wxEvtHandler::wxEvtHandler()
     m_eventsLocker = new wxCriticalSection;
 #  endif
 #endif
     m_eventsLocker = new wxCriticalSection;
 #  endif
 #endif

+    

     // no client data (yet)
     m_clientData = NULL;
     m_clientDataType = wxClientData_None;
     // no client data (yet)
     m_clientData = NULL;
     m_clientDataType = wxClientData_None;


@@ -1006,9 +1010,10 @@ wxEvtHandler::~wxEvtHandler()
 
     if (m_dynamicEvents)
     {
 
     if (m_dynamicEvents)
     {

-        wxList::iterator it = m_dynamicEvents->begin(),
-                         en = m_dynamicEvents->end();
-        for (;it != en; ++it)
+        for ( wxList::iterator it = m_dynamicEvents->begin(),
+                               end = m_dynamicEvents->end();
+              it != end;
+              ++it )

         {
 #if WXWIN_COMPATIBILITY_EVENT_TYPES
             wxEventTableEntry *entry = (wxEventTableEntry*)*it;
         {
 #if WXWIN_COMPATIBILITY_EVENT_TYPES
             wxEventTableEntry *entry = (wxEventTableEntry*)*it;


@@ -1051,7 +1056,7 @@ wxEvtHandler::~wxEvtHandler()
 
 #if wxUSE_THREADS
 
 
 #if wxUSE_THREADS
 

-bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
+bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)

 {
     // check that we are really in a child thread
     wxASSERT_MSG( !wxThread::IsMain(),
 {
     // check that we are really in a child thread
     wxASSERT_MSG( !wxThread::IsMain(),


@@ -1072,7 +1077,7 @@ void wxEvtHandler::ClearEventLocker()
 
 #endif // wxUSE_THREADS
 
 
 #endif // wxUSE_THREADS
 

-void wxEvtHandler::AddPendingEvent(wxEvent& event)
+void wxEvtHandler::AddPendingEvent(const wxEvent& event)

 {
     // 1) Add event to list of pending events of this event handler
 
 {
     // 1) Add event to list of pending events of this event handler
 


@@ -1110,11 +1115,11 @@ void wxEvtHandler::AddPendingEvent(wxEvent& event)
 
 void wxEvtHandler::ProcessPendingEvents()
 {
 
 void wxEvtHandler::ProcessPendingEvents()
 {

-    // this method is only called by wxApp if this handler does have pending
-    // events
+    // this method is only called by wxApp if this handler does have
+    // pending events

     wxCHECK_RET( m_pendingEvents,
                  wxT("Please call wxApp::ProcessPendingEvents() instead") );
     wxCHECK_RET( m_pendingEvents,
                  wxT("Please call wxApp::ProcessPendingEvents() instead") );

-
+    

     wxENTER_CRIT_SECT( Lock() );
 
     // we leave the loop once we have processed all events that were present at
     wxENTER_CRIT_SECT( Lock() );
 
     // we leave the loop once we have processed all events that were present at


@@ -1131,16 +1136,18 @@ void wxEvtHandler::ProcessPendingEvents()
         // It's importan we remove event from list before processing it.
         // Else a nested event loop, for example from a modal dialog, might
         // process the same event again.
         // It's importan we remove event from list before processing it.
         // Else a nested event loop, for example from a modal dialog, might
         // process the same event again.

+

         m_pendingEvents->Erase(node);
 
         wxLEAVE_CRIT_SECT( Lock() );
 
         ProcessEvent(*event);
         m_pendingEvents->Erase(node);
 
         wxLEAVE_CRIT_SECT( Lock() );
 
         ProcessEvent(*event);

+

         delete event;
 
         wxENTER_CRIT_SECT( Lock() );
 
         delete event;
 
         wxENTER_CRIT_SECT( Lock() );
 

-        if ( !--n )
+        if ( --n == 0 )

             break;
     }
 
             break;
     }
 


@@ -1245,8 +1252,10 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
     // Try going down the event handler chain
     if ( GetNextHandler() )
     {
     // Try going down the event handler chain
     if ( GetNextHandler() )
     {

-        if ( GetNextHandler()->ProcessEvent(event) )
-            return true;
+        // notice that we shouldn't let the parent have the event even if the
+        // next handler does not process it because it will have already passed
+        // it to the parent in this case
+        return GetNextHandler()->ProcessEvent(event);

     }
 
     // Finally propagate the event upwards the window chain and/or to the
     }
 
     // Finally propagate the event upwards the window chain and/or to the


@@ -1345,6 +1354,10 @@ bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 
         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 

+        // get next node before (maybe) calling the event handler as it could
+        // call Disconnect() invalidating the current node
+        node = node->GetNext();
+

         if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
         {
             wxEvtHandler *handler =
         if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
         {
             wxEvtHandler *handler =


@@ -1359,8 +1372,6 @@ bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
                 return true;
             }
         }
                 return true;
             }
         }

-
-        node = node->GetNext();

     }
 
     return false;
     }
 
     return false;


@@ -1434,4 +1445,38 @@ wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
     return focusWin;
 }
 
     return focusWin;
 }
 

+// ----------------------------------------------------------------------------
+// wxEventBlocker
+// ----------------------------------------------------------------------------
+
+wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
+{
+    wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
+
+    m_window = win;
+
+    Block(type);
+    m_window->PushEventHandler(this);
+}
+
+wxEventBlocker::~wxEventBlocker()
+{
+    wxEvtHandler *popped = m_window->PopEventHandler(false);
+    wxCHECK_RET(popped == this, 
+        wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
+}
+
+bool wxEventBlocker::ProcessEvent(wxEvent& event)
+{
+    // should this event be blocked?
+    for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
+    {
+        wxEventType t = (wxEventType)m_eventsToBlock[i];
+        if ( t == wxEVT_ANY || t == event.GetEventType() )
+            return true;   // yes, it should: mark this event as processed
+    }
+
+    return false;
+}
+

 #endif // wxUSE_GUI
 #endif // wxUSE_GUI