Store property name and value in wxPropertyGridEvent, keep track of live event instan...

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 3ecf5dfc94e93dc4655880d0af518eb778f558a7..6be32bc266d58aa50a86b7640212acd82c4111cb 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -99,60 +99,51 @@ typedef int wxEventType;
 // generate a new unique event type
 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
 
 // generate a new unique event type
 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
 

-// New macros to create templatized event types:
-
-#ifndef wxHAS_EVENT_BIND
-
-    // Define/Declare a wxEventType-based event type:
+// define macros to create new event types:
+#ifdef wxHAS_EVENT_BIND
+    // events are represented by an instance of wxEventTypeTag and the
+    // corresponding type must be specified for type-safety checks

 
 

+    // define a new custom event type, can be used alone or after event
+    // declaration in the header using one of the macros below

     #define wxDEFINE_EVENT( name, type ) \
     #define wxDEFINE_EVENT( name, type ) \

-        const wxEventType name( wxNewEventType() )
+        const wxEventTypeTag< type > name( wxNewEventType() )

 
 

+    // the general version allowing exporting the event type from DLL, used by
+    // wxWidgets itself

     #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
     #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \

-        extern const expdecl wxEventType name
-
-    // Define/Declare a wxEventType-based event type and initialize it with a
-    // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
-    // compatibility)
-
-    #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
-        const wxEventType name = value
-
-    #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
-        extern const expdecl wxEventType name
-
-    // Declare a local (not exported) wxEventType-based event type:
+        extern const expdecl wxEventTypeTag< type > name

 
 

+    // this is the version which will normally be used in the user code

     #define wxDECLARE_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
 
     #define wxDECLARE_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
 

-#else // wxHAS_EVENT_BIND
-
-    // Define/Declare a templatized event type with the corresponding event as
-    // a nested typedef:
-
-    #define wxDEFINE_EVENT( name, type ) \
-        const wxEventTypeTag< type > name( wxNewEventType() )
-
-    #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
-        extern const expdecl wxEventTypeTag< type > name
-
-    // Define/Declare a templatized event type and initialize it with a
-    // predefined event type. (Only used for wxEVT_SPIN_XXX for backward
-    // compatibility)

 
 

+    // these macros are only used internally for backwards compatibility and
+    // allow to define an alias for an existing event type (this is used by
+    // wxEVT_SPIN_XXX)

     #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
         const wxEventTypeTag< type > name( value )
 
     #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
         extern const expdecl wxEventTypeTag< type > name
     #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
         const wxEventTypeTag< type > name( value )
 
     #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
         extern const expdecl wxEventTypeTag< type > name

+#else // !wxHAS_EVENT_BIND
+    // the macros are the same ones as above but defined differently as we only
+    // use the integer event type values to identify events in this case

 
 

-    // Declare a local (not exported) templatized event type:
+    #define wxDEFINE_EVENT( name, type ) \
+        const wxEventType name( wxNewEventType() )

 
 

+    #define wxDECLARE_EXPORTED_EVENT( expdecl, name, type ) \
+        extern const expdecl wxEventType name

     #define wxDECLARE_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
 
     #define wxDECLARE_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
 

-#endif // wxHAS_EVENT_BIND
+    #define wxDEFINE_EVENT_ALIAS( name, type, value ) \
+        const wxEventType name = value
+    #define wxDECLARE_EXPORTED_EVENT_ALIAS( expdecl, name, type ) \
+        extern const expdecl wxEventType name
+#endif // wxHAS_EVENT_BIND/!wxHAS_EVENT_BIND

 
 // Try to cast the given event handler to the correct handler type:
 
 
 // Try to cast the given event handler to the correct handler type:
 


@@ -569,7 +560,7 @@ private:
 
 // Create functors for the templatized events, either allocated on the heap for
 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them
 
 // Create functors for the templatized events, either allocated on the heap for
 // wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them

-// in dynamic event table) or just by returning them as a temporary objects (this
+// in dynamic event table) or just by returning them as temporary objects (this

 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
 
 
 // is enough for Unbind<>() and we avoid unnecessary heap allocation like this).
 
 


