#include <qtextdocumentlayout_p.h>

Inheritance diagram for QTextDocumentLayout:

Collaboration diagram for QTextDocumentLayout:

Public Member Functions
	QTextDocumentLayout (QTextDocument *doc)

void	draw (QPainter *painter, const PaintContext &context) override

int	hitTest (const QPointF &point, Qt::HitTestAccuracy accuracy) const override

int	pageCount () const override

QSizeF	documentSize () const override

void	setCursorWidth (int width)

int	cursorWidth () const

void	setFixedColumnWidth (int width)

void	setViewport (const QRectF &viewport)

virtual QRectF	frameBoundingRect (QTextFrame *frame) const override

virtual QRectF	blockBoundingRect (const QTextBlock &block) const override

QRectF	tableBoundingRect (QTextTable *table) const

QRectF	tableCellBoundingRect (QTextTable *table, const QTextTableCell &cell) const

int	layoutStatus () const

int	dynamicPageCount () const

QSizeF	dynamicDocumentSize () const

void	ensureLayouted (qreal)

qreal	idealWidth () const

bool	contentHasAlignment () const

Public Member Functions inherited from QAbstractTextDocumentLayout
	QAbstractTextDocumentLayout (QTextDocument *doc)
	the format of the selection More...

	~QAbstractTextDocumentLayout ()

QString	anchorAt (const QPointF &pos) const

QString	imageAt (const QPointF &pos) const

QTextFormat	formatAt (const QPointF &pos) const

QTextBlock	blockWithMarkerAt (const QPointF &pos) const

void	setPaintDevice (QPaintDevice *device)

QPaintDevice *	paintDevice () const

QTextDocument *	document () const

void	registerHandler (int objectType, QObject *component)

void	unregisterHandler (int objectType, QObject *component=nullptr)

QTextObjectInterface *	handlerForObject (int objectType) 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
void	documentChanged (int from, int oldLength, int length) override

void	resizeInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) override

void	positionInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) override

void	drawInlineObject (QPainter *p, const QRectF &rect, QTextInlineObject item, int posInDocument, const QTextFormat &format) override

virtual void	timerEvent (QTimerEvent *e) override

Protected Member Functions inherited from QAbstractTextDocumentLayout
	QAbstractTextDocumentLayout (QAbstractTextDocumentLayoutPrivate &, QTextDocument *)

int	formatIndex (int pos)

QTextCharFormat	format (int pos)

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	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)

Properties
int	cursorWidth

qreal	idealWidth

bool	contentHasAlignment

Properties inherited from QObject
QString	objectName
	the name of this object More...

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

Signals inherited from QAbstractTextDocumentLayout
void	update (const QRectF &=QRectF(0., 0., 1000000000., 1000000000.))

void	updateBlock (const QTextBlock &block)

void	documentSizeChanged (const QSizeF &newSize)

void	pageCountChanged (int newPages)

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

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

Definition at line 65 of file qtextdocumentlayout_p.h.

Constructor & Destructor Documentation

◆ QTextDocumentLayout()

QTextDocumentLayout::QTextDocumentLayout ( QTextDocument * doc )

explicit

Definition at line 3721 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ blockBoundingRect()

QRectF QTextDocumentLayout::blockBoundingRect ( const QTextBlock & block ) const

overridevirtual

Returns the bounding rectangle of block.

Implements QAbstractTextDocumentLayout.

Definition at line 4124 of file qtextdocumentlayout.cpp.

◆ contentHasAlignment()

bool QTextDocumentLayout::contentHasAlignment ( ) const

Definition at line 4207 of file qtextdocumentlayout.cpp.

◆ cursorWidth()

int QTextDocumentLayout::cursorWidth ( ) const

Definition at line 4043 of file qtextdocumentlayout.cpp.

◆ documentChanged()

void QTextDocumentLayout::documentChanged	(	int	position,
		int	charsRemoved,
		int	charsAdded
	)

