added note about GetTimestamp() (fixes #1986)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56981 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 2db11fddb5792aa3dd8856089619c8fabb6d1a94..a8d4459f1e60a99d9b247244942cae56762b1921 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -83,6 +83,10 @@ public:
         Gets the timestamp for the event. The timestamp is the time in milliseconds
         since some fixed moment (not necessarily the standard Unix Epoch, so only
         differences between the timestamps and not their absolute values usually make sense).
+
+        @warning
+        wxWidgets returns a non-NULL timestamp only for mouse and key events
+        (see wxMouseEvent and wxKeyEvent).
     */
     long GetTimestamp() const;
 
@@ -117,7 +121,7 @@ public:
     /**
         Sets the timestamp for the event.
     */
-    void SetTimestamp(long = 0);
+    void SetTimestamp(long timeStamp = 0);
 
     /**
         Test if this event should be propagated or not, i.e. if the propagation level