QAbstractTextDocumentLayout

The QAbstractTextDocumentLayout class is an abstract base class used to implement custom layouts for QTextDocuments. More

Inheritance diagram of PySide6.QtGui.QAbstractTextDocumentLayout

Inherited by: QPlainTextDocumentLayout

Synopsis

Functions

Virtual functions

Detailed Description

The standard layout provided by Qt can handle simple word processing including inline images, lists and tables.

Some applications, e.g., a word processor or a DTP application might need more features than the ones provided by Qt’s layout engine, in which case you can subclass QAbstractTextDocumentLayout to provide custom layout behavior for your text documents.

An instance of the QAbstractTextDocumentLayout subclass can be installed on a QTextDocument object with the setDocumentLayout() function.

You can insert custom objects into a QTextDocument ; see the QTextObjectInterface class description for details.

class PySide6.QtGui.QAbstractTextDocumentLayout(doc)
Parameters

docPySide6.QtGui.QTextDocument

Creates a new text document layout for the given document.

PySide6.QtGui.QAbstractTextDocumentLayout.anchorAt(pos)
Parameters

posPySide6.QtCore.QPointF

Return type

str

Returns the reference of the anchor the given position, or an empty string if no anchor exists at that point.

PySide6.QtGui.QAbstractTextDocumentLayout.blockBoundingRect(block)
Parameters

blockPySide6.QtGui.QTextBlock

Return type

PySide6.QtCore.QRectF

Returns the bounding rectangle of block.

PySide6.QtGui.QAbstractTextDocumentLayout.blockWithMarkerAt(pos)
Parameters

posPySide6.QtCore.QPointF

Return type

PySide6.QtGui.QTextBlock

Returns the block (probably a list item) whose marker is found at the given position pos.

PySide6.QtGui.QAbstractTextDocumentLayout.document()
Return type

PySide6.QtGui.QTextDocument

Returns the text document that this layout is operating on.

PySide6.QtGui.QAbstractTextDocumentLayout.documentChanged(from, charsRemoved, charsAdded)
Parameters
  • from – int

  • charsRemoved – int

  • charsAdded – int

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:

  • Determine the list of changed QTextBlock (s) using the parameters provided.

  • Each QTextBlock object’s corresponding QTextLayout object needs to be processed. You can access the QTextBlock ‘s layout using the 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.

See also

QTextLayout

PySide6.QtGui.QAbstractTextDocumentLayout.documentSize()
Return type

PySide6.QtCore.QSizeF

Returns the total size of the document’s layout.

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

PySide6.QtGui.QAbstractTextDocumentLayout.documentSizeChanged(newSize)
Parameters

newSizePySide6.QtCore.QSizeF

This signal is emitted when the size of the document layout changes to newSize.

Subclasses of QAbstractTextDocumentLayout should emit this signal when the document’s entire layout size changes. This signal is useful for widgets that display text documents since it enables them to update their scroll bars correctly.

See also

documentSize()

PySide6.QtGui.QAbstractTextDocumentLayout.draw(painter, context)
Parameters

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

PySide6.QtGui.QAbstractTextDocumentLayout.drawInlineObject(painter, rect, object, posInDocument, format)
Parameters

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

PySide6.QtGui.QAbstractTextDocumentLayout.format(pos)
Parameters

pos – int

Return type

PySide6.QtGui.QTextCharFormat

Returns the character format that is applicable at the given position.

PySide6.QtGui.QAbstractTextDocumentLayout.formatAt(pos)
Parameters

posPySide6.QtCore.QPointF

Return type

PySide6.QtGui.QTextFormat

Returns the text format at the given position pos.

PySide6.QtGui.QAbstractTextDocumentLayout.formatIndex(pos)
Parameters

pos – int

Return type

int

Returns the index of the format at position pos.

PySide6.QtGui.QAbstractTextDocumentLayout.frameBoundingRect(frame)
Parameters

framePySide6.QtGui.QTextFrame

Return type

PySide6.QtCore.QRectF

Returns the bounding rectangle of frame.

PySide6.QtGui.QAbstractTextDocumentLayout.handlerForObject(objectType)
Parameters

objectType – int

Return type

PySide6.QtGui.QTextObjectInterface

Returns a handler for objects of the given objectType.

PySide6.QtGui.QAbstractTextDocumentLayout.hitTest(point, accuracy)
Parameters
Return type

int

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

PySide6.QtGui.QAbstractTextDocumentLayout.imageAt(pos)
Parameters

posPySide6.QtCore.QPointF

Return type

str

Returns the source of the image at the given position pos, or an empty string if no image exists at that point.

PySide6.QtGui.QAbstractTextDocumentLayout.pageCount()
Return type

int

Returns the number of pages contained in the layout.

PySide6.QtGui.QAbstractTextDocumentLayout.pageCountChanged(newPages)
Parameters

newPages – int

This signal is emitted when the number of pages in the layout changes; newPages is the updated page count.

Subclasses of QAbstractTextDocumentLayout should emit this signal when the number of pages in the layout has changed. Changes to the page count are caused by changes to the layout or the document content itself.

See also

pageCount()

PySide6.QtGui.QAbstractTextDocumentLayout.paintDevice()
Return type

PySide6.QtGui.QPaintDevice

Returns the paint device used to render the document’s layout.

See also

setPaintDevice()

PySide6.QtGui.QAbstractTextDocumentLayout.positionInlineObject(item, posInDocument, format)
Parameters

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.

PySide6.QtGui.QAbstractTextDocumentLayout.registerHandler(objectType, component)
Parameters

Registers the given component as a handler for items of the given objectType.

Note

has to be called once for each object type. This means that there is only one handler for multiple replacement characters of the same object type.

The text document layout does not take ownership of component.

PySide6.QtGui.QAbstractTextDocumentLayout.resizeInlineObject(item, posInDocument, format)
Parameters

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.

PySide6.QtGui.QAbstractTextDocumentLayout.setPaintDevice(device)
Parameters

devicePySide6.QtGui.QPaintDevice

Sets the paint device used for rendering the document’s layout to the given device.

See also

paintDevice()

PySide6.QtGui.QAbstractTextDocumentLayout.unregisterHandler(objectType[, component=None])
Parameters

Unregisters the given component as a handler for items of the given objectType, or any handler if the component is not specified.

PySide6.QtGui.QAbstractTextDocumentLayout.update([arg__1=QRectF(0., 0., 1000000000., 1000000000.)])
Parameters

arg__1PySide6.QtCore.QRectF

This signal is emitted when the rectangle rect has been updated.

Subclasses of QAbstractTextDocumentLayout should emit this signal when the layout of the contents change in order to repaint.

PySide6.QtGui.QAbstractTextDocumentLayout.updateBlock(block)
Parameters

blockPySide6.QtGui.QTextBlock

This signal is emitted when the specified block has been updated.

Subclasses of QAbstractTextDocumentLayout should emit this signal when the layout of block has changed in order to repaint.