PySide6.QtGui.QFontDatabase¶

class QFontDatabase¶

The QFontDatabase class provides information about the fonts available in the underlying window system. More…

Synopsis¶

Methods¶

def __init__()

Static functions¶

def addApplicationFont()
def addApplicationFontFromData()
def applicationFontFamilies()
def bold()
def families()
def font()
def hasFamily()
def isBitmapScalable()
def isFixedPitch()
def isPrivateFamily()
def isScalable()
def isSmoothlyScalable()
def italic()
def pointSizes()
def removeAllApplicationFonts()
def removeApplicationFont()
def smoothSizes()
def standardSizes()
def styleString()
def styles()
def systemFont()
def weight()
def writingSystemName()
def writingSystemSample()
def writingSystems()

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.

The most common uses of this class are to query the database for the list of font families() and for the pointSizes() and styles() that are available for each family. An alternative to pointSizes() is smoothSizes() which returns the sizes at which a given family and style will look attractive.

If the font family is available from two or more foundries the foundry name is included in the family name; for example: “Helvetica [Adobe]” and “Helvetica [Cronyx]”. When you specify a family, you can either use the old hyphenated “foundry-family” format or the bracketed “family [foundry]” format; for example: “Cronyx-Helvetica” or “Helvetica [Cronyx]”. If the family has a foundry it is always returned using the bracketed format, as is the case with the value returned by families() .

The font() function returns a QFont given a family, style and point size.

A family and style combination can be checked to see if it is italic() or bold() , and to retrieve its weight() . Similarly we can call isBitmapScalable() , isSmoothlyScalable() , isScalable() and isFixedPitch() .

Use the styleString() to obtain a text version of a style.

The QFontDatabase class provides some helper functions, for example, standardSizes() . You can retrieve the description of a writing system using writingSystemName() , and a sample of characters in a writing system with writingSystemSample() .

Example:

fontTree = QTreeWidget()
fontTree.setColumnCount(2)
fontTree.setHeaderLabels(QStringList() << "Font" << "Smooth Sizes")
fontFamilies = QFontDatabase.families()
for family in fontFamilies:
    familyItem = QTreeWidgetItem(fontTree)
    familyItem.setText(0, family)
    fontStyles = QFontDatabase.styles(family)
    for style in fontStyles:
        styleItem = QTreeWidgetItem(familyItem)
        styleItem.setText(0, style)
        sizes = QString()
        smoothSizes = QFontDatabase.smoothSizes(family, style)
        for points in smoothSizes:
            sizes += QString.number(points) + ' '
        styleItem.setText(1, sizes.trimmed())

This example gets the list of font families, the list of styles for each family, and the point sizes that are available for each combination of family and style, displaying this information in a tree view.

See also

QFont QFontInfo QFontMetrics

class WritingSystem¶

Constant	Description
QFontDatabase.Any
QFontDatabase.Latin
QFontDatabase.Greek
QFontDatabase.Cyrillic
QFontDatabase.Armenian
QFontDatabase.Hebrew
QFontDatabase.Arabic
QFontDatabase.Syriac
QFontDatabase.Thaana
QFontDatabase.Devanagari
QFontDatabase.Bengali
QFontDatabase.Gurmukhi
QFontDatabase.Gujarati
QFontDatabase.Oriya
QFontDatabase.Tamil
QFontDatabase.Telugu
QFontDatabase.Kannada
QFontDatabase.Malayalam
QFontDatabase.Sinhala
QFontDatabase.Thai
QFontDatabase.Lao
QFontDatabase.Tibetan
QFontDatabase.Myanmar
QFontDatabase.Georgian
QFontDatabase.Khmer
QFontDatabase.SimplifiedChinese
QFontDatabase.TraditionalChinese
QFontDatabase.Japanese
QFontDatabase.Korean
QFontDatabase.Vietnamese
QFontDatabase.Symbol
QFontDatabase.Other	(the same as Symbol)
QFontDatabase.Ogham
QFontDatabase.Runic
QFontDatabase.Nko

class SystemFont¶

Constant	Description
QFontDatabase.GeneralFont	The default system font.
QFontDatabase.FixedFont	The fixed font that the system recommends.
QFontDatabase.TitleFont	The system standard font for titles.
QFontDatabase.SmallestReadableFont	The smallest readable system font.

__init__()¶: Note

This function is deprecated.

Call the class methods as static functions instead.

Creates a font database object.

static addApplicationFont(fileName)¶

Parameters:: fileName – str
Return type:: int

Loads the font from the file specified by fileName and makes it available to the application. An ID is returned that can be used to remove the font again with removeApplicationFont() or to retrieve the list of family names contained in the font.

The function returns -1 if the font could not be loaded.

Currently only TrueType fonts, TrueType font collections, and OpenType fonts are supported.

See also

addApplicationFontFromData() applicationFontFamilies() removeApplicationFont()

static addApplicationFontFromData(fontData)¶

Parameters:: fontData – QByteArray
Return type:: int

Loads the font from binary data specified by fontData and makes it available to the application. An ID is returned that can be used to remove the font again with removeApplicationFont() or to retrieve the list of family names contained in the font.

The function returns -1 if the font could not be loaded.

Currently only TrueType fonts, TrueType font collections, and OpenType fonts are supported.

See also

addApplicationFont() applicationFontFamilies() removeApplicationFont()

