API reference - Class QTextObject

Notation used in Ruby API documentation

Description: Binding of QTextObject

Class hierarchy: QTextObject » QObject

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QTextObject::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextDocument ptrdocumentMethod QTextDocument *QTextObject::document()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QTextObject::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QTextObject::eventFilter(QObject *, QEvent *)
[const]QTextFormatformatMethod QTextFormat QTextObject::format()
[const]intformatIndexMethod int QTextObject::formatIndex()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]intobjectIndexMethod int QTextObject::objectIndex()

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QTextObject::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QTextObject::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QTextObject::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QTextObject::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QTextDocument ptr document

Description: Method QTextDocument *QTextObject::document()

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] QTextFormat format

Description: Method QTextFormat QTextObject::format()

[const] int formatIndex

Description: Method int QTextObject::formatIndex()

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

[const] int objectIndex

Description: Method int QTextObject::objectIndex()

[const] int receivers(string signal)

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

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

void setFormat(const QTextFormat format)

Description: Method void QTextObject::setFormat(const QTextFormat &format)

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 QTextObject::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

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

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

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