overrideprotectedvirtual

This function is called whenever the contents of the document change. A change occurs when text is inserted, removed, or a combination of these two. The change is specified by position, charsRemoved, and charsAdded corresponding to the starting character position of the change, the number of characters removed from the document, and the number of characters added.

For example, when inserting the text "Hello" into an empty document, charsRemoved would be 0 and charsAdded would be 5 (the length of the string).

Replacing text is a combination of removing and inserting. For example, if the text "Hello" gets replaced by "Hi", charsRemoved would be 5 and charsAdded would be 2.

For subclasses of QAbstractTextDocumentLayout, this is the central function where a large portion of the work to lay out and position document contents is done.

For example, in a subclass that only arranges blocks of text, an implementation of this function would have to do the following:

\list

Determine the list of changed \l{QTextBlock}(s) using the parameters provided.
Each QTextBlock object's corresponding QTextLayout object needs to be processed. You can access the \l{QTextBlock}'s layout using the QTextBlock::layout() function. This processing should take the document's page size into consideration.
If the total number of pages changed, the pageCountChanged() signal should be emitted.
If the total size changed, the documentSizeChanged() signal should be emitted.
The update() signal should be emitted to schedule a repaint of areas in the layout that require repainting. \endlist

See also: QTextLayout

Implements QAbstractTextDocumentLayout.

Definition at line 3782 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ documentSize()

QSizeF QTextDocumentLayout::documentSize ( ) const

overridevirtual

Returns the total size of the document's layout.

This information can be used by display widgets to update their scroll bars correctly.

See also: documentSizeChanged(), QTextDocument::pageSize

Implements QAbstractTextDocumentLayout.

Definition at line 3996 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ draw()

void QTextDocumentLayout::draw	(	QPainter *	painter,
		const PaintContext &	context
	)

overridevirtual

Draws the layout with the given painter using the given context.

Implements QAbstractTextDocumentLayout.

Definition at line 3728 of file qtextdocumentlayout.cpp.

◆ drawInlineObject()

void QTextDocumentLayout::drawInlineObject	(	QPainter *	painter,
		const QRectF &	rect,
		QTextInlineObject	object,
		int	posInDocument,
		const QTextFormat &	format
	)

overrideprotectedvirtual

This function is called to draw the inline object, object, with the given painter within the rectangle specified by rect using the specified text format.

posInDocument specifies the position of the object within the document.

The default implementation calls drawObject() on the object handlers. This function is called only within Qt. Subclasses can reimplement this function to customize the drawing of inline objects.

See also: draw()

Reimplemented from QAbstractTextDocumentLayout.

Definition at line 3960 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ dynamicDocumentSize()

QSizeF QTextDocumentLayout::dynamicDocumentSize ( ) const

Definition at line 3983 of file qtextdocumentlayout.cpp.

Here is the caller graph for this function:

◆ dynamicPageCount()

int QTextDocumentLayout::dynamicPageCount ( ) const

Definition at line 3974 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureLayouted()

void QTextDocumentLayout::ensureLayouted ( qreal y )

Definition at line 4195 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameBoundingRect()

QRectF QTextDocumentLayout::frameBoundingRect ( QTextFrame * frame ) const

overridevirtual

Returns the bounding rectangle of frame.

Implements QAbstractTextDocumentLayout.

Definition at line 4095 of file qtextdocumentlayout.cpp.

◆ hitTest()

int QTextDocumentLayout::hitTest	(	const QPointF &	point,
		Qt::HitTestAccuracy	accuracy
	)		const

overridevirtual

Returns the cursor position for the given point with the specified accuracy. Returns -1 if no valid cursor position was found.

Implements QAbstractTextDocumentLayout.

Definition at line 3872 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ idealWidth()

qreal QTextDocumentLayout::idealWidth ( ) const

Definition at line 4200 of file qtextdocumentlayout.cpp.

