API reference - Class QDeadlineTimer

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QDeadlineTimer

Sub-classes: ForeverConstant, QFlags_ForeverConstant

Public constructors

new QDeadlineTimernew(const Qt_TimerType type_ = Qt::CoarseTimer)Constructor QDeadlineTimer::QDeadlineTimer(Qt::TimerType type_)
new QDeadlineTimernew(const QDeadlineTimer_ForeverConstant arg1,
const Qt_TimerType type_ = Qt::CoarseTimer)
Constructor QDeadlineTimer::QDeadlineTimer(QDeadlineTimer::ForeverConstant, Qt::TimerType type_)
new QDeadlineTimernew(long long msecs,
const Qt_TimerType type = Qt::CoarseTimer)
Constructor QDeadlineTimer::QDeadlineTimer(qint64 msecs, Qt::TimerType type)

Public methods

QDeadlineTimer+=(long long msecs)Method QDeadlineTimer &QDeadlineTimer::operator+=(qint64 msecs)
QDeadlineTimer-=(long long msecs)Method QDeadlineTimer &QDeadlineTimer::operator-=(qint64 msecs)
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.
voidassign(const QDeadlineTimer other)Assigns another object to self
[const]long longdeadlineMethod qint64 QDeadlineTimer::deadline()
[const]long longdeadlineNSecsMethod qint64 QDeadlineTimer::deadlineNSecs()
[const]new QDeadlineTimer ptrdupCreates a copy of self
[const]boolhasExpiredMethod bool QDeadlineTimer::hasExpired()
[const]boolisForever?Method bool QDeadlineTimer::isForever()
[const]long longremainingTimeMethod qint64 QDeadlineTimer::remainingTime()
[const]long longremainingTimeNSecsMethod qint64 QDeadlineTimer::remainingTimeNSecs()
voidsetDeadline(long long msecs,
const Qt_TimerType timerType = Qt::CoarseTimer)
Method void QDeadlineTimer::setDeadline(qint64 msecs, Qt::TimerType timerType)
voidsetPreciseDeadline(long long secs,
long long nsecs = 0,
const Qt_TimerType type = Qt::CoarseTimer)
Method void QDeadlineTimer::setPreciseDeadline(qint64 secs, qint64 nsecs, Qt::TimerType type)
voidsetPreciseRemainingTime(long long secs,
long long nsecs = 0,
const Qt_TimerType type = Qt::CoarseTimer)
Method void QDeadlineTimer::setPreciseRemainingTime(qint64 secs, qint64 nsecs, Qt::TimerType type)
voidsetRemainingTime(long long msecs,
const Qt_TimerType type = Qt::CoarseTimer)
Method void QDeadlineTimer::setRemainingTime(qint64 msecs, Qt::TimerType type)
voidsetTimerType(const Qt_TimerType type)Method void QDeadlineTimer::setTimerType(Qt::TimerType type)
voidswap(QDeadlineTimer other)Method void QDeadlineTimer::swap(QDeadlineTimer &other)
[const]Qt_TimerTypetimerTypeMethod Qt::TimerType QDeadlineTimer::timerType()
voidtimerType=(const Qt_TimerType type)Method void QDeadlineTimer::setTimerType(Qt::TimerType type)

Public static methods and constants

[static,const]QDeadlineTimer_ForeverConstantForeverEnum constant QDeadlineTimer::Forever
QDeadlineTimeraddNSecs(QDeadlineTimer dt,
long long nsecs)
Static method QDeadlineTimer QDeadlineTimer::addNSecs(QDeadlineTimer dt, qint64 nsecs)
QDeadlineTimercurrent(const Qt_TimerType timerType = Qt::CoarseTimer)Static method QDeadlineTimer QDeadlineTimer::current(Qt::TimerType timerType)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

+=

Signature: QDeadlineTimer += (long long msecs)

Description: Method QDeadlineTimer &QDeadlineTimer::operator+=(qint64 msecs)

-=

Signature: QDeadlineTimer -= (long long msecs)

Description: Method QDeadlineTimer &QDeadlineTimer::operator-=(qint64 msecs)

