Table Of Contents

Previous topic

QColor

Next topic

QTextLayout.FormatRange

QTextLayout

Inheritance diagram of QTextLayout

Synopsis

Functions

Detailed Description

The PySide.QtGui.QTextLayout class is used to lay out and render text.

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.

PySide.QtGui.QTextLayout can be used with both plain and rich text.

PySide.QtGui.QTextLayout can be used to create a sequence of PySide.QtGui.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 PySide.QtGui.QTextLayout.setText() .

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

Here is a code snippet that demonstrates the layout phase:

leading = fontMetrics.leading()
height = 0
widthUsed = 0
textLayout.beginLayout()
while True:
    line = textLayout.createLine()
    if not line.isValid():
        break

    line.setLineWidth(lineWidth)
    height += leading
    line.setPosition(QPointF(0, height))
    height += line.height()
    widthUsed = qMax(widthUsed, line.naturalTextWidth())
textLayout.endLayout()

The text can then be rendered by calling the layout’s PySide.QtGui.QTextLayout.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 PySide.QtGui.QTextLayout.isValidCursorPosition() , PySide.QtGui.QTextLayout.nextCursorPosition() , and PySide.QtGui.QTextLayout.previousCursorPosition() .

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

See also

QStaticText

class PySide.QtGui.QTextLayout
class PySide.QtGui.QTextLayout(text)
class PySide.QtGui.QTextLayout(text, font[, paintdevice=None])
class PySide.QtGui.QTextLayout(b)
Parameters:

Constructs an empty text layout.

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 0 the calculations will be done in screen metrics.

Constructs a text layout to lay out the given block .

PySide.QtGui.QTextLayout.CursorMode
Constant Description
QTextLayout.SkipCharacters  
QTextLayout.SkipWords  
PySide.QtGui.QTextLayout.additionalFormats()
Return type:

Returns the list of additional formats supported by the text layout.

PySide.QtGui.QTextLayout.beginLayout()

Begins the layout process.

PySide.QtGui.QTextLayout.boundingRect()
Return type:PySide.QtCore.QRectF

The smallest rectangle that contains all the lines in the layout.

PySide.QtGui.QTextLayout.cacheEnabled()
Return type:PySide.QtCore.bool

Returns true if the complete layout information is cached; otherwise returns false.

PySide.QtGui.QTextLayout.clearAdditionalFormats()

Clears the list of additional formats supported by the text layout.

PySide.QtGui.QTextLayout.clearLayout()

Clears the line information in the layout. After having called this function, PySide.QtGui.QTextLayout.lineCount() returns 0.

PySide.QtGui.QTextLayout.createLine()
Return type:PySide.QtGui.QTextLine

Returns a new text line to be laid out if there is text to be inserted into the layout; otherwise returns an invalid text line.

The text layout creates a new line object that starts after the last line in the layout, or at the beginning if the layout is empty. The layout maintains an internal cursor, and each line is filled with text from the cursor position onwards when the QTextLine.setLineWidth() function is called.

Once QTextLine.setLineWidth() is called, a new line can be created and filled with text. Repeating this process will lay out the whole block of text contained in the PySide.QtGui.QTextLayout . If there is no text left to be inserted into the layout, the PySide.QtGui.QTextLine returned will not be valid ( isValid() will return false).

PySide.QtGui.QTextLayout.draw(p, pos[, selections=list()[, clip=QRectF()]])
Parameters:
PySide.QtGui.QTextLayout.drawCursor(p, pos, cursorPosition, width)
Parameters:

Draws a text cursor with the current pen and the specified width at the given position using the painter specified. The corresponding position within the text is specified by cursorPosition .

PySide.QtGui.QTextLayout.drawCursor(p, pos, cursorPosition)
Parameters:

This is an overloaded function.

Draws a text cursor with the current pen at the given position using the painter specified. The corresponding position within the text is specified by cursorPosition .

PySide.QtGui.QTextLayout.endLayout()

Ends the layout process.

PySide.QtGui.QTextLayout.font()
Return type:PySide.QtGui.QFont

Returns the current font that is used for the layout, or a default font if none is set.

PySide.QtGui.QTextLayout.isValidCursorPosition(pos)
Parameters:posPySide.QtCore.int
Return type:PySide.QtCore.bool

Returns true if position pos is a valid cursor position.

