class QTextLine

The QTextLine class represents a line of text inside a QTextLayout . More…

Synopsis

Methods

• def __init__()

• def ascent()

• def cursorToX()

• def descent()

• def draw()

• def glyphRuns()

• def height()

• def horizontalAdvance()

• def isValid()

• def leading()

• def leadingIncluded()

• def lineNumber()

• def naturalTextRect()

• def naturalTextWidth()

• def position()

• def rect()

• def setLeadingIncluded()

• def setLineWidth()

• def setNumColumns()

• def setPosition()

• def textLength()

• def textStart()

• def width()

• def x()

• def xToCursor()

• def y()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

A text line is usually created by createLine() .

After being created, the line can be filled using the setLineWidth() or setNumColumns() functions. A line has a number of attributes including the rectangle it occupies, rect() , its coordinates, x() and y() , its textLength() , width() and naturalTextWidth() , and its ascent() and descent() relative to the text. The position of the cursor in terms of the line is available from cursorToX() and its inverse from xToCursor() . A line can be moved with setPosition() .

class Edge

Constant	Description
QTextLine.Leading
QTextLine.Trailing

class CursorPosition

Constant	Description
QTextLine.CursorBetweenCharacters
QTextLine.CursorOnCharacter

__init__()

Creates an invalid line.

ascent()

Return type:

float

Returns the line’s ascent.

See also

descent() height()

cursorToX(cursorPos[, edge=QTextLine.Edge.Leading])

Parameters:

• cursorPos – int

• edge – Edge

Return type:

PyObject

This is an overloaded function.

descent()

Return type:

float

Returns the line’s descent.

See also

ascent() height()

draw(painter, position)

Parameters:

• painter – QPainter

• position – QPointF

Draws a line on the given painter at the specified position.

glyphRuns([from=-1[, length=-1]])

Parameters:

• from – int

• length – int

Return type:

.list of QGlyphRun

This is an overloaded function.

Returns the glyph indexes and positions for all glyphs in this QTextLine for characters in the range defined by from and length. The from index is relative to the beginning of the text in the containing QTextLayout , and the range must be within the range of QTextLine as given by functions textStart() and textLength() .

If from is negative, it will default to textStart() , and if length is negative it will default to the return value of textLength() .

Note

This is equivalent to calling glyphRuns (from, length, QTextLayout::GlyphRunRetrievalFlag::GlyphIndexes | QTextLayout::GlyphRunRetrievalFlag::GlyphPositions).

See also

glyphRuns()

glyphRuns(from, length, flags)

Parameters:

• from – int

• length – int

• flags – Combination of GlyphRunRetrievalFlag

Return type:

.list of QGlyphRun

Returns the glyph indexes and positions for all glyphs in this QTextLine for characters in the range defined by from and length. The from index is relative to the beginning of the text in the containing QTextLayout , and the range must be within the range of QTextLine as given by functions textStart() and textLength() .

The retrievalFlags specifies which properties of the QGlyphRun will be retrieved from the layout. To minimize allocations and memory consumption, this should be set to include only the properties that you need to access later.

If from is negative, it will default to textStart() , and if length is negative it will default to the return value of textLength() .

See also

glyphRuns()

height()

Return type:

float

Returns the line’s height. This is equal to ascent() + descent() if leading is not included. If leading is included, this equals to ascent() + descent() + leading() .

See also

ascent() descent() leading() setLeadingIncluded()

horizontalAdvance()

Return type:

float

Returns the horizontal advance of the text. The advance of the text is the distance from its position to the next position at which text would naturally be drawn.

By adding the advance to the position of the text line and using this as the position of a second text line, you will be able to position the two lines side-by-side without gaps in-between.

isValid()

Return type:

bool

Returns true if this text line is valid; otherwise returns false.

leading()

Return type:

float

Returns the line’s leading.

See also

ascent() descent() height()

leadingIncluded()

Return type:

bool

Returns true if positive leading is included into the line’s height; otherwise returns false.

By default, leading is not included.

See also

setLeadingIncluded()

lineNumber()

Return type:

int

Returns the position of the line in the text engine.

naturalTextRect()

Return type:

QRectF

Returns the rectangle covered by the line.

naturalTextWidth()

Return type:

float

Returns the width of the line that is occupied by text. This is always <= to width() , and is the minimum width that could be used by layout() without changing the line break position.

position()

Return type:

QPointF

Returns the line’s position relative to the text layout’s position.

See also

setPosition()

rect()

Return type:

QRectF

Returns the line’s bounding rectangle.

See also

x() y() textLength() width()

setLeadingIncluded(included)

Parameters:

included – bool

Includes positive leading into the line’s height if included is true; otherwise does not include leading.

By default, leading is not included.

Note that negative leading is ignored, it must be handled in the code using the text lines by letting the lines overlap.

See also

leadingIncluded()

setLineWidth(width)

Parameters:

width – float

Lays out the line with the given width. The line is filled from its starting position with as many characters as will fit into the line. In case the text cannot be split at the end of the line, it will be filled with additional characters to the next whitespace or end of the text.

setNumColumns(columns)

Parameters:

columns – int

Lays out the line. The line is filled from its starting position with as many characters as are specified by numColumns. In case the text cannot be split until numColumns characters, the line will be filled with as many characters to the next whitespace or end of the text.

setNumColumns(columns, alignmentWidth)

Parameters:

• columns – int

• alignmentWidth – float

Lays out the line. The line is filled from its starting position with as many characters as are specified by numColumns. In case the text cannot be split until numColumns characters, the line will be filled with as many characters to the next whitespace or end of the text. The provided alignmentWidth is used as reference width for alignment.

setPosition(pos)

Parameters:

pos – QPointF

Moves the line to position pos.

See also

position()

textLength()

Return type:

int

Returns the length of the text in the line.

See also

naturalTextWidth()

textStart()

Return type:

int

Returns the start of the line from the beginning of the string passed to the QTextLayout .

width()

Return type:

float

Returns the line’s width as specified by the layout() function.

See also

naturalTextWidth() x() y() textLength() rect()

x()

Return type:

float

Returns the line’s x position.

See also

rect() y() textLength() width()

xToCursor(x[, edge=QTextLine.CursorPosition.CursorBetweenCharacters])

Parameters:

• x – float

• edge – CursorPosition

Return type:

int

Converts the x-coordinate x, to the nearest matching cursor position, depending on the cursor position type, cpos. Note that result cursor position includes possible preedit area text.

See also

cursorToX()

y()

Return type:

float

Returns the line’s y position.

See also

x() rect() textLength() width()