Qt 4.8
Public Functions | Properties | List of all members
QBasicTimer Class Reference

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

#include <qbasictimer.h>

Public Functions

bool isActive () const
 Returns true if the timer is running and has not been stopped; otherwise returns false. More...
 
 QBasicTimer ()
 Contructs a basic timer. More...
 
void start (int msec, QObject *obj)
 Starts (or restarts) the timer with a msec milliseconds timeout. More...
 
void stop ()
 Stops the timer. More...
 
int timerId () const
 Returns the timer's ID. More...
 
 ~QBasicTimer ()
 Destroys the basic timer. More...
 

Properties

int id
 

Detailed Description

The QBasicTimer class provides timer events for objects.

This is a fast, lightweight, and low-level class used by Qt internally. We recommend using the higher-level QTimer class rather than this class if you want to use timers in your applications. Note that this timer is a repeating timer that will send 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().

The Wiggly example uses QBasicTimer to repaint a widget at regular intervals.

See also
QTimer, QTimerEvent, QObject::timerEvent(), Timers, {Wiggly Example}

Definition at line 55 of file qbasictimer.h.

Constructors and Destructors

◆ QBasicTimer()

QBasicTimer::QBasicTimer ( )
inline

Contructs a basic timer.

See also
start()

Definition at line 59 of file qbasictimer.h.

59 : id(0) {}

◆ ~QBasicTimer()

QBasicTimer::~QBasicTimer ( )
inline

Destroys the basic timer.

Definition at line 60 of file qbasictimer.h.

60 { if (id) stop(); }
void stop()
Stops the timer.

Functions

◆ isActive()

bool QBasicTimer::isActive ( ) const
inline

◆ start()

void QBasicTimer::start ( int  msec,
QObject object 
)

◆ stop()

void QBasicTimer::stop ( )

Stops the timer.

See also
start() isActive()

Definition at line 143 of file qbasictimer.cpp.

Referenced by QTreeModel::clear(), QNetworkAccessCache::clear(), QLineEditPrivate::drag(), QTreeModel::ensureSorted(), QTreeModel::executePendingSort(), QMenuPrivate::mouseEventTaken(), QTipLabel::restartExpireTimer(), QTextControlPrivate::setBlinkingCursorEnabled(), QTreeModel::sort(), start(), QDefaultAnimationDriver::stopped(), QTipLabel::timerEvent(), QMainWindowLayout::timerEvent(), QUnifiedTimer::timerEvent(), QWindowsVistaStylePrivate::timerEvent(), and QNetworkAccessCache::updateTimer().

144 {
145  if (id) {
147  if (eventDispatcher)
148  eventDispatcher->unregisterTimer(id);
149  }
150  id = 0;
151 }
static QAbstractEventDispatcher * instance(QThread *thread=0)
Returns a pointer to the event dispatcher object for the specified thread.
virtual bool unregisterTimer(int timerId)=0
Unregisters the timer with the given timerId.
The QAbstractEventDispatcher class provides an interface to manage Qt&#39;s event queue.

◆ timerId()

int QBasicTimer::timerId ( ) const
inline

Properties

◆ id

int QBasicTimer::id
private

Definition at line 57 of file qbasictimer.h.


The documentation for this class was generated from the following files: