fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...

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

diff --git a/src/common/event.cpp b/src/common/event.cpp
index 46efb4f7e57ce5b9ad2813fdae6f37b7c8b2d22f..630a4f20cc9e3add75cd7582ef34167befc92e73 100644 (file)
--- a/src/common/event.cpp
+++ b/src/common/event.cpp
@@ -45,6 +45,13 @@
 
 #include "wx/thread.h"
 
 
 #include "wx/thread.h"
 

+#if wxUSE_BASE
+    #include "wx/ptr_scpd.h"
+
+    wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
+    wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
+#endif // wxUSE_BASE
+

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


@@ -176,6 +183,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)

+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED)

 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED)
 
 // Mouse event types
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED)
 
 // Mouse event types


@@ -360,7 +368,7 @@ wxEvent::wxEvent(int theId, wxEventType commandType )
     m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 }
 
     m_propagationLevel = wxEVENT_PROPAGATE_NONE;
 }
 

-wxEvent::wxEvent(const wxEvent &src)
+wxEvent::wxEvent(const wxEvent& src)

     : wxObject(src)
     , m_eventObject(src.m_eventObject)
     , m_eventType(src.m_eventType)
     : wxObject(src)
     , m_eventObject(src.m_eventObject)
     , m_eventType(src.m_eventType)


@@ -373,6 +381,22 @@ wxEvent::wxEvent(const wxEvent &src)
 {
 }
 
 {
 }
 

+wxEvent& wxEvent::operator=(const wxEvent& src)
+{
+    wxObject::operator=(src);
+
+    m_eventObject = src.m_eventObject;
+    m_eventType = src.m_eventType;
+    m_timeStamp = src.m_timeStamp;
+    m_id = src.m_id;
+    m_callbackUserData = src.m_callbackUserData;
+    m_propagationLevel = src.m_propagationLevel;
+    m_skipped = src.m_skipped;
+    m_isCommandEvent = src.m_isCommandEvent;
+
+    return *this;
+}
+

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


