]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/event.h
Simple wxBatteryPower API for the support in wxWinCE, wxPalmOS and any other mobile...
[wxWidgets.git] / include / wx / event.h
index 46d21a54ff991918ae0325f2df339c5c1a76b96b..fc5cf8f04f76c69e09f8292127d37f0e202a8af5 100644 (file)
@@ -349,8 +349,8 @@ public:
     // Can instruct event processor that we wish to ignore this event
     // (treat as if the event table entry had not been found): this must be done
     // to allow the event processing by the base classes (calling event.Skip()
-    // is the analog of calling the base class verstion of a virtual function)
-    void Skip(bool skip = TRUE) { m_skipped = skip; }
+    // is the analog of calling the base class version of a virtual function)
+    void Skip(bool skip = true) { m_skipped = skip; }
     bool GetSkipped() const { return m_skipped; };
 
     // this function is used to create a copy of the event polymorphically and
@@ -382,11 +382,18 @@ public:
         m_propagationLevel = propagationLevel;
     }
 
+#if WXWIN_COMPATIBILITY_2_4
 public:
+#else
+protected:
+#endif
     wxObject*         m_eventObject;
     wxEventType       m_eventType;
     long              m_timeStamp;
     int               m_id;
+
+public:
+    // m_callbackUserData is for internal usage only
     wxObject*         m_callbackUserData;
 
 protected:
@@ -397,7 +404,11 @@ protected:
     // backwards compatibility as it is new
     int               m_propagationLevel;
 
+#if WXWIN_COMPATIBILITY_2_4
 public:
+#else
+protected:
+#endif
     bool              m_skipped;
     bool              m_isCommandEvent;
 
@@ -478,6 +489,31 @@ private:
  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
+
+#ifdef __VISUALC__
+    // 'this' : used in base member initializer list (for m_commandString)
+    #pragma warning(disable:4355)
+#endif
+
 class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
 {
 public:
@@ -485,7 +521,10 @@ public:
 
     wxCommandEvent(const wxCommandEvent& event)
         : wxEvent(event),
-          m_commandString(event.m_commandString),
+#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_clientData(event.m_clientData),
@@ -504,13 +543,13 @@ public:
     int GetSelection() const { return m_commandInt; }
 
     // Set/Get listbox/choice selection string
-    void SetString(const wxString& s) { m_commandString = s; }
-    wxString GetString() const { return m_commandString; }
+    void SetString(const wxString& s) { m_cmdString = s; }
+    wxString GetString() const;
 
     // Get checkbox value
     bool IsChecked() const { return m_commandInt != 0; }
 
-    // TRUE if the listbox event was a selection.
+    // true if the listbox event was a selection.
     bool IsSelection() const { return (m_extraLong != 0); }
 
     void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
@@ -521,8 +560,13 @@ public:
 
     virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
 
+#if WXWIN_COMPATIBILITY_2_4
 public:
-    wxString          m_commandString; // String event argument
+    wxCommandEventStringHelper m_commandString;
+#else
+protected:
+#endif
+    wxString          m_cmdString;     // String event argument
     int               m_commandInt;
     long              m_extraLong;     // Additional information (e.g. select/deselect)
     void*             m_clientData;    // Arbitrary client data
@@ -532,6 +576,27 @@ private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
 };
 
+#ifdef __VISUALC__
+    #pragma warning(default:4355)
+#endif
+
+#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
@@ -539,17 +604,17 @@ class WXDLLIMPEXP_CORE wxNotifyEvent  : public wxCommandEvent
 public:
     wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
         : wxCommandEvent(commandType, winid)
-        { m_bAllow = TRUE; }
+        { m_bAllow = true; }
 
     wxNotifyEvent(const wxNotifyEvent& event)
         : wxCommandEvent(event)
         { m_bAllow = event.m_bAllow; }
 
     // veto the operation (usually it's allowed by default)
-    void Veto() { m_bAllow = FALSE; }
+    void Veto() { m_bAllow = false; }
 
     // allow the operation if it was disabled by default
-    void Allow() { m_bAllow = TRUE; }
+    void Allow() { m_bAllow = true; }
 
     // for implementation code only: is the operation allowed?
     bool IsAllowed() const { return m_bAllow; }
@@ -623,7 +688,11 @@ public:
 
     virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
 
+#if WXWIN_COMPATIBILITY_2_4
 public:
+#else
+protected:
+#endif
     int               m_commandInt;
     long              m_extraLong;
 
