QFontMetricsF Class | Qt GUI 5.6

Qt 5.6 | Qt GUI | C++ Classes | QFontMetricsF

Qt 5.6.2 Reference Documentation

# QFontMetricsF Class

The QFontMetricsF class provides font metrics information. More...

Header: | #include <QFontMetricsF>
qmake: | QT += gui

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Functions

| QFontMetricsF(const QFont &font)
| QFontMetricsF(const QFont &font, QPaintDevice *paintdevice)
| QFontMetricsF(const QFontMetrics &fontMetrics)
| QFontMetricsF(const QFontMetricsF &fm)
| ~QFontMetricsF()
qreal | ascent() const
qreal | averageCharWidth() const
QRectF | boundingRect(const QString &text) const
QRectF | boundingRect(QChar ch) const
QRectF | boundingRect(const QRectF &rect, int flags, const QString &text, int tabStops = 0, int *tabArray = Q_NULLPTR) const
qreal | descent() const
QString | elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags = 0) const
qreal | height() const
bool | inFont(QChar ch) const
bool | inFontUcs4(uint ch) const
qreal | leading() const
qreal | leftBearing(QChar ch) const
qreal | lineSpacing() const
qreal | lineWidth() const
qreal | maxWidth() const
qreal | minLeftBearing() const
qreal | minRightBearing() const
qreal | overlinePos() const
qreal | rightBearing(QChar ch) const
QSizeF | size(int flags, const QString &text, int tabStops = 0, int *tabArray = Q_NULLPTR) const
qreal | strikeOutPos() const
void | swap(QFontMetricsF &other)
QRectF | tightBoundingRect(const QString &text) const
qreal | underlinePos() const
qreal | width(const QString &text) const
qreal | width(QChar ch) const
qreal | xHeight() const
bool | operator!=(const QFontMetricsF &other) const
QFontMetricsF & | operator=(const QFontMetricsF &fm)
QFontMetricsF & | operator=(const QFontMetrics &other)
QFontMetricsF & | operator=(QFontMetricsF &&other)
bool | operator==(const QFontMetricsF &other) const

## Detailed Description

The QFontMetricsF class provides font metrics information.

QFontMetricsF functions calculate the size of characters and strings for a given font. You can construct a QFontMetricsF object with an existing QFont to obtain metrics for that font. If the font is changed later, the font metrics object is not updated.

Once created, the object provides functions to access the individual metrics of the font, its characters, and for strings rendered in the font.

There are several functions that operate on the font: ascent(), descent(), height(), leading() and lineSpacing() return the basic size properties of the font. The underlinePos(), overlinePos(), strikeOutPos() and lineWidth() functions, return the properties of the line that underlines, overlines or strikes out the characters. These functions are all fast.

There are also some functions that operate on the set of glyphs in the font: minLeftBearing(), minRightBearing() and maxWidth(). These are by necessity slow, and we recommend avoiding them if possible.

For each character, you can get its width(), leftBearing() and rightBearing() and find out whether it is in the font using inFont(). You can also treat the character as a string, and use the string functions on it.

The string functions include width(), to return the width of a string in pixels (or points, for a printer), boundingRect(), to return a rectangle large enough to contain the rendered string, and size(), to return the size of that rectangle.

Example:

      QFont font("times", 24);
      QFontMetricsF fm(font);
      qreal pixelsWide = fm.width("What's the width of this text?");
      qreal pixelsHigh = fm.height();

See also QFont, QFontInfo, and QFontDatabase.

## Member Function Documentation

### QFontMetricsF::QFontMetricsF(const QFont &font)

Constructs a font metrics object for font.

The font metrics will be compatible with the paintdevice used to create font.

The font metrics object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later.

Use QFontMetricsF(const QFont &, QPaintDevice *) to get the font metrics that are compatible with a certain paint device.

### QFontMetricsF::QFontMetricsF(const QFont &font, QPaintDevice *paintdevice)