@@ -1078,7 +1069,7 @@ public:
     wxPropagateOnce(wxEvent& event) : m_event(event)
     {
         wxASSERT_MSG( m_event.m_propagationLevel > 0,
     wxPropagateOnce(wxEvent& event) : m_event(event)
     {
         wxASSERT_MSG( m_event.m_propagationLevel > 0,

-                        _T("shouldn't be used unless ShouldPropagate()!") );
+                        wxT("shouldn't be used unless ShouldPropagate()!") );

 
         m_event.m_propagationLevel--;
     }
 
         m_event.m_propagationLevel--;
     }


@@ -1513,6 +1504,33 @@ private:
  wxEVT_HOTKEY
  */
 
  wxEVT_HOTKEY
  */
 

+// key categories: the bit flags for IsKeyInCategory() function
+//
+// the enum values used may change in future version of wx
+// use the named constants only, or bitwise combinations thereof
+enum wxKeyCategoryFlags
+{
+    // arrow keys, on and off numeric keypads
+    WXK_CATEGORY_ARROW  = 1,
+
+    // page up and page down keys, on and off numeric keypads
+    WXK_CATEGORY_PAGING = 2,
+
+    // home and end keys, on and off numeric keypads
+    WXK_CATEGORY_JUMP   = 4,
+
+    // tab key, on and off numeric keypads
+    WXK_CATEGORY_TAB    = 8,
+
+    // backspace and delete keys, on and off numeric keypads
+    WXK_CATEGORY_CUT    = 16,
+
+    // all keys usually used for navigation
+    WXK_CATEGORY_NAVIGATION = WXK_CATEGORY_ARROW |
+                              WXK_CATEGORY_PAGING |
+                              WXK_CATEGORY_JUMP
+};
+

 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
                                     public wxKeyboardState
 {
 class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
                                     public wxKeyboardState
 {


@@ -1523,6 +1541,9 @@ public:
     // get the key code: an ASCII7 char or an element of wxKeyCode enum
     int GetKeyCode() const { return (int)m_keyCode; }
 
     // get the key code: an ASCII7 char or an element of wxKeyCode enum
     int GetKeyCode() const { return (int)m_keyCode; }
 

+    // returns true iff this event's key code is of a certain type
+    bool IsKeyInCategory(int category) const;
+

 #if wxUSE_UNICODE
     // get the Unicode character corresponding to this key
     wxChar GetUnicodeKey() const { return m_uniChar; }
 #if wxUSE_UNICODE
     // get the Unicode character corresponding to this key
     wxChar GetUnicodeKey() const { return m_uniChar; }


@@ -1926,7 +1947,7 @@ public:
         // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
         // doesn't make sense for wxEVT_CLOSE_WINDOW
         wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
         // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
         // doesn't make sense for wxEVT_CLOSE_WINDOW
         wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,

-                      _T("this flag is for end session events only") );
+                      wxT("this flag is for end session events only") );

 
         return m_loggingOff;
     }
 
         return m_loggingOff;
     }


@@ -3903,16 +3924,16 @@ typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&
 // (and not in a private header) because the base class must be visible from
 // other public headers, please do NOT use this in your code, it will be
 // removed from future wx versions without warning.
 // (and not in a private header) because the base class must be visible from
 // other public headers, please do NOT use this in your code, it will be
 // removed from future wx versions without warning.

-#ifndef wxHAS_EVENT_BIND
-    #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
-    #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
-    #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
-        win->Connect(evt, handler(func), NULL, obj)
-#else // wxHAS_EVENT_BIND
+#ifdef wxHAS_EVENT_BIND

     #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
     #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
     #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
         win->Bind(evt, &func, obj)
     #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
     #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
     #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
         win->Bind(evt, &func, obj)

+#else // wxHAS_EVENT_BIND
+    #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
+    #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
+    #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
+        win->Connect(evt, handler(func), NULL, obj)

 #endif // wxHAS_EVENT_BIND
 
 #if wxUSE_GUI
 #endif // wxHAS_EVENT_BIND
 
 #if wxUSE_GUI