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

API reference - Class QTimer

Notation used in Ruby API documentation

Description: Binding of QTimer

Class hierarchy: QTimer » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

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

Detailed description

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

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

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.

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.

[const] bool active

Description: Method bool QTimer::isActive()

Python specific notes:

The object exposes a readable attribute 'active'. This is the getter.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QTimer::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

[const] int interval

Description: Method int QTimer::interval()

Python specific notes:

The object exposes a readable attribute 'interval'. This is the getter.

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.

[const] bool isActive?

Description: Method bool QTimer::isActive()

Python specific notes:

The object exposes a readable attribute 'active'. This is the getter.

[const] bool isSingleShot?

Description: Method bool QTimer::isSingleShot()

Python specific notes:

The object exposes a readable attribute 'singleShot'. This is the getter.

[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

[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

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

[const] QObject ptr sender

Description: Method QObject *QTimer::sender()

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

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.

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.

[const] bool singleShot

Description: Method bool QTimer::isSingleShot()

Python specific notes:

The object exposes a readable attribute 'singleShot'. This is the getter.

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.

void start(int msec)

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

void start

Description: Method void QTimer::start()

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void stop

Description: Method void QTimer::stop()

[event] void timeout

Description: Signal declaration for QTimer::timeout()

You can bind a procedure to this signal.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] int timerId

Description: Method int QTimer::timerId()

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.