QFont#
The QFont
class specifies a query for a font used for drawing text. More…
Synopsis#
Functions#
def
bold
()def
capitalization
()def
defaultFamily
()def
exactMatch
()def
families
()def
family
()def
fixedPitch
()def
fromString
(arg__1)def
hintingPreference
()def
isCopyOf
(arg__1)def
italic
()def
kerning
()def
key
()def
legacyWeight
()def
letterSpacing
()def
letterSpacingType
()def
__ne__
(arg__1)def
__lt__
(arg__1)def
__eq__
(arg__1)def
overline
()def
pixelSize
()def
pointSize
()def
pointSizeF
()def
resolve
(arg__1)def
resolveMask
()def
setBold
(arg__1)def
setCapitalization
(arg__1)def
setFamilies
(arg__1)def
setFamily
(arg__1)def
setFixedPitch
(arg__1)def
setHintingPreference
(hintingPreference)def
setItalic
(b)def
setKerning
(arg__1)def
setLegacyWeight
(legacyWeight)def
setLetterSpacing
(type, spacing)def
setOverline
(arg__1)def
setPixelSize
(arg__1)def
setPointSize
(arg__1)def
setPointSizeF
(arg__1)def
setResolveMask
(mask)def
setStretch
(arg__1)def
setStrikeOut
(arg__1)def
setStyle
(style)def
setStyleHint
(arg__1[, strategy=QFont.StyleStrategy.PreferDefault])def
setStyleName
(arg__1)def
setStyleStrategy
(s)def
setUnderline
(arg__1)def
setWeight
(weight)def
setWordSpacing
(spacing)def
stretch
()def
strikeOut
()def
style
()def
styleHint
()def
styleName
()def
styleStrategy
()def
swap
(other)def
toString
()def
underline
()def
weight
()def
wordSpacing
()
Static functions#
def
cacheStatistics
()def
cleanup
()def
initialize
()def
insertSubstitution
(arg__1, arg__2)def
insertSubstitutions
(arg__1, arg__2)def
removeSubstitutions
(arg__1)def
substitute
(arg__1)def
substitutes
(arg__1)def
substitutions
()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
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:
serifFont = QFont("Times", 10, QFont.Bold) sansFont = QFont("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 font matching algorithm
by choosing a particular StyleHint
and 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.
The font matching algorithm works as follows:
The specified font families (set by
setFamilies()
) are searched for.If not found, then if set the specified font family exists and can be used to represent the writing system in use, it will be selected.
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.
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 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:
pointSize()
(see below)
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:
f = QFont("Helvetica")
If you had both an Adobe and a Cronyx Helvetica, you might get either.
f = QFont("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.
info = QFontInfo(f1) family = info.family()
To find out font metrics use a QFontMetrics
object, e.g.
fm = QFontMetrics(f1) textWidthInPixels = fm.horizontalAdvance("How many pixels wide is self text?") textHeightInPixels = fm.height()
For more general information on fonts, see the comp.fonts FAQ . Information on encodings can be found from the UTR17 page.
See also
QFontMetrics
QFontInfo
QFontDatabase
Character Map Example
- class PySide6.QtGui.QFont#
PySide6.QtGui.QFont(font)
PySide6.QtGui.QFont(font, pd)
PySide6.QtGui.QFont(family[, pointSize=-1[, weight=-1[, italic=false]]])
PySide6.QtGui.QFont(families[, pointSize=-1[, weight=-1[, italic=false]]])
- Parameters:
families – list of strings
family – str
font –
PySide6.QtGui.QFont
weight – int
pointSize – int
italic – bool
Constructs a font object that uses the application’s default font.
See also
font()
Constructs a font that is a copy of font
.
Constructs a font from font
for use on the paint device pd
.
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 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()
font()
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 font matching
algorithm.
See also
Weight
setPointSize()
setWeight()
setItalic()
setStyleHint()
setFamilies()
font()
- PySide6.QtGui.QFont.StyleHint#
Style hints are used by the font matching
algorithm to find an appropriate default family if a selected font family is not available.
Constant
Description
QFont.AnyStyle
leaves the font matching algorithm to choose the family. This is the default.
QFont.SansSerif
the font matcher prefer sans serif fonts.
QFont.Helvetica
is a synonym for
SansSerif
.QFont.Serif
the font matcher prefers serif fonts.
QFont.Times
is a synonym for
Serif
.QFont.TypeWriter
the font matcher prefers fixed pitch fonts.
QFont.Courier
a synonym for
TypeWriter
.QFont.OldEnglish
the font matcher prefers decorative fonts.
QFont.Decorative
is a synonym for
OldEnglish
.QFont.Monospace
the font matcher prefers fonts that map to the CSS generic font-family ‘monospace’.
QFont.Fantasy
the font matcher prefers fonts that map to the CSS generic font-family ‘fantasy’.
QFont.Cursive
the font matcher prefers fonts that map to the CSS generic font-family ‘cursive’.
QFont.System
the font matcher prefers system fonts.
- PySide6.QtGui.QFont.StyleStrategy#
(inherits enum.Flag
) The style strategy tells the font matching
algorithm what type of fonts should be used to find an appropriate default family.
The following strategies are available:
Constant
Description
QFont.PreferDefault
the default style strategy. It does not prefer any type of font.
QFont.PreferBitmap
prefers bitmap fonts (as opposed to outline fonts).
QFont.PreferDevice
prefers device fonts.
QFont.PreferOutline
prefers outline fonts (as opposed to bitmap fonts).
QFont.ForceOutline
forces the use of outline fonts.
QFont.NoAntialias
don’t antialias the fonts.
QFont.NoSubpixelAntialias
avoid subpixel antialiasing on the fonts if possible.
QFont.PreferAntialias
antialias if possible.
QFont.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.
QFont.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:
Constant
Description
QFont.PreferMatch
prefer an exact match. The font matcher will try to use the exact font size that has been specified.
QFont.PreferQuality
prefer the best quality font. The font matcher will use the nearest standard point size that the font supports.
- PySide6.QtGui.QFont.HintingPreference#
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.
Constant
Description
QFont.PreferDefaultHinting
Use the default hinting level for the target platform.
QFont.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.
QFont.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.
QFont.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.
PreferDefaultHinting
PreferNoHinting
PreferVerticalHinting
PreferFullHinting
Windows and DirectWrite enabled in Qt
Full hinting
Vertical hinting
Vertical hinting
Full hinting
FreeType
Operating System setting
No hinting
Vertical hinting (light)
Full hinting
Cocoa on macOS
No hinting
No hinting
No hinting
No hinting
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.
New in version 4.8.
- PySide6.QtGui.QFont.Weight#
(inherits enum.IntEnum
) 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:
Constant
Description
QFont.Thin
100
QFont.ExtraLight
200
QFont.Light
300
QFont.Normal
400
QFont.Medium
500
QFont.DemiBold
600
QFont.Bold
700
QFont.ExtraBold
800
QFont.Black
900
- PySide6.QtGui.QFont.Style#
This enum describes the different styles of glyphs that are used to display text.
Constant
Description
QFont.StyleNormal
Normal glyphs used in unstyled text.
QFont.StyleItalic
Italic glyphs that are specifically designed for the purpose of representing italicized text.
QFont.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
- PySide6.QtGui.QFont.Stretch#
(inherits enum.IntEnum
) Predefined stretch values that follow the CSS naming convention. The higher the value, the more stretched the text is.
Constant
Description
QFont.AnyStretch
0 Accept any stretch matched using the other
QFont
properties (added in Qt 5.8)QFont.UltraCondensed
50
QFont.ExtraCondensed
62
QFont.Condensed
75
QFont.SemiCondensed
87
QFont.Unstretched
100
QFont.SemiExpanded
112
QFont.Expanded
125
QFont.ExtraExpanded
150
QFont.UltraExpanded
200
See also
- PySide6.QtGui.QFont.Capitalization#
Rendering option for text this font applies to.
Constant
Description
QFont.MixedCase
This is the normal text rendering option where no capitalization change is applied.
QFont.AllUppercase
This alters the text to be rendered in all uppercase type.
QFont.AllLowercase
This alters the text to be rendered in all lowercase type.
QFont.SmallCaps
This alters the text to be rendered in small-caps type.
QFont.Capitalize
This alters the text to be rendered with the first character of each word as an uppercase character.
- PySide6.QtGui.QFont.SpacingType#
Constant
Description
QFont.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.
QFont.AbsoluteSpacing
A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.
- PySide6.QtGui.QFont.bold()#
- Return type:
bool
Returns true
if weight()
is a value greater than Medium
; otherwise returns false
.
- static PySide6.QtGui.QFont.cacheStatistics()#
- PySide6.QtGui.QFont.capitalization()#
- Return type:
Returns the current capitalization type of the font.
See also
- static PySide6.QtGui.QFont.cleanup()#
- PySide6.QtGui.QFont.defaultFamily()#
- Return type:
str
Returns the family name that corresponds to the current style hint.
See also
StyleHint
styleHint()
setStyleHint()
- PySide6.QtGui.QFont.exactMatch()#
- Return type:
bool
Returns true
if a window system font exactly matching the settings of this font is available.
See also
- PySide6.QtGui.QFont.families()#
- Return type:
list of strings
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.
- PySide6.QtGui.QFont.family()#
- Return type:
str
Returns the requested font family name. This will always be the same as the first entry in the families()
call.
- PySide6.QtGui.QFont.fixedPitch()#
- Return type:
bool
Returns true
if fixed pitch has been set; otherwise returns false
.
See also
- PySide6.QtGui.QFont.fromString(arg__1)#
- Parameters:
arg__1 – str
- Return type:
bool
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
- PySide6.QtGui.QFont.hintingPreference()#
- Return type:
Returns the currently preferred hinting level for glyphs rendered with this font.
See also
- static PySide6.QtGui.QFont.initialize()#
- static PySide6.QtGui.QFont.insertSubstitution(arg__1, arg__2)#
- Parameters:
arg__1 – str
arg__2 – str
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.
- static PySide6.QtGui.QFont.insertSubstitutions(arg__1, arg__2)#
- Parameters:
arg__1 – str
arg__2 – list of strings
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.
- PySide6.QtGui.QFont.isCopyOf(arg__1)#
- Parameters:
arg__1 –
PySide6.QtGui.QFont
- Return type:
bool
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==()
- PySide6.QtGui.QFont.italic()#
- Return type:
bool
Returns true
if the style()
of the font is not StyleNormal
See also
- PySide6.QtGui.QFont.kerning()#
- Return type:
bool
Returns true
if kerning should be used when drawing text with this font.
See also
- PySide6.QtGui.QFont.key()#
- Return type:
str
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
- PySide6.QtGui.QFont.legacyWeight()#
- Return type:
int
Note
This function is deprecated.
Use weight()
instead.
Returns the weight of the font converted to the non-standard font weight scale used in Qt 5 and earlier versions.
Since Qt 6, the OpenType standard’s font weight scale is used instead of a non-standard scale. This requires conversion from values that use the old scale. For convenience, this function may be used when porting from code which uses the old weight scale.
See also
- PySide6.QtGui.QFont.letterSpacing()#
- Return type:
float
Returns the letter spacing for the font.
- PySide6.QtGui.QFont.letterSpacingType()#
- Return type:
Returns the spacing type used for letter spacing.
- PySide6.QtGui.QFont.__ne__(arg__1)#
- Parameters:
arg__1 –
PySide6.QtGui.QFont
- Return type:
bool
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==()
- PySide6.QtGui.QFont.__lt__(arg__1)#
- Parameters:
arg__1 –
PySide6.QtGui.QFont
- Return type:
bool
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()
- PySide6.QtGui.QFont.__eq__(arg__1)#
- Parameters:
arg__1 –
PySide6.QtGui.QFont
- Return type:
bool
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()
- PySide6.QtGui.QFont.overline()#
- Return type:
bool
Returns true
if overline has been set; otherwise returns false
.
See also
- PySide6.QtGui.QFont.pixelSize()#
- Return type:
int
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
- PySide6.QtGui.QFont.pointSize()#
- Return type:
int
Returns the point size of the font. Returns -1 if the font size was specified in pixels.
See also
- PySide6.QtGui.QFont.pointSizeF()#
- Return type:
float
Returns the point size of the font. Returns -1 if the font size was specified in pixels.
- static PySide6.QtGui.QFont.removeSubstitutions(arg__1)#
- Parameters:
arg__1 – str
Removes all the substitutions for familyName
.
- PySide6.QtGui.QFont.resolve(arg__1)#
- Parameters:
arg__1 –
PySide6.QtGui.QFont
- Return type:
Returns a new QFont
that has attributes copied from other
that have not been previously set on this font.
- PySide6.QtGui.QFont.resolveMask()#
- Return type:
uint
- PySide6.QtGui.QFont.setBold(arg__1)#
- Parameters:
arg__1 – bool
If enable
is true sets the font’s weight to Bold
; otherwise sets the weight to 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
- PySide6.QtGui.QFont.setCapitalization(arg__1)#
- Parameters:
arg__1 –
Capitalization
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
- PySide6.QtGui.QFont.setFamilies(arg__1)#
- Parameters:
arg__1 – list of strings
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 font matching
algorithm.
See also
- PySide6.QtGui.QFont.setFamily(arg__1)#
- Parameters:
arg__1 – str
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 font matching
algorithm.
- PySide6.QtGui.QFont.setFixedPitch(arg__1)#
- Parameters:
arg__1 – bool
If enable
is true, sets fixed pitch on; otherwise sets fixed pitch off.
See also
- PySide6.QtGui.QFont.setHintingPreference(hintingPreference)#
- Parameters:
hintingPreference –
HintingPreference
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 HintingPreference
for more details.
The default hinting preference is PreferDefaultHinting
.
See also
- PySide6.QtGui.QFont.setItalic(b)#
- Parameters:
b – bool
Sets the style()
of the font to StyleItalic
if enable
is true; otherwise the style is set to 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.
- PySide6.QtGui.QFont.setKerning(arg__1)#
- Parameters:
arg__1 – bool
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
- PySide6.QtGui.QFont.setLegacyWeight(legacyWeight)#
- Parameters:
legacyWeight – int
Note
This function is deprecated.
Use setWeight()
instead.
Sets the weight of the font to legacyWeight
using the legacy font weight scale of Qt 5 and previous versions.
Since Qt 6, the OpenType standard’s font weight scale is used instead of a non-standard scale. This requires conversion from values that use the old scale. For convenience, this function may be used when porting from code which uses the old weight scale.
- PySide6.QtGui.QFont.setLetterSpacing(type, spacing)#
- Parameters:
type –
SpacingType
spacing – float
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.
- PySide6.QtGui.QFont.setOverline(arg__1)#
- Parameters:
arg__1 – bool
If enable
is true, sets overline on; otherwise sets overline off.
See also
- PySide6.QtGui.QFont.setPixelSize(arg__1)#
- Parameters:
arg__1 – int
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
- PySide6.QtGui.QFont.setPointSize(arg__1)#
- Parameters:
arg__1 – int
Sets the point size to pointSize
. The point size must be greater than zero.
See also
- PySide6.QtGui.QFont.setPointSizeF(arg__1)#
- Parameters:
arg__1 – float
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
- PySide6.QtGui.QFont.setResolveMask(mask)#
- Parameters:
mask –
uint
- PySide6.QtGui.QFont.setStretch(arg__1)#
- Parameters:
arg__1 – int
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()
Stretch
- PySide6.QtGui.QFont.setStrikeOut(arg__1)#
- Parameters:
arg__1 – bool
If enable
is true, sets strikeout on; otherwise sets strikeout off.
See also
Sets the style of the font to style
.
- PySide6.QtGui.QFont.setStyleHint(arg__1[, strategy=QFont.StyleStrategy.PreferDefault])#
- Parameters:
arg__1 –
StyleHint
strategy –
StyleStrategy
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
- PySide6.QtGui.QFont.setStyleName(arg__1)#
- Parameters:
arg__1 – str
Sets the style name of the font to styleName
. When set, other style properties like style()
and 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
- PySide6.QtGui.QFont.setStyleStrategy(s)#
- Parameters:
s –
StyleStrategy
Sets the style strategy for the font to s
.
See also
styleStrategy()
StyleStrategy
- PySide6.QtGui.QFont.setUnderline(arg__1)#
- Parameters:
arg__1 – bool
If enable
is true, sets underline on; otherwise sets underline off.
See also
Sets the weight of the font to weight
, using the scale defined by Weight
enumeration.
Note
If styleName()
is set, this value may be ignored for font selection.
- PySide6.QtGui.QFont.setWordSpacing(spacing)#
- Parameters:
spacing – float
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
- PySide6.QtGui.QFont.stretch()#
- Return type:
int
Returns the stretch factor for the font.
See also
- PySide6.QtGui.QFont.strikeOut()#
- Return type:
bool
Returns true
if strikeout has been set; otherwise returns false
.
See also
Returns the style of the font.
See also
Returns the StyleHint
.
The style hint affects the font matching algorithm
. See StyleHint
for the list of available hints.
See also
setStyleHint()
StyleStrategy
styleHint()
- PySide6.QtGui.QFont.styleName()#
- Return type:
str
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
- PySide6.QtGui.QFont.styleStrategy()#
- Return type:
Returns the StyleStrategy
.
The style strategy affects the font matching
algorithm. See StyleStrategy
for the list of available strategies.
See also
setStyleStrategy()
setStyleHint()
StyleHint
- static PySide6.QtGui.QFont.substitute(arg__1)#
- Parameters:
arg__1 – str
- Return type:
str
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()
.
- static PySide6.QtGui.QFont.substitutes(arg__1)#
- Parameters:
arg__1 – str
- Return type:
list of strings
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.
- static PySide6.QtGui.QFont.substitutions()#
- Return type:
list of strings
Returns a sorted list of substituted family names.
- PySide6.QtGui.QFont.swap(other)#
- Parameters:
other –
PySide6.QtGui.QFont
Swaps this font instance with other
. This function is very fast and never fails.
- PySide6.QtGui.QFont.toString()#
- Return type:
str
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:
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)
See also
- PySide6.QtGui.QFont.underline()#
- Return type:
bool
Returns true
if underline has been set; otherwise returns false
.
See also
Returns the weight of the font, using the same scale as the Weight
enumeration.
See also
setWeight()
Weight
QFontInfo
- PySide6.QtGui.QFont.wordSpacing()#
- Return type:
float
Returns the word spacing for the font.
See also