]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/event.cpp
document (and check for it with assert) that wxGetKeyState(WXK_[LMR]BUTTON) doesn...
[wxWidgets.git] / src / common / event.cpp
index 187dbf5fcdab090af2c57216b219362ca1b6af3e..7bb9ba699dfab4ec1b97b804a6e8f9b251f4b8ca 100644 (file)
         #include "wx/control.h"
         #include "wx/utils.h"
         #include "wx/dc.h"
+        #include "wx/textctrl.h"
     #endif // wxUSE_GUI
 #endif
 
 #include "wx/event.h"
+#include "wx/module.h"
 
 #if wxUSE_GUI
     #include "wx/validate.h"
@@ -119,6 +121,24 @@ wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
     { 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
+class wxEventTableEntryModule: public wxModule
+{
+DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
+public:
+    wxEventTableEntryModule() {}
+    bool OnInit() { return true; }
+    void OnExit()
+    {
+        wxEventHashTable::ClearAll();
+    }
+};
+IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
+#endif
+
 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
@@ -245,6 +265,7 @@ DEFINE_EVENT_TYPE(wxEVT_MOVING)
 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
 DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
+DEFINE_EVENT_TYPE(wxEVT_HIBERNATE)
 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
 DEFINE_EVENT_TYPE(wxEVT_POWER)
 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
@@ -319,7 +340,7 @@ int wxNewEventType()
 // ----------------------------------------------------------------------------
 
 /*
- * General wxWindows events, covering
+ * General wxWidgets events, covering
  * all interesting things that might happen (button clicking, resizing,
  * setting text in widgets, etc.).
  *
@@ -361,8 +382,16 @@ wxEvent::wxEvent(const wxEvent &src)
  *
  */
 
+#ifdef __VISUALC__
+    // 'this' : used in base member initializer list (for m_commandString)
+    #pragma warning(disable:4355)
+#endif
+
 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;
@@ -374,6 +403,26 @@ wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
     m_propagationLevel = wxEVENT_PROPAGATE_MAX;
 }
 
+#ifdef __VISUALC__
+    #pragma warning(default:4355)
+#endif
+
+wxString wxCommandEvent::GetString() const
+{
+    if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
+        return m_cmdString;
+    else
+    {
+#if wxUSE_TEXTCTRL
+        wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
+        if(txt)
+            return txt->GetValue();
+        else
+#endif // wxUSE_TEXTCTRL
+            return m_cmdString;
+    }
+}
+
 /*
  * UI update events
  */
@@ -398,23 +447,23 @@ bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
 
     if (sm_updateInterval == -1)
         return false;
-    else if (sm_updateInterval == 0)
+
+    if (sm_updateInterval == 0)
         return true;
-    else
-    {
+
 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
-        wxLongLong now = wxGetLocalTimeMillis();
-        if (now > (sm_lastUpdate + sm_updateInterval))
-        {
-            return true;
-        }
-#else
-        // If we don't have wxStopWatch or wxLongLong, we
-        // should err on the safe side and update now anyway.
+    wxLongLong now = wxGetLocalTimeMillis();
+    if (now > (sm_lastUpdate + sm_updateInterval))
+    {
         return true;
-#endif
     }
+
     return false;
+#else
+    // If we don't have wxStopWatch or wxLongLong, we
+    // should err on the safe side and update now anyway.
+    return true;
+#endif
 }
 
 // Reset the update time to provide a delay until the next
@@ -522,106 +571,120 @@ void wxMouseEvent::Assign(const wxMouseEvent& event)
     m_linesPerAction = event.m_linesPerAction;
 }
 
-// True if was a button dclick event (1 = left, 2 = middle, 3 = right)
-// or any button dclick event (but = -1)
+// return true if was a button dclick event
 bool wxMouseEvent::ButtonDClick(int but) const
 {
     switch (but)
     {
-        case -1:
+        default:
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
+            // fall through
+
+        case wxMOUSE_BTN_ANY:
             return (LeftDClick() || MiddleDClick() || RightDClick());
-        case 1:
+
+        case wxMOUSE_BTN_LEFT:
             return LeftDClick();
-        case 2:
+
+        case wxMOUSE_BTN_MIDDLE:
             return MiddleDClick();
-        case 3:
+
+        case wxMOUSE_BTN_RIGHT:
             return RightDClick();
-        default:
-            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
     }
-
-    return false;
 }
 
