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

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

voidadd(const QTextBlock block)Method void QTextList::add(const QTextBlock &block)
[const]intcountMethod int QTextList::count()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QTextList::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[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]boolisEmptyMethod bool QTextList::isEmpty()
[const]boolisEmpty?Method bool QTextList::isEmpty()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[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)Static method QString QTextList::tr(const char *s, const char *c)
stringtr(string s,
string c)
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)Static method QString QTextList::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)
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<class 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 *)

Detailed description

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<class 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 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 QTextList::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 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

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

void format=(const QTextListFormat format)

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

[const] bool isEmpty

Description: Method bool QTextList::isEmpty()

[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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

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

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

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

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)

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)

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)

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.