Constructs a font metrics object for font and paintdevice.

The font metrics will be compatible with the paintdevice passed. If the paintdevice is 0, the metrics will be screen-compatible, ie. the metrics you get if you use the font for drawing text on a widgets or pixmaps, not on a QPicture or QPrinter.

The font metrics object holds the information for the font that is passed in the constructor at the time it is created, and is not updated if the font's attributes are changed later.

### QFontMetricsF::QFontMetricsF(const QFontMetrics &fontMetrics)

Constructs a font metrics object with floating point precision from the given fontMetrics object.

This function was introduced in Qt 4.2.

### QFontMetricsF::QFontMetricsF(const QFontMetricsF &fm)

Constructs a copy of fm.

### QFontMetricsF::~QFontMetricsF()

Destroys the font metrics object and frees all allocated resources.

### qreal QFontMetricsF::ascent() const

Returns the ascent of the font.

The ascent of a font is the distance from the baseline to the highest position characters extend to. In practice, some font designers break this rule, e.g. when they put more than one accent on top of a character, or to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small.

See also descent().

### qreal QFontMetricsF::averageCharWidth() const

Returns the average width of glyphs in the font.

This function was introduced in Qt 4.2.

### QRectF QFontMetricsF::boundingRect(const QString &text) const

Returns the bounding rectangle of the characters in the string specified by text. The bounding rectangle always covers at least the set of pixels the text would cover if drawn at (0, 0).

Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the width of the returned rectangle might be different than what the width() method returns.

If you want to know the advance width of the string (to lay out a set of strings next to each other), use width() instead.

Newline characters are processed as normal characters, not as linebreaks.

The height of the bounding rectangle is at least as large as the value returned height().

See also width(), height(), and QPainter::boundingRect().

### QRectF QFontMetricsF::boundingRect(QChar ch) const

Returns the bounding rectangle of the character ch relative to the left-most point on the base line.

Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the text output may cover all pixels in the bounding rectangle.

Note that the rectangle usually extends both above and below the base line.

See also width().

### QRectF QFontMetricsF::boundingRect(const QRectF &rect, int flags, const QString &text, int tabStops = 0, int *tabArray = Q_NULLPTR) const

This is an overloaded function.

Returns the bounding rectangle of the characters in the given text. This is the set of pixels the text would cover if drawn when constrained to the bounding rectangle specified by rect.

The flags argument is the bitwise OR of the following flags:

- Qt::AlignLeft aligns to the left border, except for Arabic and Hebrew where it aligns to the right.
- Qt::AlignRight aligns to the right border, except for Arabic and Hebrew where it aligns to the left.
- Qt::AlignJustify produces justified text.
- Qt::AlignHCenter aligns horizontally centered.
- Qt::AlignTop aligns to the top border.
- Qt::AlignBottom aligns to the bottom border.
- Qt::AlignVCenter aligns vertically centered
- Qt::AlignCenter (== `Qt::AlignHCenter | Qt::AlignVCenter`)
- Qt::TextSingleLine ignores newline characters in the text.
- Qt::TextExpandTabs expands tabs (see below)
- Qt::TextShowMnemonic interprets "&x" as x; i.e., underlined.
- Qt::TextWordWrap breaks the text to fit the rectangle.

Qt::Horizontal alignment defaults to Qt::AlignLeft and vertical alignment defaults to Qt::AlignTop.

If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined.

These flags are defined in Qt::AlignmentFlag.

If Qt::TextExpandTabs is set in flags, the following behavior is used to interpret tab characters in the text:

- If tabArray is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs in the text.
- If tabStops is non-zero, it is used as the tab spacing (in pixels).

Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts.

Newline characters are processed as line breaks.

Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same.

The bounding rectangle returned by this function is somewhat larger than that calculated by the simpler boundingRect() function. This function uses the maximum left and right font bearings as is necessary for multi-line text to align correctly. Also, fontHeight() and lineSpacing() are used to calculate the height, rather than individual character heights.