Forever

Signature: [static,const] QDeadlineTimer_ForeverConstant Forever

Description: Enum constant QDeadlineTimer::Forever

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

_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.

addNSecs

Signature: [static] QDeadlineTimer addNSecs (QDeadlineTimer dt, long long nsecs)

Description: Static method QDeadlineTimer QDeadlineTimer::addNSecs(QDeadlineTimer dt, qint64 nsecs)

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

assign

Signature: void assign (const QDeadlineTimer other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

current

Signature: [static] QDeadlineTimer current (const Qt_TimerType timerType = Qt::CoarseTimer)

Description: Static method QDeadlineTimer QDeadlineTimer::current(Qt::TimerType timerType)

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

deadline

Signature: [const] long long deadline

Description: Method qint64 QDeadlineTimer::deadline()

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

deadlineNSecs

Signature: [const] long long deadlineNSecs

Description: Method qint64 QDeadlineTimer::deadlineNSecs()

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QDeadlineTimer ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hasExpired

Signature: [const] bool hasExpired

Description: Method bool QDeadlineTimer::hasExpired()

isForever?

Signature: [const] bool isForever?

Description: Method bool QDeadlineTimer::isForever()

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

new

(1) Signature: [static] new QDeadlineTimer new (const Qt_TimerType type_ = Qt::CoarseTimer)

Description: Constructor QDeadlineTimer::QDeadlineTimer(Qt::TimerType type_)

This method creates an object of class QDeadlineTimer.

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

(2) Signature: [static] new QDeadlineTimer new (const QDeadlineTimer_ForeverConstant arg1, const Qt_TimerType type_ = Qt::CoarseTimer)

Description: Constructor QDeadlineTimer::QDeadlineTimer(QDeadlineTimer::ForeverConstant, Qt::TimerType type_)

This method creates an object of class QDeadlineTimer.

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

(3) Signature: [static] new QDeadlineTimer new (long long msecs, const Qt_TimerType type = Qt::CoarseTimer)

Description: Constructor QDeadlineTimer::QDeadlineTimer(qint64 msecs, Qt::TimerType type)

This method creates an object of class QDeadlineTimer.

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

remainingTime

Signature: [const] long long remainingTime

Description: Method qint64 QDeadlineTimer::remainingTime()

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

remainingTimeNSecs

Signature: [const] long long remainingTimeNSecs

Description: Method qint64 QDeadlineTimer::remainingTimeNSecs()

setDeadline

Signature: void setDeadline (long long msecs, const Qt_TimerType timerType = Qt::CoarseTimer)

Description: Method void QDeadlineTimer::setDeadline(qint64 msecs, Qt::TimerType timerType)

setPreciseDeadline

Signature: void setPreciseDeadline (long long secs, long long nsecs = 0, const Qt_TimerType type = Qt::CoarseTimer)

Description: Method void QDeadlineTimer::setPreciseDeadline(qint64 secs, qint64 nsecs, Qt::TimerType type)

setPreciseRemainingTime

Signature: void setPreciseRemainingTime (long long secs, long long nsecs = 0, const Qt_TimerType type = Qt::CoarseTimer)

Description: Method void QDeadlineTimer::setPreciseRemainingTime(qint64 secs, qint64 nsecs, Qt::TimerType type)

setRemainingTime

Signature: void setRemainingTime (long long msecs, const Qt_TimerType type = Qt::CoarseTimer)

Description: Method void QDeadlineTimer::setRemainingTime(qint64 msecs, Qt::TimerType type)

setTimerType

Signature: void setTimerType (const Qt_TimerType type)

Description: Method void QDeadlineTimer::setTimerType(Qt::TimerType type)

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

swap

Signature: void swap (QDeadlineTimer other)

Description: Method void QDeadlineTimer::swap(QDeadlineTimer &other)

timerType

Signature: [const] Qt_TimerType timerType

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

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

timerType=

Signature: void timerType= (const Qt_TimerType type)

Description: Method void QDeadlineTimer::setTimerType(Qt::TimerType type)

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