QTextLayout¶

The QTextLayout class is used to lay out and render text. More…

Synopsis¶

Functions¶

def beginLayout ()
def boundingRect ()
def cacheEnabled ()
def clearFormats ()
def clearLayout ()
def createLine ()
def cursorMoveStyle ()
def draw (p, pos[, selections=list()[, clip=QRectF()]])
def drawCursor (p, pos, cursorPosition)
def drawCursor (p, pos, cursorPosition, width)
def endLayout ()
def font ()
def formats ()
def glyphRuns ([from=-1[, length=-1]])
def isValidCursorPosition (pos)
def leftCursorPosition (oldPos)
def lineAt (i)
def lineCount ()
def lineForTextPosition (pos)
def maximumWidth ()
def minimumWidth ()
def nextCursorPosition (oldPos[, mode=QTextLayout.CursorMode.SkipCharacters])
def position ()
def preeditAreaPosition ()
def preeditAreaText ()
def previousCursorPosition (oldPos[, mode=QTextLayout.CursorMode.SkipCharacters])
def rightCursorPosition (oldPos)
def setCacheEnabled (enable)
def setCursorMoveStyle (style)
def setFlags (flags)
def setFont (f)
def setFormats (overrides)
def setPosition (p)
def setPreeditArea (position, text)
def setRawFont (rawFont)
def setText (string)
def setTextOption (option)
def text ()
def textOption ()

Detailed Description¶

It offers many features expected from a modern text layout engine, including Unicode compliant rendering, line breaking and handling of cursor positioning. It can also produce and render device independent layout, something that is important for WYSIWYG applications.

The class has a rather low level API and unless you intend to implement your own text rendering for some specialized widget, you probably won’t need to use it directly.

QTextLayout can be used with both plain and rich text.

QTextLayout can be used to create a sequence of QTextLine instances with given widths and can position them independently on the screen. Once the layout is done, these lines can be drawn on a paint device.

The text to be laid out can be provided in the constructor or set with setText() .

The layout can be seen as a sequence of QTextLine objects; use createLine() to create a QTextLine instance, and lineAt() or lineForTextPosition() to retrieve created lines.

Here is a code snippet that demonstrates the layout phase:

leading = fontMetrics.leading()
height = 0
textLayout.setCacheEnabled(True)
textLayout.beginLayout()
while 1:
    line = textLayout.createLine()
    if (not line.isValid())
        break
    line.setLineWidth(lineWidth)
    height += leading
    line.setPosition(QPointF(0, height))
    height += line.height()

textLayout.endLayout()

The text can then be rendered by calling the layout’s draw() function:

painter = QPainter(self)
textLayout.draw(painter, QPoint(0, 0))

For a given position in the text you can find a valid cursor position with isValidCursorPosition() , nextCursorPosition() , and previousCursorPosition() .

The QTextLayout itself can be positioned with setPosition() ; it has a boundingRect() , and a minimumWidth() and a maximumWidth() .

See also

QStaticText

class PySide6.QtGui.QTextLayout¶

PySide6.QtGui.QTextLayout(text)

PySide6.QtGui.QTextLayout(text, font[, paintdevice=None])

PySide6.QtGui.QTextLayout(b)

Parameters

text – str
font – PySide6.QtGui.QFont
paintdevice – PySide6.QtGui.QPaintDevice
b – PySide6.QtGui.QTextBlock

Constructs an empty text layout.

See also

setText()

Constructs a text layout to lay out the given text.

Constructs a text layout to lay out the given text with the specified font.

All the metric and layout calculations will be done in terms of the paint device, paintdevice. If paintdevice is None the calculations will be done in screen metrics.

Constructs a text layout to lay out the given text.

PySide6.QtGui.QTextLayout.CursorMode¶

Constant	Description
QTextLayout.SkipCharacters
QTextLayout.SkipWords

PySide6.QtGui.QTextLayout.beginLayout()¶

Begins the layout process.

Warning

This will invalidate the layout, so all existing QTextLine objects that refer to the previous contents should now be discarded.

Table of Contents

Previous topic

Next topic

QTextLayout¶

Synopsis¶

Functions¶

Detailed Description¶