API reference - Class QTimer

Notation used in Ruby API documentation

Description: Binding of QTimer

Class hierarchy: QTimer » QObject

Public constructors

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

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QTimer::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QTimer::event(QEvent *)
[virtual]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]boolisActiveMethod bool QTimer::isActive()
[const]boolisActive?Method bool QTimer::isActive()
[const]boolisSingleShotMethod bool QTimer::isSingleShot()
[const]boolisSingleShot?Method bool QTimer::isSingleShot()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidsetInterval(int msec)Method void QTimer::setInterval(int msec)
voidsetSingleShot(bool singleShot)Method void QTimer::setSingleShot(bool singleShot)
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()
[event]voidtimeoutSignal declaration for QTimer::timeout()
[const]inttimerIdMethod int QTimer::timerId()

Public static methods and constants

voidsingleShot(int msec,
QObject ptr receiver,
string member)
Static method void QTimer::singleShot(int msec, QObject *receiver, const char *member)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QTimer::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QTimer::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QTimer::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QTimer::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

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

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

[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

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.

[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()

void interval=(int msec)

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

[const] bool isActive

Description: Method bool QTimer::isActive()

[const] bool isActive?

Description: Method bool QTimer::isActive()

[const] bool isSingleShot

Description: Method bool QTimer::isSingleShot()

[const] bool isSingleShot?

Description: Method bool QTimer::isSingleShot()

[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 QTimer new(QObject ptr parent = 0)

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

This method creates an object of class QTimer.

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

void setSingleShot(bool singleShot)

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

[static] void singleShot(int msec,QObject ptr receiver,string member)

Description: Static method void QTimer::singleShot(int msec, QObject *receiver, const char *member)

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

void singleShot=(bool singleShot)

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

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.