Slightly better style?

[wxWidgets.git] / include / wx / event.h

diff --git a/include/wx/event.h b/include/wx/event.h
index e934c0141940abd3a95b8b6ebddfb32bac31e9d1..cb0c18d5a7d107d92f083c26ecb395edacf891cc 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -19,6 +19,9 @@
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/gdicmn.h"
+#if wxUSE_THREADS
+#include "wx/thread.h"
+#endif
 
 /*
  * Event types
@@ -283,6 +286,10 @@ public:
     void Skip(bool skip = TRUE) { m_skipped = skip; }
     bool GetSkipped() const { return m_skipped; };
 
+    // implementation only: this test is explicitlty anti OO and this functions
+    // exists only for optimization purposes
+    bool IsCommandEvent() const { return m_isCommandEvent; }
+
 public:
     bool              m_skipped;
     wxObject*         m_eventObject;
@@ -291,6 +298,10 @@ public:
     long              m_timeStamp;
     int               m_id;
     wxObject*         m_callbackUserData;
+
+    // optimization: instead of using costly IsKindOf() we keep a flag telling
+    // whether we're a command event (by far the most common case)
+    bool              m_isCommandEvent;
 };
 
 // Item or menu event class
@@ -338,8 +349,8 @@ public:
     int GetSelection() const { return m_commandInt; }
 
     // Set/Get listbox/choice selection string
-    void SetString(char* s) { m_commandString = s; }
-    char *GetString() const { return m_commandString; }
+    void SetString(const wxString& s) { m_commandString = s; }
+    wxString GetString() const { return m_commandString; }
 
     // Get checkbox value
     bool Checked() const { return (m_commandInt != 0); }
@@ -354,7 +365,7 @@ public:
     long GetInt() const { return m_commandInt ; }
 
 public:
-    char*             m_commandString; // String event argument
+    wxString          m_commandString; // String event argument
     int               m_commandInt;
     long              m_extraLong;     // Additional information (e.g. select/deselect)
     void*             m_clientData;    // Arbitrary client data
@@ -509,6 +520,7 @@ public:
     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 
     // Find the position of the event
+    void GetPosition(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
     void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
 
     // Find the position of the event
@@ -567,18 +579,18 @@ public:
     bool ShiftDown() const { return m_shiftDown; }
     long KeyCode() const { return m_keyCode; }
 
-#if WXWIN_COMPATIBILITY
     // Find the position of the event
-    void Position(float *xpos, float *ypos) const
-        { *xpos = (float)m_x; *ypos = (float)m_y; }
+    void GetPosition(long *xpos, long *ypos) const
+        { *xpos = m_x; *ypos = m_y; }
+
+    wxPoint GetPosition() const
+        { return wxPoint(m_x, m_y); }
 
     // Get X position
-    float GetX() const { return (float)m_x; }
+    long GetX() const { return m_x; }
 
     // Get Y position
-    float GetY() const { return (float)m_y; }
-
-#endif // WXWIN_COMPATIBILITY
+    long GetY() const { return m_y; }
 
 public:
     long          m_x;
@@ -762,10 +774,18 @@ public:
     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
     bool GetLoggingOff() const { return m_loggingOff; }
 
-    void Veto(bool veto = TRUE) { wxASSERT( m_canVeto ); m_veto = veto; }
+    void Veto(bool veto = TRUE)
+    {
+        // GetVeto() will return FALSE anyhow...
+        wxCHECK_RET( m_canVeto,
+                     _T("call to Veto() ignored (can't veto this event)") );
+
+        m_veto = veto;
+    }
     void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
+    // No more asserts here please, the one you put here was wrong.
     bool CanVeto() const { return m_canVeto; }
-    bool GetVeto() const { wxASSERT( m_canVeto ); return m_veto; }
+    bool GetVeto() const { return m_canVeto && m_veto; }
 
 #if WXWIN_COMPATIBILITY
     // This is probably obsolete now, since we use CanVeto instead, in
@@ -1149,8 +1169,14 @@ public:
     virtual long Default()
         { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
 
+#if WXWIN_COMPATIBILITY
     virtual bool OnClose();
+#endif
 
+#if wxUSE_THREADS
+    bool ProcessThreadEvent(wxEvent& event);
+    void ProcessPendingEvents();
+#endif
     virtual bool ProcessEvent(wxEvent& event);
     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
 
@@ -1172,13 +1198,23 @@ private:
     static const wxEventTableEntry         sm_eventTableEntries[];
 
 protected:
-    static const wxEventTable        sm_eventTable;
-    virtual const wxEventTable*        GetEventTable() const;
+    static const wxEventTable sm_eventTable;
+
+    virtual const wxEventTable *GetEventTable() const;
+
 protected:
-    wxEvtHandler*     m_nextHandler;
-    wxEvtHandler*     m_previousHandler;
-    bool              m_enabled;                      // Is event handler enabled?
-    wxList*           m_dynamicEvents;
+    wxEvtHandler*      m_nextHandler;
+    wxEvtHandler*      m_previousHandler;
+    bool               m_enabled;           // Is event handler enabled?
+    wxList*            m_dynamicEvents;
+    wxList*           m_pendingEvents;
+#if wxUSE_THREADS
+    wxCriticalSection* m_eventsLocker;
+#endif
+
+    // optimization: instead of using costly IsKindOf() to decide whether we're
+    // a window (which is true in 99% of cases), use this flag
+    bool              m_isWindow;
 };
 
 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
@@ -1295,7 +1331,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 
 // EVT_COMMAND
 #define EVT_COMMAND(id, event, fn)  { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
-#define EVT_COMMAND_RANGE(id1, id2, event, fn)  { eventId, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
+#define EVT_COMMAND_RANGE(id1, id2, event, fn)  { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 
 // Scrolling
 #define EVT_SCROLL(func) \
@@ -1391,5 +1427,13 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_UPDATE_UI(id, func) \
  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
 
+/*
+ * Helper functions
+ */
+
+// Find a window with the focus, that is also a descendant of the given window.
+// This is used to determine the window to initially send commands to.
+wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
+
 #endif
         // _WX_EVENTH__