@@ -406,13 +430,15 @@ wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
 
 wxString wxCommandEvent::GetString() const
 {
 
 wxString wxCommandEvent::GetString() const
 {

-    if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
+    if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
+    {

         return m_cmdString;
         return m_cmdString;

+    }

     else
     {
 #if wxUSE_TEXTCTRL
         wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
     else
     {
 #if wxUSE_TEXTCTRL
         wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);

-        if(txt)
+        if ( txt )

             return txt->GetValue();
         else
 #endif // wxUSE_TEXTCTRL
             return txt->GetValue();
         else
 #endif // wxUSE_TEXTCTRL


@@ -524,11 +550,6 @@ wxMouseEvent::wxMouseEvent(wxEventType commandType)
     m_aux1Down = false;
     m_aux2Down = false;
 
     m_aux1Down = false;
     m_aux2Down = false;
 

-    m_controlDown = false;
-    m_shiftDown = false;
-    m_altDown = false;
-    m_metaDown = false;
-

     m_clickCount = -1;
 
     m_wheelRotation = 0;
     m_clickCount = -1;
 
     m_wheelRotation = 0;


@@ -539,7 +560,11 @@ wxMouseEvent::wxMouseEvent(wxEventType commandType)
 
 void wxMouseEvent::Assign(const wxMouseEvent& event)
 {
 
 void wxMouseEvent::Assign(const wxMouseEvent& event)
 {

-    m_eventType = event.m_eventType;
+    wxEvent::operator=(event);
+
+    // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
+    // defined operator=() so need to do it this way:
+    *static_cast<wxMouseState *>(this) = event;

 
     m_x = event.m_x;
     m_y = event.m_y;
 
     m_x = event.m_x;
     m_y = event.m_y;


@@ -550,11 +575,6 @@ void wxMouseEvent::Assign(const wxMouseEvent& event)
     m_aux1Down = event.m_aux1Down;
     m_aux2Down = event.m_aux2Down;
 
     m_aux1Down = event.m_aux1Down;
     m_aux2Down = event.m_aux2Down;
 

-    m_controlDown = event.m_controlDown;
-    m_shiftDown = event.m_shiftDown;
-    m_altDown = event.m_altDown;
-    m_metaDown = event.m_metaDown;
-

     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;


@@ -739,10 +759,6 @@ wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
 wxKeyEvent::wxKeyEvent(wxEventType type)
 {
     m_eventType = type;
 wxKeyEvent::wxKeyEvent(wxEventType type)
 {
     m_eventType = type;

-    m_shiftDown = false;
-    m_controlDown = false;
-    m_metaDown = false;
-    m_altDown = false;

     m_keyCode = 0;
     m_scanCode = 0;
 #if wxUSE_UNICODE
     m_keyCode = 0;
     m_scanCode = 0;
 #if wxUSE_UNICODE


@@ -751,17 +767,14 @@ wxKeyEvent::wxKeyEvent(wxEventType type)
 }
 
 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
 }
 
 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)

-    : wxEvent(evt)
+          : wxEvent(evt),
+            wxKeyboardState(evt)

 {
     m_x = evt.m_x;
     m_y = evt.m_y;
 
     m_keyCode = evt.m_keyCode;
 
 {
     m_x = evt.m_x;
     m_y = evt.m_y;
 
     m_keyCode = evt.m_keyCode;
 

-    m_controlDown = evt.m_controlDown;
-    m_shiftDown = evt.m_shiftDown;
-    m_altDown = evt.m_altDown;
-    m_metaDown = evt.m_metaDown;

     m_scanCode = evt.m_scanCode;
     m_rawCode = evt.m_rawCode;
     m_rawFlags = evt.m_rawFlags;
     m_scanCode = evt.m_scanCode;
     m_rawCode = evt.m_rawCode;
     m_rawFlags = evt.m_rawFlags;


@@ -1012,44 +1025,6 @@ void wxEventHashTable::GrowEventTypeTable()
     delete[] oldEventTypeTable;
 }
 
     delete[] oldEventTypeTable;
 }
 

-
-// ----------------------------------------------------------------------------
-// wxEventConnectionRef
-// ----------------------------------------------------------------------------
-
-// Below functions are mostly short but kept in cpp file to simplify setting 
-// breakpoints (GDB)
-wxEventConnectionRef::wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink) 
-    : m_src(src), m_sink(sink), m_refCount(1) 
-{ 
-    wxASSERT( m_sink );
-    m_sink->AddNode( this );
-}
-
-wxEventConnectionRef::~wxEventConnectionRef() 
-{ 
-}
-
-void wxEventConnectionRef::OnObjectDestroy( )
-{
-    if( m_src )
-        m_src->OnSinkDestroyed( m_sink );
-    // It is safe to delete this tracker object here 
-    delete this;
-}
-
-void wxEventConnectionRef::DecRef( ) 
-{ 
-    if( !--m_refCount )
-    {
-        // The sink holds the only external pointer to this object
-        if( m_sink )
-            m_sink->RemoveNode(this);
-        delete this;
-    }
-}
-
-

 // ----------------------------------------------------------------------------
 // wxEvtHandler
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxEvtHandler
 // ----------------------------------------------------------------------------


@@ -1089,19 +1064,20 @@ wxEvtHandler::~wxEvtHandler()
         {
             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
 
         {
             wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
 

-            // Remove ourselves from sink destructor notifications 
+            // Remove ourselves from sink destructor notifications

             // (this has usually been been done, in wxTrackable destructor)
             wxEvtHandler *eventSink = entry->m_eventSink;
             // (this has usually been been done, in wxTrackable destructor)
             wxEvtHandler *eventSink = entry->m_eventSink;

-            if( eventSink )
+            if ( eventSink )

             {
             {

-                   wxEventConnectionRef *pecr = FindRefInTrackerList( eventSink );
-                   if( pecr )
-                   {
-                       eventSink->RemoveNode( pecr );
-                       delete pecr;
-                   }
+                wxEventConnectionRef * const
+                    evtConnRef = FindRefInTrackerList(eventSink);
+                if ( evtConnRef )
+                {
+                    eventSink->RemoveNode(evtConnRef);
+                    delete evtConnRef;
+                }

             }
             }

-            
+

             if (entry->m_callbackUserData)
                 delete entry->m_callbackUserData;
             delete entry;
             if (entry->m_callbackUserData)
                 delete entry->m_callbackUserData;
             delete entry;


@@ -1116,8 +1092,10 @@ wxEvtHandler::~wxEvtHandler()
     // Remove us from wxPendingEvents if necessary.
     if ( wxPendingEvents )
     {
     // Remove us from wxPendingEvents if necessary.
     if ( wxPendingEvents )
     {

-        if(wxPendingEventsLocker)
+#if wxUSE_THREADS
+        if (wxPendingEventsLocker)

             wxENTER_CRIT_SECT(*wxPendingEventsLocker);
             wxENTER_CRIT_SECT(*wxPendingEventsLocker);

+#endif

 
         if ( wxPendingEvents->DeleteObject(this) )
         {
 
         if ( wxPendingEvents->DeleteObject(this) )
         {


@@ -1127,8 +1105,10 @@ wxEvtHandler::~wxEvtHandler()
         }
         //else: we weren't in this list at all, it's ok
 
         }
         //else: we weren't in this list at all, it's ok
 

-        if(wxPendingEventsLocker)
+#if wxUSE_THREADS
+        if (wxPendingEventsLocker)

             wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
             wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);

+#endif

     }
 
     // we only delete object data, not untyped
     }
 
     // we only delete object data, not untyped


@@ -1151,23 +1131,17 @@ bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
 
 #endif // wxUSE_THREADS
 
 
 #endif // wxUSE_THREADS
 

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

 {
 {

-    // 1) Add event to list of pending events of this event handler
-
-    wxEvent *eventCopy = event.Clone();
-
-    // we must be able to copy the events here so the event class must
-    // implement Clone() properly instead of just providing a NULL stab for it
-    wxCHECK_RET( eventCopy,
-                 _T("events of this type aren't supposed to be posted") );
+    wxCHECK_RET( event, "NULL event can't be posted" );

 
 

+    // 1) Add this event to our list of pending events

     wxENTER_CRIT_SECT( m_pendingEventsLock );
 
     if ( !m_pendingEvents )
       m_pendingEvents = new wxList;
 
     wxENTER_CRIT_SECT( m_pendingEventsLock );
 
     if ( !m_pendingEvents )
       m_pendingEvents = new wxList;
 

-    m_pendingEvents->Append(eventCopy);
+    m_pendingEvents->Append(event);

 
     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
 
 
     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
 


@@ -1198,7 +1172,7 @@ void wxEvtHandler::ProcessPendingEvents()
                  "should have pending events if called" );
 
     wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
                  "should have pending events if called" );
 
     wxList::compatibility_iterator node = m_pendingEvents->GetFirst();

-    wxEvent * const event = wx_static_cast(wxEvent *, node->GetData());
+    wxEventPtr event(static_cast<wxEvent *>(node->GetData()));

 
     // it's important we remove event from list before processing it, else a
     // nested event loop, for example from a modal dialog, might process the
 
     // it's important we remove event from list before processing it, else a
     // nested event loop, for example from a modal dialog, might process the


@@ -1208,7 +1182,17 @@ void wxEvtHandler::ProcessPendingEvents()
     // if there are no more pending events left, we don't need to stay in this
     // list
     if ( m_pendingEvents->IsEmpty() )
     // if there are no more pending events left, we don't need to stay in this
     // list
     if ( m_pendingEvents->IsEmpty() )

+    {
+#if wxUSE_THREADS
+        if (wxPendingEventsLocker)
+            wxENTER_CRIT_SECT(*wxPendingEventsLocker);
+#endif

         wxPendingEvents->DeleteObject(this);
         wxPendingEvents->DeleteObject(this);

+#if wxUSE_THREADS
+        if (wxPendingEventsLocker)
+            wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
+#endif
+    }

 
     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
 
 
     wxLEAVE_CRIT_SECT( m_pendingEventsLock );
 


@@ -1217,8 +1201,6 @@ void wxEvtHandler::ProcessPendingEvents()
     // careful: this object could have been deleted by the event handler
     // executed by the above ProcessEvent() call, so we can't access any fields
     // of this object any more
     // careful: this object could have been deleted by the event handler
     // executed by the above ProcessEvent() call, so we can't access any fields
     // of this object any more

-
-    delete event;

 }
 
 /*
 }
 
 /*


@@ -1268,6 +1250,13 @@ wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry,
 
 bool wxEvtHandler::TryParent(wxEvent& event)
 {
 
 bool wxEvtHandler::TryParent(wxEvent& event)
 {

+    if ( GetNextHandler() )
+    {
+        // the next handler will pass it to wxTheApp if it doesn't process it,
+        // so return from here to avoid doing it again
+        return GetNextHandler()->TryParent(event);
+    }
+

     if ( wxTheApp && (this != wxTheApp) )
     {
         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
     if ( wxTheApp && (this != wxTheApp) )
     {
         // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always


@@ -1299,6 +1288,16 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
         //else: proceed normally
     }
 
         //else: proceed normally
     }
 

+    if ( ProcessEventHere(event) )
+        return true;
+
+    // propagate the event upwards the window chain and/or to the application
+    // object if it wasn't processed at this level 
+    return TryParent(event);
+}
+
+bool wxEvtHandler::ProcessEventHere(wxEvent& event)
+{

     // An event handler can be enabled or disabled
     if ( GetEvtHandlerEnabled() )
     {
     // An event handler can be enabled or disabled
     if ( GetEvtHandlerEnabled() )
     {


@@ -1317,17 +1316,11 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
     }
 
     // Try going down the event handler chain
     }
 
     // Try going down the event handler chain

-    if ( GetNextHandler() )
-    {
-        // 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);
-    }
+    if ( GetNextHandler() && GetNextHandler()->ProcessEventHere(event) )
+        return true;

 
 

-    // Finally propagate the event upwards the window chain and/or to the
-    // application object as necessary
-    return TryParent(event);
+    // We don't have a handler for this event.
+    return false;

 }
 
 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
 }
 
 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)


@@ -1397,15 +1390,15 @@ void wxEvtHandler::Connect( int id, int lastId,
 
     // Insert at the front of the list so most recent additions are found first
     m_dynamicEvents->Insert( (wxObject*) entry );
 
     // Insert at the front of the list so most recent additions are found first
     m_dynamicEvents->Insert( (wxObject*) entry );

-    
-    // Make sure we get to know when a sink is destroyed 
-    if( eventSink )
+
+    // Make sure we get to know when a sink is destroyed
+    if ( eventSink && eventSink != this )

     {
     {

-        wxEventConnectionRef *pecr = FindRefInTrackerList( eventSink );
-        if( pecr )
-            pecr->IncRef( );
+        wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
+        if ( evtConnRef )
+            evtConnRef->IncRef( );

         else
         else

-            pecr = new wxEventConnectionRef(this,eventSink);
+            new wxEventConnectionRef(this, eventSink);

     }
 }
 
     }
 }
 


@@ -1418,11 +1411,11 @@ bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
         return false;
 
     // Remove connection from tracker node (wxEventConnectionRef)
         return false;
 
     // Remove connection from tracker node (wxEventConnectionRef)

-    if( eventSink )
+    if ( eventSink && eventSink != this )

     {
     {

-        wxEventConnectionRef *pecr = FindRefInTrackerList( eventSink );
-        if( pecr )
-            pecr->DecRef( );
+        wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
+        if ( evtConnRef )
+            evtConnRef->DecRef();

     }
 
     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
     }
 
     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();


@@ -1515,37 +1508,36 @@ void *wxEvtHandler::DoGetClientData() const
     return m_clientData;
 }
 
     return m_clientData;
 }
 

-// A helper func to find an wxEventConnectionRef object 
-wxEventConnectionRef* wxEvtHandler::FindRefInTrackerList( wxEvtHandler *eventSink )
+// A helper to find an wxEventConnectionRef object
+wxEventConnectionRef *
+wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)

 {
 {

-    wxASSERT(eventSink);
-    for( wxTrackerNode *ptn=eventSink->GetFirst(); ptn; ptn=ptn->m_nxt )
+    for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )

     {
     {

-        // Only want wxEventConnectionRef nodes here 
-        if( ptn->GetType()!=wxTrackerNode::EventConnectionRef )
-            continue;
-        wxEventConnectionRef *pecr = static_cast<wxEventConnectionRef*>(ptn);
-        if( pecr && pecr->m_src==this )
+        // we only want wxEventConnectionRef nodes here
+        wxEventConnectionRef *evtConnRef = node->ToEventConnection();
+        if ( evtConnRef && evtConnRef->m_src == this )

         {
         {

-            wxASSERT( pecr->m_sink==eventSink );
-            return pecr;
+            wxASSERT( evtConnRef->m_sink==eventSink );
+            return evtConnRef;

         }
     }
         }
     }

+

     return NULL;
 }
 
 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
 {
     wxASSERT(m_dynamicEvents);
     return NULL;
 }
 
 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
 {
     wxASSERT(m_dynamicEvents);

-    
+

     // remove all connections with this sink
     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
     while (node)
     {
         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
         node_nxt = node->GetNext();
     // remove all connections with this sink
     wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
     while (node)
     {
         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
         node_nxt = node->GetNext();

-        
-        if( entry->m_eventSink==sink )
+
+        if ( entry->m_eventSink==sink )

         {
             if (entry->m_callbackUserData)
                 delete entry->m_callbackUserData;
         {
             if (entry->m_callbackUserData)
                 delete entry->m_callbackUserData;