static applicationFontFamilies(id)¶

Parameters:: id – int
Return type:: list of strings

Returns a list of font families for the given application font identified by id.

See also

addApplicationFont() addApplicationFontFromData()

static bold(family, style)¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is bold; otherwise returns false.

See also

italic() weight()

static families([writingSystem=QFontDatabase.WritingSystem.Any])¶

Parameters:: writingSystem – WritingSystem
Return type:: list of strings

Returns a sorted list of the available font families which support the writingSystem.

If a family exists in several foundries, the returned name for that font is in the form “family [foundry]”. Examples: “Times [Adobe]”, “Times [Cronyx]”, “Palatino”.

See also

writingSystems()

static font(family, style, pointSize)¶

Parameters:

family – str
style – str
pointSize – int

Return type:

QFont

Returns a QFont object that has family family, style style and point size pointSize. If no matching font could be created, a QFont object that uses the application’s default font is returned.

static hasFamily(family)¶

Parameters:: family – str
Return type:: bool

static isBitmapScalable(family[, style=""])¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is a scalable bitmap font; otherwise returns false. Scaling a bitmap font usually produces an unattractive hardly readable result, because the pixels of the font are scaled. If you need to scale a bitmap font it is better to scale it to one of the fixed sizes returned by smoothSizes() .

See also

isScalable() isSmoothlyScalable()

static isFixedPitch(family[, style=""])¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is fixed pitch; otherwise returns false.

static isPrivateFamily(family)¶

Parameters:: family – str
Return type:: bool

Returns true if and only if the family font family is private.

This happens, for instance, on macOS and iOS, where the system UI fonts are not accessible to the user. For completeness, families() returns all font families, including the private ones. You should use this function if you are developing a font selection control in order to keep private fonts hidden.

See also

families()

static isScalable(family[, style=""])¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is scalable; otherwise returns false.

See also

isBitmapScalable() isSmoothlyScalable()

static isSmoothlyScalable(family[, style=""])¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is smoothly scalable; otherwise returns false. If this function returns true, it’s safe to scale this font to any size, and the result will always look attractive.

See also

isScalable() isBitmapScalable()

static italic(family, style)¶

Parameters:

family – str
style – str

Return type:

bool

Returns true if the font that has family family and style style is italic; otherwise returns false.

See also

weight() bold()

static pointSizes(family[, style=""])¶

Parameters:

family – str
style – str

Return type:

.list of int

Returns a list of the point sizes available for the font that has family family and style styleName. The list may be empty.

See also

smoothSizes() standardSizes()

static removeAllApplicationFonts()¶

Return type:: bool

Removes all application-local fonts previously added using addApplicationFont() and addApplicationFontFromData() .

Returns true if unloading of the fonts succeeded; otherwise returns false.

See also

removeApplicationFont() addApplicationFont() addApplicationFontFromData()

static removeApplicationFont(id)¶

Parameters:: id – int
Return type:: bool

Removes the previously loaded application font identified by id. Returns true if unloading of the font succeeded; otherwise returns false.

See also

removeAllApplicationFonts() addApplicationFont() addApplicationFontFromData()

static smoothSizes(family, style)¶

Parameters:

family – str
style – str

Return type:

.list of int

Returns the point sizes of a font that has family family and style styleName that will look attractive. The list may be empty. For non-scalable fonts and bitmap scalable fonts, this function is equivalent to pointSizes() .

See also

pointSizes() standardSizes()

static standardSizes()¶

Return type:: .list of int

Returns a list of standard font sizes.

See also

smoothSizes() pointSizes()

static styleString(font)¶

Parameters:: font – QFont
Return type:: str

Returns a string that describes the style of the font. For example, “Bold Italic”, “Bold”, “Italic” or “Normal”. An empty string may be returned.

static styleString(fontInfo)

Parameters:: fontInfo – QFontInfo
Return type:: str

Returns a string that describes the style of the fontInfo. For example, “Bold Italic”, “Bold”, “Italic” or “Normal”. An empty string may be returned.

static styles(family)¶

Parameters:: family – str
Return type:: list of strings

Returns a list of the styles available for the font family family. Some example styles: “Light”, “Light Italic”, “Bold”, “Oblique”, “Demi”. The list may be empty.

See also

families()

static systemFont(type)¶

Parameters:: type – SystemFont
Return type:: QFont

Returns the most adequate font for a given type case for proper integration with the system’s look and feel.

See also

font()

static weight(family, style)¶

Parameters:

family – str
style – str

Return type:

int

Returns the weight of the font that has family family and style style. If there is no such family and style combination, returns -1.

See also

italic() bold()

static writingSystemName(writingSystem)¶

Parameters:: writingSystem – WritingSystem
Return type:: str

Returns the names the writingSystem (e.g. for displaying to the user in a dialog).

static writingSystemSample(writingSystem)¶

Parameters:: writingSystem – WritingSystem
Return type:: str

Returns a string with sample characters from writingSystem.

static writingSystems()¶

Return type:: .list of QFontDatabase.WritingSystem

Returns a sorted list of the available writing systems. This is list generated from information about all installed fonts on the system.

See also

families()

static writingSystems(family)

Parameters:: family – str
Return type:: .list of QFontDatabase.WritingSystem

Returns a sorted list of the writing systems supported by a given font family.

See also

families()