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

#include <qtextlist.h>

Inheritance diagram for QTextList:

Collaboration diagram for QTextList:

Public Member Functions
	QTextList (QTextDocument *doc)

	~QTextList ()

int	count () const

QTextBlock	item (int i) const

int	itemNumber (const QTextBlock &) const

QString	itemText (const QTextBlock &) const

void	removeItem (int i)

void	remove (const QTextBlock &)

void	add (const QTextBlock &block)

void	setFormat (const QTextListFormat &format)

QTextListFormat	format () const

Public Member Functions inherited from QTextObject
QTextFormat	format () const

int	formatIndex () const

QTextDocument *	document () const

int	objectIndex () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::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)

	~QTextBlockGroup ()

virtual void	blockInserted (const QTextBlock &block)

virtual void	blockRemoved (const QTextBlock &block)

virtual void	blockFormatChanged (const QTextBlock &block)

QList< QTextBlock >	blockList () const

	QTextBlockGroup (QTextBlockGroupPrivate &p, QTextDocument *doc)

Protected Member Functions inherited from QTextObject
	QTextObject (QTextDocument *doc)

	~QTextObject ()

void	setFormat (const QTextFormat &format)

	QTextObject (QTextObjectPrivate &p, QTextDocument *doc)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

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

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

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

\reentrant

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.

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 53 of file qtextlist.h.

Constructor & Destructor Documentation

◆ QTextList()

QTextList::QTextList ( QTextDocument * doc )

explicit

Definition at line 105 of file qtextlist.cpp.

◆ ~QTextList()

QTextList::~QTextList ( )

Definition at line 113 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 301 of file qtextlist.cpp.

Here is the call graph for this function:

◆ count()

int QTextList::count ( ) const

Returns the number of items in the list.

Definition at line 120 of file qtextlist.cpp.

◆ format()

QTextListFormat QTextList::format ( ) const

inline

Returns the list's format.

Definition at line 73 of file qtextlist.h.

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 131 of file qtextlist.cpp.

Here is the caller graph for this function:

◆ 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 157 of file qtextlist.cpp.

◆ itemText()

QString QTextList::itemText ( const QTextBlock & block ) const

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

Definition at line 168 of file qtextlist.cpp.

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 288 of file qtextlist.cpp.

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 272 of file qtextlist.cpp.

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 80 of file qtextlist.h.

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTextList()

◆ ~QTextList()

Member Function Documentation

◆ add()

◆ count()

◆ format()

◆ item()

◆ itemNumber()

◆ itemText()

◆ remove()

◆ removeItem()

◆ setFormat()