Preparing wxString for UTF-8 representation:

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 2c030fbd07e640dde65ecd53a1c1cb428ccfff72..c79633c6c039c06d3bc353c0d964edcc83de1119 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -1,43 +1,39 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/timer.h
 // Purpose:     wxTimer, wxStopWatch and global time-related functions
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/timer.h
 // Purpose:     wxTimer, wxStopWatch and global time-related functions

-// Author:      Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch)
+// Author:      Julian Smart

 // Modified by: Vadim Zeitlin (wxTimerBase)
 //              Guillermo Rodriguez (global clean up)
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Modified by: Vadim Zeitlin (wxTimerBase)
 //              Guillermo Rodriguez (global clean up)
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "timerbase.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_GUI && wxUSE_TIMER

 
 

-#include "wx/setup.h"

 #include "wx/object.h"
 #include "wx/longlong.h"
 #include "wx/event.h"
 #include "wx/object.h"
 #include "wx/longlong.h"
 #include "wx/event.h"

+#include "wx/stopwatch.h" // for backwards compatibility
+#include "wx/window.h"    // only for NewControlId()

 
 

-#if wxUSE_GUI && wxUSE_TIMER
-
-// ----------------------------------------------------------------------------
-// wxTimer
-// ----------------------------------------------------------------------------

 
 // more readable flags for Start():
 
 // generate notifications periodically until the timer is stopped (default)
 
 // more readable flags for Start():
 
 // generate notifications periodically until the timer is stopped (default)

-#define wxTIMER_CONTINUOUS FALSE
+#define wxTIMER_CONTINUOUS false

 
 // only send the notification once and then stop the timer
 
 // only send the notification once and then stop the timer

-#define wxTIMER_ONE_SHOT TRUE
+#define wxTIMER_ONE_SHOT true

 
 // the interface of wxTimer class
 
 // the interface of wxTimer class

-class WXDLLEXPORT wxTimerBase : public wxObject
+class WXDLLEXPORT wxTimerBase : public wxEvtHandler

 {
 public:
     // ctors and initializers
 {
 public:
     // ctors and initializers


@@ -45,17 +41,23 @@ public:
 
     // default: if you don't call SetOwner(), your only chance to get timer
     // notifications is to override Notify() in the derived class
 
     // default: if you don't call SetOwner(), your only chance to get timer
     // notifications is to override Notify() in the derived class

-    wxTimerBase() { Init(); SetOwner(NULL); }
+    wxTimerBase()
+        { Init(); SetOwner(this); }

 
     // ctor which allows to avoid having to override Notify() in the derived
     // class: the owner will get timer notifications which can be handled with
     // EVT_TIMER
 
     // ctor which allows to avoid having to override Notify() in the derived
     // class: the owner will get timer notifications which can be handled with
     // EVT_TIMER

-    wxTimerBase(wxEvtHandler *owner, int id = -1)
-        { Init(); SetOwner(owner, id); }
+    wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY)
+        { Init(); SetOwner(owner, timerid); }

 
     // same as ctor above
 
     // same as ctor above

-    void SetOwner(wxEvtHandler *owner, int id = -1)
-        { m_owner = owner; m_idTimer = id; }
+    void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY)
+    {
+        m_owner = owner;
+        m_idTimer = timerid == wxID_ANY ? wxWindow::NewControlId() : timerid;
+    }
+
+    wxEvtHandler *GetOwner() const { return m_owner; }

 
     virtual ~wxTimerBase();
 
 
     virtual ~wxTimerBase();
 


@@ -67,7 +69,7 @@ public:
     //
     // it is now valid to call Start() multiple times: this just restarts the
     // timer if it is already running
     //
     // it is now valid to call Start() multiple times: this just restarts the
     // timer if it is already running

-    virtual bool Start(int milliseconds = -1, bool oneShot = FALSE);
+    virtual bool Start(int milliseconds = -1, bool oneShot = false);

 
     // stop the timer
     virtual void Stop() = 0;
 
     // stop the timer
     virtual void Stop() = 0;


@@ -79,30 +81,29 @@ public:
     // getting info
     // ------------
 
     // getting info
     // ------------
 

-    // return TRUE if the timer is running
+    // return true if the timer is running

     virtual bool IsRunning() const = 0;
 
     virtual bool IsRunning() const = 0;
 

-    // get the (last) timer interval in the milliseconds
+    // return the timer ID
+    int GetId() const { return m_idTimer; }
+
+    // get the (last) timer interval in milliseconds

     int GetInterval() const { return m_milli; }
 
     int GetInterval() const { return m_milli; }
 

-    // return TRUE if the timer is one shot
+    // return true if the timer is one shot

     bool IsOneShot() const { return m_oneShot; }
 
     bool IsOneShot() const { return m_oneShot; }
 

-#if WXWIN_COMPATIBILITY_2
-    // deprecated functions
-    int Interval() const { return GetInterval(); };
-    bool OneShot() const { return IsOneShot(); }
-#endif // WXWIN_COMPATIBILITY_2
-

 protected:
     // common part of all ctors
 protected:
     // common part of all ctors

