New scrolling code.

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 692d9f18d57328ed6ad869fc65f44fa1cd0ba161..3ba1b9258a5e39e3c886b33c9eb6c4ac807ce88c 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -18,15 +18,31 @@
 
 #include "wx/defs.h"
 #include "wx/object.h"
 
 #include "wx/defs.h"
 #include "wx/object.h"

-#include "wx/gdicmn.h"
+
+#if wxUSE_GUI
+    #include "wx/gdicmn.h"
+#endif
+

 #if wxUSE_THREADS
 #if wxUSE_THREADS

-#include "wx/thread.h"
+    #include "wx/thread.h"

 #endif
 
 #endif
 

-/*
- * Event types
- *
- */
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxList;
+
+#if wxUSE_GUI
+    class WXDLLEXPORT wxClientData;
+    class WXDLLEXPORT wxDC;
+    class WXDLLEXPORT wxMenu;
+    class WXDLLEXPORT wxWindow;
+#endif // wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// Event types
+// ----------------------------------------------------------------------------

 
 typedef int wxEventType;
 
 
 typedef int wxEventType;
 


@@ -156,9 +172,14 @@ const wxEventType wxEVT_COMPARE_ITEM =                      wxEVT_FIRST + 436;
 const wxEventType wxEVT_INIT_DIALOG =                       wxEVT_FIRST + 437;
 const wxEventType wxEVT_IDLE =                              wxEVT_FIRST + 438;
 const wxEventType wxEVT_UPDATE_UI =                         wxEVT_FIRST + 439;
 const wxEventType wxEVT_INIT_DIALOG =                       wxEVT_FIRST + 437;
 const wxEventType wxEVT_IDLE =                              wxEVT_FIRST + 438;
 const wxEventType wxEVT_UPDATE_UI =                         wxEVT_FIRST + 439;

+

  /* System misc. */
 const wxEventType wxEVT_END_PROCESS =                       wxEVT_FIRST + 440;
 
  /* System misc. */
 const wxEventType wxEVT_END_PROCESS =                       wxEVT_FIRST + 440;
 

+ /* Dial up events */
+const wxEventType wxEVT_DIALUP_CONNECTED =                  wxEVT_FIRST + 450;
+const wxEventType wxEVT_DIALUP_DISCONNECTED =               wxEVT_FIRST + 451;
+

  /* Generic command events */
  /* Note: a click is a higher-level event than button down/up */
 const wxEventType wxEVT_COMMAND_LEFT_CLICK =                wxEVT_FIRST + 500;
  /* Generic command events */
  /* Note: a click is a higher-level event than button down/up */
 const wxEventType wxEVT_COMMAND_LEFT_CLICK =                wxEVT_FIRST + 500;


@@ -217,6 +238,17 @@ const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED =     wxEVT_FIRST + 802;
 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING =    wxEVT_FIRST + 803;
 #endif
 
 const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING =    wxEVT_FIRST + 803;
 #endif
 

+/* Splitter events */
+const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxEVT_FIRST + 850;
+const wxEventType wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxEVT_FIRST + 851;
+const wxEventType wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxEVT_FIRST + 852;
+const wxEventType wxEVT_COMMAND_SPLITTER_UNSPLIT = wxEVT_FIRST + 853;
+
+/* Wizard events */
+const wxEventType wxEVT_WIZARD_PAGE_CHANGED = wxEVT_FIRST + 900;
+const wxEventType wxEVT_WIZARD_PAGE_CHANGING = wxEVT_FIRST + 901;
+const wxEventType wxEVT_WIZARD_CANCEL = wxEVT_FIRST + 902;
+

 const wxEventType wxEVT_USER_FIRST =                        wxEVT_FIRST + 2000;
 
 /* Compatibility */
 const wxEventType wxEVT_USER_FIRST =                        wxEVT_FIRST + 2000;
 
 /* Compatibility */


@@ -307,19 +339,20 @@ public:
     void CopyObject(wxObject& object_dest) const;
 
 public:
     void CopyObject(wxObject& object_dest) const;
 
 public:

-    bool              m_skipped;

     wxObject*         m_eventObject;
     wxObject*         m_eventObject;

-    char*             m_eventHandle;         // Handle of an underlying windowing system event

     wxEventType       m_eventType;
     long              m_timeStamp;
     int               m_id;
     wxObject*         m_callbackUserData;
     wxEventType       m_eventType;
     long              m_timeStamp;
     int               m_id;
     wxObject*         m_callbackUserData;

+    bool              m_skipped;

 
     // 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;
 };
 
 
     // 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;
 };
 

+#if wxUSE_GUI
+

 // Item or menu event class
 /*
  wxEVT_COMMAND_BUTTON_CLICKED
 // Item or menu event class
 /*
  wxEVT_COMMAND_BUTTON_CLICKED


@@ -338,8 +371,6 @@ public:
  wxEVT_COMMAND_COMBOBOX_SELECTED
 */
 
  wxEVT_COMMAND_COMBOBOX_SELECTED
 */
 

-class WXDLLEXPORT wxClientData;
-

 class WXDLLEXPORT wxCommandEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxCommandEvent)
 class WXDLLEXPORT wxCommandEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxCommandEvent)


