KLayout Manual: Main Index » Class Index » API reference - Class QBasicTimer

API reference - Class QBasicTimer

Notation used in Ruby API documentation

Description: Binding of QBasicTimer

Public constructors

new QBasicTimernewConstructor QBasicTimer::QBasicTimer()

Public methods

[const]voidassign(const QBasicTimer other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QBasicTimerdupCreates a copy of self
[const]boolisActiveMethod bool QBasicTimer::isActive()
[const]boolisActive?Method bool QBasicTimer::isActive()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidstart(int msec,
QObject ptr obj)
Method void QBasicTimer::start(int msec, QObject *obj)
voidstopMethod void QBasicTimer::stop()
[const]inttimerIdMethod int QBasicTimer::timerId()

Detailed description

[const] void assign(const QBasicTimer other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

void destroy

Description: Explicitly destroy the object

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

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

[const] QBasicTimer dup

Description: Creates a copy of self

[const] bool isActive

Description: Method bool QBasicTimer::isActive()

[const] bool isActive?

Description: Method bool QBasicTimer::isActive()

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

[static] new QBasicTimer new

Description: Constructor QBasicTimer::QBasicTimer()

This method creates an object of class QBasicTimer.

void start(int msec,QObject ptr obj)

Description: Method void QBasicTimer::start(int msec, QObject *obj)

void stop

Description: Method void QBasicTimer::stop()

[const] int timerId

Description: Method int QBasicTimer::timerId()