-    void Init() { m_oneShot = FALSE; m_milli = 0; }
+    void Init()
+        { m_owner = NULL; m_idTimer = wxID_ANY; m_milli = 0; m_oneShot = false; }

 
     wxEvtHandler *m_owner;
     int     m_idTimer;
 
     wxEvtHandler *m_owner;
     int     m_idTimer;

-

     int     m_milli;        // the timer interval
     int     m_milli;        // the timer interval

-    bool    m_oneShot;      // TRUE if one shot
+    bool    m_oneShot;      // true if one shot
+
+    DECLARE_NO_COPY_CLASS(wxTimerBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -113,16 +114,18 @@ protected:
     #include "wx/msw/timer.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/timer.h"
     #include "wx/msw/timer.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/timer.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/timer.h"
     #include "wx/gtk/timer.h"

-#elif defined(__WXX11__) || defined(__WXMGL__)
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/timer.h"
+#elif defined(__WXX11__) || defined(__WXMGL__) || defined(__WXDFB__)

     #include "wx/generic/timer.h"
     #include "wx/generic/timer.h"

+#elif defined (__WXCOCOA__)
+    #include "wx/cocoa/timer.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)
     #include "wx/os2/timer.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)
     #include "wx/os2/timer.h"

-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/timer.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -133,13 +136,13 @@ class WXDLLEXPORT wxTimerRunner
 {
 public:
     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
 {
 public:
     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }

-    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
+    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false)

         : m_timer(timer)
     {
         m_timer.Start(milli, oneShot);
     }
 
         : m_timer(timer)
     {
         m_timer.Start(milli, oneShot);
     }
 

-    void Start(int milli, bool oneShot = FALSE)
+    void Start(int milli, bool oneShot = false)

     {
         m_timer.Start(milli, oneShot);
     }
     {
         m_timer.Start(milli, oneShot);
     }


@@ -154,6 +157,8 @@ public:
 
 private:
     wxTimer& m_timer;
 
 private:
     wxTimer& m_timer;

+
+    DECLARE_NO_COPY_CLASS(wxTimerRunner)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -163,7 +168,7 @@ private:
 class WXDLLEXPORT wxTimerEvent : public wxEvent
 {
 public:
 class WXDLLEXPORT wxTimerEvent : public wxEvent
 {
 public:

-    wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id)
+    wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid)

     {
         m_eventType = wxEVT_TIMER;
 
     {
         m_eventType = wxEVT_TIMER;
 


@@ -179,85 +184,18 @@ public:
 private:
     int m_interval;
 
 private:
     int m_interval;
 

-    DECLARE_DYNAMIC_CLASS(wxTimerEvent)
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent)

 };
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 
 };
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 

-#define EVT_TIMER(id, func) \
-    DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL),
-
-#endif // wxUSE_GUI && wxUSE_TIMER
-
-// ----------------------------------------------------------------------------
-// wxStopWatch: measure time intervals with up to 1ms resolution
-// ----------------------------------------------------------------------------
-
-#if wxUSE_STOPWATCH
-
-class WXDLLEXPORT wxStopWatch
-{
-public:
-    // ctor starts the stop watch
-    wxStopWatch() { m_pauseCount = 0; Start(); }
-
-    // start the stop watch at the moment t0
-    void Start(long t0 = 0);
-
-    // pause the stop watch
-    void Pause() { if ( !m_pauseCount++) m_pause = GetElapsedTime(); }
-
-    // resume it
-    void Resume() { if ( !--m_pauseCount ) Start(m_pause); }
-
-    // get elapsed time since the last Start() in milliseconds
-    long Time() const;
-
-protected:
-    // returns the elapsed time since t0
-    long GetElapsedTime() const;
-
-private:
-    // the time of the last Start()
-    wxLongLong m_t0;
-
-    // the time of the last Pause() (only valid if m_pauseCount > 0)
-    long m_pause;
-
-    // if > 0, the stop watch is paused, otherwise it is running
-    int m_pauseCount;
-};
-
-#endif // wxUSE_STOPWATCH
-
-#if wxUSE_LONGLONG
-
-// Starts a global timer
-// -- DEPRECATED: use wxStopWatch instead
-void WXDLLEXPORT wxStartTimer();
-
-// Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime
-// -- DEPRECATED: use wxStopWatch instead
-long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
-
-#endif // wxUSE_LONGLONG
+#define wxTimerEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func)

 
 

-// ----------------------------------------------------------------------------
-// global time functions
-// ----------------------------------------------------------------------------
-
-// Get number of seconds since local time 00:00:00 Jan 1st 1970.
-extern long WXDLLEXPORT wxGetLocalTime();
+#define EVT_TIMER(timerid, func) \
+    wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func))

 
 

-// Get number of seconds since GMT 00:00:00, Jan 1st 1970.
-extern long WXDLLEXPORT wxGetUTCTime();
-
-#if wxUSE_LONGLONG
-// Get number of milliseconds since local time 00:00:00 Jan 1st 1970
-extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis();
-#endif // wxUSE_LONGLONG
-
-#define wxGetCurrentTime() wxGetLocalTime()
+#endif // wxUSE_GUI && wxUSE_TIMER

 
 #endif
     // _WX_TIMER_H_BASE_
 
 #endif
     // _WX_TIMER_H_BASE_