QFont Class Reference

\reentrant More...

#include <qfont.h>

Inheritance diagram for QFont:

Collaboration diagram for QFont:

Classes
class	Tag
	The QFont::Tag type provides access to advanced font features. More...

Public Types
enum	StyleHint {   Helvetica , SansSerif = Helvetica , Times , Serif = Times ,   Courier , TypeWriter = Courier , OldEnglish , Decorative = OldEnglish ,   System , AnyStyle , Cursive , Monospace ,   Fantasy }
	Style hints are used by the \l{QFont}{font matching} algorithm to find an appropriate default family if a selected font family is not available. More...
enum	StyleStrategy {   PreferDefault = 0x0001 , PreferBitmap = 0x0002 , PreferDevice = 0x0004 , PreferOutline = 0x0008 ,   ForceOutline = 0x0010 , PreferMatch = 0x0020 , PreferQuality = 0x0040 , PreferAntialias = 0x0080 ,   NoAntialias = 0x0100 , NoSubpixelAntialias = 0x0800 , PreferNoShaping = 0x1000 , ContextFontMerging = 0x2000 ,   PreferTypoLineMetrics = 0x4000 , NoFontMerging = 0x8000 }
	The style strategy tells the \l{QFont}{font matching} algorithm what type of fonts should be used to find an appropriate default family. More...
enum	HintingPreference { PreferDefaultHinting = 0 , PreferNoHinting = 1 , PreferVerticalHinting = 2 , PreferFullHinting = 3 }
enum	Weight {   Thin = 100 , ExtraLight = 200 , Light = 300 , Normal = 400 ,   Medium = 500 , DemiBold = 600 , Bold = 700 , ExtraBold = 800 ,   Black = 900 }
	Qt uses a weighting scale from 1 to 1000 compatible with OpenType. More...
enum	Style { StyleNormal , StyleItalic , StyleOblique }
	This enum describes the different styles of glyphs that are used to display text. More...
enum	Stretch {   AnyStretch = 0 , UltraCondensed = 50 , ExtraCondensed = 62 , Condensed = 75 ,   SemiCondensed = 87 , Unstretched = 100 , SemiExpanded = 112 , Expanded = 125 ,   ExtraExpanded = 150 , UltraExpanded = 200 }
	Predefined stretch values that follow the CSS naming convention. More...
enum	Capitalization {   MixedCase , AllUppercase , AllLowercase , SmallCaps ,   Capitalize }
enum	SpacingType { PercentageSpacing , AbsoluteSpacing }
enum	ResolveProperties {   NoPropertiesResolved = 0x0000 , FamilyResolved = 0x0001 , SizeResolved = 0x0002 , StyleHintResolved = 0x0004 ,   StyleStrategyResolved = 0x0008 , WeightResolved = 0x0010 , StyleResolved = 0x0020 , UnderlineResolved = 0x0040 ,   OverlineResolved = 0x0080 , StrikeOutResolved = 0x0100 , FixedPitchResolved = 0x0200 , StretchResolved = 0x0400 ,   KerningResolved = 0x0800 , CapitalizationResolved = 0x1000 , LetterSpacingResolved = 0x2000 , WordSpacingResolved = 0x4000 ,   HintingPreferenceResolved = 0x8000 , StyleNameResolved = 0x10000 , FamiliesResolved = 0x20000 , FeaturesResolved = 0x40000 ,   VariableAxesResolved = 0x80000 , AllPropertiesResolved = 0xfffff }

Public Member Functions
	QFont ()
	Constructs a font object that uses the application's default font.
	QFont (const QString &family, int pointSize=-1, int weight=-1, bool italic=false)
	Constructs a font object with the specified family, pointSize, weight and italic settings.
	QFont (const QStringList &families, int pointSize=-1, int weight=-1, bool italic=false)
	Constructs a font object with the specified families, pointSize, weight and italic settings.
	QFont (const QFont &font, const QPaintDevice *pd)
	QFont (const QFont &font)
	Constructs a font that is a copy of font.
	~QFont ()
	Destroys the font object and frees all allocated resources.
void	swap (QFont &other) noexcept
QString	family () const
	Returns the requested font family name.
void	setFamily (const QString &)
	Sets the family name of the font.
QStringList	families () const
void	setFamilies (const QStringList &)
QString	styleName () const
void	setStyleName (const QString &)
int	pointSize () const
	Returns the point size of the font.
void	setPointSize (int)
	Sets the point size to pointSize.
qreal	pointSizeF () const
	Returns the point size of the font.
void	setPointSizeF (qreal)
	Sets the point size to pointSize.
int	pixelSize () const
	Returns the pixel size of the font if it was set with setPixelSize().
void	setPixelSize (int)
	Sets the font size to pixelSize pixels, with a maxiumum size of an unsigned 16-bit integer.
Weight	weight () const
	Returns the weight of the font, using the same scale as the \l{QFont::Weight} enumeration.
void	setWeight (Weight weight)
	Sets the weight of the font to weight, using the scale defined by \l QFont::Weight enumeration.
bool	bold () const
	Returns true if weight() is a value greater than \l{Weight}{QFont::Medium}; otherwise returns false.
void	setBold (bool)
	If enable is true sets the font's weight to \l{Weight}{QFont::Bold}; otherwise sets the weight to \l{Weight}{QFont::Normal}.
void	setStyle (Style style)
	Sets the style of the font to style.
Style	style () const
	Returns the style of the font.
bool	italic () const
	Returns true if the style() of the font is not QFont::StyleNormal.
void	setItalic (bool b)
	Sets the style() of the font to QFont::StyleItalic if enable is true; otherwise the style is set to QFont::StyleNormal.
bool	underline () const
	Returns true if underline has been set; otherwise returns false.
void	setUnderline (bool)
	If enable is true, sets underline on; otherwise sets underline off.
bool	overline () const
	Returns true if overline has been set; otherwise returns false.
void	setOverline (bool)
	If enable is true, sets overline on; otherwise sets overline off.
bool	strikeOut () const
	Returns true if strikeout has been set; otherwise returns false.
void	setStrikeOut (bool)
	If enable is true, sets strikeout on; otherwise sets strikeout off.
bool	fixedPitch () const
	Returns true if fixed pitch has been set; otherwise returns false.
void	setFixedPitch (bool)
	If enable is true, sets fixed pitch on; otherwise sets fixed pitch off.
bool	kerning () const
	Returns true if kerning should be used when drawing text with this font.
void	setKerning (bool)
	Enables kerning for this font if enable is true; otherwise disables it.
StyleHint	styleHint () const
	Returns the StyleHint.
StyleStrategy	styleStrategy () const
	Returns the StyleStrategy.
void	setStyleHint (StyleHint, StyleStrategy=PreferDefault)
	Sets the style hint and strategy to hint and strategy, respectively.
void	setStyleStrategy (StyleStrategy s)
	Sets the style strategy for the font to s.
int	stretch () const
	Returns the stretch factor for the font.
void	setStretch (int)
	Sets the stretch factor for the font.
