Document interaction of style name and other style properties

Setting style name to "Regular" and then setting bold to true, results
in platform depending behavior, and should be avoided.

Also removes comment about style name not working on Windows, it has
been working since 5.8.0.

Task-number: QTBUG-63792
Change-Id: Ie5be7215a673f5751dbeb6512df8ec7bfaef4d0a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
This commit is contained in:
Allan Sandfeld Jensen 2017-11-02 17:46:35 +01:00
parent d0736e9d17
commit 25b18fb241

View File

@ -727,11 +727,9 @@ void QFont::setFamily(const QString &family)
/*!
\since 4.8
Returns the requested font style name, it will be used to match the
Returns the requested font style name. This can be used to match the
font with irregular styles (that can't be normalized in other style
properties). It depends on system font support, thus only works for
\macos and X11 so far. On Windows irregular styles will be added
as separate font families so there is no need for this.
properties).
\sa setFamily(), setStyle()
*/
@ -744,7 +742,12 @@ QString QFont::styleName() const
\since 4.8
Sets the style name of the font to \a styleName. When set, other style properties
like \l style() and \l weight() will be ignored for font matching.
like \l style() and \l weight() will be ignored for font matching, though they may be
simulated afterwards if supported by the platform's font engine.
Due to the lower quality of artificially simulated styles, and the lack of full cross
platform support, it is not recommended to use matching by style name together with
matching by style properties
\sa styleName()
*/
@ -985,6 +988,10 @@ int QFont::pixelSize() const
Sets the style() of the font to QFont::StyleItalic if \a enable is true;
otherwise the style is set to QFont::StyleNormal.
\note If styleName() is set, this value may be ignored, or if supported
on the platform, the font may be rendered tilted instead of picking a
designed italic font-variant.
\sa italic(), QFontInfo
*/
@ -1050,6 +1057,8 @@ int QFont::weight() const
Sets the weight of the font to \a weight, using the scale defined by
\l QFont::Weight enumeration.
\note If styleName() is set, this value may be ignored for font selection.
\sa weight(), QFontInfo
*/
void QFont::setWeight(int weight)
@ -1083,6 +1092,9 @@ void QFont::setWeight(int weight)
For finer boldness control use setWeight().
\note If styleName() is set, this value may be ignored, or if supported
on the platform, the font artificially embolded.
\sa bold(), setWeight()
*/