@@ -962,6 +1031,9 @@ public:
         m_scanCode = evt.m_scanCode;
         m_rawCode = evt.m_rawCode;
         m_rawFlags = evt.m_rawFlags;
+#if wxUSE_UNICODE
+        m_uniChar = evt.m_uniChar;
+#endif
 
         return *this;
     }
@@ -1021,6 +1093,7 @@ public:
     virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
 
 public:
+    // For internal usage only. Will be converted to protected members.
     wxSize m_size;
     wxRect m_rect; // Used for wxEVT_SIZING
 
@@ -1058,6 +1131,11 @@ public:
 
     virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
 
+#if WXWIN_COMPATIBILITY_2_4
+public:
+#else
+protected:
+#endif
     wxPoint m_pos;
     wxRect m_rect;
 
@@ -1089,7 +1167,15 @@ public:
 #endif // debug
     }
 
+    // default copy ctor and dtor are normally fine, we only need them to keep
+    // g_isPainting updated in debug build
 #if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
+    wxPaintEvent(const wxPaintEvent& event)
+            : wxEvent(event)
+    {
+        g_isPainting++;
+    }
+
     ~wxPaintEvent()
     {
         g_isPainting--;
@@ -1137,6 +1223,11 @@ public:
 
     virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
 
+#if WXWIN_COMPATIBILITY_2_4
+public:
+#else
+protected:
+#endif
     wxDC *m_dc;
 
 private:
@@ -1199,7 +1290,7 @@ private:
 class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
 {
 public:
-    wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
+    wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
         : wxEvent(Id, type)
         { m_active = active; }
     wxActivateEvent(const wxActivateEvent& event)
@@ -1256,7 +1347,7 @@ public:
     int GetMenuId() const { return m_menuId; }
 
     // only for wxEVT_MENU_OPEN/CLOSE
-    bool IsPopup() const { return m_menuId == -1; }
+    bool IsPopup() const { return m_menuId == wxID_ANY; }
 
     // only for wxEVT_MENU_OPEN/CLOSE
     wxMenu* GetMenu() const { return m_menu; }
@@ -1282,9 +1373,9 @@ class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
 public:
     wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
         : wxEvent(winid, type),
-          m_loggingOff(TRUE),
-          m_veto(FALSE),      // should be FALSE by default
-          m_canVeto(TRUE) {}
+          m_loggingOff(true),
+          m_veto(false),      // should be false by default
+          m_canVeto(true) {}
 
     wxCloseEvent(const wxCloseEvent & event)
         : wxEvent(event),
@@ -1295,9 +1386,9 @@ public:
     void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
     bool GetLoggingOff() const { return m_loggingOff; }
 
-    void Veto(bool veto = TRUE)
+    void Veto(bool veto = true)
     {
-        // GetVeto() will return FALSE anyhow...
+        // GetVeto() will return false anyhow...
         wxCHECK_RET( m_canVeto,
                      wxT("call to Veto() ignored (can't veto this event)") );
 
@@ -1326,7 +1417,7 @@ private:
 class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
 {
 public:
-    wxShowEvent(int winid = 0, bool show = FALSE)
+    wxShowEvent(int winid = 0, bool show = false)
         : wxEvent(winid, wxEVT_SHOW)
         { m_show = show; }
     wxShowEvent(const wxShowEvent & event)
@@ -1352,7 +1443,7 @@ private:
 class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
 {
 public:
-    wxIconizeEvent(int winid = 0, bool iconized = TRUE)
+    wxIconizeEvent(int winid = 0, bool iconized = true)
         : wxEvent(winid, wxEVT_ICONIZE)
         { m_iconized = iconized; }
     wxIconizeEvent(const wxIconizeEvent & event)
@@ -1414,13 +1505,18 @@ enum
 
 class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
 {
+#if WXWIN_COMPATIBILITY_2_4
 public:
+#else
+protected:
+#endif
     wxPoint   m_pos;
     int       m_zPosition;
     int       m_buttonChange;   // Which button changed?
     int       m_buttonState;    // Which buttons are down?
     int       m_joyStick;       // Which joystick?
 
+public:
     wxJoystickEvent(wxEventType type = wxEVT_NULL,
                     int state = 0,
                     int joystick = wxJOYSTICK1,
@@ -1564,7 +1660,7 @@ public:
         m_enabled =
         m_setEnabled =
         m_setText =
-        m_setChecked = FALSE;
+        m_setChecked = false;
     }
     wxUpdateUIEvent(const wxUpdateUIEvent & event)
         : wxCommandEvent(event),
@@ -1583,9 +1679,9 @@ public:
     bool GetSetChecked() const { return m_setChecked; }
     bool GetSetEnabled() const { return m_setEnabled; }
 
-    void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
-    void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
-    void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
+    void Check(bool check) { m_checked = check; m_setChecked = true; }
+    void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
+    void SetText(const wxString& text) { m_text = text; m_setText = true; }
 
     // Sets the interval between updates in milliseconds.
     // Set to -1 to disable updates, or to 0 to update as frequently as possible.
@@ -1730,7 +1826,7 @@ class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
 public:
     wxQueryNewPaletteEvent(wxWindowID winid = 0)
         : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
-          m_paletteRealized(FALSE)
+          m_paletteRealized(false)
         { }
     wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
         : wxEvent(event),
@@ -1797,6 +1893,7 @@ public:
 
     enum
     {
+        IsBackward = 0x0000,
         IsForward = 0x0001,
         WinChange = 0x0002
     };
@@ -1948,14 +2045,14 @@ class WXDLLIMPEXP_CORE wxIdleEvent : public wxEvent
 public:
     wxIdleEvent()
         : wxEvent(0, wxEVT_IDLE),
-          m_requestMore(FALSE)
+          m_requestMore(false)
         { }
     wxIdleEvent(const wxIdleEvent & event)
         : wxEvent(event),
           m_requestMore(event.m_requestMore)
     { }
 
-    void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
+    void RequestMore(bool needMore = true) { m_requestMore = needMore; }
     bool MoreRequested() const { return m_requestMore; }
 
     virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
@@ -2415,11 +2512,18 @@ typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureC
 #define EVT_CUSTOM(event, winid, func) DECLARE_EVENT_TABLE_ENTRY( event, winid, wxID_ANY, (wxObjectEventFunction)  wxStaticCastEvent( wxEventFunction, & func ), (wxObject *) NULL ),
 #define EVT_CUSTOM_RANGE(event, id1, id2, func) DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction)  wxStaticCastEvent( wxEventFunction, & func ), (wxObject *) NULL ),
 
+// EVT_COMMAND
+#define EVT_COMMAND(winid, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
+#define EVT_COMMAND_RANGE(id1, id2, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
+
+#define EVT_NOTIFY(event, winid, func) DECLARE_EVENT_TABLE_ENTRY( event, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction)  wxStaticCastEvent( wxNotifyFunction, & func ), (wxObject *) NULL ),
+#define EVT_NOTIFY_RANGE(event, id1, id2, func) DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction)  wxStaticCastEvent( wxNotifyFunction, & func ), (wxObject *) NULL ),
+
 // Miscellaneous
 #define EVT_SIZE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SIZE, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxSizeEventFunction, & func ), (wxObject *) NULL ),
-#define EVT_SIZING(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SIZING, -1, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxSizeEventFunction, & func ), (wxObject *) NULL ),
+#define EVT_SIZING(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_SIZING, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxSizeEventFunction, & func ), (wxObject *) NULL ),
 #define EVT_MOVE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOVE, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxMoveEventFunction, & func ), (wxObject *) NULL ),
-#define EVT_MOVING(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOVING, -1, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxMoveEventFunction, & func ), (wxObject *) NULL ),
+#define EVT_MOVING(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOVING, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxMoveEventFunction, & func ), (wxObject *) NULL ),
 #define EVT_CLOSE(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_CLOSE_WINDOW, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCloseEventFunction, & func ), (wxObject *) NULL ),
 #define EVT_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_END_SESSION, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCloseEventFunction, & func ), (wxObject *) NULL ),
 #define EVT_QUERY_END_SESSION(func)  DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_END_SESSION, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCloseEventFunction, & func ), (wxObject *) NULL ),
@@ -2490,10 +2594,6 @@ typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureC
  DECLARE_EVENT_TABLE_ENTRY( wxEVT_LEAVE_WINDOW, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxMouseEventFunction, & func ), (wxObject *) NULL ),\
  DECLARE_EVENT_TABLE_ENTRY( wxEVT_MOUSEWHEEL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxMouseEventFunction, & func ), (wxObject *) NULL ),
 
-// EVT_COMMAND
-#define EVT_COMMAND(winid, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
-#define EVT_COMMAND_RANGE(id1, id2, event, fn)  DECLARE_EVENT_TABLE_ENTRY( event, id1, id2, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
-
 // Scrolling from wxWindow (sent to wxScrolledWindow)
 #define EVT_SCROLLWIN(func) \
   DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLLWIN_TOP, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxScrollWinEventFunction, & func ), (wxObject *) NULL ),\