API reference - Class QEventLoop

Notation used in Ruby API documentation

Description: Binding of QEventLoop

Class hierarchy: QEventLoop » QObject

Public constructors

new QEventLoopnew(QObject ptr parent = 0)Constructor QEventLoop::QEventLoop(QObject *parent)

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QEventLoop::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QEventLoop::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QEventLoop::eventFilter(QObject *, QEvent *)
intexec(const QEventLoop_QFlags_ProcessEventsFlag flags = QEventLoop::AllEvents)Method int QEventLoop::exec(QFlags<QEventLoop::ProcessEventsFlag> flags)
voidexit(int returnCode = 0)Method void QEventLoop::exit(int returnCode)
[const]boolisRunningMethod bool QEventLoop::isRunning()
[const]boolisRunning?Method bool QEventLoop::isRunning()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boolprocessEvents(const QEventLoop_QFlags_ProcessEventsFlag flags = QEventLoop::AllEvents)Method bool QEventLoop::processEvents(QFlags<QEventLoop::ProcessEventsFlag> flags)
voidprocessEvents(const QEventLoop_QFlags_ProcessEventsFlag flags,
int maximumTime)
Method void QEventLoop::processEvents(QFlags<QEventLoop::ProcessEventsFlag> flags, int maximumTime)
voidquitMethod void QEventLoop::quit()
voidwakeUpMethod void QEventLoop::wakeUp()

Public static methods and constants

QEventLoop_ProcessEventsFlagAllEventsEnum constant QEventLoop::AllEvents
QEventLoop_ProcessEventsFlagDeferredDeletionEnum constant QEventLoop::DeferredDeletion
QEventLoop_ProcessEventsFlagDialogExecEnum constant QEventLoop::DialogExec
QEventLoop_ProcessEventsFlagEventLoopExecEnum constant QEventLoop::EventLoopExec
QEventLoop_ProcessEventsFlagExcludeSocketNotifiersEnum constant QEventLoop::ExcludeSocketNotifiers
QEventLoop_ProcessEventsFlagExcludeUserInputEventsEnum constant QEventLoop::ExcludeUserInputEvents
QEventLoop_ProcessEventsFlagWaitForMoreEventsEnum constant QEventLoop::WaitForMoreEvents
QEventLoop_ProcessEventsFlagX11ExcludeTimersEnum constant QEventLoop::X11ExcludeTimers
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QEventLoop::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QEventLoop::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QEventLoop::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QEventLoop::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

[static] QEventLoop_ProcessEventsFlag AllEvents

Description: Enum constant QEventLoop::AllEvents

[static] QEventLoop_ProcessEventsFlag DeferredDeletion

Description: Enum constant QEventLoop::DeferredDeletion

[static] QEventLoop_ProcessEventsFlag DialogExec

Description: Enum constant QEventLoop::DialogExec

[static] QEventLoop_ProcessEventsFlag EventLoopExec

Description: Enum constant QEventLoop::EventLoopExec

[static] QEventLoop_ProcessEventsFlag ExcludeSocketNotifiers

Description: Enum constant QEventLoop::ExcludeSocketNotifiers

[static] QEventLoop_ProcessEventsFlag ExcludeUserInputEvents

Description: Enum constant QEventLoop::ExcludeUserInputEvents

[static] QEventLoop_ProcessEventsFlag WaitForMoreEvents

Description: Enum constant QEventLoop::WaitForMoreEvents

[static] QEventLoop_ProcessEventsFlag X11ExcludeTimers

Description: Enum constant QEventLoop::X11ExcludeTimers

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QEventLoop::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 QEventLoop::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 QEventLoop::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 QEventLoop::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

int exec(const QEventLoop_QFlags_ProcessEventsFlag flags = QEventLoop::AllEvents)

Description: Method int QEventLoop::exec(QFlags<QEventLoop::ProcessEventsFlag> flags)

void exit(int returnCode = 0)

Description: Method void QEventLoop::exit(int returnCode)

[const] bool isRunning

Description: Method bool QEventLoop::isRunning()

[const] bool isRunning?

Description: Method bool QEventLoop::isRunning()

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

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

This method creates an object of class QEventLoop.

bool processEvents(const QEventLoop_QFlags_ProcessEventsFlag flags = QEventLoop::AllEvents)

Description: Method bool QEventLoop::processEvents(QFlags<QEventLoop::ProcessEventsFlag> flags)

void processEvents(const QEventLoop_QFlags_ProcessEventsFlag flags,int maximumTime)

Description: Method void QEventLoop::processEvents(QFlags<QEventLoop::ProcessEventsFlag> flags, int maximumTime)

void quit

Description: Method void QEventLoop::quit()

[const] int receivers(string signal)

Description: Method int QEventLoop::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 *QEventLoop::sender()

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

Description: Static method QString QEventLoop::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 QEventLoop::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 QEventLoop::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 QEventLoop::trUtf8(const char *s, const char *c, int n)

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

void wakeUp

Description: Method void QEventLoop::wakeUp()