-// True if was a button down event (1 = left, 2 = middle, 3 = right)
-// or any button down event (but = -1)
+// return true if was a button down event
 bool wxMouseEvent::ButtonDown(int but) const
 {
     switch (but)
     {
-        case -1:
+        default:
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
+            // fall through
+
+        case wxMOUSE_BTN_ANY:
             return (LeftDown() || MiddleDown() || RightDown());
-        case 1:
+
+        case wxMOUSE_BTN_LEFT:
             return LeftDown();
-        case 2:
+
+        case wxMOUSE_BTN_MIDDLE:
             return MiddleDown();
-        case 3:
+
+        case wxMOUSE_BTN_RIGHT:
             return RightDown();
-        default:
-            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
     }
-
-    return false;
 }
 
-// True if was a button up event (1 = left, 2 = middle, 3 = right)
-// or any button up event (but = -1)
+// return true if was a button up event
 bool wxMouseEvent::ButtonUp(int but) const
 {
     switch (but)
     {
-        case -1:
+        default:
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
+            // fall through
+
+        case wxMOUSE_BTN_ANY:
             return (LeftUp() || MiddleUp() || RightUp());
-        case 1:
+
+        case wxMOUSE_BTN_LEFT:
             return LeftUp();
-        case 2:
+
+        case wxMOUSE_BTN_MIDDLE:
             return MiddleUp();
-        case 3:
+
+        case wxMOUSE_BTN_RIGHT:
             return RightUp();
-        default:
-            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
     }
-
-    return false;
 }
 
-// True if the given button is currently changing state
+// return true if the given button is currently changing state
 bool wxMouseEvent::Button(int but) const
 {
     switch (but)
     {
-        case -1:
-            return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
-        case 1:
-            return (LeftDown() || LeftUp() || LeftDClick());
-        case 2:
-            return (MiddleDown() || MiddleUp() || MiddleDClick());
-        case 3:
-            return (RightDown() || RightUp() || RightDClick());
         default:
             wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
-    }
+            // fall through
 
-    return false;
+        case wxMOUSE_BTN_ANY:
+            return ButtonUp(wxMOUSE_BTN_ANY) ||
+                    ButtonDown(wxMOUSE_BTN_ANY) ||
+                        ButtonDClick(wxMOUSE_BTN_ANY);
+
+        case wxMOUSE_BTN_LEFT:
+            return LeftDown() || LeftUp() || LeftDClick();
+
+        case wxMOUSE_BTN_MIDDLE:
+            return MiddleDown() || MiddleUp() || MiddleDClick();
+
+        case wxMOUSE_BTN_RIGHT:
+            return RightDown() || RightUp() || RightDClick();
+    }
 }
 
 bool wxMouseEvent::ButtonIsDown(int but) const
 {
     switch (but)
     {
-        case -1:
-            return (LeftIsDown() || MiddleIsDown() || RightIsDown());
-        case 1:
+        default:
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
+            // fall through
+
+        case wxMOUSE_BTN_ANY:
+            return LeftIsDown() || MiddleIsDown() || RightIsDown();
+
+        case wxMOUSE_BTN_LEFT:
             return LeftIsDown();
-        case 2:
+
+        case wxMOUSE_BTN_MIDDLE:
             return MiddleIsDown();
-        case 3:
+
+        case wxMOUSE_BTN_RIGHT:
             return RightIsDown();
-        default:
-            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
     }
-
-    return false;
 }
 
 int wxMouseEvent::GetButton() const
@@ -634,7 +697,7 @@ int wxMouseEvent::GetButton() const
         }
     }
 
-    return -1;
+    return wxMOUSE_BTN_NONE;
 }
 
 // Find the logical position of the event given the DC
@@ -717,16 +780,35 @@ wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
 // wxEventHashTable
 // ----------------------------------------------------------------------------
 
-static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not to big not to small...
+static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
+
+wxEventHashTable* wxEventHashTable::sm_first = NULL;
 
 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
                 : m_table(table),
                   m_rebuildHash(true)
 {
     AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
+
+    m_next = sm_first;
+    if (m_next)
+        m_next->m_previous = this;
+    sm_first = this;
 }
 
 wxEventHashTable::~wxEventHashTable()
+{
+    if (m_next)
+        m_next->m_previous = m_previous;
+    if (m_previous)
+        m_previous->m_next = m_next;
+    if (sm_first == this)
+        sm_first = m_next;
+
+    Clear();
+}
+
+void wxEventHashTable::Clear()
 {
     size_t i;
     for(i = 0; i < m_size; i++)
@@ -738,7 +820,24 @@ wxEventHashTable::~wxEventHashTable()
         }
     }
 
-    delete[] m_eventTypeTable;
+    // Necessary in order to not invoke the
+    // overloaded delete operator when statics are cleaned up
+    if (m_eventTypeTable)
+        delete[] m_eventTypeTable;
+
+    m_eventTypeTable = NULL;
+    m_size = 0;
+}
+
+// Clear all tables
+void wxEventHashTable::ClearAll()
+{
+    wxEventHashTable* table = sm_first;
+    while (table)
+    {
+        table->Clear();
+        table = table->m_next;
+    }
 }
 
 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
