Qt logo

QFontMetrics Class Reference


The QFontMetrics class provides font metrics information about fonts. More...

#include <qfontmetrics.h>

List of all member functions.

Public Members


Detailed Description

The QFontMetrics class provides font metrics information about fonts.

QFontMetrics functions calculate size of characters and strings for a given font.

There are three ways you can create a QFontMetrics object:

  1. The QFontMetrics constructor with a QFont creates a font metrics object for a screen-compatible font, i.e. the font must not be a printer font.
  2. QWidget::fontMetrics() returns the font metrics for a widget's font. This is equivalent to QFontMetrics(widget->font()). Setting a new font for the widget later will not affect the font metrics object.
  3. QPainter::fontMetrics() returns the font metrics for a painter's current font. The font metrics object is automatically updated if somebody sets a new painter font (unlike the two above cases, which take a "snapshot" of a font).

Example:

    QFont font("times",24);
    QFontMetrics fm(font);
    int w = fm.width("What's the width of this text");
    int h = fm.height();

See also: QFont and QFontInfo.

Examples: grapher/grapher.cpp xform/xform.cpp drawdemo/drawdemo.cpp scrollview/scrollview.cpp movies/main.cpp


Member Function Documentation

QFontMetrics::QFontMetrics(constQFont&font)

Constructs a font metrics object for font.

The font must be screen-compatible, i.e. a font you use when drawing text in widgets or pixmaps. If font is a printer font, you'll probably get wrong results.

Use the QPainter::fontMetrics() to get the font metrics when painting. This is a little slower than using this constructor, but it always gives correct results.

QFontMetrics::QFontMetrics(constQFontMetrics&fm)

Constructs a copy of fm.

QFontMetrics::~QFontMetrics()

Destroys the font metrics object.

intQFontMetrics::ascent()const

Returns the maximum ascent of the font.

The ascent is the distance from the base line to the uppermost line where pixels may be drawn.

See also: descent().

Examples: drawdemo/drawdemo.cpp scrollview/scrollview.cpp

QRectQFontMetrics::boundingRect(QCharch)const

Returns the bounding rectangle of ch relative to the leftmost 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().

Examples: xform/xform.cpp

QRectQFontMetrics::boundingRect(constQString&str, intlen=-1)const

Returns the bounding rectangle of the first len characters of str, which is the set of pixels the text would cover if drawn at (0,0).

If len is negative (default value), the whole string is used.

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.

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

Due to the different actual character heights, the height of the bounding rectangle of "Yes" and "yes" may be different.

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

QRectQFontMetrics::boundingRect(intx, inty, intw, inth, intflgs, constQString&str, intlen=-1, inttabstops=0, int*tabarray=0, char**intern=0)const

Returns the bounding rectangle of the first len characters of str, which is the set of pixels the text would cover if drawn at (0,0).

If len is negative (default value), the whole string is used.

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

Horizontal alignment defaults to AlignLeft and vertical alignment defaults to 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 the Qt namespace.

If ExpandTabs is set in flgs, then: if tabarray is non.zero, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise 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, and that the text output may cover all pixels in the bounding rectangle.

Newline characters are processed as linebreaks.

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

The bounding rectangle given 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.

The internal argument is for internal purposes.

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

intQFontMetrics::descent()const

Returns the maximum descent of the font.

The descent is the distance from the base line to the lowermost line where pixels may be drawn. (Note that this is different from X, which adds 1 pixel.)

See also: ascent().

Examples: drawdemo/drawdemo.cpp

intQFontMetrics::height()const

Returns the height of the font.

This is always equal to ascent()+descent()+1 (the 1 is for the base line).

See also: leading() and lineSpacing().

Examples: grapher/grapher.cpp

boolQFontMetrics::inFont(QCharch)const

Returns TRUE if ch is a valid character in the font.

intQFontMetrics::leading()const

Returns the leading of the font.

This is the natural inter-line spacing.

See also: height() and lineSpacing().

intQFontMetrics::leftBearing(QCharch)const

Returns the left bearing of character ch in the font.

The left bearing is the rightward 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(QChar), minLeftBearing() and width().

intQFontMetrics::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().

Examples: scrollview/scrollview.cpp

intQFontMetrics::lineWidth()const

Returns the width of the underline and strike-out lines, adjusted for the point size of the font.

See also: underlinePos() and strikeOutPos().

intQFontMetrics::maxWidth()const

Returns the width of the widest character in the font.

intQFontMetrics::minLeftBearing()const

Returns the minimum left bearing of the font.

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

See also: minRightBearing() and leftBearing(char).

intQFontMetrics::minRightBearing()const

Returns the minimum right bearing of the font.

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

See also: minLeftBearing() and rightBearing(char).

QFontMetrics&QFontMetrics::operator=(constQFontMetrics&fm)

Font metrics assignment.

intQFontMetrics::rightBearing(QCharch)const

Returns the right bearing of character ch in the font.

The right bearing is the leftward 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(char), minRightBearing() and width().

QSizeQFontMetrics::size(intflgs, constQString&str, intlen=-1, inttabstops=0, int*tabarray=0, char**intern=0)const

Returns the size in pixels of the first len characters of str.

If len is negative (default value), the whole string is used.

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

These flags are defined in qnamespace.h.

If ExpandTabs is set in flgs, then: if tabarray is non.zero, it specifies a 0-terminated sequence of pixel-positions for tabs; otherwise if tabstops is non-zero, it is used as the tab spacing (in pixels).

Newline characters are processed as linebreaks.

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

The internal argument is for internal purposes.

See also: boundingRect().

intQFontMetrics::strikeOutPos()const

Returns the distance from the base line to where the strike-out line should be drawn.

See also: underlinePos() and lineWidth().

intQFontMetrics::underlinePos()const

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

See also: strikeOutPos() and lineWidth().

intQFontMetrics::width(QCharch)const

Returns the logical width of a 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 tall dark rectangle covers the logical width() of a character. The shorter pale rectangles cover the left and right bearings of the characters. Notice that the bearings of "f" in this particular font are both negative, while the bearings of "o" are both positive.

See also: boundingRect().

intQFontMetrics::width(constQString&str, intlen=-1)const

Returns the width in pixels of the first len characters of str.

If len is negative (default value), the whole string is used.

Note that this value is not equal to boundingRect().width(); boundingRect() returns a rectangle describing the pixels this string will cover whereas width() returns the distance to where the next string should be drawn. Thus, width(stra)+width(strb) is always equal to width(stra+strb). This is almost never the case with boundingRect().

See also: boundingRect().

Examples: drawdemo/drawdemo.cpp scrollview/scrollview.cpp movies/main.cpp

intQFontMetrics::width(charc)const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Provided to aid porting from Qt 1.x.


Search the documentation, FAQ, qt-interest archive and more (uses www.troll.no):


This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.


Copyright 1999 Troll TechTrademarks
Qt version 2.0.2