![]() |
Qt 6.x
The Qt SDK
|
#include <qtextdocumentlayout_p.h>
Public Member Functions | |
QTextDocumentLayout (QTextDocument *doc) | |
void | draw (QPainter *painter, const PaintContext &context) override |
Draws the layout with the given painter using the given context. | |
int | hitTest (const QPointF &point, Qt::HitTestAccuracy accuracy) const override |
Returns the cursor position for the given point with the specified accuracy. | |
int | pageCount () const override |
Returns the number of pages contained in the layout. | |
QSizeF | documentSize () const override |
Returns the total size of the document's layout. | |
void | setCursorWidth (int width) |
int | cursorWidth () const |
void | setFixedColumnWidth (int width) |
void | setViewport (const QRectF &viewport) |
virtual QRectF | frameBoundingRect (QTextFrame *frame) const override |
Returns the bounding rectangle of frame. | |
virtual QRectF | blockBoundingRect (const QTextBlock &block) const override |
Returns the bounding rectangle of block. | |
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 |
![]() | |
QAbstractTextDocumentLayout (QTextDocument *doc) | |
\variable QAbstractTextDocumentLayout::Selection::format | |
~QAbstractTextDocumentLayout () | |
virtual void | draw (QPainter *painter, const PaintContext &context)=0 |
Draws the layout with the given painter using the given context. | |
virtual int | hitTest (const QPointF &point, Qt::HitTestAccuracy accuracy) const =0 |
Returns the cursor position for the given point with the specified accuracy. | |
QString | anchorAt (const QPointF &pos) const |
Returns the reference of the anchor the given position, or an empty string if no anchor exists at that point. | |
QString | imageAt (const QPointF &pos) const |
QTextFormat | formatAt (const QPointF &pos) const |
QTextBlock | blockWithMarkerAt (const QPointF &pos) const |
virtual int | pageCount () const =0 |
Returns the number of pages contained in the layout. | |
virtual QSizeF | documentSize () const =0 |
Returns the total size of the document's layout. | |
virtual QRectF | frameBoundingRect (QTextFrame *frame) const =0 |
Returns the bounding rectangle of frame. | |
virtual QRectF | blockBoundingRect (const QTextBlock &block) const =0 |
Returns the bounding rectangle of block. | |
void | setPaintDevice (QPaintDevice *device) |
Sets the paint device used for rendering the document's layout to the given device. | |
QPaintDevice * | paintDevice () const |
Returns the paint device used to render the document's layout. | |
QTextDocument * | document () const |
Returns the text document that this layout is operating on. | |
void | registerHandler (int objectType, QObject *component) |
Registers the given component as a handler for items of the given objectType. | |
void | unregisterHandler (int objectType, QObject *component=nullptr) |
QTextObjectInterface * | handlerForObject (int objectType) const |
Returns a handler for objects of the given objectType. | |
![]() | |
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 | |
void | documentChanged (int from, int oldLength, int length) override |
This function is called whenever the contents of the document change. | |
void | resizeInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) override |
Sets the size of the inline object item corresponding to the text format. | |
void | positionInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) override |
Lays out the inline object item using the given text format. | |
void | drawInlineObject (QPainter *p, const QRectF &rect, QTextInlineObject item, int posInDocument, const QTextFormat &format) override |
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. | |
virtual void | timerEvent (QTimerEvent *e) override |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
![]() | |
QAbstractTextDocumentLayout (QAbstractTextDocumentLayoutPrivate &, QTextDocument *) | |
virtual void | documentChanged (int from, int charsRemoved, int charsAdded)=0 |
This function is called whenever the contents of the document change. | |
virtual void | resizeInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) |
Sets the size of the inline object item corresponding to the text format. | |
virtual void | positionInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat &format) |
Lays out the inline object item using the given text format. | |
virtual void | drawInlineObject (QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format) |
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. | |
int | formatIndex (int pos) |
QTextCharFormat | format (int pos) |
Returns the character format that is applicable at the given position. | |
![]() | |
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) | |
Properties | |
int | cursorWidth |
qreal | idealWidth |
bool | contentHasAlignment |
![]() | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
![]() | |
void | deleteLater () |
\threadsafe | |
![]() | |
void | update (const QRectF &=QRectF(0., 0., 1000000000., 1000000000.)) |
This signal is emitted when the rectangle rect has been updated. | |
void | updateBlock (const QTextBlock &block) |
void | documentSizeChanged (const QSizeF &newSize) |
This signal is emitted when the size of the document layout changes to newSize. | |
void | pageCountChanged (int newPages) |
This signal is emitted when the number of pages in the layout changes; newPages is the updated page count. | |
![]() | |
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 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) |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
![]() | |
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) | |
Definition at line 29 of file qtextdocumentlayout_p.h.
|
explicit |
Definition at line 3689 of file qtextdocumentlayout.cpp.
References QTextFormat::ImageObject, and QAbstractTextDocumentLayout::registerHandler().
|
overridevirtual |
Returns the bounding rectangle of block.
Implements QAbstractTextDocumentLayout.
Definition at line 4092 of file qtextdocumentlayout.cpp.
References d, frame, QTextBlock::isValid(), QTextTableCell::isValid(), QTextBlock::isVisible(), layout, QTextBlock::layout(), QTextBlock::length(), QTextBlock::position(), and rect.
bool QTextDocumentLayout::contentHasAlignment | ( | ) | const |
Definition at line 4175 of file qtextdocumentlayout.cpp.
References d.
int QTextDocumentLayout::cursorWidth | ( | ) | const |
Definition at line 4011 of file qtextdocumentlayout.cpp.
References d.
|
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
Implements QAbstractTextDocumentLayout.
Definition at line 3750 of file qtextdocumentlayout.cpp.
References QTextBlock::clearLayout(), d, QAbstractTextDocumentLayout::document(), QAbstractTextDocumentLayout::documentSizeChanged(), dynamicDocumentSize(), emit, QTextDocument::findBlock(), QTextBlock::isValid(), QRectF::isValid(), QTextBlock::next(), qMax(), and QAbstractTextDocumentLayout::update().
|
overridevirtual |
Returns the total size of the document's layout.
This information can be used by display widgets to update their scroll bars correctly.
Implements QAbstractTextDocumentLayout.
Definition at line 3964 of file qtextdocumentlayout.cpp.
References d, and dynamicDocumentSize().
|
overridevirtual |
Draws the layout with the given painter using the given context.
Implements QAbstractTextDocumentLayout.
Definition at line 3696 of file qtextdocumentlayout.cpp.
References QRectF::adjusted(), context, d, frame, QFixed::fromReal(), painter, and qMax().
|
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.
Reimplemented from QAbstractTextDocumentLayout.
Definition at line 3928 of file qtextdocumentlayout.cpp.
References d, QAbstractTextDocumentLayout::drawInlineObject(), frame, QTextFrameFormat::InFlow, item, Q_ASSERT, rect, and QTextFormat::toCharFormat().
QSizeF QTextDocumentLayout::dynamicDocumentSize | ( | ) | const |
Definition at line 3951 of file qtextdocumentlayout.cpp.
References d.
Referenced by documentChanged(), documentSize(), dynamicPageCount(), QTextEditPrivate::relayoutDocument(), and timerEvent().
int QTextDocumentLayout::dynamicPageCount | ( | ) | const |
Definition at line 3942 of file qtextdocumentlayout.cpp.
References d, dynamicDocumentSize(), QSizeF::height(), and qCeil().
Referenced by pageCount(), and timerEvent().
Definition at line 4163 of file qtextdocumentlayout.cpp.
References QFixed::fromReal().
Referenced by QTextEditPrivate::relayoutDocument().
|
overridevirtual |
Returns the bounding rectangle of frame.
Implements QAbstractTextDocumentLayout.
Definition at line 4063 of file qtextdocumentlayout.cpp.
Referenced by QQuickTextNodeEngine::addFrameDecorations().
|
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 3840 of file qtextdocumentlayout.cpp.
References d, Qt::ExactHit, QFixed::fromReal(), QString::isEmpty(), QTextDocumentLayoutPrivate::PointExact, position(), QTextLayout::preeditAreaText(), QString::size(), QPointF::x(), QFixedPoint::x, QPointF::y(), and QFixedPoint::y.
qreal QTextDocumentLayout::idealWidth | ( | ) | const |
Definition at line 4168 of file qtextdocumentlayout.cpp.
References d.
int QTextDocumentLayout::layoutStatus | ( | ) | const |
Definition at line 4121 of file qtextdocumentlayout.cpp.
References d, QTextDocumentPrivate::get(), QTextDocumentPrivate::length(), and pos.
|
overridevirtual |
Returns the number of pages contained in the layout.
Implements QAbstractTextDocumentLayout.
Definition at line 3957 of file qtextdocumentlayout.cpp.
References d, and dynamicPageCount().
|
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.
Reimplemented from QAbstractTextDocumentLayout.
Definition at line 3901 of file qtextdocumentlayout.cpp.
References QTextObjectHandler::component, d, frame, item, line, Q_ASSERT, Q_UNUSED, and QTextFormat::toCharFormat().
|
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 3866 of file qtextdocumentlayout.cpp.
References QTextCharFormat::AlignMiddle, QTextObjectHandler::component, d, frame, QFixedSize::fromSizeF(), QSizeF::height(), QTextObjectHandler::iface, QTextFrameFormat::InFlow, QTextObjectInterface::intrinsicSize(), item, pos, Q_ASSERT, QTextFormat::toCharFormat(), and QSizeF::width().
void QTextDocumentLayout::setCursorWidth | ( | int | width | ) |
Definition at line 4005 of file qtextdocumentlayout.cpp.
References d.
void QTextDocumentLayout::setFixedColumnWidth | ( | int | width | ) |
Definition at line 4017 of file qtextdocumentlayout.cpp.
References d.
Definition at line 3724 of file qtextdocumentlayout.cpp.
References d, and viewport().
QRectF QTextDocumentLayout::tableBoundingRect | ( | QTextTable * | table | ) | const |
Definition at line 4036 of file qtextdocumentlayout.cpp.
References d, QTextTableCell::isValid(), and pos.
Referenced by QQuickTextNodeEngine::addFrameDecorations(), and tableCellBoundingRect().
QRectF QTextDocumentLayout::tableCellBoundingRect | ( | QTextTable * | table, |
const QTextTableCell & | cell | ||
) | const |
Definition at line 4023 of file qtextdocumentlayout.cpp.
References QTextTableData::cellRect(), QTextTableCell::isValid(), tableBoundingRect(), QRectF::topLeft(), and QRectF::translated().
Referenced by QQuickTextNodeEngine::addFrameDecorations().
|
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.
Reimplemented from QObject.
Definition at line 4130 of file qtextdocumentlayout.cpp.
References d, QAbstractTextDocumentLayout::documentSizeChanged(), dynamicDocumentSize(), dynamicPageCount(), e, emit, QAbstractTextDocumentLayout::pageCountChanged(), and QObject::timerEvent().
|
read |
Definition at line 82 of file qtextdocumentlayout_p.h.
|
readwrite |
Definition at line 82 of file qtextdocumentlayout_p.h.
|
read |
Definition at line 82 of file qtextdocumentlayout_p.h.