\reentrant More...

#include <qtextobject.h>

Inheritance diagram for QTextFrame:

Collaboration diagram for QTextFrame:

Classes
class	iterator
	\reentrant More...

Public Types
typedef iterator	Iterator
	Qt-style synonym for QTextFrame::iterator.

Public Member Functions
	QTextFrame (QTextDocument *doc)
	Creates a new empty frame for the text document.

	~QTextFrame ()
	Destroys the text frame.

void	setFrameFormat (const QTextFrameFormat &format)
	Sets the frame's format.

QTextFrameFormat	frameFormat () const
	Returns the frame's format.

QTextCursor	firstCursorPosition () const
	Returns the first cursor position inside the frame.

QTextCursor	lastCursorPosition () const
	Returns the last cursor position inside the frame.

int	firstPosition () const
	Returns the first document position inside the frame.

int	lastPosition () const
	Returns the last document position inside the frame.

QTextFrameLayoutData *	layoutData () const

void	setLayoutData (QTextFrameLayoutData *data)

QList< QTextFrame * >	childFrames () const
	Returns a (possibly empty) list of the frame's child frames.

QTextFrame *	parentFrame () const
	Returns the frame's parent frame.

iterator	begin () const
	Returns an iterator pointing to the first document element inside the frame.

iterator	end () const
	Returns an iterator pointing to the position past the last document element inside the frame.

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

