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

#include <qglyphrun.h>

Public Types
enum	GlyphRunFlag { Overline = 0x01 , Underline = 0x02 , StrikeOut = 0x04 , RightToLeft = 0x08 , SplitLigature = 0x10 }

Public Member Functions
	QGlyphRun ()

	QGlyphRun (const QGlyphRun &other)

QGlyphRun &	operator= (const QGlyphRun &other)

	~QGlyphRun ()

void	swap (QGlyphRun &other) noexcept

QRawFont	rawFont () const

void	setRawFont (const QRawFont &rawFont)

void	setRawData (const quint32 glyphIndexArray, const QPointF glyphPositionArray, int size)

QList< quint32 >	glyphIndexes () const

void	setGlyphIndexes (const QList< quint32 > &glyphIndexes)

QList< QPointF >	positions () const

void	setPositions (const QList< QPointF > &positions)

void	clear ()

bool	operator== (const QGlyphRun &other) const

bool	operator!= (const QGlyphRun &other) const

void	setOverline (bool overline)

bool	overline () const

void	setUnderline (bool underline)

bool	underline () const

void	setStrikeOut (bool strikeOut)

bool	strikeOut () const

void	setRightToLeft (bool on)

bool	isRightToLeft () const

void	setFlag (GlyphRunFlag flag, bool enabled=true)

void	setFlags (GlyphRunFlags flags)

GlyphRunFlags	flags () const

void	setBoundingRect (const QRectF &boundingRect)

QRectF	boundingRect () const

bool	isEmpty () const

Friends
class	QGlyphRunPrivate

class	QTextLine

Detailed Description

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

Since: 4.8 \inmodule QtGui

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.

Definition at line 55 of file qglyphrun.h.

Member Enumeration Documentation

◆ GlyphRunFlag

enum QGlyphRun::GlyphRunFlag

Since: 5.0

This enum describes flags that alter the way the run of glyphs might be presented or behave in a visual layout. The layout which generates the glyph runs can set these flags based on relevant internal data, to retain information needed to present the text as intended by the user of the layout.

\value Overline Indicates that the glyphs should be visualized together with an overline. \value Underline Indicates that the glyphs should be visualized together with an underline. \value StrikeOut Indicates that the glyphs should be struck out visually. \value RightToLeft Indicates that the glyphs are ordered right to left. This can affect the positioning of other screen elements that are relative to the glyph run, such as an inline text object. \value SplitLigature Indicates that the glyph run splits a ligature glyph. This means that a ligature glyph is included in the run, but the characters represented by it corresponds only to part of that ligature. The glyph run's boundingRect() function can in this case be used to retrieve the area covered by glyphs that correspond to the characters represented by the glyph run. When visualizing the glyphs, care needs to be taken to clip to this bounding rect to ensure that only the corresponding part of the ligature is painted. In particular, this can be the case when retrieving a glyph run from a QTextLayout for a specific character range, e.g. when retrieving the selected area of a QTextLayout.

Enumerator
Overline
Underline
StrikeOut
RightToLeft
SplitLigature

Definition at line 58 of file qglyphrun.h.

Constructor & Destructor Documentation

◆ QGlyphRun() [1/2]

QGlyphRun::QGlyphRun ( )

Constructs an empty QGlyphRun object.

Definition at line 115 of file qglyphrun.cpp.

◆ QGlyphRun() [2/2]

QGlyphRun::QGlyphRun ( const QGlyphRun & other )

Constructs a QGlyphRun object which is a copy of other.

Definition at line 122 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ ~QGlyphRun()

QGlyphRun::~QGlyphRun ( )

Destroys the QGlyphRun.

Definition at line 130 of file qglyphrun.cpp.

Member Function Documentation

◆ boundingRect()

QRectF QGlyphRun::boundingRect ( ) const

Returns the smallest rectangle that contains all glyphs in this QGlyphRun. If a bounding rect has been set using setBoundingRect(), then this will be returned. Otherwise the bounding rect will be calculated based on the font metrics of the glyphs in the glyph run.

Since: 5.0

Definition at line 469 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ clear()

void QGlyphRun::clear ( )

Clears all data in the QGlyphRun object.

Definition at line 278 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ flags()

QGlyphRun::GlyphRunFlags QGlyphRun::flags ( ) const

Returns the flags set for this QGlyphRun.

Since: 5.0

See also: setFlag(), setFlag()

Definition at line 400 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ glyphIndexes()

QList< quint32 > QGlyphRun::glyphIndexes ( ) const

Returns the glyph indexes for this QGlyphRun object.

See also: setGlyphIndexes(), setPositions()

Definition at line 225 of file qglyphrun.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

bool QGlyphRun::isEmpty ( ) const

Returns true if the QGlyphRun does not contain any glyphs.

Since: 5.0

Definition at line 502 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ isRightToLeft()

bool QGlyphRun::isRightToLeft ( ) const

Returns true if this QGlyphRun contains glyphs that are painted from the right to the left.

Since: 5.0

See also: setRightToLeft(), flags()

Definition at line 377 of file qglyphrun.cpp.

◆ operator!=()

bool QGlyphRun::operator!= ( const QGlyphRun & other ) const

inline

Compares other to this QGlyphRun object. Returns true if any of the list of glyph indexes, the list of positions or the font are different, otherwise returns false.

Definition at line 91 of file qglyphrun.h.

Here is the call graph for this function:

◆ operator=()

QGlyphRun & QGlyphRun::operator= ( const QGlyphRun & other )

Assigns other to this QGlyphRun object.

Definition at line 147 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ operator==()

bool QGlyphRun::operator== ( const QGlyphRun & other ) const