In a Unicode context some positions in the text are not valid cursor positions, because the position is inside a Unicode surrogate or a grapheme cluster.

A grapheme cluster is a sequence of two or more Unicode characters that form one indivisible entity on the screen. For example the latin character ` .. raw:: html Ä ‘ can be represented in Unicode by two characters, `A’ (0x41), and the combining diaresis (0x308). A text cursor can only validly be positioned before or after these two characters, never between them since that wouldn’t make sense. In indic languages every syllable forms a grapheme cluster.

PySide.QtGui.QTextLayout.lineAt(i)
Parameters:iPySide.QtCore.int
Return type:PySide.QtGui.QTextLine

Returns the i -th line of text in this text layout.

PySide.QtGui.QTextLayout.lineCount()
Return type:PySide.QtCore.int

Returns the number of lines in this text layout.

PySide.QtGui.QTextLayout.lineForTextPosition(pos)
Parameters:posPySide.QtCore.int
Return type:PySide.QtGui.QTextLine

Returns the line that contains the cursor position specified by pos .

PySide.QtGui.QTextLayout.maximumWidth()
Return type:PySide.QtCore.qreal

The maximum width the layout could expand to; this is essentially the width of the entire text.

Warning

This function only returns a valid value after the layout has been done.

PySide.QtGui.QTextLayout.minimumWidth()
Return type:PySide.QtCore.qreal

The minimum width the layout needs. This is the width of the layout’s smallest non-breakable substring.

Warning

This function only returns a valid value after the layout has been done.

PySide.QtGui.QTextLayout.nextCursorPosition(oldPos[, mode=SkipCharacters])
Parameters:
Return type:

PySide.QtCore.int

Returns the next valid cursor position after oldPos that respects the given cursor mode .

PySide.QtGui.QTextLayout.position()
Return type:PySide.QtCore.QPointF

The global position of the layout. This is independent of the bounding rectangle and of the layout process.

PySide.QtGui.QTextLayout.preeditAreaPosition()
Return type:PySide.QtCore.int

Returns the position of the area in the text layout that will be processed before editing occurs.

PySide.QtGui.QTextLayout.preeditAreaText()
Return type:unicode

Returns the text that is inserted in the layout before editing occurs.

PySide.QtGui.QTextLayout.previousCursorPosition(oldPos[, mode=SkipCharacters])
Parameters:
Return type:

PySide.QtCore.int

Returns the first valid cursor position before oldPos that respects the given cursor mode .

PySide.QtGui.QTextLayout.setAdditionalFormats(overrides)
Parameters:overrides
PySide.QtGui.QTextLayout.setCacheEnabled(enable)
Parameters:enablePySide.QtCore.bool

Enables caching of the complete layout information if enable is true; otherwise disables layout caching. Usually PySide.QtGui.QTextLayout throws most of the layouting information away after a call to PySide.QtGui.QTextLayout.endLayout() to reduce memory consumption. If you however want to draw the laid out text directly afterwards enabling caching might speed up drawing significantly.

PySide.QtGui.QTextLayout.setFlags(flags)
Parameters:flagsPySide.QtCore.int
PySide.QtGui.QTextLayout.setFont(f)
Parameters:fPySide.QtGui.QFont

Sets the layout’s font to the given font . The layout is invalidated and must be laid out again.

PySide.QtGui.QTextLayout.setPosition(p)
Parameters:pPySide.QtCore.QPointF

Moves the text layout to point p .

PySide.QtGui.QTextLayout.setPreeditArea(position, text)
Parameters:
  • positionPySide.QtCore.int
  • text – unicode

Sets the position and text of the area in the layout that is processed before editing occurs.

PySide.QtGui.QTextLayout.setText(string)
Parameters:string – unicode

Sets the layout’s text to the given string . The layout is invalidated and must be laid out again.

Notice that when using this PySide.QtGui.QTextLayout as part of a PySide.QtGui.QTextDocument this method will have no effect.

PySide.QtGui.QTextLayout.setTextOption(option)
Parameters:optionPySide.QtGui.QTextOption

Sets the text option structure that controls the layout process to the given option .

PySide.QtGui.QTextLayout.text()
Return type:unicode

Returns the layout’s text.

PySide.QtGui.QTextLayout.textOption()
Return type:PySide.QtGui.QTextOption

Returns the current text option used to control the layout process.