@@ -472,6 +503,7 @@ public:
     void SetOrientation(int orient) { m_extraLong = (long) orient; }
     void SetPosition(int pos) { m_commandInt = pos; }
 
     void SetOrientation(int orient) { m_extraLong = (long) orient; }
     void SetPosition(int pos) { m_commandInt = pos; }
 

+    void CopyObject(wxObject& object_dest) const;

 public:
     int               m_commandInt;    // Additional information
     long              m_extraLong;     
 public:
     int               m_commandInt;    // Additional information
     long              m_extraLong;     


@@ -506,7 +538,6 @@ public:
  wxEVT_NC_RIGHT_DCLICK,
 */
 
  wxEVT_NC_RIGHT_DCLICK,
 */
 

-class WXDLLEXPORT wxDC;

 class WXDLLEXPORT wxMouseEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxMouseEvent)
 class WXDLLEXPORT wxMouseEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxMouseEvent)


@@ -713,12 +744,33 @@ public:
  wxEVT_PAINT_ICON
  */
 
  wxEVT_PAINT_ICON
  */
 

+#if defined(__WXDEBUG__) && defined(__WXMSW__)
+    // see comments in src/msw/dcclient.cpp where g_isPainting is defined
+    extern int g_isPainting;
+#endif // debug
+

 class WXDLLEXPORT wxPaintEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxPaintEvent)
 
 public:
 class WXDLLEXPORT wxPaintEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxPaintEvent)
 
 public:

-    wxPaintEvent(int Id = 0) { m_eventType = wxEVT_PAINT; m_id = Id; }
+    wxPaintEvent(int Id = 0)
+    {
+        m_eventType = wxEVT_PAINT;
+        m_id = Id;
+
+#if defined(__WXDEBUG__) && defined(__WXMSW__)
+        // set the internal flag for the duration of processing of WM_PAINT
+        g_isPainting++;
+#endif // debug
+    }
+
+#if defined(__WXDEBUG__) && defined(__WXMSW__)
+    ~wxPaintEvent()
+    {
+        g_isPainting--;
+    }
+#endif // debug

 };
 
 // Erase background event class
 };
 
 // Erase background event class


@@ -726,7 +778,6 @@ public:
  wxEVT_ERASE_BACKGROUND
  */
 
  wxEVT_ERASE_BACKGROUND
  */
 

-class WXDLLEXPORT wxDC;

 class WXDLLEXPORT wxEraseEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxEraseEvent)
 class WXDLLEXPORT wxEraseEvent : public wxEvent
 {
     DECLARE_DYNAMIC_CLASS(wxEraseEvent)


@@ -846,7 +897,7 @@ public:
     {
         // GetVeto() will return FALSE anyhow...
         wxCHECK_RET( m_canVeto,
     {
         // GetVeto() will return FALSE anyhow...
         wxCHECK_RET( m_canVeto,

-                     _T("call to Veto() ignored (can't veto this event)") );
+                     wxT("call to Veto() ignored (can't veto this event)") );

 
         m_veto = veto;
     }
 
         m_veto = veto;
     }


@@ -979,7 +1030,7 @@ public:
 
     // Was it a button event? (*doesn't* mean: is any button *down*?)
     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
 
     // Was it a button event? (*doesn't* mean: is any button *down*?)
     bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||

-            (GetEventType() == wxEVT_JOY_BUTTON_DOWN)); }
+            (GetEventType() == wxEVT_JOY_BUTTON_UP)); }

 
     // Was it a move event?
     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
 
     // Was it a move event?
     bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }


@@ -1031,36 +1082,11 @@ public:
     void CopyObject(wxObject& obj) const;
 };
 
     void CopyObject(wxObject& obj) const;
 };
 

-// Idle event
-/*
- wxEVT_IDLE
- */
-
-class WXDLLEXPORT wxIdleEvent : public wxEvent
-{
-    DECLARE_DYNAMIC_CLASS(wxIdleEvent)
-
-public:
-    wxIdleEvent()
-        { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
-
-    void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
-    bool MoreRequested() const { return m_requestMore; }
-
-    void CopyObject(wxObject& obj) const;
-
-protected:
-    bool m_requestMore;
-};
-

 // Update UI event
 /*
  wxEVT_UPDATE_UI
  */
 
 // Update UI event
 /*
  wxEVT_UPDATE_UI
  */
 

-class WXDLLEXPORT wxMenu;
-class WXDLLEXPORT wxWindow;
-

 class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
 {
     DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
 class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
 {
     DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)


@@ -1166,7 +1192,7 @@ protected:
  wxEVT_NAVIGATION_KEY
  */
 // must derive from command event to be propagated to the parent
  wxEVT_NAVIGATION_KEY
  */
 // must derive from command event to be propagated to the parent

-class WXDLLEXPORT wxNavigationKeyEvent  : public wxCommandEvent
+class WXDLLEXPORT wxNavigationKeyEvent : public wxCommandEvent

 {
     DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
 
 {
     DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
 


@@ -1188,10 +1214,62 @@ public:
     void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; }
 };
 
     void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; }
 };
 

