#include <qqmltimer_p.h>

Inheritance diagram for QQmlTimer:

Collaboration diagram for QQmlTimer:

Public Slots
void	start ()
	\qmlmethod QtQml::Timer::start()

void	stop ()
	\qmlmethod QtQml::Timer::stop()

void	restart ()
	\qmlmethod QtQml::Timer::restart()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	triggered ()

void	runningChanged ()

void	intervalChanged ()

void	repeatChanged ()

void	triggeredOnStartChanged ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQmlTimer (QObject *parent=nullptr)
	\qmltype Timer \instantiates QQmlTimer \inqmlmodule QtQml

void	setInterval (int interval)
	\qmlproperty int QtQml::Timer::interval

int	interval () const

bool	isRunning () const
	\qmlproperty bool QtQml::Timer::running

void	setRunning (bool running)

bool	isRepeating () const
	\qmlproperty bool QtQml::Timer::repeat

void	setRepeating (bool repeating)

bool	triggeredOnStart () const
	\qmlproperty bool QtQml::Timer::triggeredOnStart

void	setTriggeredOnStart (bool triggeredOnStart)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Protected Member Functions
void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

bool	event (QEvent *) override

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
int	interval

bool	running

bool	repeat

bool	triggeredOnStart

QObject *	parent

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 29 of file qqmltimer_p.h.

Constructor & Destructor Documentation

◆ QQmlTimer()

QQmlTimer::QQmlTimer ( QObject * parent = nullptr )

\qmltype Timer \instantiates QQmlTimer \inqmlmodule QtQml

Triggers a handler at a specified interval.

A Timer can be used to trigger an action either once, or repeatedly at a given interval.

Here is a Timer that shows the current date and time, and updates the text every 500 milliseconds. It uses the JavaScript Date object to access the current time.

\qml import QtQuick 2.0

Item { Timer { interval: 500; running: true; repeat: true onTriggered: time.text = Date().toString() }

Text { id: time } } \endqml

The Timer type is synchronized with the animation timer. Since the animation timer is usually set to 60fps, the resolution of Timer will be at best 16ms.

If the Timer is running and one of its properties is changed, the elapsed time will be reset. For example, if a Timer with interval of 1000ms has its repeat property changed 500ms after starting, the elapsed time will be reset to 0, and the Timer will be triggered 1000ms later.

See also: {Qt Quick Demo - Clocks}

Definition at line 89 of file qqmltimer.cpp.

References QAbstractAnimationJob::Completion, QAbstractAnimationJob::CurrentLoop, and d.

Member Function Documentation

◆ classBegin()

void QQmlTimer::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 263 of file qqmltimer.cpp.

References d.

◆ componentComplete()

void QQmlTimer::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 269 of file qqmltimer.cpp.

References d.

◆ event()

bool QQmlTimer::event ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QObject.

Definition at line 292 of file qqmltimer.cpp.

References d, emit, QObject::event(), runningChanged(), triggered(), and QEvent::type().

Here is the call graph for this function:

◆ interval()

int QQmlTimer::interval ( ) const

Definition at line 115 of file qqmltimer.cpp.

References d.

◆ intervalChanged

void QQmlTimer::intervalChanged ( )

signal

Referenced by setInterval().

Here is the caller graph for this function:

◆ isRepeating()

bool QQmlTimer::isRepeating ( ) const

\qmlproperty bool QtQml::Timer::repeat

If repeat is true the timer is triggered repeatedly at the specified interval; otherwise, the timer will trigger once at the specified interval and then stop (i.e. running will be set to false).

repeat defaults to false.

See also: running

Definition at line 160 of file qqmltimer.cpp.

References d.

◆ isRunning()

bool QQmlTimer::isRunning ( ) const

\qmlproperty bool QtQml::Timer::running

If set to true, starts the timer; otherwise stops the timer. For a non-repeating timer, running is set to false after the timer has been triggered.

running defaults to false.

See also: repeat

Definition at line 132 of file qqmltimer.cpp.

References d.

◆ repeatChanged

void QQmlTimer::repeatChanged ( )

signal

Referenced by setRepeating().

Here is the caller graph for this function:

◆ restart

void QQmlTimer::restart ( )

slot

\qmlmethod QtQml::Timer::restart()

Restarts the timer

If the Timer is not running it will be started, otherwise it will be stopped, reset to initial state and started. The running property will be true following a call to restart().

