QtBase  v6.3.1
Public Types | Public Member Functions | Static Public Member Functions | Friends | Related Functions | List of all members
QFont Class Reference

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

#include <qfont.h>

Public Types

enum  StyleHint {
  Helvetica , SansSerif = Helvetica , Times , Serif = Times ,
  Courier , TypeWriter = Courier , OldEnglish , Decorative = OldEnglish ,
  System , AnyStyle , Cursive , Monospace ,
  Fantasy
}
 
enum  StyleStrategy {
  PreferDefault = 0x0001 , PreferBitmap = 0x0002 , PreferDevice = 0x0004 , PreferOutline = 0x0008 ,
  ForceOutline = 0x0010 , PreferMatch = 0x0020 , PreferQuality = 0x0040 , PreferAntialias = 0x0080 ,
  NoAntialias = 0x0100 , NoSubpixelAntialias = 0x0800 , PreferNoShaping = 0x1000 , NoFontMerging = 0x8000
}
 
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
}
 
enum  Style { StyleNormal , StyleItalic , StyleOblique }
 
enum  Stretch {
  AnyStretch = 0 , UltraCondensed = 50 , ExtraCondensed = 62 , Condensed = 75 ,
  SemiCondensed = 87 , Unstretched = 100 , SemiExpanded = 112 , Expanded = 125 ,
  ExtraExpanded = 150 , UltraExpanded = 200
}
 
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 , AllPropertiesResolved = 0x3ffff
}
 

Public Member Functions

 QFont ()
 
 QFont (const QString &family, int pointSize=-1, int weight=-1, bool italic=false)
 
 QFont (const QStringList &families, int pointSize=-1, int weight=-1, bool italic=false)
 
 QFont (const QFont &font, const QPaintDevice *pd)
 
 QFont (const QFont &font)
 
 ~QFont ()
 
void swap (QFont &other) noexcept
 
QString family () const
 
void setFamily (const QString &)
 
QStringList families () const
 
void setFamilies (const QStringList &)
 
QString styleName () const
 
void setStyleName (const QString &)
 
int pointSize () const
 
void setPointSize (int)
 
qreal pointSizeF () const
 
void setPointSizeF (qreal)
 
int pixelSize () const
 
void setPixelSize (int)
 
Weight weight () const
 
void setWeight (Weight weight)
 
bool bold () const
 
void setBold (bool)
 
void setStyle (Style style)
 
Style style () const
 
bool italic () const
 
void setItalic (bool b)
 
bool underline () const
 
void setUnderline (bool)
 
bool overline () const
 
void setOverline (bool)
 
bool strikeOut () const
 
void setStrikeOut (bool)
 
bool fixedPitch () const
 
void setFixedPitch (bool)
 
bool kerning () const
 
void setKerning (bool)
 
StyleHint styleHint () const
 
StyleStrategy styleStrategy () const
 
void setStyleHint (StyleHint, StyleStrategy=PreferDefault)
 
void setStyleStrategy (StyleStrategy s)
 
int stretch () const
 
void setStretch (int)
 
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
 
bool exactMatch () const
 
QFontoperator= (const QFont &)
 
bool operator== (const QFont &) const
 
bool operator!= (const QFont &) const
 
bool operator< (const QFont &) const
 
 operator QVariant () const
 
bool isCopyOf (const QFont &) const
 
QString key () const
 
QString toString () const
 
bool fromString (const QString &)
 
QString defaultFamily () const
 
QFont resolve (const QFont &) const
 
uint resolveMask () const
 
void setResolveMask (uint mask)
 

Static Public Member Functions

static QString substitute (const QString &)
 
static QStringList substitutes (const QString &)
 
static QStringList substitutions ()
 
static void insertSubstitution (const QString &, const QString &)
 
static void insertSubstitutions (const QString &, const QStringList &)
 
static void removeSubstitutions (const QString &)
 
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 QDataStreamoperator<< (QDataStream &, const QFont &)
 
Q_GUI_EXPORT QDataStreamoperator>> (QDataStream &, QFont &)
 
Q_GUI_EXPORT QDebug operator<< (QDebug, const QFont &)
 

Related Functions

(Note that these are not member functions.)

size_t qHash (const QFont &font, size_t seed) noexcept
 
QDataStreamoperator<< (QDataStream &s, const QFont &font)
 
QDataStreamoperator>> (QDataStream &s, QFont &font)
 

Detailed Description

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

\reentrant

\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:

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

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

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:

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

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.

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

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, {Character Map Example}

Definition at line 55 of file qfont.h.

Member Enumeration Documentation

◆ 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 130 of file qfont.h.

◆ 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
Note
Please be aware that altering the hinting preference on Windows is available through the DirectWrite font engine. This is available on Windows Vista after installing the platform update, and on Windows 7. In order to use this extension, configure Qt using -directwrite. The target application will then depend on the availability of DirectWrite on the target system.
Enumerator
PreferDefaultHinting 
PreferNoHinting 
PreferVerticalHinting 
PreferFullHinting 