Compares other to this QGlyphRun object. Returns true if the list of glyph indexes, the list of positions and the font are all equal, otherwise returns false.

Definition at line 165 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ overline()

bool QGlyphRun::overline ( ) const

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

See also: setOverline(), flags()

Definition at line 313 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ positions()

QList< QPointF > QGlyphRun::positions ( ) const

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

Definition at line 251 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ rawFont()

QRawFont QGlyphRun::rawFont ( ) const

Returns the font selected for this QGlyphRun object.

See also: setRawFont()

Definition at line 203 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ setBoundingRect()

void QGlyphRun::setBoundingRect ( const QRectF & boundingRect )

Sets the bounding rect of the glyphs in this QGlyphRun to be boundingRect. This rectangle will be returned by boundingRect() unless it is null, in which case the bounding rectangle of the glyphs in the glyph run will be returned instead.

Note: Unless you are implementing text shaping, you should not have to use this function. It is used specifically when the QGlyphRun should represent an area which is smaller than the area of the glyphs it contains. This could happen e.g. if the glyph run is retrieved by calling QTextLayout::glyphRuns() and the specified range only includes part of a ligature (where two or more characters are combined to a single glyph.) When this is the case, the bounding rect should only include the appropriate part of the ligature glyph, based on a calculation of the average width of the characters in the ligature.

In order to support such a case (an example is selections which should be drawn with a different color than the main text color), it is necessary to clip the painting mechanism to the rectangle returned from boundingRect() to avoid drawing the entire ligature glyph.

See also: boundingRect()

Since: 5.0

Definition at line 456 of file qglyphrun.cpp.

◆ setFlag()

void QGlyphRun::setFlag	(	GlyphRunFlag	flag,
		bool	enabled = `true`
	)

If enabled is true, then flag is enabled; otherwise, it is disabled.

Since: 5.0

See also: flags(), setFlags()

Definition at line 411 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ setFlags()

void QGlyphRun::setFlags ( GlyphRunFlags flags )

Sets the flags of this QGlyphRun to flags.

Since: 5.0

See also: setFlag(), flags()

Definition at line 426 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setGlyphIndexes()

void QGlyphRun::setGlyphIndexes ( const QList< quint32 > & glyphIndexes )

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

Definition at line 240 of file qglyphrun.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOverline()

void QGlyphRun::setOverline ( 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(), setFlag(), setFlags()

Definition at line 324 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setPositions()

void QGlyphRun::setPositions ( const QList< QPointF > & positions )

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

Definition at line 267 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ setRawData()

void QGlyphRun::setRawData	(	const quint32 *	glyphIndexArray,
		const QPointF *	glyphPositionArray,
		int	size
	)

Sets the glyph indexes and positions of this QGlyphRun to use the first size elements in the arrays glyphIndexArray and glyphPositionArray. The data is not copied. The caller must guarantee that the arrays are not deleted as long as this QGlyphRun and any copies of it exists.

See also: setGlyphIndexes(), setPositions()

Definition at line 296 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setRawFont()

void QGlyphRun::setRawFont ( const QRawFont & rawFont )

Sets the font in which to look up the glyph indexes to the rawFont specified.

See also: rawFont(), setGlyphIndexes()

Definition at line 214 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setRightToLeft()

void QGlyphRun::setRightToLeft ( bool rightToLeft )

Indicates that this QGlyphRun contains glyphs that should be ordered from the right to left if rightToLeft is true. Otherwise the order of the glyphs is assumed to be left to right.

Since: 5.0

See also: isRightToLeft(), setFlag(), setFlags()

Definition at line 389 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setStrikeOut()

void QGlyphRun::setStrikeOut ( 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(), setFlag(), setFlags()

Definition at line 366 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ setUnderline()

void QGlyphRun::setUnderline ( 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(), setFlag(), setFlags()

Definition at line 345 of file qglyphrun.cpp.

Here is the call graph for this function:

◆ strikeOut()

bool QGlyphRun::strikeOut ( ) const

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

See also: setStrikeOut(), flags()

Definition at line 355 of file qglyphrun.cpp.

Here is the caller graph for this function:

◆ swap()

void QGlyphRun::swap ( QGlyphRun & other )

inlinenoexcept

Since: 5.0

Swaps this glyph run instance with other. This function is very fast and never fails.

Definition at line 73 of file qglyphrun.h.

Here is the call graph for this function:

◆ underline()

bool QGlyphRun::underline ( ) const

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

See also: setUnderline(), flags()

Definition at line 334 of file qglyphrun.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QGlyphRunPrivate

friend class QGlyphRunPrivate

friend

Definition at line 116 of file qglyphrun.h.

◆ QTextLine

friend class QTextLine

friend

Definition at line 117 of file qglyphrun.h.

The documentation for this class was generated from the following files:

src/gui/text/qglyphrun.h
src/gui/text/qglyphrun.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ GlyphRunFlag

Constructor & Destructor Documentation

◆ QGlyphRun() [1/2]

◆ QGlyphRun() [2/2]

◆ ~QGlyphRun()

Member Function Documentation

◆ boundingRect()

◆ clear()

◆ flags()

◆ glyphIndexes()

◆ isEmpty()

◆ isRightToLeft()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ overline()

◆ positions()

◆ rawFont()

◆ setBoundingRect()

◆ setFlag()

◆ setFlags()

◆ setGlyphIndexes()

◆ setOverline()

◆ setPositions()

◆ setRawData()

◆ setRawFont()

◆ setRightToLeft()

◆ setStrikeOut()

◆ setUnderline()

◆ strikeOut()

◆ swap()

◆ underline()

Friends And Related Function Documentation

◆ QGlyphRunPrivate

◆ QTextLine