API reference - Class QTimer

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QTimer

Class hierarchy: QTimer » QObject

Public constructors

new QTimernew(QObject ptr parent = 0)Constructor QTimer::QTimer(QObject *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]boolactiveMethod bool QTimer::isActive()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QTimer::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QTimer::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QTimer::objectNameChanged(const QString &objectName)
voidemit_timeoutEmitter for signal void QTimer::timeout()
boolevent(QEvent ptr arg1)Virtual method bool QTimer::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QTimer::eventFilter(QObject *, QEvent *)
[const]intintervalMethod int QTimer::interval()
voidinterval=(int msec)Method void QTimer::setInterval(int msec)
[const]boolisActive?Method bool QTimer::isActive()
[const]boolisSingleShot?Method bool QTimer::isSingleShot()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QTimer::objectNameChanged(const QString &objectName)
[const]intremainingTimeMethod int QTimer::remainingTime()
voidsetInterval(int msec)Method void QTimer::setInterval(int msec)
voidsetSingleShot(bool singleShot)Method void QTimer::setSingleShot(bool singleShot)
voidsetTimerType(const Qt_TimerType atype)Method void QTimer::setTimerType(Qt::TimerType atype)
[const]boolsingleShotMethod bool QTimer::isSingleShot()
voidsingleShot=(bool singleShot)Method void QTimer::setSingleShot(bool singleShot)
voidstart(int msec)Method void QTimer::start(int msec)
voidstartMethod void QTimer::start()
voidstopMethod void QTimer::stop()
[signal]voidtimeoutSignal declaration for QTimer::timeout()
[const]inttimerIdMethod int QTimer::timerId()
[const]Qt_TimerTypetimerTypeMethod Qt::TimerType QTimer::timerType()
voidtimerType=(const Qt_TimerType atype)Method void QTimer::setTimerType(Qt::TimerType atype)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QTimer::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QTimer::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QTimer::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QTimer::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QTimer::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QTimer::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QTimer::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QTimer::sender()
[const]intsenderSignalIndexMethod int QTimer::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QTimer::timerEvent(QTimerEvent *)

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

active

Signature: [const] bool active

Description: Method bool QTimer::isActive()

Python specific notes:
The object exposes a readable attribute 'active'. This is the getter.

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QTimer::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QTimer::customEvent(QEvent *)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QTimer::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QTimer::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

Description: Emitter for signal void QTimer::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QTimer::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_timeout

Signature: void emit_timeout

Description: Emitter for signal void QTimer::timeout()

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QTimer::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QTimer::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

interval

Signature: [const] int interval

Description: Method int QTimer::interval()

Python specific notes:
The object exposes a readable attribute 'interval'. This is the getter.

interval=

Signature: void interval= (int msec)

Description: Method void QTimer::setInterval(int msec)

Python specific notes:
The object exposes a writable attribute 'interval'. This is the setter.

isActive?

Signature: [const] bool isActive?

Description: Method bool QTimer::isActive()

Python specific notes:
The object exposes a readable attribute 'active'. This is the getter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QTimer::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

isSingleShot?

Signature: [const] bool isSingleShot?

Description: Method bool QTimer::isSingleShot()

Python specific notes:
The object exposes a readable attribute 'singleShot'. This is the getter.

new

Signature: [static] new QTimer new (QObject ptr parent = 0)

Description: Constructor QTimer::QTimer(QObject *parent)

This method creates an object of class QTimer.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QTimer::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QTimer::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

remainingTime

Signature: [const] int remainingTime

Description: Method int QTimer::remainingTime()

Python specific notes:
The object exposes a readable attribute 'remainingTime'. This is the getter.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QTimer::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QTimer::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setInterval

Signature: void setInterval (int msec)

Description: Method void QTimer::setInterval(int msec)

Python specific notes:
The object exposes a writable attribute 'interval'. This is the setter.

setSingleShot

Signature: void setSingleShot (bool singleShot)

Description: Method void QTimer::setSingleShot(bool singleShot)

Python specific notes:
The object exposes a writable attribute 'singleShot'. This is the setter.

setTimerType

Signature: void setTimerType (const Qt_TimerType atype)

Description: Method void QTimer::setTimerType(Qt::TimerType atype)

Python specific notes:
The object exposes a writable attribute 'timerType'. This is the setter.

singleShot

Signature: [const] bool singleShot

Description: Method bool QTimer::isSingleShot()

Python specific notes:
The object exposes a readable attribute 'singleShot'. This is the getter.

singleShot=

Signature: void singleShot= (bool singleShot)

Description: Method void QTimer::setSingleShot(bool singleShot)

Python specific notes:
The object exposes a writable attribute 'singleShot'. This is the setter.

start

(1) Signature: void start (int msec)

Description: Method void QTimer::start(int msec)

(2) Signature: void start

Description: Method void QTimer::start()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Method void QTimer::stop()

timeout

Signature: [signal] void timeout

Description: Signal declaration for QTimer::timeout()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'timeout'. This is the getter.
The object exposes a writable attribute 'timeout'. This is the setter.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QTimer::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

timerId

Signature: [const] int timerId

Description: Method int QTimer::timerId()

timerType

Signature: [const] Qt_TimerType timerType

Description: Method Qt::TimerType QTimer::timerType()

Python specific notes:
The object exposes a readable attribute 'timerType'. This is the getter.

timerType=

Signature: void timerType= (const Qt_TimerType atype)

Description: Method void QTimer::setTimerType(Qt::TimerType atype)

Python specific notes:
The object exposes a writable attribute 'timerType'. This is the setter.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QTimer::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QTimer::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.