QTextList Class Reference

\reentrant More...

#include <qtextlist.h>

Inheritance diagram for QTextList:

Collaboration diagram for QTextList:

Public Member Functions
	QTextList (QTextDocument *doc)
	~QTextList ()
int	count () const
	Returns the number of items in the list.
QTextBlock	item (int i) const
	Returns the {i}-th text block in the list.
int	itemNumber (const QTextBlock &) const
	Returns the index of the list item that corresponds to the given block.
QString	itemText (const QTextBlock &) const
	Returns the text of the list item that corresponds to the given block.
void	removeItem (int i)
	Removes the item at item position i from the list.
void	remove (const QTextBlock &)
	Removes the given block from the list.
void	add (const QTextBlock &block)
	Makes the given block part of the list.
void	setFormat (const QTextListFormat &format)
	Sets the list's format to format.
QTextListFormat	format () const
	Returns the list's format.
Public Member Functions inherited from QTextObject
QTextFormat	format () const
	Returns the text object's format.
int	formatIndex () const
	Returns the index of the object's format in the document's internal list of formats.
QTextDocument *	document () const
	Returns the document this object belongs to.
int	objectIndex () const
	Returns the object index of this object.
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject *watched, QEvent *event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false.
bool	isWindowType () const
	Returns true if the object is a window; otherwise returns false.
bool	isQuickItemType () const
	Returns true if the object is a QQuickItem; otherwise returns false.
bool	signalsBlocked () const noexcept
	Returns true if signals are blocked; otherwise returns false.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject *receiver, const char *member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	\threadsafe
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QTextBlockGroup
	QTextBlockGroup (QTextDocument *doc)
	Creates a new block group for the given document.
	~QTextBlockGroup ()
	Destroys this block group; the blocks are not deleted, they simply don't belong to this block anymore.
virtual void	blockInserted (const QTextBlock &block)
	Appends the given block to the end of the group.
virtual void	blockRemoved (const QTextBlock &block)
	Removes the given block from the group; the block itself is not deleted, it simply isn't a member of this group anymore.
virtual void	blockFormatChanged (const QTextBlock &block)
	This function is called whenever the specified block of text is changed.
QList< QTextBlock >	blockList () const
	Returns a (possibly empty) list of all the blocks that are part of the block group.
	QTextBlockGroup (QTextBlockGroupPrivate &p, QTextDocument *doc)
Protected Member Functions inherited from QTextObject
	QTextObject (QTextDocument *doc)
	Creates a new QTextObject for the given document.
	~QTextObject ()
	Destroys the text object.
void	setFormat (const QTextFormat &format)
	Sets the text object's format.
	QTextObject (QTextObjectPrivate &p, QTextDocument *doc)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\reentrant

The QTextList class provides a decorated list of items in a QTextDocument. \inmodule QtGui

A list contains a sequence of text blocks, each of which is marked with a bullet point or other symbol. Multiple levels of lists can be used, and the automatic numbering feature provides support for ordered numeric and alphabetical lists.

Lists are created by using a text cursor to insert an empty list at the current position or by moving existing text into a new list. The \l{QTextCursor::insertList()} function inserts an empty block into the document at the cursor position, and makes it the first item in a list.

    QTextListFormat listFormat;
    if (list) {
        listFormat = list->format();
        listFormat.setIndent(listFormat.indent() + 1);
    }
 
    listFormat.setStyle(QTextListFormat::ListDisc);
    cursor.insertList(listFormat);

The \l{QTextCursor::createList()} function takes the contents of the cursor's current block and turns it into the first item of a new list.

The cursor's current list is found with \l{QTextCursor::currentList()}.

The number of items in a list is given by count(). Each item can be obtained by its index in the list with the item() function. Similarly, the index of a given item can be found with itemNumber(). The text of each item can be found with the itemText() function.

Note that the items in the list may not be adjacent elements in the document. For example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.

List items can be deleted by index with the removeItem() function. remove() deletes the specified item in the list.

