QTextLine

PyQt5.QtGui.QTextLine

Description

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

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().

Enums

CursorPosition

Member	Value	Description
CursorBetweenCharacters	TODO	TODO
CursorOnCharacter	TODO	TODO

---

Edge

Member	Value	Description
Leading	TODO	TODO
Trailing	TODO	TODO

Methods

__init__()

TODO

---

__init__(QTextLine)

TODO

---

ascent() → float

Returns the line’s ascent.

See also

descent(), height().

---

cursorToX(int, edge: Edge = Leading) → (float, int)

Converts the cursor position cursorPos to the corresponding x position inside the line, taking account of the edge.

If cursorPos is not a valid cursor position, the nearest valid cursor position will be used instead, and cursorPos will be modified to point to this valid cursor position.

See also

xToCursor().

---

descent() → float

Returns the line’s descent.

See also

ascent(), height().

---

draw(QPainter, Union[QPointF, QPoint], selection: FormatRange = None)

TODO

---

glyphRuns(from: int = -1, length: int = -1) → List[QGlyphRun]

TODO

---

height() → 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() → 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() → bool

TODO

---

leading() → float

Returns the line’s leading.

See also

ascent(), descent(), height().

---

leadingIncluded() → 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() → int

TODO

---

naturalTextRect() → QRectF

Returns the rectangle covered by the line.

---

naturalTextWidth() → 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() → QPointF

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

See also

setPosition().

---

rect() → QRectF

Returns the line’s bounding rectangle.

See also

x(), y(), textLength(), width().

---

setLeadingIncluded(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(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(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(int, 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(Union[QPointF, QPoint])

Moves the line to position pos.

See also

position().

---

textLength() → int

Returns the length of the text in the line.

See also

naturalTextWidth().

---

textStart() → int

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

---

width() → float

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

See also

naturalTextWidth(), x(), y(), textLength(), rect().

---

x() → float

Returns the line’s x position.

See also

rect(), y(), textLength(), width().

---

xToCursor(float, edge: CursorPosition = CursorBetweenCharacters) → int

TODO

---

y() → float

Returns the line’s y position.

See also

x(), rect(), textLength(), width().