Logo Search packages:      
Sourcecode: qt4-x11 version File versions  Download package

Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Properties | Private Member Functions | Private Attributes | Friends | Related Functions

QTimer Class Reference

The QTimer class provides repetitive and single-shot timers. More...

Inheritance diagram for QTimer:
Inheritance graph
[legend]
Collaboration diagram for QTimer:
Collaboration graph
[legend]

List of all members.

Public Slots

void deleteLater ()
void start ()
void start (int msec)
void stop ()

Signals

void destroyed (QObject *=0)
void timeout ()

Public Member Functions

bool blockSignals (bool b)
const QObjectListchildren () const
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
bool disconnect (const QObject *receiver, const char *member=0)
void dumpObjectInfo ()
void dumpObjectTree ()
QList< QByteArraydynamicPropertyNames () const
virtual bool event (QEvent *)
virtual bool eventFilter (QObject *, QEvent *)
template<typename T >
findChild (const QString &aName=QString()) const
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
template<typename T >
QList< T > findChildren (const QRegExp &re) const
bool inherits (const char *classname) const
void installEventFilter (QObject *)
int interval () const
bool isActive () const
bool isSingleShot () const
bool isWidgetType () const
void moveToThread (QThread *thread)
QString objectName () const
QObjectparent () const
QVariant property (const char *name) const
 QTimer (QObject *parent=0)
void removeEventFilter (QObject *)
void setInterval (int msec)
void setObjectName (const QString &name)
void setParent (QObject *)
bool setProperty (const char *name, const QVariant &value)
void setSingleShot (bool singleShot)
void setUserData (uint id, QObjectUserData *data)
bool signalsBlocked () const
QThreadthread () const
int timerId () const
QObjectUserDatauserData (uint id) const
 ~QTimer ()

Static Public Member Functions

static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
static uint registerUserData ()
static void singleShot (int msec, QObject *receiver, const char *member)

Protected Member Functions

virtual void childEvent (QChildEvent *)
virtual void connectNotify (const char *signal)
virtual void customEvent (QEvent *)
virtual void disconnectNotify (const char *signal)
int receivers (const char *signal) const
QObjectsender () const
void timerEvent (QTimerEvent *)

Protected Attributes

QObjectDatad_ptr

Static Protected Attributes

static const QMetaObject staticQtMetaObject

Properties

bool active
int interval
 the timeout interval in milliseconds
QString objectName
 the name of this object
bool singleShot
 whether the timer is a single-shot timer

Private Member Functions

void killTimer (int)
int startTimer (int)

Private Attributes

int del
int id
int inter
uint nulltimer: 1
uint single: 1

Friends

class QApplication
class QApplicationPrivate
class QCoreApplication
class QCoreApplicationPrivate
struct QMetaObject
class QThreadData
class QWidget

Related Functions

(Note that these are not member functions.)


qFindChild (const QObject *obj, const QString &name)
qFindChildqFindChildren (const QObject *obj, const QString &name=QString(), T dummy=0)()
QList< T > qFindChildren (const QObject *obj, const QString &name)
QList< T > qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()
QList< T > qFindChildrenqFindChildren (const QObject *obj, const QString &name=QString(), T dummy=0)()
T * qobject_cast (QObject *object)
 QObjectList
void * qt_find_obj_child (QObject *parent, const char *type, const QString &name)

Detailed Description

The QTimer class provides repetitive and single-shot timers.

The QTimer class provides a high-level programming interface for timers. To use it, create a QTimer, connect its timeout() signal to the appropriate slots, and call start(). From then on it will emit the timeout() signal at constant intervals.

Example for a one second (1000 millisecond) timer (from the {widgets/analogclock}{Analog Clock} example):

examples/widgets/analogclock/analogclock.cpp 4 examples/widgets/analogclock/analogclock.cpp 5 examples/widgets/analogclock/analogclock.cpp 6

From then on, the update() slot is called every second.

You can set a timer to time out only once by calling setSingleShot(true). You can also use the static QTimer::singleShot() function to call a slot after a specified interval:

doc/src/snippets/timers/timers.cpp 3

In multithreaded applications, you can use QTimer in any thread that has an event loop. To start an event loop from a non-GUI thread, use QThread::exec(). Qt uses the timer's {QObject::thread()}{thread affinity} to determine which thread will emit the {QTimer::}{timeout()} signal. Because of this, you must start and stop the timer in its thread; it is not possible to start a timer from another thread.

As a special case, a QTimer with a timeout of 0 will time out as soon as all the events in the window system's event queue have been processed. This can be used to do heavy work while providing a snappy user interface:

doc/src/snippets/timers/timers.cpp 4 doc/src/snippets/timers/timers.cpp 5 doc/src/snippets/timers/timers.cpp 6

processOneThing() will from then on be called repeatedly. It should be written in such a way that it always returns quickly (typically after processing one data item) so that Qt can deliver events to widgets and stop the timer as soon as it has done all its work. This is the traditional way of implementing heavy work in GUI applications; multithreading is now becoming available on more and more platforms, and we expect that zero-millisecond QTimers will gradually be replaced by {QThread}s.

Note that QTimer's accuracy depends on the underlying operating system and hardware. Most platforms support an accuracy of 1 millisecond, but Windows 98 supports only 55. If Qt is unable to deliver the requested number of timer clicks, it will silently discard some.

An alternative to using QTimer is to call QObject::startTimer() for your object and reimplement the QObject::timerEvent() event handler in your class (which must inherit QObject). The disadvantage is that timerEvent() does not support such high-level features as single-shot timers or signals.

Another alternative to using QTimer is to use QBasicTimer. It is typically less cumbersome than using QObject::startTimer() directly. See {Timers} for an overview of all three approaches.

Some operating systems limit the number of timers that may be used; Qt tries to work around these limitations.

See also:
QBasicTimer, QTimerEvent, QObject::timerEvent(), Timers, {Analog Clock Example}, {Wiggly Example}

Definition at line 56 of file qtimer.h.


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

Generated by  Doxygen 1.6.0   Back to index