df0c322667
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5019 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
145 lines
3.9 KiB
C++
145 lines
3.9 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/timer.h
|
|
// Purpose: wxTimer class and global time-related functions
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 04/01/98
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart and Markus Holzem
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_TIMER_H_BASE_
|
|
#define _WX_TIMER_H_BASE_
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "timerbase.h"
|
|
#endif
|
|
|
|
#include "wx/setup.h"
|
|
#include "wx/object.h"
|
|
#include "wx/longlong.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTimer
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// the interface of wxTimer class
|
|
class WXDLLEXPORT wxTimerBase : public wxObject
|
|
{
|
|
public:
|
|
wxTimerBase() { m_oneShot = FALSE; m_milli = 0; }
|
|
|
|
// working with the timer
|
|
// ----------------------
|
|
|
|
// start the timer: if milliseconds == -1, use the same value as for the
|
|
// last Start()
|
|
virtual bool Start(int milliseconds = -1, bool oneShot = FALSE)
|
|
{
|
|
if ( milliseconds != -1 )
|
|
{
|
|
m_milli = milliseconds;
|
|
}
|
|
|
|
m_oneShot = oneShot;
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
// stop the timer
|
|
virtual void Stop() = 0;
|
|
|
|
// override this in your wxTimer-derived class
|
|
virtual void Notify() = 0;
|
|
|
|
// getting info
|
|
// ------------
|
|
|
|
// return TRUE if the timer is running
|
|
virtual bool IsRunning() const = 0;
|
|
|
|
// get the (last) timer interval in the milliseconds
|
|
int GetInterval() const { return m_milli; }
|
|
|
|
// return TRUE if the timer is one shot
|
|
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:
|
|
int m_milli; // the timer interval
|
|
bool m_oneShot; // TRUE if one shot
|
|
};
|
|
|
|
#if defined(__WXMSW__)
|
|
#include "wx/msw/timer.h"
|
|
#elif defined(__WXMOTIF__)
|
|
#include "wx/motif/timer.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk/timer.h"
|
|
#elif defined(__WXQT__)
|
|
#include "wx/qt/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
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxStopWatch
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxStopWatch
|
|
{
|
|
public:
|
|
// ctor starts the stop watch
|
|
wxStopWatch() { Start(); }
|
|
void Start(long t = 0);
|
|
inline void Pause() { m_pause = GetElapsedTime(); }
|
|
inline void Resume() { Start(m_pause); }
|
|
|
|
// get elapsed time since the last Start() or Pause() in milliseconds
|
|
long Time() const;
|
|
|
|
protected:
|
|
// returns the elapsed time since t0
|
|
long GetElapsedTime() const;
|
|
|
|
private:
|
|
wxLongLong m_t0; // the time of the last Start()
|
|
long m_pause; // the time of the last Pause() or 0
|
|
};
|
|
|
|
|
|
// 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);
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// global time functions
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// Get number of seconds since local time 00:00:00 Jan 1st 1970.
|
|
long WXDLLEXPORT wxGetLocalTime();
|
|
|
|
// Get number of seconds since GMT 00:00:00, Jan 1st 1970.
|
|
long WXDLLEXPORT wxGetUTCTime();
|
|
|
|
#define wxGetCurrentTime() wxGetLocalTime()
|
|
|
|
#endif
|
|
// _WX_TIMER_H_BASE_
|