Describe meaning of typographic units in QRawFont documentation

Text is copied from corresponding QFontMetrics methods.

Change-Id: Ife79e0d1b06ca3f691f2fd8bd796b41aeaa76954
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
This commit is contained in:
Konstantin Tokarev 2016-08-06 17:02:31 +03:00 committed by Antti Kokko
parent a45566eec7
commit f050f2180f

View File

@ -310,6 +310,13 @@ bool QRawFont::operator==(const QRawFont &other) const
/*!
Returns the ascent of this QRawFont in pixel units.
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.
\sa QFontMetricsF::ascent()
*/
qreal QRawFont::ascent() const
@ -320,6 +327,11 @@ qreal QRawFont::ascent() const
/*!
Returns the descent of this QRawFont in pixel units.
The descent is the distance from the base line to the lowest point
characters extend to. 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.
\sa QFontMetricsF::descent()
*/
qreal QRawFont::descent() const
@ -330,6 +342,8 @@ qreal QRawFont::descent() const
/*!
Returns the xHeight of this QRawFont in pixel units.
This is often but not always the same as the height of the character 'x'.
\sa QFontMetricsF::xHeight()
*/
qreal QRawFont::xHeight() const
@ -340,6 +354,8 @@ qreal QRawFont::xHeight() const
/*!
Returns the leading of this QRawFont in pixel units.
This is the natural inter-line spacing.
\sa QFontMetricsF::leading()
*/
qreal QRawFont::leading() const