CopperSpice API  1.7.2
QBasicTimer Class Reference

The QBasicTimer class provides timer events for objects. More...

Public Methods

 QBasicTimer ()
 
 ~QBasicTimer ()
 
bool isActive () const
 
void start (int msec, QObject *object)
 
void start (int msec, Qt::TimerType timerType, QObject *object)
 
void stop ()
 
int timerId () const
 

Detailed Description

The QBasicTimer class provides timer events for objects.

This is a fast, lightweight, and low-level class used by CopperSpice internally. We recommend using the higher-level QTimer class if you want to use timers in your applications. This timer is a repeating timer which sends subsequent timer events unless the stop() function is called.

To use this class, create a QBasicTimer, and call its start() function with a timeout interval and with a pointer to a QObject subclass. When the timer times out it will send a timer event to the QObject subclass. The timer can be stopped at any time using stop(). isActive() returns true for a timer that is running; i.e. it has been started, has not reached the timeout time, and has not been stopped. The timer's ID can be retrieved using timerId().

See also
QTimer, QTimerEvent, QObject::timerEvent(), Timers

Constructor & Destructor Documentation

QBasicTimer::QBasicTimer ( )
inline

Constructs a basic timer.

See also
start()
QBasicTimer::~QBasicTimer ( )
inline

Destroys the basic timer.

Method Documentation

bool QBasicTimer::isActive ( ) const
inline

Returns true if the timer is running and has not been stopped, otherwise returns false.

See also
start(), stop()
void QBasicTimer::start ( int  msec,
QObject object 
)

Starts (or restarts) the timer with a msec milliseconds timeout. The parameter object will receive timer events.

See also
stop(), isActive(), QObject::timerEvent()
void QBasicTimer::start ( int  msec,
Qt::TimerType  timerType,
QObject object 
)

Starts (or restarts) the timer with a msec milliseconds timeout and the given timerType. The parameter object will receive timer events.

See also
stop(), isActive(), QObject::timerEvent(), Qt::TimerType
void QBasicTimer::stop ( )

Stops the timer.

See also
start(), isActive()
int QBasicTimer::timerId ( ) const
inline

Returns the timer's ID.

See also
QTimerEvent::timerId()