+// Window creation/destruction events: the first is sent as soon as window is
+// created (i.e. the underlying GUI object exists), but when the C++ object is
+// fully initialized (so virtual functions may be called). The second,
+// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
+// still safe to call virtual functions at this moment
+/*
+ wxEVT_CREATE
+ wxEVT_DESTROY
+ */
+
+class WXDLLEXPORT wxWindowCreateEvent : public wxEvent
+{
+    DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent)
+
+public:
+    wxWindowCreateEvent(wxWindow *win = NULL);
+
+    wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
+};
+
+class WXDLLEXPORT wxWindowDestroyEvent : public wxEvent
+{
+    DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent)
+
+public:
+    wxWindowDestroyEvent(wxWindow *win = NULL);
+
+    wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
+};
+
+#endif // wxUSE_GUI
+
+// Idle event
+/*
+ wxEVT_IDLE
+ */
+
+class WXDLLEXPORT wxIdleEvent : public wxEvent
+{
+    DECLARE_DYNAMIC_CLASS(wxIdleEvent)
+
+public:
+    wxIdleEvent()
+        { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
+
+    void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
+    bool MoreRequested() const { return m_requestMore; }
+
+    void CopyObject(wxObject& obj) const;
+
+protected:
+    bool m_requestMore;
+};
+

 /* TODO
  wxEVT_POWER,
 /* TODO
  wxEVT_POWER,

- wxEVT_CREATE,
- wxEVT_DESTROY,

  wxEVT_MOUSE_CAPTURE_CHANGED,
  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
  wxEVT_MOUSE_CAPTURE_CHANGED,
  wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
 // wxEVT_FONT_CHANGED,  // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate


@@ -1201,11 +1279,6 @@ public:
  wxEVT_COMPARE_ITEM
 */
 
  wxEVT_COMPARE_ITEM
 */
 

-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxControl;
-
-// struct WXDLLEXPORT wxEventTableEntry;
-

 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
 
 struct WXDLLEXPORT wxEventTableEntry
 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
 
 struct WXDLLEXPORT wxEventTableEntry


@@ -1242,16 +1315,17 @@ public:
     void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
     bool GetEvtHandlerEnabled() const { return m_enabled; }
 
     void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
     bool GetEvtHandlerEnabled() const { return m_enabled; }
 

+#if WXWIN_COMPATIBILITY_2

     virtual void OnCommand(wxWindow& WXUNUSED(win),
                            wxCommandEvent& WXUNUSED(event))
     {
     virtual void OnCommand(wxWindow& WXUNUSED(win),
                            wxCommandEvent& WXUNUSED(event))
     {

+        wxFAIL_MSG(wxT("shouldn't be called any more"));

     }
 
     }
 

-    // Called if child control has no
-    // callback function
-    // Default behaviour
+    // Called if child control has no callback function

     virtual long Default()
         { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
     virtual long Default()
         { return GetNextHandler() ? GetNextHandler()->Default() : 0; };

+#endif // WXWIN_COMPATIBILITY_2

 
 #if WXWIN_COMPATIBILITY
     virtual bool OnClose();
 
 #if WXWIN_COMPATIBILITY
     virtual bool OnClose();


@@ -1295,7 +1369,7 @@ protected:
     wxEvtHandler*       m_previousHandler;
     bool                m_enabled;           // Is event handler enabled?
     wxList*             m_dynamicEvents;
     wxEvtHandler*       m_previousHandler;
     bool                m_enabled;           // Is event handler enabled?
     wxList*             m_dynamicEvents;

-    wxList*                m_pendingEvents;
+    wxList*             m_pendingEvents;

 #if wxUSE_THREADS
     wxCriticalSection*  m_eventsLocker;
 #endif
 #if wxUSE_THREADS
     wxCriticalSection*  m_eventsLocker;
 #endif


@@ -1306,6 +1380,7 @@ protected:
 };
 
 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
 };
 
 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);

+#if wxUSE_GUI

 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&);


@@ -1331,6 +1406,7 @@ typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
 typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
 typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
 typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);

+#endif // wxUSE_GUI

 
 // N.B. In GNU-WIN32, you *have* to take the address of a member function
 // (use &) or the compiler crashes...
 
 // N.B. In GNU-WIN32, you *have* to take the address of a member function
 // (use &) or the compiler crashes...


@@ -1388,6 +1464,8 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
 #define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
 #define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
 #define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
 #define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
 #define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },

+#define EVT_WINDOW_CREATE(func) { wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
+#define EVT_WINDOW_DESTROY(func) { wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },

 
 // Mouse events
 #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
 
 // Mouse events
 #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },


@@ -1534,13 +1612,17 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_UPDATE_UI(id, func) \
  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
 
 #define EVT_UPDATE_UI(id, func) \
  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
 

-/*
- * Helper functions
- */
+// ----------------------------------------------------------------------------
+// Helper functions
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI

 
 // 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);
 
 
 // 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 // wxUSE_GUI
+

 #endif
         // _WX_EVENTH__
 #endif
         // _WX_EVENTH__