◆ layoutStatus()

int QTextDocumentLayout::layoutStatus ( ) const

Definition at line 4153 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ pageCount()

int QTextDocumentLayout::pageCount ( ) const

overridevirtual

Returns the number of pages contained in the layout.

See also: pageCountChanged()

Implements QAbstractTextDocumentLayout.

Definition at line 3989 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ positionInlineObject()

void QTextDocumentLayout::positionInlineObject	(	QTextInlineObject	item,
		int	posInDocument,
		const QTextFormat &	format
	)

overrideprotectedvirtual

Lays out the inline object item using the given text format.

posInDocument specifies the position of the object within the document.

The default implementation does nothing. This function is called only within Qt. Subclasses can reimplement this function to customize the position of inline objects.

See also: drawInlineObject()

Reimplemented from QAbstractTextDocumentLayout.

Definition at line 3933 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ resizeInlineObject()

void QTextDocumentLayout::resizeInlineObject	(	QTextInlineObject	item,
		int	posInDocument,
		const QTextFormat &	format
	)

overrideprotectedvirtual

Sets the size of the inline object item corresponding to the text format.

posInDocument specifies the position of the object within the document.

The default implementation resizes the item to the size returned by the object handler's intrinsicSize() function. This function is called only within Qt. Subclasses can reimplement this function to customize the resizing of inline objects.

Reimplemented from QAbstractTextDocumentLayout.

Definition at line 3898 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ setCursorWidth()

void QTextDocumentLayout::setCursorWidth ( int width )

Definition at line 4037 of file qtextdocumentlayout.cpp.

◆ setFixedColumnWidth()

void QTextDocumentLayout::setFixedColumnWidth ( int width )

Definition at line 4049 of file qtextdocumentlayout.cpp.

◆ setViewport()

void QTextDocumentLayout::setViewport ( const QRectF & viewport )

Definition at line 3756 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ tableBoundingRect()

QRectF QTextDocumentLayout::tableBoundingRect ( QTextTable * table ) const

Definition at line 4068 of file qtextdocumentlayout.cpp.

◆ tableCellBoundingRect()

QRectF QTextDocumentLayout::tableCellBoundingRect	(	QTextTable *	table,
		const QTextTableCell &	cell
	)		const

Definition at line 4055 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

◆ timerEvent()

void QTextDocumentLayout::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QTimer provides a higher-level interface to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also: startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 4162 of file qtextdocumentlayout.cpp.

Here is the call graph for this function:

Property Documentation

◆ contentHasAlignment

bool QTextDocumentLayout::contentHasAlignment

read

Definition at line 118 of file qtextdocumentlayout_p.h.

◆ cursorWidth

int QTextDocumentLayout::cursorWidth

readwrite

Definition at line 118 of file qtextdocumentlayout_p.h.

◆ idealWidth

qreal QTextDocumentLayout::idealWidth

read

Definition at line 118 of file qtextdocumentlayout_p.h.

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

src/gui/text/qtextdocumentlayout_p.h
src/gui/text/qtextdocumentlayout.cpp

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTextDocumentLayout()

Member Function Documentation

◆ blockBoundingRect()

◆ contentHasAlignment()

◆ cursorWidth()

◆ documentChanged()

◆ documentSize()

◆ draw()

◆ drawInlineObject()

◆ dynamicDocumentSize()

◆ dynamicPageCount()

◆ ensureLayouted()

◆ frameBoundingRect()

◆ hitTest()

◆ idealWidth()

◆ layoutStatus()

◆ pageCount()

◆ positionInlineObject()

◆ resizeInlineObject()

◆ setCursorWidth()

◆ setFixedColumnWidth()

◆ setViewport()

◆ tableBoundingRect()

◆ tableCellBoundingRect()

◆ timerEvent()

Property Documentation

◆ contentHasAlignment

◆ cursorWidth

◆ idealWidth