Protected Member Functions
	QTextFrame (QTextFramePrivate &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	iterator

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.

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 QTextFrame class represents a frame in a QTextDocument. \inmodule QtGui

Text frames provide structure for the text in a document. They are used as generic containers for other document elements. Frames are usually created by using QTextCursor::insertFrame().

\omit Each frame in a document consists of a frame start character, QChar(0xFDD0), followed by the frame's contents, followed by a frame end character, QChar(0xFDD1). The character formats of the start and end character contain a reference to the frame object's objectIndex. \endomit

Frames can be used to create hierarchical structures in rich text documents. Each document has a root frame (QTextDocument::rootFrame()), and each frame beneath the root frame has a parent frame and a (possibly empty) list of child frames. The parent frame can be found with parentFrame(), and the childFrames() function provides a list of child frames.

Each frame contains at least one text block to enable text cursors to insert new document elements within. As a result, the QTextFrame::iterator class is used to traverse both the blocks and child frames within a given frame. The first and last child elements in the frame can be found with begin() and end().

A frame also has a format (specified using QTextFrameFormat) which can be set with setFormat() and read with format().

Text cursors can be obtained that point to the first and last valid cursor positions within a frame; use the firstCursorPosition() and lastCursorPosition() functions for this. The frame's extent in the document can be found with firstPosition() and lastPosition().

You can iterate over a frame's contents using the QTextFrame::iterator class: this provides read-only access to its internal list of text blocks and child frames.

See also: QTextCursor, QTextDocument

Definition at line 80 of file qtextobject.h.

Member Typedef Documentation

◆ Iterator

QTextFrame::Iterator

Qt-style synonym for QTextFrame::iterator.

Definition at line 134 of file qtextobject.h.

Constructor & Destructor Documentation

◆ QTextFrame() [1/2]

QTextFrame::QTextFrame ( QTextDocument * doc )

explicit

Creates a new empty frame for the text document.

Definition at line 372 of file qtextobject.cpp.

◆ ~QTextFrame()

QTextFrame::~QTextFrame ( )

Destroys the text frame.

Warning: Text frames are owned by the document, so you should never destroy them yourself. In order to remove a frame from its document, remove its contents using a QTextCursor.

Definition at line 384 of file qtextobject.cpp.

References d.

◆ QTextFrame() [2/2]

QTextFrame::QTextFrame	(	QTextFramePrivate &	p,
		QTextDocument *	doc
	)

protected

Definition at line 393 of file qtextobject.cpp.

Member Function Documentation

◆ begin()

QTextFrame::iterator QTextFrame::begin ( ) const

Returns an iterator pointing to the first document element inside the frame.

Please see the document \l{STL-style-Iterators} for more information.

See also: end()

Definition at line 587 of file qtextobject.cpp.

References e, firstPosition(), QTextDocumentPrivate::get(), lastPosition(), and priv().

Referenced by QQuickTextNode::addTextDocument(), QTextDocumentLayoutPrivate::frameIteratorForYPosition(), QTextTable::mergeCells(), QTextTable::splitCell(), QTextHtmlExporter::toHtml(), and QQuickTextEdit::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ childFrames()

QList< QTextFrame * > QTextFrame::childFrames ( ) const

Returns a (possibly empty) list of the frame's child frames.

See also: parentFrame()

Definition at line 403 of file qtextobject.cpp.

References d.

Referenced by QQuickTextNode::addTextDocument(), QTextDocumentLayoutPrivate::layoutFlow(), markFrames(), QTextFramePrivate::remove_me(), and QQuickTextEdit::updatePaintNode().

Here is the caller graph for this function:

◆ end()

QTextFrame::iterator QTextFrame::end ( ) const

Returns an iterator pointing to the position past the last document element inside the frame.

Please see the document \l{STL-Style Iterators} for more information.

See also: begin()

Definition at line 600 of file qtextobject.cpp.

References e, firstPosition(), QTextDocumentPrivate::get(), lastPosition(), and priv().

Referenced by QTextFrame::iterator::operator--(), QTextBlock::text(), QTextBlock::textDirection(), and QTextBlock::textFormats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ firstCursorPosition()

QTextCursor QTextFrame::firstCursorPosition ( ) const

Returns the first cursor position inside the frame.

See also: lastCursorPosition(), firstPosition(), lastPosition()

Definition at line 427 of file qtextobject.cpp.

References d, firstPosition(), and QTextCursorPrivate::fromPosition().

Referenced by QQuickTextNode::addTextDocument(), and QQuickTextEdit::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ firstPosition()

int QTextFrame::firstPosition ( ) const

Returns the first document position inside the frame.

See also: lastPosition(), firstCursorPosition(), lastCursorPosition()

Definition at line 449 of file qtextobject.cpp.

References d.

Referenced by QQuickTextNode::addTextDocument(), begin(), end(), firstCursorPosition(), QTextDocumentLayoutPrivate::frameIteratorForTextPosition(), QTextDocumentLayoutPrivate::frameIteratorForYPosition(), isEmptyBlockBeforeTable(), markFrames(), QTextTable::removeColumns(), QTextTable::removeRows(), and QQuickTextEdit::updatePaintNode().

Here is the caller graph for this function:

◆ frameFormat()

QTextFrameFormat QTextFrame::frameFormat ( ) const

inline

Returns the frame's format.

See also: setFrameFormat()

Definition at line 89 of file qtextobject.h.

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

Referenced by QGraphicsTextItemPrivate::_q_mouseOnEdge(), QQuickTextNode::addTextDocument(), QLabelPrivate::ensureTextLayouted(), QTextDocumentLayoutPrivate::floatMargins(), QTextDocument::print(), QTextDocument::setDocumentMargin(), QTextHtmlExporter::toHtml(), and QQuickTextEdit::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lastCursorPosition()

QTextCursor QTextFrame::lastCursorPosition ( ) const

Returns the last cursor position inside the frame.

See also: firstCursorPosition(), firstPosition(), lastPosition()

Definition at line 438 of file qtextobject.cpp.

References d, QTextCursorPrivate::fromPosition(), and lastPosition().

Here is the call graph for this function:

◆ lastPosition()

int QTextFrame::lastPosition ( ) const

Returns the last document position inside the frame.

See also: firstPosition(), firstCursorPosition(), lastCursorPosition()

Definition at line 462 of file qtextobject.cpp.

References d.

Referenced by QQuickTextNode::addTextDocument(), begin(), end(), QTextDocumentLayoutPrivate::frameIteratorForTextPosition(), isEmptyBlockAfterTable(), isLineSeparatorBlockAfterTable(), lastCursorPosition(), markFrames(), and QQuickTextEdit::updatePaintNode().

Here is the caller graph for this function:

◆ layoutData()

QTextFrameLayoutData * QTextFrame::layoutData ( ) const

Definition at line 473 of file qtextobject.cpp.

References d.

◆ parentFrame()

QTextFrame * QTextFrame::parentFrame ( ) const

Returns the frame's parent frame.

If the frame is the root frame of a document, this will return 0.

See also: childFrames(), QTextDocument::rootFrame()

Definition at line 415 of file qtextobject.cpp.

References d.

Referenced by QTextDocumentLayoutPrivate::drawFrame(), QTextDocumentLayoutPrivate::frameIteratorForTextPosition(), and QTextDocumentPrivate::move().

Here is the caller graph for this function:

◆ setFrameFormat()

void QTextFrame::setFrameFormat ( const QTextFrameFormat & format )

inline

Sets the frame's format.

See also: frameFormat()

Definition at line 148 of file qtextobject.h.

References QTextObject::setFormat().

Referenced by QTextDocument::clone(), QLabelPrivate::ensureTextLayouted(), QTextDocument::print(), and QTextDocument::setDocumentMargin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLayoutData()

void QTextFrame::setLayoutData ( QTextFrameLayoutData * data )

Definition at line 482 of file qtextobject.cpp.

References d.

Friends And Related Symbol Documentation

◆ iterator

friend class iterator

friend

Definition at line 132 of file qtextobject.h.

◆ QTextDocumentPrivate

friend class QTextDocumentPrivate

friend

Definition at line 142 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

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Iterator

Constructor & Destructor Documentation

◆ QTextFrame() [1/2]

◆ ~QTextFrame()

◆ QTextFrame() [2/2]

Member Function Documentation

◆ begin()

◆ childFrames()

◆ end()

◆ firstCursorPosition()

◆ firstPosition()

◆ frameFormat()

◆ lastCursorPosition()

◆ lastPosition()

◆ layoutData()

◆ parentFrame()

◆ setFrameFormat()

◆ setLayoutData()

Friends And Related Symbol Documentation

◆ iterator

◆ QTextDocumentPrivate