qreal	letterSpacing () const
SpacingType	letterSpacingType () const
void	setLetterSpacing (SpacingType type, qreal spacing)
qreal	wordSpacing () const
void	setWordSpacing (qreal spacing)
void	setCapitalization (Capitalization)
Capitalization	capitalization () const
void	setHintingPreference (HintingPreference hintingPreference)
HintingPreference	hintingPreference () const
void	setFeature (Tag tag, quint32 value)
void	unsetFeature (Tag tag)
quint32	featureValue (Tag tag) const
bool	isFeatureSet (Tag tag) const
QList< Tag >	featureTags () const
void	clearFeatures ()
void	setVariableAxis (Tag tag, float value)
void	unsetVariableAxis (Tag tag)
bool	isVariableAxisSet (Tag tag) const
float	variableAxisValue (Tag tag) const
void	clearVariableAxes ()
QList< Tag >	variableAxisTags () const
bool	exactMatch () const
	Returns true if a window system font exactly matching the settings of this font is available.
QFont &	operator= (const QFont &)
	Move-assigns other to this QFont instance.
bool	operator== (const QFont &) const
	Returns true if this font is equal to f; otherwise returns false.
bool	operator!= (const QFont &) const
	Returns true if this font is different from f; otherwise returns false.
bool	operator< (const QFont &) const
	Provides an arbitrary comparison of this font and font f.
	operator QVariant () const
	Returns the font as a QVariant.
bool	isCopyOf (const QFont &) const
	Returns true if this font and f are copies of each other, i.e.
QString	key () const
	Returns the font's key, a textual representation of a font.
QString	toString () const
	Returns a description of the font.
bool	fromString (const QString &)
	Sets this font to match the description descrip.
QString	defaultFamily () const
	Returns the family name that corresponds to the current style hint.
QFont	resolve (const QFont &) const
	Returns a new QFont that has attributes copied from other that have not been previously set on this font.
uint	resolveMask () const
void	setResolveMask (uint mask)

Static Public Member Functions
static QString	substitute (const QString &)
	Returns the first family name to be used whenever familyName is specified.
static QStringList	substitutes (const QString &)
	Returns a list of family names to be used whenever familyName is specified.
static QStringList	substitutions ()
	Returns a sorted list of substituted family names.
static void	insertSubstitution (const QString &, const QString &)
	Inserts substituteName into the substitution table for the family familyName.
static void	insertSubstitutions (const QString &, const QStringList &)
	Inserts the list of families substituteNames into the substitution list for familyName.
static void	removeSubstitutions (const QString &)
	Removes all the substitutions for familyName.
static void	initialize ()
static void	cleanup ()
static void	cacheStatistics ()

Friends
class	QFontPrivate
class	QFontDialogPrivate
class	QFontMetrics
class	QFontMetricsF
class	QFontInfo
class	QPainter
class	QPainterPrivate
class	QApplication
class	QWidget
class	QWidgetPrivate
class	QTextLayout
class	QTextEngine
class	QStackTextEngine
class	QTextLine
struct	QScriptLine
class	QOpenGLContext
class	QWin32PaintEngine
class	QAlphaPaintEngine
class	QPainterPath
class	QTextItemInt
class	QPicturePaintEngine
class	QPainterReplayer
class	QPaintBufferEngine
class	QCommandLinkButtonPrivate
class	QFontEngine
Q_GUI_EXPORT QDataStream &	operator<< (QDataStream &, const QFont &)
	Writes the font font to the data stream s.
Q_GUI_EXPORT QDataStream &	operator>> (QDataStream &, QFont &)
	Reads the font font from the data stream s.
Q_GUI_EXPORT QDebug	operator<< (QDebug stream, const QFont &font)

Related Symbols
(Note that these are not member symbols.)
size_t	qHash (const QFont &font, size_t seed) noexcept
	Returns the hash value for font.

Detailed Description

\reentrant

The QFont class specifies a query for a font used for drawing text.

\inmodule QtGui

QFont can be regarded as a query for one or more fonts on the system.

When you create a QFont object you specify various attributes that you want the font to have. Qt will use the font with the specified attributes, or if no matching font exists, Qt will use the closest matching installed font. The attributes of the font that is actually used are retrievable from a QFontInfo object. If the window system provides an exact match exactMatch() returns true. Use QFontMetricsF to get measurements, e.g. the pixel length of a string using QFontMetrics::width().

Attributes which are not specifically set will not affect the font selection algorithm, and default values will be preferred instead.

To load a specific physical font, typically represented by a single file, use QRawFont instead.

Note that a QGuiApplication instance must exist before a QFont can be used. You can set the application's default font with QGuiApplication::setFont().

If a chosen font does not include all the characters that need to be displayed, QFont will try to find the characters in the nearest equivalent fonts. When a QPainter draws a character from a font the QFont will report whether or not it has the character; if it does not, QPainter will draw an unfilled square.

Create QFonts like this:

QFont serifFont("Times", 10, QFont::Bold);
QFont sansFont("Helvetica [Cronyx]", 12);

The attributes set in the constructor can also be set later, e.g. setFamily(), setPointSize(), setPointSizeF(), setWeight() and setItalic(). The remaining attributes must be set after construction, e.g. setBold(), setUnderline(), setOverline(), setStrikeOut() and setFixedPitch(). QFontInfo objects should be created after the font's attributes have been set. A QFontInfo object will not change, even if you change the font's attributes. The corresponding "get" functions, e.g. family(), pointSize(), etc., return the values that were set, even though the values used may differ. The actual values are available from a QFontInfo object.