Definition at line 88 of file qfont.h.

◆ ResolveProperties

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

Definition at line 145 of file qfont.h.

◆ 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 139 of file qfont.h.

◆ Stretch

Predefined stretch values that follow the CSS naming convention. The higher the value, the more stretched the text is.

\value AnyStretch 0 Accept any stretch matched using the other QFont properties (added in Qt 5.8) \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 116 of file qfont.h.

◆ 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 109 of file qfont.h.

◆ 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 59 of file qfont.h.

◆ 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 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 
NoFontMerging 

Definition at line 72 of file qfont.h.

◆ 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 96 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 689 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 716 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 759 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 625 of file qfont.cpp.

Here is the call graph for this function:

◆ QFont() [5/5]

QFont::QFont ( const QFont font)

Constructs a font that is a copy of font.

Definition at line 785 of file qfont.cpp.

◆ ~QFont()

QFont::~QFont ( )

Destroys the font object and frees all allocated resources.

Definition at line 793 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 331 of file qfont.h.

◆ cacheStatistics()

void QFont::cacheStatistics ( )
static

Definition at line 2249 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 1755 of file qfont.cpp.

Here is the caller graph for this function:

◆ cleanup()

void QFont::cleanup ( )
static

Definition at line 2240 of file qfont.cpp.

Here is the call graph for this function:

◆ defaultFamily()

QString QFont::defaultFamily ( ) const

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

See also
StyleHint, styleHint(), setStyleHint()

Definition at line 2265 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1766 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 2284 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 821 of file qfont.cpp.

Here is the caller graph for this function:

◆ fixedPitch()

bool QFont::fixedPitch ( ) const

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

See also
setFixedPitch(), QFontInfo::fixedPitch()

Definition at line 1351 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 2171 of file qfont.cpp.

Here is the call graph for this function:

◆ hintingPreference()

QFont::HintingPreference QFont::hintingPreference ( ) const
Since
4.8

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

Definition at line 995 of file qfont.cpp.

Here is the caller graph for this function:

◆ initialize()

void QFont::initialize ( )
static

Definition at line 2231 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 1956 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1978 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1865 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 338 of file qfont.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ kerning()

bool QFont::kerning ( ) const

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

See also
setKerning()

Definition at line 1379 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 2093 of file qfont.cpp.

Here is the call graph for this function:

◆ letterSpacing()

qreal QFont::letterSpacing ( ) const
Since
4.4 Returns the letter spacing for the font.
See also
setLetterSpacing(), letterSpacingType(), setWordSpacing()

Definition at line 1633 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1672 of file qfont.cpp.

Here is the caller graph for this function:

◆ operator QVariant()

QFont::operator QVariant ( ) const

Returns the font as a QVariant

Definition at line 1853 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1845 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1810 of file qfont.cpp.

◆ operator=()

QFont & QFont::operator= ( const QFont font)

Move-assigns other to this QFont instance.

Since
5.2

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

Definition at line 800 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 1782 of file qfont.cpp.

Here is the caller graph for this function:

◆ overline()

bool QFont::overline ( ) const

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

See also
setOverline()

Definition at line 1298 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1094 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 899 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1055 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1997 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1874 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ resolveMask()

uint QFont::resolveMask ( ) const
inline

Definition at line 274 of file qfont.h.

Here is the caller graph for this function:

◆ 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 335 of file qfont.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1737 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 2306 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

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

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 it's name then use setFamilies() directly. From Qt 6.2 this behavior will no longer happen and family will be passed as a single family.

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

Definition at line 844 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1362 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 978 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 343 of file qfont.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1395 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1650 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOverline()

void QFont::setOverline ( bool  enable)

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

See also
overline(), QFontInfo

Definition at line 1308 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setPixelSize()

void QFont::setPixelSize ( int  pixelSize)

Sets the font size to pixelSize pixels.

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 1069 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1006 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1031 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setResolveMask()

void QFont::setResolveMask ( uint  mask)
inline

Definition at line 275 of file qfont.h.

Here is the caller graph for this function:

◆ 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 1600 of file qfont.cpp.

Here is the caller graph for this function:

◆ setStrikeOut()

void QFont::setStrikeOut ( bool  enable)

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

See also
strikeOut(), QFontInfo

Definition at line 1335 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setStyle()

void QFont::setStyle ( Style  style)

Sets the style of the font to style.

See also
italic(), QFontInfo

Definition at line 1136 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1517 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 882 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setStyleStrategy()

void QFont::setStyleStrategy ( StyleStrategy  s)

Sets the style strategy for the font to s.

See also
QFont::StyleStrategy

Definition at line 1538 of file qfont.cpp.

Here is the caller graph for this function:

◆ setUnderline()

void QFont::setUnderline ( bool  enable)

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

See also
underline(), QFontInfo

