QAbstractTextDocumentLayout

Inherited by: QPlainTextDocumentLayout

Synopsis

Functions

• def anchorAt (pos)
• def document ()
• def format (pos)
• def formatIndex (pos)
• def handlerForObject (objectType)
• def paintDevice ()
• def registerHandler (objectType, component)
• def setPaintDevice (device)

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 PySide.QtGui.QAbstractTextDocumentLayout class is an abstract base class used to implement custom layouts for QTextDocuments.

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 PySide.QtGui.QAbstractTextDocumentLayout to provide custom layout behavior for your text documents.

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

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

See also

PySide.QtGui.QTextObjectInterface

class PySide.QtGui.QAbstractTextDocumentLayout(doc)

Parameters:doc – PySide.QtGui.QTextDocument

Creates a new text document layout for the given document .

PySide.QtGui.QAbstractTextDocumentLayout.anchorAt(pos)

Parameters:pos – PySide.QtCore.QPointF Return type:unicode

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

PySide.QtGui.QAbstractTextDocumentLayout.blockBoundingRect(block)

Parameters:block – PySide.QtGui.QTextBlock Return type:PySide.QtCore.QRectF

Returns the bounding rectangle of block .

PySide.QtGui.QAbstractTextDocumentLayout.document()

Return type:PySide.QtGui.QTextDocument

Returns the text document that this layout is operating on.

PySide.QtGui.QAbstractTextDocumentLayout.documentChanged(from, charsRemoved, charsAdded)

Parameters:

• from – PySide.QtCore.int
• charsRemoved – PySide.QtCore.int
• charsAdded – PySide.QtCore.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 PySide.QtGui.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 PySide.QtGui.QTextBlock (s) using the parameters provided.
• Each PySide.QtGui.QTextBlock object’s corresponding PySide.QtGui.QTextLayout object needs to be processed. You can access the PySide.QtGui.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 PySide.QtGui.QAbstractTextDocumentLayout.pageCountChanged() signal should be emitted.
• If the total size changed, the PySide.QtGui.QAbstractTextDocumentLayout.documentSizeChanged() signal should be emitted.
• The PySide.QtGui.QAbstractTextDocumentLayout.update() signal should be emitted to schedule a repaint of areas in the layout that require repainting.

See also

PySide.QtGui.QTextLayout

PySide.QtGui.QAbstractTextDocumentLayout.documentSize()

Return type:PySide.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.

See also

PySide.QtGui.QAbstractTextDocumentLayout.documentSizeChanged() QTextDocument.pageSize

PySide.QtGui.QAbstractTextDocumentLayout.documentSizeChanged(newSize)

Parameters:newSize – PySide.QtCore.QSizeF

PySide.QtGui.QAbstractTextDocumentLayout.draw(painter, context)

Parameters:

• painter – PySide.QtGui.QPainter
• context – PySide.QtGui.QAbstractTextDocumentLayout::PaintContext

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

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

Parameters:

• painter – PySide.QtGui.QPainter
• rect – PySide.QtCore.QRectF
• object – PySide.QtGui.QTextInlineObject
• posInDocument – PySide.QtCore.int
• format – PySide.QtGui.QTextFormat

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

PySide.QtGui.QAbstractTextDocumentLayout.draw()

PySide.QtGui.QAbstractTextDocumentLayout.format(pos)

Parameters:pos – PySide.QtCore.int Return type:PySide.QtGui.QTextCharFormat

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

PySide.QtGui.QAbstractTextDocumentLayout.formatIndex(pos)

Parameters:pos – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the index of the format at position pos .

PySide.QtGui.QAbstractTextDocumentLayout.frameBoundingRect(frame)

Parameters:frame – PySide.QtGui.QTextFrame Return type:PySide.QtCore.QRectF

Returns the bounding rectangle of frame .

PySide.QtGui.QAbstractTextDocumentLayout.handlerForObject(objectType)

Parameters:objectType – PySide.QtCore.int Return type:PySide.QtGui.QTextObjectInterface

Returns a handler for objects of the given objectType .

PySide.QtGui.QAbstractTextDocumentLayout.hitTest(point, accuracy)

Parameters:

• point – PySide.QtCore.QPointF
• accuracy – PySide.QtCore.Qt.HitTestAccuracy

Return type:

PySide.QtCore.int

PySide.QtGui.QAbstractTextDocumentLayout.pageCount()

Return type:PySide.QtCore.int

Returns the number of pages contained in the layout.

See also

PySide.QtGui.QAbstractTextDocumentLayout.pageCountChanged()

PySide.QtGui.QAbstractTextDocumentLayout.pageCountChanged(newPages)

Parameters:newPages – PySide.QtCore.int

PySide.QtGui.QAbstractTextDocumentLayout.paintDevice()

Return type:PySide.QtGui.QPaintDevice

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

See also

PySide.QtGui.QAbstractTextDocumentLayout.setPaintDevice()

PySide.QtGui.QAbstractTextDocumentLayout.positionInlineObject(item, posInDocument, format)

Parameters:

• item – PySide.QtGui.QTextInlineObject
• posInDocument – PySide.QtCore.int
• format – PySide.QtGui.QTextFormat

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

PySide.QtGui.QAbstractTextDocumentLayout.drawInlineObject()

PySide.QtGui.QAbstractTextDocumentLayout.registerHandler(objectType, component)

Parameters:

• objectType – PySide.QtCore.int
• component – PySide.QtCore.QObject

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

Note

PySide.QtGui.QAbstractTextDocumentLayout.registerHandler() 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.

PySide.QtGui.QAbstractTextDocumentLayout.resizeInlineObject(item, posInDocument, format)

Parameters:

• item – PySide.QtGui.QTextInlineObject
• posInDocument – PySide.QtCore.int
• format – PySide.QtGui.QTextFormat

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.

PySide.QtGui.QAbstractTextDocumentLayout.setPaintDevice(device)

Parameters:device – PySide.QtGui.QPaintDevice

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

See also

PySide.QtGui.QAbstractTextDocumentLayout.paintDevice()

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

Parameters:arg__1 – PySide.QtCore.QRectF

PySide.QtGui.QAbstractTextDocumentLayout.updateBlock(block)

Parameters:block – PySide.QtGui.QTextBlock