QAbstractTextDocumentLayout¶
The
QAbstractTextDocumentLayout
class is an abstract base class used to implement custom layouts for QTextDocuments. More…
Inherited by: QPlainTextDocumentLayout
Synopsis¶
Functions¶
def
anchorAt
(pos)def
blockWithMarkerAt
(pos)def
document
()def
format
(pos)def
formatAt
(pos)def
formatIndex
(pos)def
handlerForObject
(objectType)def
imageAt
(pos)def
paintDevice
()def
registerHandler
(objectType, component)def
setPaintDevice
(device)def
unregisterHandler
(objectType[, component=None])
Virtual functions¶
def
blockBoundingRect
(block)def
documentChanged
(from, charsRemoved, charsAdded)def
documentSize
()def
draw
(painter, context)def
drawInlineObject
(painter, rect, object, posInDocument, format)def
frameBoundingRect
(frame)def
hitTest
(point, accuracy)def
pageCount
()def
positionInlineObject
(item, posInDocument, format)def
resizeInlineObject
(item, posInDocument, format)
Signals¶
def
documentSizeChanged
(newSize)def
pageCountChanged
(newPages)def
update
([arg__1=QRectF(0., 0., 1000000000., 1000000000.)])def
updateBlock
(block)
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 aQTextDocument
object with thesetDocumentLayout()
function.You can insert custom objects into a
QTextDocument
; see theQTextObjectInterface
class description for details.See also
- class PySide2.QtGui.QAbstractTextDocumentLayout(doc)¶
- param doc:
Creates a new text document layout for the given
document
.
- PySide2.QtGui.QAbstractTextDocumentLayout.anchorAt(pos)¶
- Parameters:
pos –
PySide2.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.
- PySide2.QtGui.QAbstractTextDocumentLayout.blockBoundingRect(block)¶
- Parameters:
block –
PySide2.QtGui.QTextBlock
- Return type:
Returns the bounding rectangle of
block
.
- PySide2.QtGui.QAbstractTextDocumentLayout.blockWithMarkerAt(pos)¶
- Parameters:
pos –
PySide2.QtCore.QPointF
- Return type:
Returns the block (probably a list item) whose
marker
is found at the given positionpos
.
- PySide2.QtGui.QAbstractTextDocumentLayout.document()¶
- Return type:
Returns the text document that this layout is operating on.
- PySide2.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
, andcharsAdded
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 andcharsAdded
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 andcharsAdded
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 correspondingQTextLayout
object needs to be processed. You can access theQTextBlock
‘s layout using thelayout()
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
- PySide2.QtGui.QAbstractTextDocumentLayout.documentSize()¶
- Return type:
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
- PySide2.QtGui.QAbstractTextDocumentLayout.documentSizeChanged(newSize)¶
- Parameters:
newSize –
PySide2.QtCore.QSizeF
- PySide2.QtGui.QAbstractTextDocumentLayout.draw(painter, context)¶
- Parameters:
painter –
PySide2.QtGui.QPainter
context –
PySide2.QtGui.QAbstractTextDocumentLayout.PaintContext
Draws the layout with the given
painter
using the givencontext
.
- PySide2.QtGui.QAbstractTextDocumentLayout.drawInlineObject(painter, rect, object, posInDocument, format)¶
- Parameters:
painter –
PySide2.QtGui.QPainter
rect –
PySide2.QtCore.QRectF
object –
PySide2.QtGui.QTextInlineObject
posInDocument – int
format –
PySide2.QtGui.QTextFormat
This function is called to draw the inline object,
object
, with the givenpainter
within the rectangle specified byrect
using the specified textformat
.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
- PySide2.QtGui.QAbstractTextDocumentLayout.format(pos)¶
- Parameters:
pos – int
- Return type:
Returns the character format that is applicable at the given
position
.
- PySide2.QtGui.QAbstractTextDocumentLayout.formatAt(pos)¶
- Parameters:
pos –
PySide2.QtCore.QPointF
- Return type:
Returns the text format at the given position
pos
.
- PySide2.QtGui.QAbstractTextDocumentLayout.formatIndex(pos)¶
- Parameters:
pos – int
- Return type:
int
Returns the index of the format at position
pos
.
- PySide2.QtGui.QAbstractTextDocumentLayout.frameBoundingRect(frame)¶
- Parameters:
frame –
PySide2.QtGui.QTextFrame
- Return type:
Returns the bounding rectangle of
frame
.
- PySide2.QtGui.QAbstractTextDocumentLayout.handlerForObject(objectType)¶
- Parameters:
objectType – int
- Return type:
Returns a handler for objects of the given
objectType
.
- PySide2.QtGui.QAbstractTextDocumentLayout.hitTest(point, accuracy)¶
- Parameters:
point –
PySide2.QtCore.QPointF
accuracy –
HitTestAccuracy
- Return type:
int
Returns the cursor position for the given
point
with the specifiedaccuracy
. Returns -1 if no valid cursor position was found.
- PySide2.QtGui.QAbstractTextDocumentLayout.imageAt(pos)¶
- Parameters:
pos –
PySide2.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.
- PySide2.QtGui.QAbstractTextDocumentLayout.pageCount()¶
- Return type:
int
Returns the number of pages contained in the layout.
See also
- PySide2.QtGui.QAbstractTextDocumentLayout.pageCountChanged(newPages)¶
- Parameters:
newPages – int
- PySide2.QtGui.QAbstractTextDocumentLayout.paintDevice()¶
- Return type:
Returns the paint device used to render the document’s layout.
See also
- PySide2.QtGui.QAbstractTextDocumentLayout.positionInlineObject(item, posInDocument, format)¶
- Parameters:
posInDocument – int
format –
PySide2.QtGui.QTextFormat
Lays out the inline object
item
using the given textformat
.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
- PySide2.QtGui.QAbstractTextDocumentLayout.registerHandler(objectType, component)¶
- Parameters:
objectType – int
component –
PySide2.QtCore.QObject
Registers the given
component
as a handler for items of the givenobjectType
.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
.
- PySide2.QtGui.QAbstractTextDocumentLayout.resizeInlineObject(item, posInDocument, format)¶
- Parameters:
posInDocument – int
format –
PySide2.QtGui.QTextFormat
Sets the size of the inline object
item
corresponding to the textformat
.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.
- PySide2.QtGui.QAbstractTextDocumentLayout.setPaintDevice(device)¶
- Parameters:
device –
PySide2.QtGui.QPaintDevice
Sets the paint device used for rendering the document’s layout to the given
device
.See also
- PySide2.QtGui.QAbstractTextDocumentLayout.unregisterHandler(objectType[, component=None])¶
- Parameters:
objectType – int
component –
PySide2.QtCore.QObject
Unregisters the given
component
as a handler for items of the givenobjectType
, or any handler if thecomponent
is not specified.
- PySide2.QtGui.QAbstractTextDocumentLayout.update([arg__1=QRectF(0., 0., 1000000000., 1000000000.)])¶
- Parameters:
arg__1 –
PySide2.QtCore.QRectF
- PySide2.QtGui.QAbstractTextDocumentLayout.updateBlock(block)¶
- Parameters:
block –
PySide2.QtGui.QTextBlock
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.