Document wxBK_HITTEST_XXX values.

[wxWidgets.git] / interface / wx / timer.h

diff --git a/interface/wx/timer.h b/interface/wx/timer.h
index 12513350aeccf3ba55f687774054d8180611ea34..054e890057f9bf26988e56d96c5e2a148aa7bd50 100644 (file)
--- a/interface/wx/timer.h
+++ b/interface/wx/timer.h
@@ -3,9 +3,18 @@
 // Purpose:     interface of wxTimer
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTimer
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// generate notifications periodically until the timer is stopped (default)
+#define wxTIMER_CONTINUOUS false
+
+// only send the notification once and then stop the timer
+#define wxTIMER_ONE_SHOT true
+
+wxEventType wxEVT_TIMER;
+
+

 /**
     @class wxTimer
 
 /**
     @class wxTimer
 


@@ -131,6 +140,19 @@ public:
 };
 
 
 };
 
 

+/**
+   @class wxTimerRunner
+
+   Starts the timer in its ctor, stops in the dtor.
+*/ 
+class wxTimerRunner
+{
+public:
+    wxTimerRunner(wxTimer& timer);
+    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false);
+    void Start(int milli, bool oneShot = false);
+    ~wxTimerRunner();
+};

 
 /**
     @class wxTimerEvent
 
 /**
     @class wxTimerEvent


@@ -176,6 +198,9 @@ public:
 class wxTimerEvent : public wxEvent
 {
 public:
 class wxTimerEvent : public wxEvent
 {
 public:

+    wxTimerEvent();
+    wxTimerEvent(wxTimer& timer);
+

     /**
         Returns the interval of the timer which generated this event.
     */
     /**
         Returns the interval of the timer which generated this event.
     */