API reference - Class QTextList

Notation used in Ruby API documentation

Description: Binding of QTextList

Class hierarchy: QTextList » QTextBlockGroup » QTextObject » QObject

Public constructors

new QTextListnew(QTextDocument ptr doc)Constructor QTextList::QTextList(QTextDocument *doc)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidadd(const QTextBlock block)Method void QTextList::add(const QTextBlock &block)
[const]intcountMethod int QTextList::count()
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QTextList::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QTextList::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QTextList::eventFilter(QObject *, QEvent *)
[const]QTextListFormatformatMethod QTextListFormat QTextList::format()
voidformat=(const QTextListFormat format)Method void QTextList::setFormat(const QTextListFormat &format)
[const]boolisEmpty?Method bool QTextList::isEmpty()
[const]QTextBlockitem(int i)Method QTextBlock QTextList::item(int i)
[const]intitemNumber(const QTextBlock arg1)Method int QTextList::itemNumber(const QTextBlock &)
[const]stringitemText(const QTextBlock arg1)Method QString QTextList::itemText(const QTextBlock &)
voidremove(const QTextBlock arg1)Method void QTextList::remove(const QTextBlock &)
voidremoveItem(int i)Method void QTextList::removeItem(int i)
voidsetFormat(const QTextListFormat format)Method void QTextList::setFormat(const QTextListFormat &format)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

[virtual]voidblockFormatChanged(const QTextBlock block)Virtual method void QTextList::blockFormatChanged(const QTextBlock &block)
[virtual]voidblockInserted(const QTextBlock block)Virtual method void QTextList::blockInserted(const QTextBlock &block)
[const]QTextBlock[]blockListMethod QList<QTextBlock> QTextList::blockList()
[virtual]voidblockRemoved(const QTextBlock block)Virtual method void QTextList::blockRemoved(const QTextBlock &block)
[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QTextList::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QTextList::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QTextList::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QTextList::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QTextList::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QTextList::timerEvent(QTimerEvent *)

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

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.

void add(const QTextBlock block)

Description: Method void QTextList::add(const QTextBlock &block)

[virtual] void blockFormatChanged(const QTextBlock block)

Description: Virtual method void QTextList::blockFormatChanged(const QTextBlock &block)

This method can be reimplemented in a derived class.

[virtual] void blockInserted(const QTextBlock block)

Description: Virtual method void QTextList::blockInserted(const QTextBlock &block)

This method can be reimplemented in a derived class.

[const] QTextBlock[] blockList

Description: Method QList<QTextBlock> QTextList::blockList()

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

[virtual] void blockRemoved(const QTextBlock block)

Description: Virtual method void QTextList::blockRemoved(const QTextBlock &block)

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] int count

Description: Method int QTextList::count()

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 QTextList::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 QTextList::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 QTextList::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] QTextListFormat format

Description: Method QTextListFormat QTextList::format()

Python specific notes:

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

void format=(const QTextListFormat format)

Description: Method void QTextList::setFormat(const QTextListFormat &format)

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

[const] bool isEmpty?

Description: Method bool QTextList::isEmpty()

[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

[const] QTextBlock item(int i)

Description: Method QTextBlock QTextList::item(int i)

[const] int itemNumber(const QTextBlock arg1)

Description: Method int QTextList::itemNumber(const QTextBlock &)

[const] string itemText(const QTextBlock arg1)

Description: Method QString QTextList::itemText(const QTextBlock &)

[static] new QTextList new(QTextDocument ptr doc)

Description: Constructor QTextList::QTextList(QTextDocument *doc)

This method creates an object of class QTextList.

Python specific notes:

This method is the default initializer of the object

[const] int receivers(string signal)

Description: Method int QTextList::receivers(const char *signal)

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

void remove(const QTextBlock arg1)

Description: Method void QTextList::remove(const QTextBlock &)

void removeItem(int i)

Description: Method void QTextList::removeItem(int i)

[const] QObject ptr sender

Description: Method QObject *QTextList::sender()

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

void setFormat(const QTextListFormat format)

Description: Method void QTextList::setFormat(const QTextListFormat &format)

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

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