QGlyphRun¶

PyQt5.QtGui.QGlyphRun

Description¶

The QGlyphRun class provides direct access to the internal glyphs in a font.

When Qt displays a string of text encoded in Unicode, it will first convert the Unicode points into a list of glyph indexes and a list of positions based on one or more fonts. The Unicode representation of the text and the QFont object will in this case serve as a convenient abstraction that hides the details of what actually takes place when displaying the text on-screen. For instance, by the time the text actually reaches the screen, it may be represented by a set of fonts in addition to the one specified by the user, e.g. in case the originally selected font did not support all the writing systems contained in the text.

Under certain circumstances, it can be useful as an application developer to have more low-level control over which glyphs in a specific font are drawn to the screen. This could for instance be the case in applications that use an external font engine and text shaper together with Qt. QGlyphRun provides an interface to the raw data needed to get text on the screen. It contains a list of glyph indexes, a position for each glyph and a font.

It is the user’s responsibility to ensure that the selected font actually contains the provided glyph indexes.

glyphRuns() or glyphRuns() can be used to convert unicode encoded text into a list of QGlyphRun objects, and drawGlyphRun() can be used to draw the glyphs.

Note: Please note that QRawFont is considered local to the thread in which it is constructed. This in turn means that a new QRawFont will have to be created and set on the QGlyphRun if it is moved to a different thread. If the QGlyphRun contains a reference to a QRawFont from a different thread than the current, it will not be possible to draw the glyphs using a QPainter, as the QRawFont is considered invalid and inaccessible in this case.

Classes¶

GlyphRunFlags

Enums¶

GlyphRunFlag

TODO

Member	Value	Description
Overline	TODO	TODO
RightToLeft	TODO	TODO
SplitLigature	TODO	TODO
StrikeOut	TODO	TODO
Underline	TODO	TODO

Methods¶

__init__(): Constructs an empty QGlyphRun object.

__init__(QGlyphRun): Constructs a QGlyphRun object which is a copy of other.

boundingRect() → QRectF: TODO

clear(): Clears all data in the QGlyphRun object.

__eq__(QGlyphRun) → bool: TODO

flags() → GlyphRunFlags: TODO

glyphIndexes() → List[int]: Returns the glyph indexes for this QGlyphRun object.

See also

setGlyphIndexes(), setPositions().

isEmpty() → bool: TODO

isRightToLeft() → bool: TODO

__ne__(QGlyphRun) → bool: TODO

overline() → bool: Returns true if this QGlyphRun should be painted with an overline decoration.

See also

setOverline().

positions() → List[QPointF]: Returns the position of the edge of the baseline for each glyph in this set of glyph indexes.

See also

setPositions().

rawFont() → QRawFont: Returns the font selected for this QGlyphRun object.

See also

setRawFont().

setBoundingRect(QRectF): TODO

setFlag(GlyphRunFlag, enabled: bool = True): TODO

setFlags(Union[GlyphRunFlags, GlyphRunFlag]): TODO

setGlyphIndexes(Iterable[int]): TODO

setOverline(bool): Indicates that this QGlyphRun should be painted with an overline decoration if overline is true. Otherwise the QGlyphRun should be painted with no overline decoration.

See also

overline().

setPositions(Iterable[Union[QPointF, QPoint]]): Sets the positions of the edge of the baseline for each glyph in this set of glyph indexes to positions.

See also

positions().

setRawFont(QRawFont): Sets the font in which to look up the glyph indexes to the rawFont specified.

See also

rawFont(), setGlyphIndexes().

setRightToLeft(bool): TODO

setStrikeOut(bool): Indicates that this QGlyphRun should be painted with an strike out decoration if strikeOut is true. Otherwise the QGlyphRun should be painted with no strike out decoration.

See also

strikeOut().

setUnderline(bool): Indicates that this QGlyphRun should be painted with an underline decoration if underline is true. Otherwise the QGlyphRun should be painted with no underline decoration.

See also

underline().

strikeOut() → bool: Returns true if this QGlyphRun should be painted with a strike out decoration.

See also

setStrikeOut().

swap(QGlyphRun): TODO

underline() → bool: Returns true if this QGlyphRun should be painted with an underline decoration.

See also

setUnderline().