The QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together. \inmodule QtGui. More...

#include <qtextobject.h>

Inheritance diagram for QTextObject:

[legend]

Collaboration diagram for QTextObject:

[legend]

Public Member Functions
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

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

Friends
class	QTextDocumentPrivate

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 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 QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together. \inmodule QtGui.

\reentrant

The common grouping text objects are lists (QTextList), frames (QTextFrame), and tables (QTextTable). A text object has an associated format() and document().

There are essentially two kinds of text objects: those that are used with blocks (block formats), and those that are used with characters (character formats). The first kind are derived from QTextBlockGroup, and the second kind from QTextFrame.

You rarely need to use this class directly. When creating custom text objects, you will also need to reimplement QTextDocument::createObject() which acts as a factory method for creating text objects.

See also: QTextDocument, {Text Object Example}

Definition at line 60 of file qtextobject.h.

Constructor & Destructor Documentation

◆ QTextObject() [1/2]

QTextObject::QTextObject ( QTextDocument * document )

explicitprotected

Creates a new QTextObject for the given document.

Warning: This function should never be called directly, but only from QTextDocument::createObject().

Definition at line 92 of file qtextobject.cpp.

◆ ~QTextObject()

QTextObject::~QTextObject ( )

protected

Destroys the text object.

Warning: Text objects are owned by the document, so you should never destroy them yourself.

Definition at line 113 of file qtextobject.cpp.

◆ QTextObject() [2/2]

QTextObject::QTextObject	(	QTextObjectPrivate &	p,
		QTextDocument *	doc
	)

protected

Definition at line 102 of file qtextobject.cpp.

Member Function Documentation

◆ document()

QTextDocument * QTextObject::document ( ) const

Returns the document this object belongs to.

See also: format()

Definition at line 168 of file qtextobject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format()

QTextFormat QTextObject::format ( ) const

Returns the text object's format.

See also: setFormat(), document()

Definition at line 122 of file qtextobject.cpp.

Here is the caller graph for this function:

◆ formatIndex()

int QTextObject::formatIndex ( ) const

Returns the index of the object's format in the document's internal list of formats.

See also: QTextDocument::allFormats()

Definition at line 134 of file qtextobject.cpp.

Here is the caller graph for this function:

◆ objectIndex()

int QTextObject::objectIndex ( ) const

Returns the object index of this object. This can be used together with QTextFormat::setObjectIndex().

Definition at line 157 of file qtextobject.cpp.

Here is the caller graph for this function:

◆ setFormat()

void QTextObject::setFormat ( const QTextFormat & format )

protected

Sets the text object's format.

See also: format()

Definition at line 146 of file qtextobject.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QTextDocumentPrivate

friend class QTextDocumentPrivate

friend

Definition at line 84 of file qtextobject.h.

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

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTextObject() [1/2]

◆ ~QTextObject()

◆ QTextObject() [2/2]

Member Function Documentation

◆ document()

◆ format()

◆ formatIndex()

◆ objectIndex()

◆ setFormat()

Friends And Related Function Documentation

◆ QTextDocumentPrivate