]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/event.cpp
Added chapter on collection and container classes to contents
[wxWidgets.git] / src / common / event.cpp
index 1b71ae091290f6de885dfd848a8067281bdaa1f9..3ace246251136bc2af953944ede28d1f2c09eb7a 100644 (file)
 // wxWin macros
 // ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
-    IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
-    IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
+IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
+IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
+IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
 
-    #if wxUSE_GUI
-        IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
-        IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
-    #endif // wxUSE_GUI
+#if wxUSE_GUI
+    IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
+#endif // wxUSE_GUI
 
-    const wxEventTable *wxEvtHandler::GetEventTable() const
-        { return &wxEvtHandler::sm_eventTable; }
+const wxEventTable *wxEvtHandler::GetEventTable() const
+    { return &wxEvtHandler::sm_eventTable; }
 
-    const wxEventTable wxEvtHandler::sm_eventTable =
-        { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
+const wxEventTable wxEvtHandler::sm_eventTable =
+    { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
 
-    const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
-        { { 0, 0, 0, (wxObjectEventFunction) NULL, (wxObject*) NULL } };
+const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
+    { { 0, 0, 0, (wxObjectEventFunction) NULL, (wxObject*) NULL } };
 
-#endif // !USE_SHARED_LIBRARY
 
 // ----------------------------------------------------------------------------
 // global variables
@@ -175,10 +173,24 @@ void wxCommandEvent::CopyObject(wxObject& obj_d) const
 
     wxEvent::CopyObject(obj_d);
 
-    obj->m_clientData   = m_clientData;
-    obj->m_clientObject = m_clientObject;
-    obj->m_extraLong    = m_extraLong;
-    obj->m_commandInt   = m_commandInt;
+    obj->m_clientData    = m_clientData;
+    obj->m_clientObject  = m_clientObject;
+    obj->m_extraLong     = m_extraLong;
+    obj->m_commandInt    = m_commandInt;
+    obj->m_commandString = m_commandString;
+}
+
+/*
+ * Notify events
+ */
+
+void wxNotifyEvent::CopyObject(wxObject& obj_d) const
+{
+    wxNotifyEvent *obj = (wxNotifyEvent *)&obj_d;
+
+    wxEvent::CopyObject(obj_d);
+
+    if (!m_bAllow) obj->Veto();
 }
 
 /*
@@ -382,6 +394,10 @@ void wxKeyEvent::CopyObject(wxObject& obj_d) const
     wxKeyEvent *obj = (wxKeyEvent *)&obj_d;
     wxEvent::CopyObject(obj_d);
 
+    obj->m_x = m_x;
+    obj->m_y = m_y;
+    obj->m_keyCode = m_keyCode;
+    
     obj->m_shiftDown   = m_shiftDown;
     obj->m_controlDown = m_controlDown;
     obj->m_metaDown    = m_metaDown;
@@ -508,14 +524,14 @@ void wxQueryNewPaletteEvent::CopyObject(wxObject& obj_d) const
 }
 
 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
-                   : wxEvent(wxEVT_CREATE)
 {
+    SetEventType(wxEVT_CREATE);
     SetEventObject(win);
 }
 
 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
-                    : wxEvent(wxEVT_DESTROY)
 {
+    SetEventType(wxEVT_DESTROY);
     SetEventObject(win);
 }
 
@@ -542,7 +558,9 @@ wxEvtHandler::wxEvtHandler()
     m_isWindow = FALSE;
     m_pendingEvents = (wxList *) NULL;
 #if wxUSE_THREADS
+#  if !defined(__VISAGECPP__)
     m_eventsLocker = new wxCriticalSection;
+#  endif
 #endif
 }
 
@@ -571,7 +589,9 @@ wxEvtHandler::~wxEvtHandler()
     delete m_pendingEvents;
 
 #if wxUSE_THREADS
+#  if !defined(__VISAGECPP__)
     delete m_eventsLocker;
+#  endif
 #endif
 }
 
@@ -579,8 +599,6 @@ wxEvtHandler::~wxEvtHandler()
 
 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
 {
-    wxCriticalSectionLocker locker(*m_eventsLocker);
-
     // check that we are really in a child thread
     wxASSERT_MSG( !wxThread::IsMain(),
                   wxT("use ProcessEvent() in main thread") );
@@ -594,6 +612,14 @@ bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
 
 void wxEvtHandler::AddPendingEvent(wxEvent& event)
 {
+    // 1) Add event to list of pending events of this event handler
+
+#if defined(__VISAGECPP__)
+    wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+    wxENTER_CRIT_SECT( *m_eventsLocker);
+#endif
+
     if ( !m_pendingEvents )
       m_pendingEvents = new wxList;
 
@@ -601,42 +627,65 @@ void wxEvtHandler::AddPendingEvent(wxEvent& event)
 
     m_pendingEvents->Append(event2);
 
-    wxENTER_CRIT_SECT(wxPendingEventsLocker);
+#if defined(__VISAGECPP__)
+    wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+    wxLEAVE_CRIT_SECT( *m_eventsLocker);
+#endif
+
+    // 2) Add this event handler to list of event handlers that
+    //    have pending events.
+
+    wxENTER_CRIT_SECT(*wxPendingEventsLocker);
 
     if ( !wxPendingEvents )
         wxPendingEvents = new wxList;
     wxPendingEvents->Append(this);
 
-    wxLEAVE_CRIT_SECT(wxPendingEventsLocker);
-
-    // TODO: Wake up idle handler for the other platforms.
-#ifdef __WXGTK__
-    extern bool g_isIdle;
-    extern void wxapp_install_idle_handler();
-    if ( g_isIdle )
-        wxapp_install_idle_handler();
-#elif wxUSE_GUI // this works for wxMSW, but may be for others too?
-    // might also send a dummy message to the top level window, this would
-    // probably be cleaner?
-    wxIdleEvent eventIdle;
-    wxTheApp->OnIdle(eventIdle);
-#endif // platform
+    wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
+    
+    // 3) Inform the system that new pending events are somwehere,
+    //    and that these should be processed in idle time.
+    wxWakeUpIdle();
 }
 
 void wxEvtHandler::ProcessPendingEvents()
 {
-    wxCRIT_SECT_LOCKER(locker, m_eventsLocker);
+#if defined(__VISAGECPP__)
+    wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+    wxENTER_CRIT_SECT( *m_eventsLocker);
+#endif
 
     wxNode *node = m_pendingEvents->First();
-    wxEvent *event;
-
     while ( node )
     {
-        event = (wxEvent *)node->Data();
-        ProcessEvent(*event);
+        wxEvent *event = (wxEvent *)node->Data();
         delete node;
+
+        // In ProcessEvent, new events might get added and
+           // we can safely leave the crtical section here.
+#if defined(__VISAGECPP__)
+        wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+        wxLEAVE_CRIT_SECT( *m_eventsLocker);
+#endif
+        ProcessEvent(*event);
+        delete event;
+#if defined(__VISAGECPP__)
+        wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+        wxENTER_CRIT_SECT( *m_eventsLocker);
+#endif
+
         node = m_pendingEvents->First();
     }
+
+#if defined(__VISAGECPP__)
+    wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+    wxLEAVE_CRIT_SECT( *m_eventsLocker);
+#endif
 }
 
 /*
@@ -653,11 +702,18 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
     // An event handler can be enabled or disabled
     if ( GetEvtHandlerEnabled() )
     {
-#if wxUSE_THREADS
+    
+#if 0
+/*
+        What is this? When using GUI threads, a non main
+        threads can send an event and process it itself.
+        This breaks GTK's GUI threads, so please explain.
+*/
+
         // Check whether we are in a child thread.
         if ( !wxThread::IsMain() )
           return ProcessThreadEvent(event);
-#endif // wxUSE_THREADS
+#endif
 
         // Handle per-instance dynamic event tables first
         if ( m_dynamicEvents && SearchDynamicEventTable(event) )
@@ -739,37 +795,48 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
 
 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
 {
-    int i = 0;
-    int commandId = event.GetId();
+    wxEventType eventType = event.GetEventType();
+    int eventId = event.GetId();
 
-    // BC++ doesn't like while (table.entries[i].m_fn)
-
-#ifdef __SC__
-    while (table.entries[i].m_fn != 0)
+    // BC++ doesn't like testing for m_fn without != 0
+    for ( int i = 0; table.entries[i].m_fn != 0; i++ )
+    {
+        // the line using reference exposes a bug in gcc: although it _seems_
+        // to work, it leads to weird crashes later on during program
+        // execution
+#ifdef __GNUG__
+        wxEventTableEntry entry = table.entries[i];
 #else
-    while (table.entries[i].m_fn != 0L)
+        const wxEventTableEntry& entry = table.entries[i];
 #endif
-    {
-        if ((event.GetEventType() == table.entries[i].m_eventType) &&
-                (table.entries[i].m_id == -1 || // Match, if event spec says any id will do (id == -1)
-                 (table.entries[i].m_lastId == -1 && commandId == table.entries[i].m_id) ||
-                 (table.entries[i].m_lastId != -1 &&
-                  (commandId >= table.entries[i].m_id && commandId <= table.entries[i].m_lastId))))
+
+        // match only if the event type is the same and the id is either -1 in
+        // the event table (meaning "any") or the event id matches the id
+        // specified in the event table either exactly or by falling into
+        // range between first and last
+        if ( eventType == entry.m_eventType )
         {
-            event.Skip(FALSE);
-            event.m_callbackUserData = table.entries[i].m_callbackUserData;
+            int tableId1 = entry.m_id,
+                tableId2 = entry.m_lastId;
 
-            (this->*((wxEventFunction) (table.entries[i].m_fn)))(event);
+            if ( (tableId1 == -1) ||
+                 (tableId2 == -1 && eventId == tableId1) ||
+                 (tableId2 != -1 &&
+                    (eventId >= tableId1 && eventId <= tableId2)) )
+            {
+                event.Skip(FALSE);
+                event.m_callbackUserData = entry.m_callbackUserData;
 
-            if ( event.GetSkipped() )
-                return FALSE;
-            else
-                return TRUE;
+                (this->*((wxEventFunction) (entry.m_fn)))(event);
+
+                return !event.GetSkipped();
+            }
         }
-        i++;
     }
+
     return FALSE;
 }
+
 void wxEvtHandler::Connect( int id, int lastId,
                             wxEventType eventType,
                             wxObjectEventFunction func,
@@ -788,6 +855,33 @@ void wxEvtHandler::Connect( int id, int lastId,
     m_dynamicEvents->Append( (wxObject*) entry );
 }
 
+bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
+                  wxObjectEventFunction func,
+                  wxObject *userData )
+{
+    if (!m_dynamicEvents)
+        return FALSE;
+
+    wxNode *node = m_dynamicEvents->First();
+    while (node)
+    {
+        wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
+        if ((entry->m_id == id) &&
+            ((entry->m_lastId == lastId) || (lastId == -1)) &&
+            ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
+            ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
+            ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
+        {
+            if (entry->m_callbackUserData) delete entry->m_callbackUserData;
+            m_dynamicEvents->DeleteNode( node );
+            delete entry;
+            return TRUE;
+        }
+        node = node->Next();
+    }
+    return FALSE;
+}
+
 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
 {
     wxCHECK_MSG( m_dynamicEvents, FALSE,