The list's format is set with setFormat() and read with format(). The format describes the decoration of the list itself, and not the individual items.

See also

QTextBlock, QTextListFormat, QTextCursor

Definition at line 17 of file qtextlist.h.

Constructor & Destructor Documentation

QTextList()

QTextList::QTextList ( QTextDocument *  doc )

explicit

Definition at line 71 of file qtextlist.cpp.

~QTextList()

QTextList::~QTextList

(

)

Definition at line 79 of file qtextlist.cpp.

Member Function Documentation

add()

void QTextList::add

(

const QTextBlock &

block

)

Makes the given block part of the list.

See also

remove(), removeItem()

Definition at line 278 of file qtextlist.cpp.

References QTextBlock::blockFormat(), fmt, QTextDocumentPrivate::get(), QTextObject::objectIndex(), and QTextDocumentPrivate::SetFormat.

Here is the call graph for this function:

count()

int QTextList::count

(

)

const

Returns the number of items in the list.

Definition at line 86 of file qtextlist.cpp.

References d.

format()

QTextListFormat QTextList::format ( ) const

inline

Returns the list's format.

Definition at line 37 of file qtextlist.h.

References QTextObject::format(), and QTextFormat::toListFormat().

Referenced by QAbstractTextDocumentLayout::blockWithMarkerAt(), QTextMarkdownImporter::cbText(), itemText(), QTextMarkdownWriter::writeBlock(), and QTextOdfWriter::writeBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

item()

QTextBlock QTextList::item

(

int

i

)

const

Returns the {i}-th text block in the list.

See also

count(), itemText()

Definition at line 97 of file qtextlist.cpp.

References d, and i.

itemNumber()

int QTextList::itemNumber

(

const QTextBlock &

block

)

const

Returns the index of the list item that corresponds to the given block.

Returns -1 if the block was not present in the list.

Definition at line 123 of file qtextlist.cpp.

References d.

Referenced by itemText(), and QTextMarkdownWriter::writeBlock().

Here is the caller graph for this function:

itemText()

QString QTextList::itemText

(

const QTextBlock &

block

)

const

Returns the text of the list item that corresponds to the given block.

Definition at line 134 of file qtextlist.cpp.

References QByteArray::append(), QTextBlock::blockFormat(), d, format(), QString::fromLatin1(), QByteArray::fromRawData(), QChar::fromUcs2(), i, item, itemNumber(), QTextListFormat::ListDecimal, QTextListFormat::ListLowerAlpha, QTextListFormat::ListLowerRoman, QTextFormat::ListNumberPrefix, QTextFormat::ListNumberSuffix, QTextListFormat::ListUpperAlpha, QTextListFormat::ListUpperRoman, QByteArray::mid(), QString::number(), QTextListFormat::numberPrefix(), QTextListFormat::numberSuffix(), numDigits(), Q_ASSERT, Qt::RightToLeft, QTextListFormat::start(), QTextListFormat::style(), and QTextBlock::textDirection().

Here is the call graph for this function:

remove()

void QTextList::remove

(

const QTextBlock &

block

)

Removes the given block from the list.

See also

add(), removeItem()

Definition at line 265 of file qtextlist.cpp.

References QTextBlock::blockFormat(), fmt, QTextDocumentPrivate::get(), and QTextDocumentPrivate::SetFormat.

Referenced by removeItem().

Here is the call graph for this function:

Here is the caller graph for this function:

removeItem()

void QTextList::removeItem

(

int

i

)

Removes the item at item position i from the list.

When the last item in the list is removed, the list is automatically deleted by the QTextDocument that owns it.

See also

add(), remove()

Definition at line 249 of file qtextlist.cpp.

References d, i, and remove().

Here is the call graph for this function:

setFormat()

void QTextList::setFormat ( const QTextListFormat &  format )

inline

Sets the list's format to format.

Definition at line 44 of file qtextlist.h.

References QTextObject::setFormat().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• qtbase/src/gui/text/qtextlist.h
• qtbase/src/gui/text/qtextlist.cpp