FontMetrics QML Type | Qt Quick | Qt 6.10.3
Description: Provides metrics for a given font.

- Qt 6.10
- Qt Quick
- QML Types
- FontMetrics
- Qt 6.10.3 Reference Documentation

# FontMetrics QML Type

Provides metrics for a given font. More...

Import Statement: | `import QtQuick`

- List of all members, including inherited members

## Properties

- ascent : real
- averageCharacterWidth : real
- capitalHeight : real `(since 6.9)`
- descent : real
- font : font
- height : real
- leading : real
- lineSpacing : real
- lineWidth : real
- maximumCharacterWidth : real
- minimumLeftBearing : real
- minimumRightBearing : real
- overlinePosition : real
- strikeOutPosition : real
- underlinePosition : real
- xHeight : real

## Methods

- qreal advanceWidth(string text)
- rect boundingRect(string text)
- string elidedText(string text, enumeration mode, real width, int flags)
- rect tightBoundingRect(string text)

## Detailed Description

FontMetrics calculates the size of characters and strings for a given font.

It provides a subset of the C++ QFontMetricsF API, with the added ability to change the font that is used for calculations via the font property.

     FontMetrics {
         id: fontMetrics
         font.family: "Arial"
     }

     Rectangle {
         width: fontMetrics.height * 4
         height: fontMetrics.height * 2
     }

See also QFontMetricsF and TextMetrics.

## Property Documentation

ascent : real `[read-only]`

This property holds the ascent of the font.

See also QFontMetricsF::ascent(), descent, and height.

averageCharacterWidth : real `[read-only]`

This property holds the average width of glyphs in the font.

See also QFontMetricsF::averageCharWidth().

capitalHeight : real `[read-only, since 6.9]`

Returns the capital height as specified by the font.

The cap-height of a font is defined as the height of a capital letter above the baseline. It specifically refers to the height of capital letters that are flat - such as H or I - as opposed to round letters such as O, or pointed letters like A, both of which may display overshoot.

This property was introduced in Qt 6.9.

See also QFontMetricsF::capHeight, ascent, descent, height, and xHeight.

descent : real `[read-only]`

This property holds the descent of the font.

See also QFontMetricsF::descent(), ascent, and height.

font : font

This property holds the font used for the metrics calculations.

height : real `[read-only]`

This property holds the height of the font.

See also QFontMetricsF::height().

leading : real `[read-only]`

This property holds the leading of the font.

See also QFontMetricsF::leading().

lineSpacing : real `[read-only]`

This property holds the distance from one base line to the next.

See also QFontMetricsF::lineSpacing().

lineWidth : real `[read-only]`

This property holds the width of the underline and strikeout lines, adjusted for the point size of the font.

See also QFontMetricsF::lineWidth().

maximumCharacterWidth : real `[read-only]`

This property holds the width of the widest character in the font.

See also QFontMetricsF::maxWidth().

minimumLeftBearing : real `[read-only]`

This property holds the minimum left bearing of the font.

See also QFontMetricsF::minLeftBearing().

minimumRightBearing : real `[read-only]`

This property holds the minimum right bearing of the font.

See also QFontMetricsF::minRightBearing().

overlinePosition : real `[read-only]`

This property holds the distance from the base line to where an overline should be drawn.

See also QFontMetricsF::overlinePos(), underlinePosition, and strikeOutPosition.

strikeOutPosition : real `[read-only]`

This property holds the distance from the base line to where the strikeout line should be drawn.

See also QFontMetricsF::strikeOutPos(), overlinePosition, and underlinePosition.

underlinePosition : real `[read-only]`

This property holds the distance from the base line to where an underscore should be drawn.

See also QFontMetricsF::underlinePos(), overlinePosition, and strikeOutPosition.

xHeight : real `[read-only]`

This property holds the 'x' height of the font.

See also QFontMetricsF::xHeight().

## Method Documentation

qreal advanceWidth(string text)

This method returns the advance in pixels of the characters in text. This is the distance from the position of the string to where the next string should be drawn.

This method is offered as an imperative alternative to the advanceWidth property of TextMetrics.

See also QFontMetricsF::horizontalAdvance() and QFontMetricsF::height().

rect boundingRect(string text)

This method returns the bounding rectangle of the characters in the string specified by text.

This method is offered as an imperative alternative to the boundingRect property of TextMetrics.

See also QFontMetricsF::boundingRect() and tightBoundingRect().

string elidedText(string text, enumeration mode, real width, int flags)

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

The mode argument specifies the text elide mode; that is, where the ellipsis should appear when displaying text that doesn't fit.

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

This method is offered as an imperative alternative to the elidedText property of TextMetrics.

See also Qt::TextElideMode and QFontMetricsF::elidedText().

rect tightBoundingRect(string text)

This method returns a tight bounding rectangle around the characters in the string specified by text.

This method is offered as an imperative alternative to the tightBoundingRect property of TextMetrics.

See also QFontMetricsF::tightBoundingRect() and boundingRect().