Definition at line 1282 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1225 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 1702 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ stretch()

int QFont::stretch ( ) const

Returns the stretch factor for the font.

See also
setStretch()

Definition at line 1576 of file qfont.cpp.

Here is the caller graph for this function:

◆ strikeOut()

bool QFont::strikeOut ( ) const

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

See also
setStrikeOut()

Definition at line 1324 of file qfont.cpp.

Here is the caller graph for this function:

◆ style()

QFont::Style QFont::style ( ) const

Returns the style of the font.

See also
setStyle()

Definition at line 1125 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1427 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 864 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1414 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1918 of file qfont.cpp.

Here is the call graph for this function:

◆ 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 1939 of file qfont.cpp.

Here is the call graph for this function:

◆ substitutions()

QStringList QFont::substitutions ( )
static

Returns a sorted list of substituted family names.

See also
insertSubstitution(), removeSubstitutions(), substitute()

Definition at line 2009 of file qfont.cpp.

Here is the call graph for this function:

◆ swap()

void QFont::swap ( QFont other)
inlinenoexcept
Since
5.0

Swaps this font instance with other. This function is very fast and never fails.

Definition at line 177 of file qfont.h.

Here is the call graph for this function:

◆ 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 2124 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ underline()

bool QFont::underline ( ) const

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

See also
setUnderline()

Definition at line 1271 of file qfont.cpp.

Here is the caller graph for this function:

◆ 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 1153 of file qfont.cpp.

Here is the caller graph for this function:

◆ wordSpacing()

qreal QFont::wordSpacing ( ) const
Since
4.4 Returns the word spacing for the font.
See also
setWordSpacing(), setLetterSpacing()

Definition at line 1683 of file qfont.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/3]

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 2329 of file qfont.cpp.

◆ operator<<() [2/3]

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

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 2329 of file qfont.cpp.

◆ operator<< [3/3]

Q_GUI_EXPORT QDebug operator<< ( QDebug  ,
const QFont  
)
friend

Definition at line 3252 of file qfont.cpp.

◆ operator>> [1/2]

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 2402 of file qfont.cpp.

◆ operator>>() [2/2]

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

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 2402 of file qfont.cpp.

◆ QAlphaPaintEngine

friend class QAlphaPaintEngine
friend

Definition at line 305 of file qfont.h.

◆ QApplication

friend class QApplication
friend

Definition at line 295 of file qfont.h.

◆ QCommandLinkButtonPrivate

friend class QCommandLinkButtonPrivate
friend

Definition at line 311 of file qfont.h.

◆ QFontDialogPrivate

friend class QFontDialogPrivate
friend

Definition at line 289 of file qfont.h.

◆ QFontEngine

friend class QFontEngine
friend

Definition at line 312 of file qfont.h.

◆ QFontInfo

friend class QFontInfo
friend

Definition at line 292 of file qfont.h.

◆ QFontMetrics

friend class QFontMetrics
friend

Definition at line 290 of file qfont.h.

◆ QFontMetricsF

friend class QFontMetricsF
friend

Definition at line 291 of file qfont.h.

◆ QFontPrivate

friend class QFontPrivate
friend

Definition at line 288 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 2158 of file qfont.cpp.

◆ QOpenGLContext

friend class QOpenGLContext
friend

Definition at line 303 of file qfont.h.

◆ QPaintBufferEngine

friend class QPaintBufferEngine
friend

Definition at line 310 of file qfont.h.

◆ QPainter

friend class QPainter
friend

Definition at line 293 of file qfont.h.

◆ QPainterPath

friend class QPainterPath
friend

Definition at line 306 of file qfont.h.

◆ QPainterPrivate

friend class QPainterPrivate
friend

Definition at line 294 of file qfont.h.

◆ QPainterReplayer

friend class QPainterReplayer
friend

Definition at line 309 of file qfont.h.

◆ QPicturePaintEngine

friend class QPicturePaintEngine
friend

Definition at line 308 of file qfont.h.

◆ QScriptLine

friend struct QScriptLine
friend

Definition at line 302 of file qfont.h.

◆ QStackTextEngine

friend class QStackTextEngine
friend

Definition at line 300 of file qfont.h.

◆ QTextEngine

friend class QTextEngine
friend

Definition at line 299 of file qfont.h.

◆ QTextItemInt

friend class QTextItemInt
friend

Definition at line 307 of file qfont.h.

◆ QTextLayout

friend class QTextLayout
friend

Definition at line 298 of file qfont.h.

◆ QTextLine

friend class QTextLine
friend

Definition at line 301 of file qfont.h.

◆ QWidget

friend class QWidget
friend

Definition at line 296 of file qfont.h.

◆ QWidgetPrivate

friend class QWidgetPrivate
friend

Definition at line 297 of file qfont.h.

◆ QWin32PaintEngine

friend class QWin32PaintEngine
friend

Definition at line 304 of file qfont.h.


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