Preparing wxString for UTF-8 representation:

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 4de9cac013b4803a0a82323d1b09643c57ea35c8..4e84b4958af3cde23a67d3920f8182a3bb3d33df 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -13,6 +13,7 @@
 #define _WX_EVENT_H__
 
 #include "wx/defs.h"
 #define _WX_EVENT_H__
 
 #include "wx/defs.h"

+#include "wx/cpp.h"

 #include "wx/object.h"
 #include "wx/clntdata.h"
 
 #include "wx/object.h"
 #include "wx/clntdata.h"
 


@@ -46,6 +47,8 @@ class WXDLLIMPEXP_BASE wxEvtHandler;
 
 typedef int wxEventType;
 
 
 typedef int wxEventType;
 

+#define wxEVT_ANY           ((wxEventType)-1)
+

 // this is used to make the event table entry type safe, so that for an event
 // handler only a function with proper parameter list can be given.
 #define wxStaticCastEvent(type, val) wx_static_cast(type, val)
 // this is used to make the event table entry type safe, so that for an event
 // handler only a function with proper parameter list can be given.
 #define wxStaticCastEvent(type, val) wx_static_cast(type, val)


@@ -94,8 +97,6 @@ typedef int wxEventType;
 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
     wxEventTableEntry(type, winid, idLast, fn, obj)
 
 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
     wxEventTableEntry(type, winid, idLast, fn, obj)
 

-#define EMPTY_PARAMETER_VALUE /* Fake macro parameter value */
-

 #define BEGIN_DECLARE_EVENT_TYPES()
 #define END_DECLARE_EVENT_TYPES()
 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
 #define BEGIN_DECLARE_EVENT_TYPES()
 #define END_DECLARE_EVENT_TYPES()
 #define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \


@@ -103,7 +104,7 @@ typedef int wxEventType;
 #define DECLARE_EVENT_TYPE(name, value) \
     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \
 #define DECLARE_EVENT_TYPE(name, value) \
     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
 #define DECLARE_LOCAL_EVENT_TYPE(name, value) \

-    DECLARE_EXPORTED_EVENT_TYPE(EMPTY_PARAMETER_VALUE, name, value)
+    DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)

 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
 
 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
 #define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
 


@@ -383,11 +384,7 @@ public:
         m_propagationLevel = propagationLevel;
     }
 
         m_propagationLevel = propagationLevel;
     }
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     wxObject*         m_eventObject;
     wxEventType       m_eventType;
     long              m_timeStamp;
     wxObject*         m_eventObject;
     wxEventType       m_eventType;
     long              m_timeStamp;


@@ -405,11 +402,7 @@ protected:
     // backwards compatibility as it is new
     int               m_propagationLevel;
 
     // backwards compatibility as it is new
     int               m_propagationLevel;
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     bool              m_skipped;
     bool              m_isCommandEvent;
 
     bool              m_skipped;
     bool              m_isCommandEvent;
 


@@ -468,6 +461,7 @@ private:
     DECLARE_NO_COPY_CLASS(wxPropagateOnce)
 };
 
     DECLARE_NO_COPY_CLASS(wxPropagateOnce)
 };
 

+

 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 
 


@@ -490,26 +484,6 @@ private:
  wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
 */
 
  wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
 */
 

-#if WXWIN_COMPATIBILITY_2_4
-// Backwards compatibility for wxCommandEvent::m_commandString, will lead to compilation errors in some cases of usage
-class WXDLLIMPEXP_CORE wxCommandEvent;
-
-class WXDLLIMPEXP_CORE wxCommandEventStringHelper
-{
-public:
-    wxCommandEventStringHelper(wxCommandEvent * evt)
-        : m_evt(evt)
-        { }
-
-    void operator=(const wxString &str);
-    operator wxString();
-    const wxChar* c_str() const;
-
-private:
-    wxCommandEvent* m_evt;
-};
-#endif
-

 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
 {
 public:
 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
 {
 public:


@@ -517,9 +491,6 @@ public:
 
     wxCommandEvent(const wxCommandEvent& event)
         : wxEvent(event),
 
     wxCommandEvent(const wxCommandEvent& event)
         : wxEvent(event),

-#if WXWIN_COMPATIBILITY_2_4
-          m_commandString(this),
-#endif

           m_cmdString(event.m_cmdString),
           m_commandInt(event.m_commandInt),
           m_extraLong(event.m_extraLong),
           m_cmdString(event.m_cmdString),
           m_commandInt(event.m_commandInt),
           m_extraLong(event.m_extraLong),


@@ -556,12 +527,7 @@ public:
 
     virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-    wxCommandEventStringHelper m_commandString;
-#else

 protected:
 protected:

-#endif

     wxString          m_cmdString;     // String event argument
     int               m_commandInt;
     long              m_extraLong;     // Additional information (e.g. select/deselect)
     wxString          m_cmdString;     // String event argument
     int               m_commandInt;
     long              m_extraLong;     // Additional information (e.g. select/deselect)


@@ -572,23 +538,6 @@ private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
 };
 

-#if WXWIN_COMPATIBILITY_2_4
-inline void wxCommandEventStringHelper::operator=(const wxString &str)
-{
-    m_evt->SetString(str);
-}
-
-inline wxCommandEventStringHelper::operator wxString()
-{
-    return m_evt->GetString();
-}
-
-inline const wxChar* wxCommandEventStringHelper::c_str() const
-{
-    return m_evt->GetString().c_str();
-}
-#endif
-

 // this class adds a possibility to react (from the user) code to a control
 // notification: allow or veto the operation being reported.
 class WXDLLIMPEXP_CORE wxNotifyEvent  : public wxCommandEvent
 // this class adds a possibility to react (from the user) code to a control
 // notification: allow or veto the operation being reported.
 class WXDLLIMPEXP_CORE wxNotifyEvent  : public wxCommandEvent


@@ -680,11 +629,7 @@ public:
 
     virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     int               m_commandInt;
     long              m_extraLong;
 
     int               m_commandInt;
     long              m_extraLong;
 


@@ -853,10 +798,15 @@ public:
     // should occur for each delta.
     int GetWheelDelta() const { return m_wheelDelta; }
 
     // should occur for each delta.
     int GetWheelDelta() const { return m_wheelDelta; }
 

+    // Gets the axis the wheel operation concerns, 0 being the y axis as on
+    // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
+    // or horizontal trackpad scrolling
+    int GetWheelAxis() const { return m_wheelAxis; }
+

     // Returns the configured number of lines (or whatever) to be scrolled per
     // wheel action.  Defaults to one.
     int GetLinesPerAction() const { return m_linesPerAction; }
     // Returns the configured number of lines (or whatever) to be scrolled per
     // wheel action.  Defaults to one.
     int GetLinesPerAction() const { return m_linesPerAction; }

-
+    

     // Is the system set to do page scrolling?
     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 
     // Is the system set to do page scrolling?
     bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
 


@@ -875,7 +825,8 @@ public:
     bool          m_shiftDown;
     bool          m_altDown;
     bool          m_metaDown;
     bool          m_shiftDown;
     bool          m_altDown;
     bool          m_metaDown;

-
+    
+    int           m_wheelAxis;

     int           m_wheelRotation;
     int           m_wheelDelta;
     int           m_linesPerAction;
     int           m_wheelRotation;
     int           m_wheelDelta;
     int           m_linesPerAction;


@@ -1140,11 +1091,7 @@ public:
 
     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     wxPoint m_pos;
     wxRect m_rect;
 
     wxPoint m_pos;
     wxRect m_rect;
 


@@ -1185,7 +1132,7 @@ public:
         g_isPainting++;
     }
 
         g_isPainting++;
     }
 