If the requested font family is unavailable you can influence the \l{#fontmatching}{font matching algorithm} by choosing a particular \l{QFont::StyleHint} and \l{QFont::StyleStrategy} with setStyleHint(). The default family (corresponding to the current style hint) is returned by defaultFamily().

You can provide substitutions for font family names using insertSubstitution() and insertSubstitutions(). Substitutions can be removed with removeSubstitutions(). Use substitute() to retrieve a family's first substitute, or the family name itself if it has no substitutes. Use substitutes() to retrieve a list of a family's substitutes (which may be empty). After substituting a font, you must trigger the updating of the font by destroying and re-creating all QFont objects.

Every QFont has a key() which you can use, for example, as the key in a cache or dictionary. If you want to store a user's font preferences you could use QSettings, writing the font information with toString() and reading it back with fromString(). The operator<<() and operator>>() functions are also available, but they work on a data stream.

It is possible to set the height of characters shown on the screen to a specified number of pixels with setPixelSize(); however using setPointSize() has a similar effect and provides device independence.

Loading fonts can be expensive, especially on X11. QFont contains extensive optimizations to make the copying of QFont objects fast, and to cache the results of the slow window system functions it depends upon.

\target fontmatching The font matching algorithm works as follows: \list 1

• The specified font families (set by setFamilies()) are searched for.
• If not, a replacement font that supports the writing system is selected. The font matching algorithm will try to find the best match for all the properties set in the QFont. How this is done varies from platform to platform.
• If no font exists on the system that can support the text, then special "missing character" boxes will be shown in its place. \endlist

Note

If the selected font, though supporting the writing system in general, is missing glyphs for one or more specific characters, then Qt will try to find a fallback font for this or these particular characters. This feature can be disabled using QFont::NoFontMerging style strategy.

In Windows a request for the "Courier" font is automatically changed to "Courier New", an improved version of Courier that allows for smooth scaling. The older "Courier" bitmap font can be selected by setting the PreferBitmap style strategy (see setStyleStrategy()).

Once a font is found, the remaining attributes are matched in order of priority: \list 1

• fixedPitch()
• pointSize() (see below)
• weight()
• style() \endlist

If you have a font which matches on family, even if none of the other attributes match, this font will be chosen in preference to a font which doesn't match on family but which does match on the other attributes. This is because font family is the dominant search criteria.

The point size is defined to match if it is within 20% of the requested point size. When several fonts match and are only distinguished by point size, the font with the closest point size to the one requested will be chosen.

The actual family, font size, weight and other font attributes used for drawing text will depend on what's available for the chosen family under the window system. A QFontInfo object can be used to determine the actual values used for drawing the text.

Examples:

QFont f("Helvetica");

If you had both an Adobe and a Cronyx Helvetica, you might get either.

QFont f("Helvetica [Cronyx]");

You can specify the foundry you want in the family name. The font f in the above example will be set to "Helvetica [Cronyx]".

To determine the attributes of the font actually used in the window system, use a QFontInfo object, e.g.

QFontInfo info(f1);
QString family = info.family();

To find out font metrics use a QFontMetrics object, e.g.

QFontMetrics fm(f1);
int textWidthInPixels = fm.horizontalAdvance("How many pixels wide is this text?");
int textHeightInPixels = fm.height();

For more general information on fonts, see the \l{comp.fonts FAQ}{comp.fonts FAQ}. Information on encodings can be found from the \l{UTR17} page.

See also

QFontMetrics, QFontInfo, QFontDatabase

Definition at line 21 of file qfont.h.

Member Enumeration Documentation

Capitalization

enum QFont::Capitalization

Since

4.4

Rendering option for text this font applies to.

\value MixedCase This is the normal text rendering option where no capitalization change is applied. \value AllUppercase This alters the text to be rendered in all uppercase type. \value AllLowercase This alters the text to be rendered in all lowercase type. \value SmallCaps This alters the text to be rendered in small-caps type. \value Capitalize This alters the text to be rendered with the first character of each word as an uppercase character.

Enumerator
MixedCase
AllUppercase
AllLowercase
SmallCaps
Capitalize

Definition at line 98 of file qfont.h.

HintingPreference

enum QFont::HintingPreference

Since

4.8

This enum describes the different levels of hinting that can be applied to glyphs to improve legibility on displays where it might be warranted by the density of pixels.

\value PreferDefaultHinting Use the default hinting level for the target platform. \value PreferNoHinting If possible, render text without hinting the outlines of the glyphs. The text layout will be typographically accurate and scalable, using the same metrics as are used e.g. when printing. \value PreferVerticalHinting If possible, render text with no horizontal hinting, but align glyphs to the pixel grid in the vertical direction. The text will appear crisper on displays where the density is too low to give an accurate rendering of the glyphs. But since the horizontal metrics of the glyphs are unhinted, the text's layout will be scalable to higher density devices (such as printers) without impacting details such as line breaks. \value PreferFullHinting If possible, render text with hinting in both horizontal and vertical directions. The text will be altered to optimize legibility on the target device, but since the metrics will depend on the target size of the text, the positions of glyphs, line breaks, and other typographical detail will not scale, meaning that a text layout may look different on devices with different pixel densities.

Please note that this enum only describes a preference, as the full range of hinting levels are not supported on all of Qt's supported platforms. The following table details the effect of a given hinting preference on a selected set of target platforms.

\table \header

• PreferDefaultHinting
• PreferNoHinting
• PreferVerticalHinting
• PreferFullHinting \row
• Windows and DirectWrite enabled in Qt
• Full hinting
• Vertical hinting
• Vertical hinting
• Full hinting \row
• FreeType
• Operating System setting
• No hinting
• Vertical hinting (light)
• Full hinting \row
• Cocoa on \macos
• No hinting
• No hinting
• No hinting
• No hinting \endtable

Enumerator
PreferDefaultHinting
PreferNoHinting
PreferVerticalHinting
PreferFullHinting

Definition at line 56 of file qfont.h.

ResolveProperties

enum QFont::ResolveProperties

This enum describes the properties of a QFont that can be set on a font individually and then considered resolved.

\value FamilyResolved \value FamiliesResolved \value SizeResolved \value StyleHintResolved \value StyleStrategyResolved \value WeightResolved \value StyleResolved \value UnderlineResolved \value OverlineResolved \value StrikeOutResolved \value FixedPitchResolved \value StretchResolved \value KerningResolved \value CapitalizationResolved \value LetterSpacingResolved \value WordSpacingResolved \value CompletelyResolved

Enumerator
NoPropertiesResolved
FamilyResolved
SizeResolved
StyleHintResolved
StyleStrategyResolved
WeightResolved
StyleResolved
UnderlineResolved
OverlineResolved
StrikeOutResolved
FixedPitchResolved
StretchResolved
KerningResolved
CapitalizationResolved
LetterSpacingResolved
WordSpacingResolved
HintingPreferenceResolved
StyleNameResolved
FamiliesResolved
FeaturesResolved
VariableAxesResolved
AllPropertiesResolved

Definition at line 113 of file qfont.h.

SpacingType

enum QFont::SpacingType

Since

4.4

\value PercentageSpacing A value of 100 will keep the spacing unchanged; a value of 200 will enlarge the spacing after a character by the width of the character itself. \value AbsoluteSpacing A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.

Enumerator
PercentageSpacing
AbsoluteSpacing

Definition at line 107 of file qfont.h.

Stretch

enum QFont::Stretch

Predefined stretch values that follow the CSS naming convention.

The higher the value, the more stretched the text is.

\value [since 5.8] AnyStretch 0 Accept any stretch matched using the other QFont properties \value UltraCondensed 50 \value ExtraCondensed 62 \value Condensed 75 \value SemiCondensed 87 \value Unstretched 100 \value SemiExpanded 112 \value Expanded 125 \value ExtraExpanded 150 \value UltraExpanded 200

See also

setStretch(), stretch()

Enumerator
AnyStretch
UltraCondensed
ExtraCondensed
Condensed
SemiCondensed
Unstretched
SemiExpanded
Expanded
ExtraExpanded
UltraExpanded

Definition at line 84 of file qfont.h.

Style

enum QFont::Style

This enum describes the different styles of glyphs that are used to display text.

\value StyleNormal Normal glyphs used in unstyled text. \value StyleItalic Italic glyphs that are specifically designed for the purpose of representing italicized text. \value StyleOblique Glyphs with an italic appearance that are typically based on the unstyled glyphs, but are not fine-tuned for the purpose of representing italicized text.

See also

Weight

Enumerator
StyleNormal
StyleItalic
StyleOblique

Definition at line 77 of file qfont.h.

StyleHint

enum QFont::StyleHint

Style hints are used by the \l{QFont}{font matching} algorithm to find an appropriate default family if a selected font family is not available.

\value AnyStyle leaves the font matching algorithm to choose the family. This is the default.

\value SansSerif the font matcher prefer sans serif fonts. \value Helvetica is a synonym for SansSerif.

\value Serif the font matcher prefers serif fonts. \value Times is a synonym for Serif.

\value TypeWriter the font matcher prefers fixed pitch fonts. \value Courier a synonym for TypeWriter.

\value OldEnglish the font matcher prefers decorative fonts. \value Decorative is a synonym for OldEnglish.

\value Monospace the font matcher prefers fonts that map to the CSS generic font-family 'monospace'.

\value Fantasy the font matcher prefers fonts that map to the CSS generic font-family 'fantasy'.

\value Cursive the font matcher prefers fonts that map to the CSS generic font-family 'cursive'.

\value System the font matcher prefers system fonts.

Enumerator
Helvetica
SansSerif
Times
Serif
Courier
TypeWriter
OldEnglish
Decorative
System
AnyStyle
Cursive
Monospace
Fantasy

Definition at line 25 of file qfont.h.

StyleStrategy

enum QFont::StyleStrategy

The style strategy tells the \l{QFont}{font matching} algorithm what type of fonts should be used to find an appropriate default family.

The following strategies are available:

\value PreferDefault the default style strategy. It does not prefer any type of font. \value PreferBitmap prefers bitmap fonts (as opposed to outline fonts). \value PreferDevice prefers device fonts. \value PreferOutline prefers outline fonts (as opposed to bitmap fonts). \value ForceOutline forces the use of outline fonts. \value NoAntialias don't antialias the fonts. \value NoSubpixelAntialias avoid subpixel antialiasing on the fonts if possible. \value PreferAntialias antialias if possible. \value [since 6.8] ContextFontMerging If the selected font does not contain a certain character, then Qt automatically chooses a similar-looking fallback font that contains the character. By default this is done on a character-by-character basis. This means that in certain uncommon cases, multiple fonts may be used to represent one string of text even if it's in the same script. Setting ContextFontMerging will try finding the fallback font that matches the largest subset of the input string instead. This will be more expensive for strings where missing glyphs occur, but may give more consistent results. If NoFontMerging is set, then ContextFontMerging will have no effect. \value [since 6.8] PreferTypoLineMetrics For compatibility reasons, OpenType fonts contain two competing sets of the vertical line metrics that provide the \l{QFontMetricsF::ascent()}{ascent}, \l{QFontMetricsF::descent()}{descent} and \l{QFontMetricsF::leading()}{leading} of the font. These are often referred to as the \l{https://learn.microsoft.com/en-us/typography/opentype/spec/os2#uswinascent}{win} (Windows) metrics and the \l{https://learn.microsoft.com/en-us/typography/opentype/spec/os2#sta}{typo} (typographical) metrics. While the specification recommends using the typo metrics for line spacing, many applications prefer the win metrics unless the {USE_TYPO_METRICS} flag is set in the \l{https://learn.microsoft.com/en-us/typography/opentype/spec/os2#fsselection}{fsSelection} field of the font. For backwards-compatibility reasons, this is also the case for Qt applications. This is not an issue for fonts that set the {USE_TYPO_METRICS} flag to indicate that the {typo} metrics are valid, nor for fonts where the {win} metrics and {typo} metrics match up. However, for certain fonts the {win} metrics may be larger than the preferable line spacing and the {USE_TYPO_METRICS} flag may be unset by mistake. For such fonts, setting {PreferTypoLineMetrics} may give superior results. \value NoFontMerging If the font selected for a certain writing system does not contain a character requested to draw, then Qt automatically chooses a similar looking font that contains the character. The NoFontMerging flag disables this feature. Please note that enabling this flag will not prevent Qt from automatically picking a suitable font when the selected font does not support the writing system of the text. \value PreferNoShaping Sometimes, a font will apply complex rules to a set of characters in order to display them correctly. In some writing systems, such as Brahmic scripts, this is required in order for the text to be legible, but in e.g. Latin script, it is merely a cosmetic feature. The PreferNoShaping flag will disable all such features when they are not required, which will improve performance in most cases (since Qt 5.10).

Any of these may be OR-ed with one of these flags:

\value PreferMatch prefer an exact match. The font matcher will try to use the exact font size that has been specified. \value PreferQuality prefer the best quality font. The font matcher will use the nearest standard point size that the font supports.

Enumerator
PreferDefault
PreferBitmap
PreferDevice
PreferOutline
ForceOutline
PreferMatch
PreferQuality
PreferAntialias
NoAntialias
NoSubpixelAntialias
PreferNoShaping
ContextFontMerging
PreferTypoLineMetrics
NoFontMerging

Definition at line 38 of file qfont.h.

Weight

enum QFont::Weight

Qt uses a weighting scale from 1 to 1000 compatible with OpenType.

A weight of 1 will be thin, whilst 1000 will be extremely black.

This enum contains the predefined font weights:

\value Thin 100 \value ExtraLight 200 \value Light 300 \value Normal 400 \value Medium 500 \value DemiBold 600 \value Bold 700 \value ExtraBold 800 \value Black 900

Enumerator
Thin
ExtraLight
Light
Normal
Medium
DemiBold
Bold
ExtraBold
Black

Definition at line 64 of file qfont.h.

Constructor & Destructor Documentation

QFont() [1/5]

QFont::QFont

(

)

Constructs a font object that uses the application's default font.

See also

QGuiApplication::setFont(), QGuiApplication::font()

Definition at line 685 of file qfont.cpp.

QFont() [2/5]

QFont::QFont	(	const QString &	family,
		int	pointSize = -1,
		int	weight = -1,
		bool	italic = false )

Constructs a font object with the specified family, pointSize, weight and italic settings.

If pointSize is zero or negative, the point size of the font is set to a system-dependent default value. Generally, this is 12 points.

The family name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the \l{QFont}{font matching} algorithm.

This will split the family string on a comma and call setFamilies() with the resulting list. To preserve a font that uses a comma in its name, use the constructor that takes a QStringList.

See also

Weight, setFamily(), setPointSize(), setWeight(), setItalic(), setStyleHint(), setFamilies(), QGuiApplication::font()

Definition at line 712 of file qfont.cpp.

QFont() [3/5]

QFont::QFont ( const QStringList & families, int pointSize = -1, int weight = -1, bool italic = false )

explicit

Constructs a font object with the specified families, pointSize, weight and italic settings.

If pointSize is zero or negative, the point size of the font is set to a system-dependent default value. Generally, this is 12 points.

Each family name entry in families may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the \l{QFont}{font matching} algorithm.

See also

Weight, setPointSize(), setWeight(), setItalic(), setStyleHint(), setFamilies(), QGuiApplication::font()

Definition at line 755 of file qfont.cpp.

QFont() [4/5]

QFont::QFont	(	const QFont &	font,
		const QPaintDevice *	pd )

Since

5.13 Constructs a font from font for use on the paint device pd.

Definition at line 621 of file qfont.cpp.

QFont() [5/5]

QFont::QFont

(

const QFont &

font

)

Constructs a font that is a copy of font.

Definition at line 781 of file qfont.cpp.

~QFont()

QFont::~QFont

(

)

Destroys the font object and frees all allocated resources.

Definition at line 789 of file qfont.cpp.

Member Function Documentation

bold()

bool QFont::bold ( ) const

inline

Returns true if weight() is a value greater than \l{Weight}{QFont::Medium}; otherwise returns false.

See also

weight(), setBold(), QFontInfo::bold()

Definition at line 370 of file qfont.h.

cacheStatistics()

void QFont::cacheStatistics ( )

static

Internal function that dumps font cache statistics.

Definition at line 2283 of file qfont.cpp.

capitalization()

QFont::Capitalization QFont::capitalization

(

)

const

Since

4.4 Returns the current capitalization type of the font.

See also

setCapitalization()

Definition at line 1758 of file qfont.cpp.

cleanup()

void QFont::cleanup ( )

static

Internal function that cleans up the font system.

Definition at line 2274 of file qfont.cpp.

clearFeatures()

void QFont::clearFeatures

(

)

Since

6.7

Clears any previously set features on the QFont.

See \l{QFont::}{setFeature()} for more details on font features.

See also

QFont::Tag, setFeature(), unsetFeature(), featureTags(), featureValue()

Definition at line 2675 of file qfont.cpp.

clearVariableAxes()

void QFont::clearVariableAxes

(

)

Since

6.7

Clears any previously set variable axis values on the QFont.

See \l{QFont::}{setVariableAxis()} for more details on variable axes.

See also

QFont::Tag, setVariableAxis(), unsetVariableAxis(), isVariableAxisSet(), variableAxisValue()

Definition at line 2543 of file qfont.cpp.

defaultFamily()

QString QFont::defaultFamily

(

)

const

Returns the family name that corresponds to the current style hint.

See also

StyleHint, styleHint(), setStyleHint()

Definition at line 2695 of file qfont.cpp.

exactMatch()

bool QFont::exactMatch

(

)

const

Returns true if a window system font exactly matching the settings of this font is available.

See also

QFontInfo

Definition at line 1769 of file qfont.cpp.

families()

QStringList QFont::families

(

)

const

Since

5.13

Returns the requested font family names, i.e. the names set in the last setFamilies() call or via the constructor. Otherwise it returns an empty list.

See also

setFamily(), setFamilies(), family(), substitutes(), substitute()

Definition at line 2714 of file qfont.cpp.

family()

QString QFont::family

(

)

const

Returns the requested font family name.

This will always be the same as the first entry in the families() call.

See also

setFamily(), substitutes(), substitute(), setFamilies(), families()

Definition at line 815 of file qfont.cpp.

featureTags()

QList< QFont::Tag > QFont::featureTags

(

)

const

Since

6.7

Returns a list of tags for all font features currently set on this QFont.

See \l{QFont::}{setFeature()} for more details on font features.

See also

QFont::Tag, setFeature(), unsetFeature(), isFeatureSet(), clearFeatures()

Definition at line 2631 of file qfont.cpp.

featureValue()

quint32 QFont::featureValue

(

Tag

tag

)

const

Since

6.7

Returns the value set for a specific feature tag. If the tag has not been set, 0 will be returned instead.

See \l{QFont::}{setFeature()} for more details on font features.

See also

QFont::Tag, setFeature(), unsetFeature(), featureTags(), isFeatureSet()

Definition at line 2646 of file qfont.cpp.

fixedPitch()

bool QFont::fixedPitch

(

)

const

Returns true if fixed pitch has been set; otherwise returns false.

See also

setFixedPitch(), QFontInfo::fixedPitch()

Definition at line 1329 of file qfont.cpp.

fromString()

bool QFont::fromString

(

const QString &

descrip

)

Sets this font to match the description descrip.

The description is a comma-separated list of the font attributes, as returned by toString().

See also

toString()

Definition at line 2205 of file qfont.cpp.

hintingPreference()

QFont::HintingPreference QFont::hintingPreference

(

)

const

Since

4.8

Returns the currently preferred hinting level for glyphs rendered with this font.

Definition at line 972 of file qfont.cpp.

initialize()

void QFont::initialize ( )

static

Internal function that initializes the font system. The font cache and font dict do not alloc the keys. The key is a QString which is shared between QFontPrivate and QXFontName.

Definition at line 2265 of file qfont.cpp.

insertSubstitution()

void QFont::insertSubstitution ( const QString & familyName, const QString & substituteName )

static

Inserts substituteName into the substitution table for the family familyName.

After substituting a font, trigger the updating of the font by destroying and re-creating all QFont objects.

See also

insertSubstitutions(), removeSubstitutions(), substitutions(), substitute(), substitutes()

Definition at line 1990 of file qfont.cpp.

insertSubstitutions()

void QFont::insertSubstitutions ( const QString & familyName, const QStringList & substituteNames )

static

Inserts the list of families substituteNames into the substitution list for familyName.

After substituting a font, trigger the updating of the font by destroying and re-creating all QFont objects.

See also

insertSubstitution(), removeSubstitutions(), substitutions(), substitute()

Definition at line 2012 of file qfont.cpp.

isCopyOf()

bool QFont::isCopyOf

(

const QFont &

f

)

const

Returns true if this font and f are copies of each other, i.e.

one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality.

See also

operator=(), operator==()

Definition at line 1899 of file qfont.cpp.

isFeatureSet()

bool QFont::isFeatureSet

(

Tag

tag

)

const

Since

6.7

Returns true if a value for the feature given by tag has been set on the QFont, otherwise returns false.

See \l{QFont::}{setFeature()} for more details on font features.

See also

QFont::Tag, setFeature(), unsetFeature(), featureTags(), featureValue()

Definition at line 2661 of file qfont.cpp.

isVariableAxisSet()

bool QFont::isVariableAxisSet

(

Tag

tag

)

const

Since

6.7

Returns true if a value for the variable axis given by tag has been set on the QFont, otherwise returns false.

See \l{QFont::}{setVariableAxis()} for more details on font variable axes.

See also

QFont::Tag, setVariableAxis(), unsetVariableAxis(), variableAxisValue(), clearVariableAxes()

Definition at line 2529 of file qfont.cpp.

italic()

bool QFont::italic ( ) const

inline

Returns true if the style() of the font is not QFont::StyleNormal.

See also

setItalic(), style()

Definition at line 377 of file qfont.h.

kerning()

bool QFont::kerning

(

)

const

Returns true if kerning should be used when drawing text with this font.

See also

setKerning()

Definition at line 1357 of file qfont.cpp.

key()

QString QFont::key

(

)

const

Returns the font's key, a textual representation of a font.

It is typically used as the key for a cache or dictionary of fonts.

See also

QMap

Definition at line 2127 of file qfont.cpp.

letterSpacing()

qreal QFont::letterSpacing

(

)

const

Since

4.4 Returns the letter spacing for the font.

See also

setLetterSpacing(), letterSpacingType(), setWordSpacing()

Definition at line 1636 of file qfont.cpp.

letterSpacingType()

QFont::SpacingType QFont::letterSpacingType

(

)

const

Since

4.4 Returns the spacing type used for letter spacing.

See also

letterSpacing(), setLetterSpacing(), setWordSpacing()

Definition at line 1675 of file qfont.cpp.

operator QVariant()

QFont::operator QVariant

(

)

const

Returns the font as a QVariant.

Definition at line 1887 of file qfont.cpp.

operator!=()

bool QFont::operator!=

(

const QFont &

f

)

const

Returns true if this font is different from f; otherwise returns false.

Two QFonts are considered to be different if their font attributes are different.

See also

operator==()

Definition at line 1879 of file qfont.cpp.

operator<()

bool QFont::operator<

(

const QFont &

f

)

const

Provides an arbitrary comparison of this font and font f.

All that is guaranteed is that the operator returns false if both fonts are equal and that (f1 < f2) == !(f2 < f1) if the fonts are not equal.

This function is useful in some circumstances, for example if you want to use QFont objects as keys in a QMap.

See also

operator==(), operator!=(), isCopyOf()

Definition at line 1814 of file qfont.cpp.

operator=()

QFont & QFont::operator=

(

const QFont &

font

)

Move-assigns other to this QFont instance.

Assigns font to this font and returns a reference to it.

Since

5.2

Definition at line 796 of file qfont.cpp.

operator==()

bool QFont::operator==

(

const QFont &

f

)

const

Returns true if this font is equal to f; otherwise returns false.

Two QFonts are considered equal if their font attributes are equal.

See also

operator!=(), isCopyOf()

Definition at line 1785 of file qfont.cpp.

overline()

bool QFont::overline

(

)

const

Returns true if overline has been set; otherwise returns false.

See also

setOverline()

Definition at line 1276 of file qfont.cpp.

pixelSize()

int QFont::pixelSize

(

)

const

Returns the pixel size of the font if it was set with setPixelSize().

Returns -1 if the size was set with setPointSize() or setPointSizeF().

See also

setPixelSize(), pointSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()

Definition at line 1072 of file qfont.cpp.

pointSize()

int QFont::pointSize

(

)

const

Returns the point size of the font.

Returns -1 if the font size was specified in pixels.

See also

setPointSize(), pointSizeF()

Definition at line 882 of file qfont.cpp.

pointSizeF()

qreal QFont::pointSizeF

(

)

const

Returns the point size of the font.

Returns -1 if the font size was specified in pixels.

See also

pointSize(), setPointSizeF(), pixelSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()

Definition at line 1032 of file qfont.cpp.

removeSubstitutions()

void QFont::removeSubstitutions ( const QString & familyName )

static

Removes all the substitutions for familyName.

See also

insertSubstitutions(), insertSubstitution(), substitutions(), substitute()

Since

5.0

Definition at line 2031 of file qfont.cpp.

resolve()

QFont QFont::resolve

(

const QFont &

other

)

const

Returns a new QFont that has attributes copied from other that have not been previously set on this font.

Definition at line 1908 of file qfont.cpp.

resolveMask()

uint QFont::resolveMask ( ) const

inline

Definition at line 313 of file qfont.h.

setBold()

void QFont::setBold ( bool enable )

inline

If enable is true sets the font's weight to \l{Weight}{QFont::Bold}; otherwise sets the weight to \l{Weight}{QFont::Normal}.

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.

See also

bold(), setWeight()

Definition at line 374 of file qfont.h.

setCapitalization()

void QFont::setCapitalization

(

Capitalization

caps

)

Since

4.4 Sets the capitalization of the text in this font to caps.

A font's capitalization makes the text appear in the selected capitalization mode.

See also

capitalization()

Definition at line 1740 of file qfont.cpp.

setFamilies()

void QFont::setFamilies

(

const QStringList &

families

)

Since

5.13

Sets the list of family names for the font. The names are case insensitive and may include a foundry name. The first family in families will be set as the main family for the font.

Each family name entry in families may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the \l{QFont}{font matching} algorithm.

See also

family(), families(), setFamily(), setStyleHint(), QFontInfo

Definition at line 2736 of file qfont.cpp.

setFamily()

void QFont::setFamily

(

const QString &

family

)

Sets the family name of the font.

The name is case insensitive and may include a foundry name.

The family name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the \l{QFont}{font matching} algorithm.

See also

family(), setStyleHint(), setFamilies(), families(), QFontInfo

Definition at line 833 of file qfont.cpp.

setFeature()

void QFont::setFeature	(	Tag	tag,
		quint32	value )

Since

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

Applies an integer value to the typographical feature specified by tag when shaping the text. This provides advanced access to the font shaping process, and can be used to support font features that are otherwise not covered in the API.

The feature is specified by a \l{QFont::Tag}{tag}, which is typically encoded from the four-character feature name in the font feature map.

This integer value passed along with the tag in most cases represents a boolean value: A zero value means the feature is disabled, and a non-zero value means it is enabled. For certain font features, however, it may have other interpretations. For example, when applied to the salt feature, the value is an index that specifies the stylistic alternative to use.

For example, the frac font feature will convert diagonal fractions separated with a slash (such as 1/2) with a different representation. Typically this will involve baking the full fraction into a single character width (such as ½).

If a font supports the frac feature, then it can be enabled in the shaper by setting {features["frac"] = 1} in the font feature map.

Note

By default, Qt will enable and disable certain font features based on other font properties. In particular, the kern feature will be enabled/disabled depending on the \l kerning() property of the QFont. In addition, all ligature features (liga, clig, dlig, hlig) will be disabled if a \l letterSpacing() is applied, but only for writing systems where the use of ligature is cosmetic. For writing systems where ligatures are required, the features will remain in their default state. The values set using setFeature() and related functions will override the default behavior. If, for instance, the feature "kern" is set to 1, then kerning will always be enabled, regardless of whether the kerning property is set to false. Similarly, if it is set to 0, then it will always be disabled. To reset a font feature to its default behavior, you can unset it using unsetFeature().

See also

QFont::Tag, clearFeatures(), setFeature(), unsetFeature(), featureTags()

Definition at line 2589 of file qfont.cpp.

setFixedPitch()

void QFont::setFixedPitch

(

bool

enable

)

If enable is true, sets fixed pitch on; otherwise sets fixed pitch off.

See also

fixedPitch(), QFontInfo

Definition at line 1340 of file qfont.cpp.

setHintingPreference()

void QFont::setHintingPreference

(

HintingPreference

hintingPreference

)

Since

4.8

Set the preference for the hinting level of the glyphs to hintingPreference. This is a hint to the underlying font rendering system to use a certain level of hinting, and has varying support across platforms. See the table in the documentation for QFont::HintingPreference for more details.

The default hinting preference is QFont::PreferDefaultHinting.

Definition at line 955 of file qfont.cpp.

setItalic()

void QFont::setItalic ( bool enable )

inline

Sets the style() of the font to QFont::StyleItalic if 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.

See also

italic(), QFontInfo

Definition at line 382 of file qfont.h.

setKerning()

void QFont::setKerning

(

bool

enable

)

Enables kerning for this font if enable is true; otherwise disables it.

By default, kerning is enabled.

When kerning is enabled, glyph metrics do not add up anymore, even for Latin text. In other words, the assumption that width('a') + width('b') is equal to width("ab") is not necessarily true.

See also

kerning(), QFontMetrics

Definition at line 1373 of file qfont.cpp.

setLetterSpacing()

void QFont::setLetterSpacing	(	SpacingType	type,
		qreal	spacing )

Since

4.4 Sets the letter spacing for the font to spacing and the type of spacing to type.

Letter spacing changes the default spacing between individual letters in the font. The spacing between the letters can be made smaller as well as larger either in percentage of the character width or in pixels, depending on the selected spacing type.

See also

letterSpacing(), letterSpacingType(), setWordSpacing()

Definition at line 1653 of file qfont.cpp.

setOverline()

void QFont::setOverline

(

bool

enable

)

If enable is true, sets overline on; otherwise sets overline off.

See also

overline(), QFontInfo

Definition at line 1286 of file qfont.cpp.

setPixelSize()

void QFont::setPixelSize

(

int

pixelSize

)

Sets the font size to pixelSize pixels, with a maxiumum size of an unsigned 16-bit integer.

Using this function makes the font device dependent. Use setPointSize() or setPointSizeF() to set the size of the font in a device independent manner.

See also

pixelSize()

Definition at line 1047 of file qfont.cpp.

setPointSize()

void QFont::setPointSize

(

int

pointSize

)

Sets the point size to pointSize.

The point size must be greater than zero.

See also

pointSize(), setPointSizeF()

Definition at line 983 of file qfont.cpp.

setPointSizeF()

void QFont::setPointSizeF

(

qreal

pointSize

)

Sets the point size to pointSize.

The point size must be greater than zero. The requested precision may not be achieved on all platforms.

See also

pointSizeF(), setPointSize(), setPixelSize()

Definition at line 1008 of file qfont.cpp.

setResolveMask()

void QFont::setResolveMask ( uint mask )

inline

Definition at line 314 of file qfont.h.

setStretch()

void QFont::setStretch

(

int

factor

)

Sets the stretch factor for the font.

The stretch factor matches a condensed or expanded version of the font or applies a stretch transform that changes the width of all characters in the font by factor percent. For example, setting factor to 150 results in all characters in the font being 1.5 times (ie. 150%) wider. The minimum stretch factor is 1, and the maximum stretch factor is 4000. The default stretch factor is AnyStretch, which will accept any stretch factor and not apply any transform on the font.

The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts.

Note

When matching a font with a native non-default stretch factor, requesting a stretch of 100 will stretch it back to a medium width font.

See also

stretch(), QFont::Stretch

Definition at line 1603 of file qfont.cpp.

setStrikeOut()

void QFont::setStrikeOut

(

bool

enable

)

If enable is true, sets strikeout on; otherwise sets strikeout off.

See also

strikeOut(), QFontInfo

Definition at line 1313 of file qfont.cpp.

setStyle()

void QFont::setStyle

(

Style

style

)

Sets the style of the font to style.

See also

italic(), QFontInfo

Definition at line 1114 of file qfont.cpp.

setStyleHint()

void QFont::setStyleHint	(	StyleHint	hint,
		StyleStrategy	strategy = PreferDefault )

Sets the style hint and strategy to hint and strategy, respectively.

If these aren't set explicitly the style hint will default to AnyStyle and the style strategy to PreferDefault.

Qt does not support style hints on X11 since this information is not provided by the window system.

See also

StyleHint, styleHint(), StyleStrategy, styleStrategy(), QFontInfo

Definition at line 1520 of file qfont.cpp.

setStyleName()

void QFont::setStyleName

(

const QString &

styleName

)

Since

4.8

Sets the style name of the font to styleName. When set, other style properties 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

See also

styleName()

Definition at line 865 of file qfont.cpp.

setStyleStrategy()

void QFont::setStyleStrategy

(

StyleStrategy

s

)

Sets the style strategy for the font to s.

See also

QFont::StyleStrategy

Definition at line 1541 of file qfont.cpp.

setUnderline()

void QFont::setUnderline

(

bool

enable

)

If enable is true, sets underline on; otherwise sets underline off.

See also

underline(), QFontInfo

Definition at line 1260 of file qfont.cpp.

setVariableAxis()

void QFont::setVariableAxis	(	Tag	tag,
		float	value )

Since

6.7

Applies a value to the variable axis corresponding to tag.

Variable fonts provide a way to store multiple variations (with different weights, widths or styles) in the same font file. The variations are given as floating point values for a pre-defined set of parameters, called "variable axes". Specific instances are typically given names by the font designer, and, in Qt, these can be selected using setStyleName() just like traditional sub-families.

In some cases, it is also useful to provide arbitrary values for the different axes. For instance, if a font has a Regular and Bold sub-family, you may want a weight in-between these. You could then manually request this by supplying a custom value for the "wght" axis in the font.

QFont font;
font.setVariableAxis("wght", (QFont::Normal + QFont::Bold) / 2.0f);

If the "wght" axis is supported by the font and the given value is within its defined range, a font corresponding to the weight 550.0 will be provided.

There are a few standard axes than many fonts provide, such as "wght" (weight), "wdth" (width), "ital" (italic) and "opsz" (optical size). They each have indivdual ranges defined in the font itself. For instance, "wght" may span from 100 to 900 (QFont::Thin to QFont::Black) whereas "ital" can span from 0 to 1 (from not italic to fully italic).

A font may also choose to define custom axes; the only limitation is that the name has to meet the requirements for a QFont::Tag (sequence of four latin-1 characters.)

By default, no variable axes are set.

Note

On Windows, variable axes are not supported if the optional GDI font backend is in use.

See also

unsetVariableAxis

Definition at line 2457 of file qfont.cpp.

setWeight()

void QFont::setWeight

(

QFont::Weight

weight

)

Sets the weight of the font to weight, using the scale defined by \l QFont::Weight enumeration.

Note

If styleName() is set, this value may be ignored for font selection.

See also

weight(), QFontInfo

Definition at line 1203 of file qfont.cpp.

setWordSpacing()

void QFont::setWordSpacing

(

qreal

spacing

)

Since

4.4 Sets the word spacing for the font to spacing.

Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.

Word spacing will not apply to writing systems, where indiviaul words are not separated by white space.

See also

wordSpacing(), setLetterSpacing()

Definition at line 1705 of file qfont.cpp.

stretch()

int QFont::stretch

(

)

const

Returns the stretch factor for the font.

See also

setStretch()

Definition at line 1579 of file qfont.cpp.

strikeOut()

bool QFont::strikeOut

(

)

const

Returns true if strikeout has been set; otherwise returns false.

See also

setStrikeOut()

Definition at line 1302 of file qfont.cpp.

style()

QFont::Style QFont::style

(

)

const

Returns the style of the font.

See also

setStyle()

Definition at line 1103 of file qfont.cpp.

styleHint()

QFont::StyleHint QFont::styleHint

(

)

const

Returns the StyleHint.

The style hint affects the \l{QFont#fontmatching}{font matching algorithm}. See \l QFont::StyleHint for the list of available hints.

See also

setStyleHint(), QFont::StyleStrategy, QFontInfo::styleHint()

Definition at line 1405 of file qfont.cpp.

styleName()

QString QFont::styleName

(

)

const

Since

4.8

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).

See also

setFamily(), setStyle()

Definition at line 847 of file qfont.cpp.

styleStrategy()

QFont::StyleStrategy QFont::styleStrategy

(

)

const

Returns the StyleStrategy.

The style strategy affects the \l{QFont}{font matching} algorithm. See \l QFont::StyleStrategy for the list of available strategies.

See also

setStyleHint(), QFont::StyleHint

Definition at line 1392 of file qfont.cpp.

substitute()

QString QFont::substitute ( const QString & familyName )

static

Returns the first family name to be used whenever familyName is specified.

The lookup is case insensitive.

If there is no substitution for familyName, familyName is returned.

To obtain a list of substitutions use substitutes().

See also

setFamily(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()

Definition at line 1952 of file qfont.cpp.

substitutes()

QStringList QFont::substitutes ( const QString & familyName )

static

Returns a list of family names to be used whenever familyName is specified.

The lookup is case insensitive.

If there is no substitution for familyName, an empty list is returned.

See also

substitute(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()

Definition at line 1973 of file qfont.cpp.

substitutions()

QStringList QFont::substitutions ( )

static

Returns a sorted list of substituted family names.

See also

insertSubstitution(), removeSubstitutions(), substitute()

Definition at line 2043 of file qfont.cpp.

swap()

void QFont::swap ( QFont & other )

inlinenoexcept

Since

5.0 \memberswap{font instance}

Definition at line 147 of file qfont.h.

toString()

QString QFont::toString

(

)

const

Returns a description of the font.

The description is a comma-separated list of the attributes, perfectly suited for use in QSettings, and consists of the following:

\list

• Font family
• Point size
• Pixel size
• Style hint
• Font weight
• Font style
• Underline
• Strike out
• Fixed pitch
• Always {0}
• Capitalization
• Letter spacing
• Word spacing
• Stretch
• Style strategy
• Font style (omitted when unavailable) \endlist

See also

fromString()

Definition at line 2158 of file qfont.cpp.

underline()

bool QFont::underline

(

)

const

Returns true if underline has been set; otherwise returns false.

See also

setUnderline()

Definition at line 1249 of file qfont.cpp.

unsetFeature()

void QFont::unsetFeature

(

Tag

tag

)

Since

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

Unsets the tag from the map of explicitly enabled/disabled features.

Note

Even if the feature has not previously been added, this will mark the font features map as modified in this QFont, so that it will take precedence when resolving against other fonts.

Unsetting an existing feature on the QFont reverts behavior to the default.

See \l setFeature() for more details on font features.

See also

QFont::Tag, clearFeatures(), setFeature(), featureTags(), featureValue()

Definition at line 2613 of file qfont.cpp.

unsetVariableAxis()

void QFont::unsetVariableAxis

(

Tag

tag

)

Since

6.7

Unsets a previously set variable axis value given by tag.

Note

If no value has previously been given for this tag, the QFont will still consider its variable axes as set when resolving against other QFont values.

See also

setVariableAxis

Definition at line 2480 of file qfont.cpp.

variableAxisTags()

QList< QFont::Tag > QFont::variableAxisTags

(

)

const

Since

6.7

Returns a list of tags for all variable axes currently set on this QFont.

See \l{QFont::}{setVariableAxis()} for more details on variable axes.

See also

QFont::Tag, setVariableAxis(), unsetVariableAxis(), isVariableAxisSet(), clearVariableAxes()

Definition at line 2499 of file qfont.cpp.

variableAxisValue()

float QFont::variableAxisValue

(

Tag

tag

)

const

Since

6.7

Returns the value set for a specific variable axis tag. If the tag has not been set, 0.0 will be returned instead.

See \l{QFont::}{setVariableAxis()} for more details on variable axes.

See also

QFont::Tag, setVariableAxis(), unsetVariableAxis(), isVariableAxisSet(), clearVariableAxes()

Definition at line 2514 of file qfont.cpp.

weight()

QFont::Weight QFont::weight

(

)

const

Returns the weight of the font, using the same scale as the \l{QFont::Weight} enumeration.

See also

setWeight(), Weight, QFontInfo

Definition at line 1131 of file qfont.cpp.

wordSpacing()

qreal QFont::wordSpacing

(

)

const

Since

4.4 Returns the word spacing for the font.

See also

setWordSpacing(), setLetterSpacing()

Definition at line 1686 of file qfont.cpp.

Friends And Related Symbol Documentation

operator<< [1/2]

QDataStream & operator<< ( QDataStream & s, const QFont & font )

friend

Writes the font font to the data stream s.

(toString() writes to a text stream.)

See also

{Serializing Qt Data Types}{Format of the QDataStream operators}

Definition at line 2759 of file qfont.cpp.

operator<< [2/2]

Q_GUI_EXPORT QDebug operator<< ( QDebug stream, const QFont & font )

friend

Definition at line 3749 of file qfont.cpp.

operator>>

QDataStream & operator>> ( QDataStream & s, QFont & font )

friend

Reads the font font from the data stream s.

(fromString() reads from a text stream.)

See also

{Serializing Qt Data Types}{Format of the QDataStream operators}

Definition at line 2836 of file qfont.cpp.

QAlphaPaintEngine

friend class QAlphaPaintEngine

friend

Definition at line 344 of file qfont.h.

QApplication

friend class QApplication

friend

Definition at line 334 of file qfont.h.

QCommandLinkButtonPrivate

friend class QCommandLinkButtonPrivate

friend

Definition at line 350 of file qfont.h.

QFontDialogPrivate

friend class QFontDialogPrivate

friend

Definition at line 328 of file qfont.h.

QFontEngine

friend class QFontEngine

friend

Definition at line 351 of file qfont.h.

QFontInfo

friend class QFontInfo

friend

Definition at line 331 of file qfont.h.

QFontMetrics

friend class QFontMetrics

friend

Definition at line 329 of file qfont.h.

QFontMetricsF

friend class QFontMetricsF

friend

Definition at line 330 of file qfont.h.

QFontPrivate

friend class QFontPrivate

friend

Definition at line 327 of file qfont.h.

qHash()

size_t qHash ( const QFont & font, size_t seed )

related

Returns the hash value for font.

If specified, seed is used to initialize the hash.

Since

5.3

Definition at line 2192 of file qfont.cpp.

QOpenGLContext

friend class QOpenGLContext

friend

Definition at line 342 of file qfont.h.

QPaintBufferEngine

friend class QPaintBufferEngine

friend

Definition at line 349 of file qfont.h.

QPainter

friend class QPainter

friend

Definition at line 332 of file qfont.h.

QPainterPath

friend class QPainterPath

friend

Definition at line 345 of file qfont.h.

QPainterPrivate

friend class QPainterPrivate

friend

Definition at line 333 of file qfont.h.

QPainterReplayer

friend class QPainterReplayer

friend

Definition at line 348 of file qfont.h.

QPicturePaintEngine

friend class QPicturePaintEngine

friend

Definition at line 347 of file qfont.h.

QScriptLine

friend struct QScriptLine

friend

Definition at line 341 of file qfont.h.

QStackTextEngine

friend class QStackTextEngine

friend

Definition at line 339 of file qfont.h.

QTextEngine

friend class QTextEngine

friend

Definition at line 338 of file qfont.h.

QTextItemInt

friend class QTextItemInt

friend

Definition at line 346 of file qfont.h.

QTextLayout

friend class QTextLayout

friend

Definition at line 337 of file qfont.h.

QTextLine

friend class QTextLine

friend

Definition at line 340 of file qfont.h.

QWidget

friend class QWidget

friend

Definition at line 335 of file qfont.h.

QWidgetPrivate

friend class QWidgetPrivate

friend

Definition at line 336 of file qfont.h.

QWin32PaintEngine

friend class QWin32PaintEngine

friend

Definition at line 343 of file qfont.h.

---

The documentation for this class was generated from the following files:

• qtbase/src/gui/text/qfont.h (1bc78f7739ca4319323de5e7e07f88ef5cbd52bc)
• qtbase/src/gui/text/qfont.cpp (5627e113793df3df24742d7af502a075c2c9e95d)