QtQuick TextMetrics

Provides metrics for a given font and text

Import Statement: import QtQuick 2.4
Since: Qt 5.4

Properties

Detailed Description

TextMetrics calculates various properties of a given string of text for a particular font.

It provides a declarative API for the functions in QFontMetricsF which take arguments.

TextMetrics {
    id: textMetrics
    font.family: "Arial"
    elide: Text.ElideMiddle
    elideWidth: 100
    text: "Hello World"
}
MyItem {
    text: textMetrics.elidedText
}

See also QFontMetricsF and FontMetrics.

Property Documentation

advanceWidth : real

This property holds 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.

See also QFontMetricsF::width().

boundingRect : rect

This property holds the bounding rectangle of the characters in the string specified by text .

See also QFontMetricsF::boundingRect() and tightBoundingRect.

elide : enumeration

This property holds the elide mode of the text. This determines the position in which the string is elided. The possible values are:

  • Qt::ElideNone - No eliding; this is the default value.
  • Qt::ElideLeft - For example: “…World”
  • Qt::ElideMiddle - For example: “He…ld”
  • Qt::ElideRight - For example: “Hello…”

See also elideWidth and elidedText.

elideWidth : real

This property holds the largest width the text can have (in pixels) before eliding will occur.

See also elide and elidedText.

font : font

This property holds the font used for the metrics calculations.

height : real

This property holds the height of the bounding rectangle of the characters in the string specified by text . It is equivalent to:

textMetrics.boundingRect.height

See also boundingRect.

text : string

This property holds the text used for the metrics calculations.

tightBoundingRect : rect

This property holds a tight bounding rectangle around the characters in the string specified by text .

See also QFontMetricsF::tightBoundingRect() and boundingRect.

width : real

This property holds the width of the bounding rectangle of the characters in the string specified by text . It is equivalent to:

textMetrics.boundingRect.width

See also boundingRect.