\reentrant More...

#include <qtextobject.h>

Inheritance diagram for QTextBlockGroup:

Collaboration diagram for QTextBlockGroup:

Protected Member Functions
	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)

Friends
class	QTextDocumentPrivate

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.

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

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 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 QTextBlockGroup class provides a container for text blocks within a QTextDocument. \inmodule QtGui

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, QTextDocument

Definition at line 52 of file qtextobject.h.

Constructor & Destructor Documentation

◆ QTextBlockGroup() [1/2]

QTextBlockGroup::QTextBlockGroup ( QTextDocument * document )

explicitprotected

Creates a new block group for the given document.

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

Definition at line 182 of file qtextobject.cpp.

◆ ~QTextBlockGroup()

QTextBlockGroup::~QTextBlockGroup ( )

protected

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

Definition at line 199 of file qtextobject.cpp.

◆ QTextBlockGroup() [2/2]

QTextBlockGroup::QTextBlockGroup	(	QTextBlockGroupPrivate &	p,
		QTextDocument *	doc
	)

protected

Definition at line 190 of file qtextobject.cpp.

Member Function Documentation

◆ blockFormatChanged()

void QTextBlockGroup::blockFormatChanged ( const QTextBlock & block )

protectedvirtual

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.

Definition at line 240 of file qtextobject.cpp.

◆ blockInserted()

void QTextBlockGroup::blockInserted ( const QTextBlock & block )

protectedvirtual

Appends the given block to the end of the group.

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

Definition at line 210 of file qtextobject.cpp.

References d, and it.

◆ blockList()

QList< QTextBlock > QTextBlockGroup::blockList ( ) const

protected

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

Definition at line 248 of file qtextobject.cpp.

References d.

◆ blockRemoved()

void QTextBlockGroup::blockRemoved ( const QTextBlock & block )

protectedvirtual

Removes the given block from the group; the block itself is not deleted, it simply isn't a member of this group anymore.

Definition at line 223 of file qtextobject.cpp.

References d, QTextDocumentPrivate::deleteObject(), QTextObject::document(), and QTextDocumentPrivate::get().

Referenced by QTextDocumentPrivate::setBlockFormat(), and QTextDocumentPrivate::undoRedo().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QTextDocumentPrivate

friend class QTextDocumentPrivate

friend

Definition at line 71 of file qtextobject.h.

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

qtbase/src/gui/text/qtextobject.h
qtbase/src/gui/text/qtextobject.cpp

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTextBlockGroup() [1/2]

◆ ~QTextBlockGroup()

◆ QTextBlockGroup() [2/2]

Member Function Documentation

◆ blockFormatChanged()

◆ blockInserted()

◆ blockList()

◆ blockRemoved()

Friends And Related Symbol Documentation

◆ QTextDocumentPrivate