The QFontMetricsF class provides font metrics information. More...
#include <qfontmetrics.h>
Detailed Description
The QFontMetricsF class provides font metrics information.
\reentrant \inmodule QtGui
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 horizontalAdvance(), 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 horizontalAdvance(), 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:
- See also
- QFont, QFontInfo, QFontDatabase
Definition at line 126 of file qfontmetrics.h.
Constructor & Destructor Documentation
◆ QFontMetricsF() [1/4]
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.
Definition at line 1084 of file qfontmetrics.cpp.
◆ QFontMetricsF() [2/4]
| QFontMetricsF::QFontMetricsF | ( | const QFont & | font, |
| const QPaintDevice * | paintdevice | ||
| ) |
- Since
- 5.13 Constructs a font metrics object for font and paintdevice.
The font metrics will be compatible with the paintdevice passed. If the paintdevice is \nullptr, the metrics will be screen-compatible, ie. the metrics you get if you use the font for drawing text on a \l{QWidget}{widgets} or \l{QPixmap}{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.
Definition at line 1104 of file qfontmetrics.cpp.
◆ QFontMetricsF() [3/4]
| QFontMetricsF::QFontMetricsF | ( | const QFontMetrics & | fontMetrics | ) |
- Since
- 4.2
Constructs a font metrics object with floating point precision from the given fontMetrics object.
Definition at line 1045 of file qfontmetrics.cpp.
◆ QFontMetricsF() [4/4]
| QFontMetricsF::QFontMetricsF | ( | const QFontMetricsF & | fm | ) |
Constructs a copy of fm.
Definition at line 1119 of file qfontmetrics.cpp.
◆ ~QFontMetricsF()
| QFontMetricsF::~QFontMetricsF | ( | ) |
Destroys the font metrics object and frees all allocated resources.
Definition at line 1128 of file qfontmetrics.cpp.
Member Function Documentation
◆ ascent()
| 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 a certain character, so it is possible (though rare) that this value will be too small.
- See also
- descent()
Definition at line 1175 of file qfontmetrics.cpp.
◆ averageCharWidth()
| qreal QFontMetricsF::averageCharWidth | ( | ) | const |
- Since
- 4.2
Returns the average width of glyphs in the font.
Definition at line 1324 of file qfontmetrics.cpp.
◆ boundingRect() [1/4]
| QRectF QFontMetricsF::boundingRect | ( | const QRectF & | rect, |
| int | flags, | ||
| const QString & | text, | ||
| int | tabStops = 0, |
||
| int * | tabArray = nullptr |
||
| ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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. If rect is a reference to a \nullptr object, e.g. when passing a default constructed QRectF, the bounding rectangle will not constrain itself to the size.
The flags argument is the bitwise OR of the following flags: \list
- 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 \underline{x}; i.e., underlined.
- Qt::TextWordWrap breaks the text to fit the rectangle. \endlist
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 \l{Qt::AlignmentFlag}.
If Qt::TextExpandTabs is set in flags, the following behavior is used to interpret tab characters in the text: \list
- 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). \endlist
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 \l{minLeftBearing()}{maximum left} and \l{minRightBearing()}{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
- horizontalAdvance(), QPainter::boundingRect(), Qt::Alignment
Definition at line 1694 of file qfontmetrics.cpp.
◆ boundingRect() [2/4]
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 horizontalAdvance() 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 horizontalAdvance() 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().
Definition at line 1553 of file qfontmetrics.cpp.
◆ boundingRect() [3/4]
| QRectF QFontMetricsF::boundingRect | ( | const QString & | text, |
| const QTextOption & | option | ||
| ) | const |
Returns the bounding rectangle of the characters in the string specified by text laid out using option. 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 horizontalAdvance() 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 horizontalAdvance() 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().
- Since
- 6.3
Definition at line 1588 of file qfontmetrics.cpp.
◆ boundingRect() [4/4]
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
- horizontalAdvance()
Definition at line 1615 of file qfontmetrics.cpp.
◆ capHeight()
| qreal QFontMetricsF::capHeight | ( | ) | const |
Returns the cap height of the font.
- Since
- 5.8
The cap height of a font is the height of a capital letter above the baseline. It specifically is 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.
- See also
- ascent()
Definition at line 1194 of file qfontmetrics.cpp.
◆ descent()
| 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 a certain character, so it is possible (though rare) that this value will be too small.
- See also
- ascent()
Definition at line 1212 of file qfontmetrics.cpp.
◆ elidedText()
| QString QFontMetricsF::elidedText | ( | const QString & | text, |
| Qt::TextElideMode | mode, | ||
| qreal | width, | ||
| int | flags = 0 |
||
| ) | const |
- Since
- 4.2
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 \l{Qt::LayoutDirection}{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}.
Definition at line 1827 of file qfontmetrics.cpp.
◆ fontDpi()
| qreal QFontMetricsF::fontDpi | ( | ) | const |
◆ height()
| qreal QFontMetricsF::height | ( | ) | const |
Returns the height of the font.
This is always equal to ascent()+descent().
- See also
- leading(), lineSpacing()
Definition at line 1226 of file qfontmetrics.cpp.
◆ horizontalAdvance() [1/3]
| qreal QFontMetricsF::horizontalAdvance | ( | const QString & | text, |
| const QTextOption & | option | ||
| ) | const |
Returns the horizontal advance in pixels of text laid out using option.
The advance is the distance appropriate for drawing a subsequent character after text.
- Since
- 6.3
- See also
- boundingRect()
Definition at line 1461 of file qfontmetrics.cpp.
◆ horizontalAdvance() [2/3]
Returns the horizontal advance in pixels of the first length characters of text. If length is negative (the default), the entire string is used.
The advance is the distance appropriate for drawing a subsequent character after text.
- Since
- 5.11
- See also
- boundingRect()
Definition at line 1435 of file qfontmetrics.cpp.
◆ horizontalAdvance() [3/3]
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Bearings
Returns the horizontal advance 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 horizontalAdvance() 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.
- Since
- 5.11
- See also
- boundingRect()
Definition at line 1505 of file qfontmetrics.cpp.
◆ inFont()
| bool QFontMetricsF::inFont | ( | QChar | ch | ) | const |
Returns true if character ch is a valid character in the font; otherwise returns false.
Definition at line 1335 of file qfontmetrics.cpp.
◆ inFontUcs4()
| 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.
Definition at line 1346 of file qfontmetrics.cpp.
◆ leading()
| qreal QFontMetricsF::leading | ( | ) | const |
Returns the leading of the font.
This is the natural inter-line spacing.
- See also
- height(), lineSpacing()
Definition at line 1241 of file qfontmetrics.cpp.
◆ leftBearing()
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 horizontalAdvance() for a graphical description of this metric.
Definition at line 1368 of file qfontmetrics.cpp.
◆ lineSpacing()
| qreal QFontMetricsF::lineSpacing | ( | ) | const |
◆ lineWidth()
| 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(), strikeOutPos()
Definition at line 1887 of file qfontmetrics.cpp.
◆ maxWidth()
| qreal QFontMetricsF::maxWidth | ( | ) | const |
Returns the width of the widest character in the font.
Definition at line 1299 of file qfontmetrics.cpp.
◆ minLeftBearing()
| 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(), leftBearing()
Definition at line 1272 of file qfontmetrics.cpp.
◆ minRightBearing()
| 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(), rightBearing()
Definition at line 1289 of file qfontmetrics.cpp.
◆ operator!=()
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Returns true if the font metrics are not equal to the other font metrics; otherwise returns false.
- See also
- operator==()
Definition at line 183 of file qfontmetrics.h.
◆ operator=() [1/2]
| QFontMetricsF & QFontMetricsF::operator= | ( | const QFontMetrics & | other | ) |
- Since
- 4.2
Assigns other to this object.
Definition at line 1055 of file qfontmetrics.cpp.
◆ operator=() [2/2]
| QFontMetricsF & QFontMetricsF::operator= | ( | const QFontMetricsF & | fm | ) |
Assigns the font metrics fm to this font metrics object.
Definition at line 1135 of file qfontmetrics.cpp.
◆ operator==()
| 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.
Definition at line 1149 of file qfontmetrics.cpp.
◆ overlinePos()
| qreal QFontMetricsF::overlinePos | ( | ) | const |
Returns the distance from the base line to where an overline should be drawn.
- See also
- underlinePos(), strikeOutPos(), lineWidth()
Definition at line 1865 of file qfontmetrics.cpp.
◆ rightBearing()
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 horizontalAdvance() of the character.
See horizontalAdvance() for a graphical description of this metric.
Definition at line 1401 of file qfontmetrics.cpp.
◆ size()
| QSizeF QFontMetricsF::size | ( | int | flags, |
| const QString & | text, | ||
| int | tabStops = 0, |
||
| int * | tabArray = 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: \list
- Qt::TextSingleLine ignores newline characters.
- Qt::TextExpandTabs expands tabs (see below)
- Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined.
- Qt::TextWordWrap breaks the text to fit the rectangle. \endlist
These flags are defined in the \l{Qt::TextFlag} enum.
If Qt::TextExpandTabs is set in flags, the following behavior is used to interpret tab characters in the text: \list
- 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). \endlist
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()
Definition at line 1736 of file qfontmetrics.cpp.
◆ strikeOutPos()
| qreal QFontMetricsF::strikeOutPos | ( | ) | const |
Returns the distance from the base line to where the strikeout line should be drawn.
- See also
- underlinePos(), overlinePos(), lineWidth()
Definition at line 1876 of file qfontmetrics.cpp.
◆ swap()
|
inlinenoexcept |
- Since
- 5.0
Swaps this font metrics instance with other. This function is very fast and never fails.
Definition at line 139 of file qfontmetrics.h.
◆ tightBoundingRect() [1/2]
- Since
- 4.3
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 horizontalAdvance() 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 horizontalAdvance() instead.
Newline characters are processed as normal characters, not as linebreaks.
- See also
- horizontalAdvance(), height(), boundingRect()
Definition at line 1762 of file qfontmetrics.cpp.
◆ tightBoundingRect() [2/2]
| QRectF QFontMetricsF::tightBoundingRect | ( | const QString & | text, |
| const QTextOption & | option | ||
| ) | const |
Returns a tight bounding rectangle around the characters in the string specified by text laid out using option. 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 horizontalAdvance() 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 horizontalAdvance() instead.
Newline characters are processed as normal characters, not as linebreaks.
- Since
- 6.3
- See also
- horizontalAdvance(), height(), boundingRect()
Definition at line 1794 of file qfontmetrics.cpp.
◆ underlinePos()
| qreal QFontMetricsF::underlinePos | ( | ) | const |
Returns the distance from the base line to where an underscore should be drawn.
- See also
- overlinePos(), strikeOutPos(), lineWidth()
Definition at line 1852 of file qfontmetrics.cpp.
◆ xHeight()
| 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'.
Definition at line 1310 of file qfontmetrics.cpp.
The documentation for this class was generated from the following files:
- src/gui/text/qfontmetrics.h
- src/gui/text/qfontmetrics.cpp
