Minor fixes to wxDateTime documentation.

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

diff --git a/interface/wx/timer.h b/interface/wx/timer.h
index 3960006bee49afe8e88b278071a9567248162c67..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
 


@@ -92,6 +101,10 @@ public:
         used and SetOwner() wasn't called.
 
         Perform whatever action which is to be taken periodically here.
         used and SetOwner() wasn't called.
 
         Perform whatever action which is to be taken periodically here.

+
+        Notice that throwing exceptions from this method is currently not
+        supported, use event-based timer handling approach if an exception can
+        be thrown while handling timer notifications.

     */
     virtual void Notify();
 
     */
     virtual void Notify();
 


@@ -127,11 +140,25 @@ 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
 

-    wxTimerEvent object is passed to the event handler of timer events.
+    wxTimerEvent object is passed to the event handler of timer events
+    (see wxTimer::SetOwner).

 
     For example:
 
 
     For example:
 


@@ -144,11 +171,12 @@ public:
 
     private:
         wxTimer m_timer;
 
     private:
         wxTimer m_timer;

+        wxDECLARE_EVENT_TABLE();

     };
 
     };
 

-    BEGIN_EVENT_TABLE(MyFrame, wxFrame)
+    wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)

         EVT_TIMER(TIMER_ID, MyFrame::OnTimer)
         EVT_TIMER(TIMER_ID, MyFrame::OnTimer)

-    END_EVENT_TABLE()
+    wxEND_EVENT_TABLE()

 
     MyFrame::MyFrame()
            : m_timer(this, TIMER_ID)
 
     MyFrame::MyFrame()
            : m_timer(this, TIMER_ID)


@@ -170,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.
     */