@@ -749,6 +848,9 @@ bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
         m_rebuildHash = false;
     }
 
+    if (!m_eventTypeTable)
+        return false;
+
     // Find all entries for the given event type.
     wxEventType eventType = event.GetEventType();
     const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
@@ -806,6 +908,10 @@ void wxEventHashTable::InitHashTable()
 
 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
 {
+    // This might happen 'accidentally' as the app is exiting
+    if (!m_eventTypeTable)
+        return;
+
     EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
     EventTypeTablePointer  eTTnode = *peTTnode;
 
@@ -874,6 +980,7 @@ void wxEventHashTable::GrowEventTypeTable()
     delete[] oldEventTypeTable;
 }
 
+
 // ----------------------------------------------------------------------------
 // wxEvtHandler
 // ----------------------------------------------------------------------------
@@ -983,22 +1090,14 @@ void wxEvtHandler::AddPendingEvent(wxEvent& event)
     wxCHECK_RET( eventCopy,
                  _T("events of this type aren't supposed to be posted") );
 
-#if defined(__VISAGECPP__)
-    wxENTER_CRIT_SECT( m_eventsLocker);
-#else
-    wxENTER_CRIT_SECT( *m_eventsLocker);
-#endif
+    wxENTER_CRIT_SECT( Lock() );
 
     if ( !m_pendingEvents )
       m_pendingEvents = new wxList;
 
     m_pendingEvents->Append(eventCopy);
 
-#if defined(__VISAGECPP__)
-    wxLEAVE_CRIT_SECT( m_eventsLocker);
-#else
-    wxLEAVE_CRIT_SECT( *m_eventsLocker);
-#endif
+    wxLEAVE_CRIT_SECT( Lock() );
 
     // 2) Add this event handler to list of event handlers that
     //    have pending events.
@@ -1018,41 +1117,38 @@ void wxEvtHandler::AddPendingEvent(wxEvent& event)
 
 void wxEvtHandler::ProcessPendingEvents()
 {
-#if defined(__VISAGECPP__)
-    wxENTER_CRIT_SECT( m_eventsLocker);
-#else
-    wxENTER_CRIT_SECT( *m_eventsLocker);
-#endif
-
-    wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
-    while ( node )
+    // this method is only called by wxApp if this handler does have pending
+    // events
+    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
+    // the start of ProcessPendingEvents because otherwise we could get into
+    // infinite loop if the pending event handler execution resulted in another
+    // event being posted
+    size_t n = m_pendingEvents->size();
+    for ( wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
+          node;
+          node = m_pendingEvents->GetFirst() )
     {
         wxEvent *event = (wxEvent *)node->GetData();
+
         m_pendingEvents->Erase(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
+        wxLEAVE_CRIT_SECT( Lock() );
+
         ProcessEvent(*event);
         delete event;
-#if defined(__VISAGECPP__)
-        wxENTER_CRIT_SECT( m_eventsLocker);
-#else
-        wxENTER_CRIT_SECT( *m_eventsLocker);
-#endif
 
-        node = m_pendingEvents->GetFirst();
+        wxENTER_CRIT_SECT( Lock() );
+
+        if ( !--n )
+            break;
     }
 
-#if defined(__VISAGECPP__)
-    wxLEAVE_CRIT_SECT( m_eventsLocker);
-#else
-    wxLEAVE_CRIT_SECT( *m_eventsLocker);
-#endif
+    wxLEAVE_CRIT_SECT( Lock() );
 }
 
 /*
@@ -1070,9 +1166,9 @@ wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry,
     // 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 ((tableId1 == -1) ||
-        (tableId2 == -1 && tableId1 == event.GetId()) ||
-        (tableId2 != -1 &&
+    if ((tableId1 == wxID_ANY) ||
+        (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
+        (tableId2 != wxID_ANY &&
          (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
     {
         event.Skip(false);
@@ -1222,7 +1318,7 @@ bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 
         if ((entry->m_id == id) &&
-            ((entry->m_lastId == lastId) || (lastId == -1)) &&
+            ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
             ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
             ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
             ((entry->m_eventSink == eventSink) || (eventSink == (wxEvtHandler*)NULL)) &&
@@ -1253,7 +1349,7 @@ bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
         wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
 
-        if ((event.m_eventType == entry->m_eventType) && entry->m_fn)
+        if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
         {
             wxEvtHandler *handler =
 #if !WXWIN_COMPATIBILITY_EVENT_TYPES