QTextBlockGroup Class

The QTextBlockGroup class provides a container for text blocks within a QTextDocument. More...

Header: #include <QTextBlockGroup>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Inherits: QTextObject
Inherited By:


Note: All functions in this class are reentrant.

Protected Functions

QTextBlockGroup(QTextDocument *document)
virtual ~QTextBlockGroup()
virtual void blockFormatChanged(const QTextBlock &block)
virtual void blockInserted(const QTextBlock &block)
QList<QTextBlock> blockList() const
virtual void blockRemoved(const QTextBlock &block)

Detailed Description

Block groups can be used to organize blocks of text within a document. They maintain an up-to-date list of the text blocks that belong to them, even when text blocks are being edited.

Each group has a parent document which is specified when the group is constructed.

Text blocks can be inserted into a group with blockInserted(), and removed with blockRemoved(). If a block's format is changed, blockFormatChanged() is called.

The list of blocks in the group is returned by blockList(). Note that the blocks in the list are not necessarily 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.

See also QTextBlock and QTextDocument.

Member Function Documentation

[explicit protected] QTextBlockGroup::QTextBlockGroup(QTextDocument *document)

Creates a new block group for the given document.

Warning: This function should only be called from QTextDocument::createObject().

[virtual noexcept protected] QTextBlockGroup::~QTextBlockGroup()

Destroys this block group; the blocks are not deleted, they simply don't belong to this block anymore.

[virtual protected] void QTextBlockGroup::blockFormatChanged(const QTextBlock &block)

This function is called whenever the specified block of text is changed. The text block is a member of this group.

The base class implementation does nothing.

[virtual protected] void QTextBlockGroup::blockInserted(const QTextBlock &block)

Appends the given block to the end of the group.

Warning: If you reimplement this function you must call the base class implementation.

[protected] QList<QTextBlock> QTextBlockGroup::blockList() const

Returns a (possibly empty) list of all the blocks that are part of the block group.

[virtual protected] void QTextBlockGroup::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.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.