See also width(), QPainter::boundingRect(), and Qt::Alignment.

### qreal QFontMetricsF::descent() const

Returns the descent of the font.

The descent is the distance from the base line to the lowest point characters extend to. (Note that this is different from X, which adds 1 pixel.) In practice, some font designers break this rule, e.g. to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small.

See also ascent().

### QString QFontMetricsF::elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags = 0) const

If the string text is wider than width, returns an elided version of the string (i.e., a string with "..." in it). Otherwise, returns the original string.

The mode parameter specifies whether the text is elided on the left (for example, "...tech"), in the middle (for example, "Tr...ch"), or on the right (for example, "Trol...").

The width is specified in pixels, not characters.

The flags argument is optional and currently only supports Qt::TextShowMnemonic as value.

The elide mark follows the layoutdirection. For example, it will be on the right side of the text for right-to-left layouts if the mode is `Qt::ElideLeft`, and on the left side of the text if the mode is `Qt::ElideRight`.

This function was introduced in Qt 4.2.

### qreal QFontMetricsF::height() const

Returns the height of the font.

This is always equal to ascent()+descent().

See also leading() and lineSpacing().

### bool QFontMetricsF::inFont(QChar ch) const

Returns `true` if character ch is a valid character in the font; otherwise returns `false`.

### bool QFontMetricsF::inFontUcs4(uint ch) const

Returns `true` if the character given by ch, encoded in UCS-4/UTF-32, is a valid character in the font; otherwise returns `false`.

### qreal QFontMetricsF::leading() const

Returns the leading of the font.

This is the natural inter-line spacing.

See also height() and lineSpacing().

### qreal QFontMetricsF::leftBearing(QChar ch) const

Returns the left bearing of character ch in the font.

The left bearing is the right-ward distance of the left-most pixel of the character from the logical origin of the character. This value is negative if the pixels of the character extend to the left of the logical origin.

See width(QChar) for a graphical description of this metric.

See also rightBearing(), minLeftBearing(), and width().

### qreal QFontMetricsF::lineSpacing() const

Returns the distance from one base line to the next.

This value is always equal to leading()+height().

See also height() and leading().

### qreal QFontMetricsF::lineWidth() const

Returns the width of the underline and strikeout lines, adjusted for the point size of the font.

See also underlinePos(), overlinePos(), and strikeOutPos().

### qreal QFontMetricsF::maxWidth() const

Returns the width of the widest character in the font.

### qreal QFontMetricsF::minLeftBearing() const

Returns the minimum left bearing of the font.

This is the smallest leftBearing(char) of all characters in the font.

Note that this function can be very slow if the font is large.

See also minRightBearing() and leftBearing().

### qreal QFontMetricsF::minRightBearing() const

Returns the minimum right bearing of the font.

This is the smallest rightBearing(char) of all characters in the font.

Note that this function can be very slow if the font is large.

See also minLeftBearing() and rightBearing().

### qreal QFontMetricsF::overlinePos() const

Returns the distance from the base line to where an overline should be drawn.

See also underlinePos(), strikeOutPos(), and lineWidth().

### qreal QFontMetricsF::rightBearing(QChar ch) const

Returns the right bearing of character ch in the font.

The right bearing is the left-ward distance of the right-most pixel of the character from the logical origin of a subsequent character. This value is negative if the pixels of the character extend to the right of the width() of the character.

See width() for a graphical description of this metric.

See also leftBearing(), minRightBearing(), and width().

### QSizeF QFontMetricsF::size(int flags, const QString &text, int tabStops = 0, int *tabArray = Q_NULLPTR) const

Returns the size in pixels of the characters in the given text.

The flags argument is the bitwise OR of the following flags:

