|  | Home · All Classes · Modules

# QGlyphRun Class Reference
[QtGui module]

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

### Methods

- __init__ (self)
- __init__ (self, QGlyphRun other)
- clear (self)
- list-of-int glyphIndexes (self)
- bool overline (self)
- list-of-QPointF positions (self)
- QRawFont rawFont (self)
- setGlyphIndexes (self, list-of-int glyphIndexes)
- setOverline (self, bool overline)
- setPositions (self, list-of-QPointF positions)
- setRawFont (self, QRawFont rawFont)
- setStrikeOut (self, bool strikeOut)
- setUnderline (self, bool underline)
- bool strikeOut (self)
- bool underline (self)

### Special Methods

- bool __eq__ (self, QGlyphRun other)
- bool __ne__ (self, QGlyphRun other)

## Detailed 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.

QTextLayout.glyphRuns() or QTextFragment.glyphRuns() can be used to convert unicode encoded text into a list of QGlyphRun objects, and QPainter.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.

## Method Documentation

### QGlyphRun.__init__ (self)

Constructs an empty QGlyphRun object.

### QGlyphRun.__init__ (self, QGlyphRun other)

Constructs a QGlyphRun object which is a copy of other.

### QGlyphRun.clear (self)

Clears all data in the QGlyphRun object.

### list-of-int QGlyphRun.glyphIndexes (self)

Returns the glyph indexes for this QGlyphRun object.

See also setGlyphIndexes() and setPositions().

### bool QGlyphRun.overline (self)

Returns true if this QGlyphRun should be painted with an overline decoration.

See also setOverline().

### list-of-QPointF QGlyphRun.positions (self)

Returns the position of the edge of the baseline for each glyph in this set of glyph indexes.

See also setPositions().

### QRawFont QGlyphRun.rawFont (self)

Returns the font selected for this QGlyphRun object.

See also setRawFont().

### QGlyphRun.setGlyphIndexes (self, list-of-int glyphIndexes)

Set the glyph indexes for this QGlyphRun object to glyphIndexes. The glyph indexes must be valid for the selected font.

See also glyphIndexes().

### QGlyphRun.setOverline (self, bool overline)

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

### QGlyphRun.setPositions (self, list-of-QPointF positions)

Sets the positions of the edge of the baseline for each glyph in this set of glyph indexes to positions.

See also positions().

### QGlyphRun.setRawFont (self, QRawFont rawFont)

Sets the font specified by rawFont to be the font used to look up the glyph indexes.

See also rawFont() and setGlyphIndexes().

### QGlyphRun.setStrikeOut (self, bool strikeOut)

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

### QGlyphRun.setUnderline (self, bool underline)

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

### bool QGlyphRun.strikeOut (self)

Returns true if this QGlyphRun should be painted with a strike out decoration.

See also setStrikeOut().

### bool QGlyphRun.underline (self)

Returns true if this QGlyphRun should be painted with an underline decoration.

See also setUnderline().

### bool QGlyphRun.__eq__ (self, QGlyphRun other)

### bool QGlyphRun.__ne__ (self, QGlyphRun other)