-    ~wxPaintEvent()
+    virtual ~wxPaintEvent()

     {
         g_isPainting--;
     }
     {
         g_isPainting--;
     }


@@ -1232,11 +1179,7 @@ public:
 
     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
 

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     wxDC *m_dc;
 
 private:
     wxDC *m_dc;
 
 private:


@@ -1522,11 +1465,7 @@ enum
 
 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
 {
 
 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
 {

-#if WXWIN_COMPATIBILITY_2_4
-public:
-#else

 protected:
 protected:

-#endif

     wxPoint   m_pos;
     int       m_zPosition;
     int       m_buttonChange;   // Which button changed?
     wxPoint   m_pos;
     int       m_zPosition;
     int       m_buttonChange;   // Which button changed?


@@ -2396,9 +2335,8 @@ public:
     virtual bool ProcessEvent(wxEvent& event);
 
     // add an event to be processed later
     virtual bool ProcessEvent(wxEvent& event);
 
     // add an event to be processed later

-    void AddPendingEvent(wxEvent& event);
+    virtual void AddPendingEvent(wxEvent& event);

 
 

-    // process all pending events

     void ProcessPendingEvents();
 
 #if wxUSE_THREADS
     void ProcessPendingEvents();
 
 #if wxUSE_THREADS


@@ -2572,6 +2510,30 @@ typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 

+// ----------------------------------------------------------------------------
+// wxEventBlocker: helper class to temporarily disable event handling for a window
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
+{
+public:
+    wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
+    virtual ~wxEventBlocker();
+
+    void Block(wxEventType type)
+    {
+        m_eventsToBlock.push_back(type);
+    }
+
+    virtual bool ProcessEvent(wxEvent& event);
+
+protected:
+    wxArrayInt m_eventsToBlock;
+    wxWindow *m_window;
+
+    DECLARE_NO_COPY_CLASS(wxEventBlocker)
+};
+

 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
 typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
 typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
 typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);


@@ -2610,13 +2572,6 @@ typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureC
 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
 
 typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
 typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
 

-// these typedefs don't have the same name structure as the others, keep for
-// backwards compatibility only
-#if WXWIN_COMPATIBILITY_2_4
-    typedef wxSysColourChangedEventFunction wxSysColourChangedFunction;
-    typedef wxDisplayChangedEventFunction wxDisplayChangedFunction;
-#endif // WXWIN_COMPATIBILITY_2_4
-

 
 #define wxCommandEventHandler(func) \
     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
 
 #define wxCommandEventHandler(func) \
     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)


@@ -3055,12 +3010,6 @@ typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&
 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
 
 #define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
 #define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
 

-// These are obsolete, see _BUTTON_ events
-#if WXWIN_COMPATIBILITY_2_4
-    #define EVT_JOY_DOWN(func) EVT_JOY_BUTTON_DOWN(func)
-    #define EVT_JOY_UP(func) EVT_JOY_BUTTON_UP(func)
-#endif // WXWIN_COMPATIBILITY_2_4
-

 // All joystick events
 #define EVT_JOYSTICK_EVENTS(func) \
     EVT_JOY_BUTTON_DOWN(func) \
 // All joystick events
 #define EVT_JOYSTICK_EVENTS(func) \
     EVT_JOY_BUTTON_DOWN(func) \