- Qt::TextSingleLine ignores newline characters.
- Qt::TextExpandTabs expands tabs (see below)
- Qt::TextShowMnemonic interprets "&x" as x; i.e., underlined.
- Qt::TextWordWrap breaks the text to fit the rectangle.

These flags are defined in the Qt::TextFlag enum.

If Qt::TextExpandTabs is set in flags, the following behavior is used to interpret tab characters in the text:

- If tabArray is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs in the text.
- If tabStops is non-zero, it is used as the tab spacing (in pixels).

Newline characters are processed as line breaks.

Note: Despite the different actual character heights, the heights of the bounding rectangles of "Yes" and "yes" are the same.

See also boundingRect().

### qreal QFontMetricsF::strikeOutPos() const

Returns the distance from the base line to where the strikeout line should be drawn.

See also underlinePos(), overlinePos(), and lineWidth().

### void QFontMetricsF::swap(QFontMetricsF &other)

Swaps this font metrics instance with other. This function is very fast and never fails.

This function was introduced in Qt 5.0.

### QRectF QFontMetricsF::tightBoundingRect(const QString &text) const

Returns a tight bounding rectangle around the characters in the string specified by text. The bounding rectangle always covers at least the set of pixels the text would cover if drawn at (0, 0).

Note that the bounding rectangle may extend to the left of (0, 0), e.g. for italicized fonts, and that the width of the returned rectangle might be different than what the width() method returns.

If you want to know the advance width of the string (to lay out a set of strings next to each other), use width() instead.

Newline characters are processed as normal characters, not as linebreaks.

Warning: Calling this method is very slow on Windows.

This function was introduced in Qt 4.3.

See also width(), height(), and boundingRect().

### qreal QFontMetricsF::underlinePos() const

Returns the distance from the base line to where an underscore should be drawn.

See also overlinePos(), strikeOutPos(), and lineWidth().

### qreal QFontMetricsF::width(const QString &text) const

Returns the width in pixels of the characters in the given text.

Note that this value is not equal to the width returned by boundingRect().width() because boundingRect() returns a rectangle describing the pixels this string will cover whereas width() returns the distance to where the next string should be drawn.

See also boundingRect().

### qreal QFontMetricsF::width(QChar ch) const

This is an overloaded function.

Returns the logical width of character ch in pixels. This is a distance appropriate for drawing a subsequent character after ch.

Some of the metrics are described in the image to the right. The central dark rectangles cover the logical width() of each character. The outer pale rectangles cover the leftBearing() and rightBearing() of each character. Notice that the bearings of "f" in this particular font are both negative, while the bearings of "o" are both positive.

Warning: This function will produce incorrect results for Arabic characters or non-spacing marks in the middle of a string, as the glyph shaping and positioning of marks that happens when processing strings cannot be taken into account. When implementing an interactive text control, use QTextLayout instead.

See also boundingRect().

### qreal QFontMetricsF::xHeight() const

Returns the 'x' height of the font. This is often but not always the same as the height of the character 'x'.

### bool QFontMetricsF::operator!=(const QFontMetricsF &other) const

This is an overloaded function.

Returns `true` if the font metrics are not equal to the other font metrics; otherwise returns `false`.

See also operator==().

### QFontMetricsF &QFontMetricsF::operator=(const QFontMetricsF &fm)

Assigns the font metrics fm to this font metrics object.

### QFontMetricsF &QFontMetricsF::operator=(const QFontMetrics &other)

Assigns other to this object.

This function was introduced in Qt 4.2.

### QFontMetricsF &QFontMetricsF::operator=(QFontMetricsF &&other)

Move-assigns other to this QFontMetricsF instance.

### bool QFontMetricsF::operator==(const QFontMetricsF &other) const

Returns `true` if the font metrics are equal to the other font metrics; otherwise returns `false`.

Two font metrics are considered equal if they were constructed from the same QFont and the paint devices they were constructed for are considered to be compatible.