Definition at line 241 of file qqmltimer.cpp.

References setRunning().

Here is the call graph for this function:

◆ runningChanged

void QQmlTimer::runningChanged ( )

signal

Referenced by event(), and setRunning().

Here is the caller graph for this function:

◆ setInterval()

void QQmlTimer::setInterval ( int interval )

\qmlproperty int QtQml::Timer::interval

Sets the interval between triggers, in milliseconds.

The default interval is 1000 milliseconds.

Definition at line 105 of file qqmltimer.cpp.

References d, emit, interval, and intervalChanged().

Here is the call graph for this function:

◆ setRepeating()

void QQmlTimer::setRepeating ( bool repeating )

Definition at line 166 of file qqmltimer.cpp.

References d, emit, and repeatChanged().

Here is the call graph for this function:

◆ setRunning()

void QQmlTimer::setRunning ( bool running )

Definition at line 138 of file qqmltimer.cpp.

References d, emit, running, and runningChanged().

Referenced by restart(), start(), and stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTriggeredOnStart()

void QQmlTimer::setTriggeredOnStart ( bool triggeredOnStart )

Definition at line 199 of file qqmltimer.cpp.

References d, emit, triggeredOnStart, and triggeredOnStartChanged().

Here is the call graph for this function:

◆ start

void QQmlTimer::start ( )

slot

\qmlmethod QtQml::Timer::start()

Starts the timer

If the timer is already running, calling this method has no effect. The running property will be true following a call to start().

Definition at line 216 of file qqmltimer.cpp.

References setRunning().

Here is the call graph for this function:

◆ stop

void QQmlTimer::stop ( )

slot

\qmlmethod QtQml::Timer::stop()

Stops the timer

If the timer is not running, calling this method has no effect. The running property will be false following a call to stop().

Definition at line 228 of file qqmltimer.cpp.

References setRunning().

Here is the call graph for this function:

◆ triggered

void QQmlTimer::triggered ( )

signal

Referenced by event().

Here is the caller graph for this function:

◆ triggeredOnStart()

bool QQmlTimer::triggeredOnStart ( ) const

\qmlproperty bool QtQml::Timer::triggeredOnStart

When a timer is started, the first trigger is usually after the specified interval has elapsed. It is sometimes desirable to trigger immediately when the timer is started; for example, to establish an initial state.

If triggeredOnStart is true, the timer is triggered immediately when started, and subsequently at the specified interval. Note that if repeat is set to false, the timer is triggered twice; once on start, and again at the interval.

triggeredOnStart defaults to false.

See also: running

Definition at line 193 of file qqmltimer.cpp.

References d.

◆ triggeredOnStartChanged

void QQmlTimer::triggeredOnStartChanged ( )

signal

Referenced by setTriggeredOnStart().

Here is the caller graph for this function:

Property Documentation

◆ interval

int QQmlTimer::interval

readwrite

Definition at line 34 of file qqmltimer_p.h.

Referenced by setInterval().

◆ parent

QObject * QQmlTimer::parent

read

Definition at line 38 of file qqmltimer_p.h.

◆ repeat

bool QQmlTimer::repeat

readwrite

Definition at line 36 of file qqmltimer_p.h.

◆ running

bool QQmlTimer::running

readwrite

Definition at line 35 of file qqmltimer_p.h.

Referenced by setRunning().

◆ triggeredOnStart

bool QQmlTimer::triggeredOnStart

readwrite

Definition at line 37 of file qqmltimer_p.h.

Referenced by setTriggeredOnStart().

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

qtdeclarative/src/qml/types/qqmltimer_p.h (5c5a2c24847c636857153078e4716fcb242f394d)
qtdeclarative/src/qml/types/qqmltimer.cpp (0dc4fd240a2897c5c443a0ef6d84c416843e4938)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlTimer()

Member Function Documentation

◆ classBegin()

◆ componentComplete()

◆ event()

◆ interval()

◆ intervalChanged

◆ isRepeating()

◆ isRunning()

◆ repeatChanged

◆ restart

◆ runningChanged

◆ setInterval()

◆ setRepeating()

◆ setRunning()

◆ setTriggeredOnStart()

◆ start

◆ stop

◆ triggered

◆ triggeredOnStart()

◆ triggeredOnStartChanged

Property Documentation

◆ interval

◆ parent

◆ repeat

◆ running

◆ triggeredOnStart