QTextLine¶
The
QTextLine
class represents a line of text inside aQTextLayout
. More…
Synopsis¶
Functions¶
def
ascent
()def
cursorToX
(cursorPos[, edge=Leading])def
descent
()def
draw
(p, point[, selection=None])def
height
()def
horizontalAdvance
()def
isValid
()def
leading
()def
leadingIncluded
()def
lineNumber
()def
naturalTextRect
()def
naturalTextWidth
()def
position
()def
rect
()def
setLeadingIncluded
(included)def
setLineWidth
(width)def
setNumColumns
(columns)def
setNumColumns
(columns, alignmentWidth)def
setPosition
(pos)def
textLength
()def
textStart
()def
width
()def
x
()def
xToCursor
(x[, edge=CursorBetweenCharacters])def
y
()
Detailed Description¶
A text line is usually created by
createLine()
.After being created, the line can be filled using the
setLineWidth()
orsetNumColumns()
functions. A line has a number of attributes including the rectangle it occupies,rect()
, its coordinates,x()
andy()
, itstextLength()
,width()
andnaturalTextWidth()
, and itsascent()
anddescent()
relative to the text. The position of the cursor in terms of the line is available fromcursorToX()
and its inverse fromxToCursor()
. A line can be moved withsetPosition()
.
- class PySide2.QtGui.QTextLine¶
Creates an invalid line.
- PySide2.QtGui.QTextLine.Edge¶
Constant
Description
QTextLine.Leading
QTextLine.Trailing
- PySide2.QtGui.QTextLine.CursorPosition¶
Constant
Description
QTextLine.CursorBetweenCharacters
QTextLine.CursorOnCharacter
- PySide2.QtGui.QTextLine.ascent()¶
- Return type:
float
Returns the line’s ascent.
- PySide2.QtGui.QTextLine.cursorToX(cursorPos[, edge=Leading])¶
- Parameters:
cursorPos – int
edge –
Edge
- Return type:
PyObject
This is an overloaded function.
- PySide2.QtGui.QTextLine.descent()¶
- Return type:
float
Returns the line’s descent.
- PySide2.QtGui.QTextLine.draw(p, point[, selection=None])¶
- Parameters:
point –
PySide2.QtCore.QPointF
selection –
PySide2.QtGui.QTextLayout.FormatRange
Draws a line on the given
painter
at the specifiedposition
. Theselection
is reserved for internal use.
- PySide2.QtGui.QTextLine.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 toascent()
+descent()
+leading()
.See also
- PySide2.QtGui.QTextLine.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.
- PySide2.QtGui.QTextLine.isValid()¶
- Return type:
bool
Returns
true
if this text line is valid; otherwise returnsfalse
.
- PySide2.QtGui.QTextLine.leading()¶
- Return type:
float
Returns the line’s leading.
- PySide2.QtGui.QTextLine.leadingIncluded()¶
- Return type:
bool
Returns
true
if positive leading is included into the line’s height; otherwise returnsfalse
.By default, leading is not included.
See also
- PySide2.QtGui.QTextLine.lineNumber()¶
- Return type:
int
Returns the position of the line in the text engine.
- PySide2.QtGui.QTextLine.naturalTextRect()¶
- Return type:
Returns the rectangle covered by the line.
- PySide2.QtGui.QTextLine.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.
- PySide2.QtGui.QTextLine.position()¶
- Return type:
Returns the line’s position relative to the text layout’s position.
See also
- PySide2.QtGui.QTextLine.rect()¶
- Return type:
Returns the line’s bounding rectangle.
See also
- PySide2.QtGui.QTextLine.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
- PySide2.QtGui.QTextLine.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.
- PySide2.QtGui.QTextLine.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 untilnumColumns
characters, the line will be filled with as many characters to the next whitespace or end of the text.
- PySide2.QtGui.QTextLine.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 untilnumColumns
characters, the line will be filled with as many characters to the next whitespace or end of the text. The providedalignmentWidth
is used as reference width for alignment.
- PySide2.QtGui.QTextLine.setPosition(pos)¶
- Parameters:
pos –
PySide2.QtCore.QPointF
Moves the line to position
pos
.See also
- PySide2.QtGui.QTextLine.textLength()¶
- Return type:
int
Returns the length of the text in the line.
See also
- PySide2.QtGui.QTextLine.textStart()¶
- Return type:
int
Returns the start of the line from the beginning of the string passed to the
QTextLayout
.
- PySide2.QtGui.QTextLine.width()¶
- Return type:
float
Returns the line’s width as specified by the layout() function.
See also
- PySide2.QtGui.QTextLine.x()¶
- Return type:
float
Returns the line’s x position.
See also
- PySide2.QtGui.QTextLine.xToCursor(x[, edge=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
- PySide2.QtGui.QTextLine.y()¶
- Return type:
float
Returns the line’s y position.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.