extend GetAsBitmap with an optional subrect

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index fa4e88b2056c01dc436b0ecc1364ad7fef45f7d1..b0efc9d3ad305f7a884b6cfb5e4d6172f05c25af 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -1,42 +1,35 @@
 /////////////////////////////////////////////////////////////////////////////
 // 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
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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/stopwatch.h" // for backwards compatibility
 

-#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
 class WXDLLEXPORT wxTimerBase : public wxEvtHandler
 
 // the interface of wxTimer class
 class WXDLLEXPORT wxTimerBase : public wxEvtHandler


@@ -47,18 +40,19 @@ 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(this); }
+    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 timerid = -1)
+    wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY)

         { Init(); SetOwner(owner, timerid); }
 
     // same as ctor above
         { Init(); SetOwner(owner, timerid); }
 
     // same as ctor above

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

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


@@ -70,7 +64,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;


@@ -82,28 +76,27 @@ 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; }
 

-    // return the timer ID
-    int GetId() const { return m_idTimer; }
-    
-

 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)
 };
 
     DECLARE_NO_COPY_CLASS(wxTimerBase)
 };


@@ -116,10 +109,14 @@ 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__) || defined(__WXCOCOA__)
+#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__)
 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)


@@ -134,13 +131,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);
     }


@@ -187,8 +184,11 @@ private:
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 

+#define wxTimerEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func)
+

 #define EVT_TIMER(timerid, func) \
 #define EVT_TIMER(timerid, func) \

-    DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, timerid, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTimerEventFunction, & func ), NULL),
+    wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func))

 
 #endif // wxUSE_GUI && wxUSE_TIMER
 
 
 #endif // wxUSE_GUI && wxUSE_TIMER