Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QWindowsDirectWriteFontDatabase Class Reference

#include <qwindowsdirectwritefontdatabase_p.h>

Inheritance diagram for QWindowsDirectWriteFontDatabase:
Collaboration diagram for QWindowsDirectWriteFontDatabase:

Public Member Functions

 QWindowsDirectWriteFontDatabase ()
 ~QWindowsDirectWriteFontDatabase () override
void populateFontDatabase () override
 This function is called once at startup by Qt's internal font database.
void populateFamily (const QString &familyName) override
 This function is called whenever a lazily populated family, populated through registerFontFamily(), needs full population.
bool populateFamilyAliases (const QString &missingFamily) override
QFontEnginefontEngine (const QFontDef &fontDef, void *handle) override
 Returns the font engine that can be used to render the font described by the font definition, fontDef, in the specified script.
QFontEnginefontEngine (const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference) override
 Returns the font engine that will be used to back a QRawFont, based on the given \fontData, pixelSize, and hintingPreference.
QStringList fallbacksForFamily (const QString &family, QFont::Style style, QFont::StyleHint styleHint, QFontDatabasePrivate::ExtendedScript script) const override
 Returns a list of alternative fonts for the specified family and style and script using the styleHint given.
QStringList addApplicationFont (const QByteArray &fontData, const QString &fileName, QFontDatabasePrivate::ApplicationFont *font=nullptr) override
 Adds an application font described by the font contained supplied fontData or using the font contained in the file referenced by fileName.
bool isPrivateFontFamily (const QString &family) const override
 Returns true if the font family is private.
bool supportsVariableApplicationFonts () const override
 Returns true if this font database supports loading named instances from variable application fonts.
void registerBitmapFont (const QString &bitmapFont)
bool hasPopulatedFont (const QString &fontFamily) const
Public Member Functions inherited from QWindowsFontDatabase
 QWindowsFontDatabase ()
 ~QWindowsFontDatabase () override
void ensureFamilyPopulated (const QString &familyName)
void populateFontDatabase () override
 This function is called once at startup by Qt's internal font database.
void invalidate () override
 This function is called whenever the font database is invalidated.
void removeApplicationFonts ()
bool supportsColrv0Fonts () const override
 Returns true if this font database supports loading color fonts in the COLRv0 format.
void populateFamily (const QString &familyName) override
 This function is called whenever a lazily populated family, populated through registerFontFamily(), needs full population.
bool populateFamilyAliases (const QString &missingFamily) override
QFontEnginefontEngine (const QFontDef &fontDef, void *handle) override
 Returns the font engine that can be used to render the font described by the font definition, fontDef, in the specified script.
QFontEnginefontEngine (const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference) override
 Returns the font engine that will be used to back a QRawFont, based on the given \fontData, pixelSize, and hintingPreference.
QStringList fallbacksForFamily (const QString &family, QFont::Style style, QFont::StyleHint styleHint, QFontDatabasePrivate::ExtendedScript script) const override
 Returns a list of alternative fonts for the specified family and style and script using the styleHint given.
QStringList addApplicationFont (const QByteArray &fontData, const QString &fileName, QFontDatabasePrivate::ApplicationFont *applicationFont=nullptr) override
 Adds an application font described by the font contained supplied fontData or using the font contained in the file referenced by fileName.
void releaseHandle (void *handle) override
 Releases the specified font handle.
QString fontDir () const override
 Returns the directory containing the fonts used by the database.
QFont defaultFont () const override
 Returns the default system font.
bool fontsAlwaysScalable () const override
 Return true if all fonts are considered scalable when using this font database.
void derefUniqueFont (const QString &uniqueFont)
void refUniqueFont (const QString &uniqueFont)
bool isPrivateFontFamily (const QString &family) const override
 Returns true if the font family is private.
Public Member Functions inherited from QWindowsFontDatabaseBase
 QWindowsFontDatabaseBase ()
 ~QWindowsFontDatabaseBase () override
QFontEnginefontEngine (const QFontDef &fontDef, void *handle) override
 Returns the font engine that can be used to render the font described by the font definition, fontDef, in the specified script.
QFontEnginefontEngine (const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference) override
 Returns the font engine that will be used to back a QRawFont, based on the given \fontData, pixelSize, and hintingPreference.
void invalidate () override
 This function is called whenever the font database is invalidated.
QFontDef sanitizeRequest (QFontDef request) const
Public Member Functions inherited from QPlatformFontDatabase
virtual ~QPlatformFontDatabase ()
virtual QFontEngineMultifontEngineMulti (QFontEngine *fontEngine, QFontDatabasePrivate::ExtendedScript script)
 Returns a multi font engine in the specified script to encapsulate fontEngine with the option to fall back to the fonts given by fallbacks if fontEngine does not support a certain character.
virtual QString resolveFontFamilyAlias (const QString &family) const
 Resolve alias to actual font family names.
virtual QList< int > standardSizes () const
 Return list of standard font sizes when using this font database.

Protected Member Functions

void invalidate () override
 This function is called whenever the font database is invalidated.

Friends

class QWindowsFontEngineDirectWrite

Additional Inherited Members

Public Types inherited from QWindowsFontDatabase
enum  FontOptions { DontUseDirectWriteFonts = 0x40 , DontUseColorFonts = 0x80 }
Static Public Member Functions inherited from QWindowsFontDatabase
static QFontEnginecreateEngine (const QFontDef &request, const QString &faceName, int dpi, const QSharedPointer< QWindowsFontEngineData > &data)
static qreal fontSmoothingGamma ()
static void setFontOptions (unsigned options)
static unsigned fontOptions ()
static void debugFormat (QDebug &d, const LOGFONT &lf)
Static Public Member Functions inherited from QWindowsFontDatabaseBase
static int defaultVerticalDPI ()
static QSharedPointer< QWindowsFontEngineDatadata ()
static QFont systemDefaultFont ()
static HFONT systemFont ()
static LOGFONT fontDefToLOGFONT (const QFontDef &fontDef, const QString &faceName)
static QFont LOGFONT_to_QFont (const LOGFONT &lf, int verticalDPI=0)
static QString familyForStyleHint (QFont::StyleHint styleHint)
static QStringList extraTryFontsForFamily (const QString &family)
static QStringList familiesForScript (QFontDatabasePrivate::ExtendedScript script)
Static Public Member Functions inherited from QPlatformFontDatabase
static QSupportedWritingSystems writingSystemsFromTrueTypeBits (quint32 unicodeRange[4], quint32 codePageRange[2])
 Helper function that determines the writing systems support by a given unicodeRange and codePageRange.
static QSupportedWritingSystems writingSystemsFromOS2Table (const char *os2Table, size_t length)
 Helper function that determines the writing system support based on the contents of the OS/2 table in the font.
static void registerFont (const QString &familyname, const QString &stylename, const QString &foundryname, QFont::Weight weight, QFont::Style style, QFont::Stretch stretch, bool antialiased, bool scalable, int pixelSize, bool fixedPitch, bool colorFont, const QSupportedWritingSystems &writingSystems, void *handle)
 Registers a font with the given set of attributes describing the font's foundry, family name, style and stretch information, pixel size, and supported writing systems.
static void registerFontFamily (const QString &familyName)
 Registers a font family with the font database.
static void registerAliasToFontFamily (const QString &familyName, const QString &alias)
 Helper function that register the alias for the familyName.
static void repopulateFontDatabase ()
 Requests that the platform font database should be repopulated.
static bool isFamilyPopulated (const QString &familyName)
 Helper function that returns true if the font family has already been registered and populated.

Detailed Description

Definition at line 34 of file qwindowsdirectwritefontdatabase_p.h.

Constructor & Destructor Documentation

◆ QWindowsDirectWriteFontDatabase()

QWindowsDirectWriteFontDatabase::QWindowsDirectWriteFontDatabase ( )

Definition at line 47 of file qwindowsdirectwritefontdatabase.cpp.

◆ ~QWindowsDirectWriteFontDatabase()

QWindowsDirectWriteFontDatabase::~QWindowsDirectWriteFontDatabase ( )
override

Definition at line 52 of file qwindowsdirectwritefontdatabase.cpp.

Member Function Documentation

◆ addApplicationFont()

QStringList QWindowsDirectWriteFontDatabase::addApplicationFont ( const QByteArray & fontData,
const QString & fileName,
QFontDatabasePrivate::ApplicationFont * applicationFont = nullptr )
overridevirtual

Adds an application font described by the font contained supplied fontData or using the font contained in the file referenced by fileName.

Returns a list of family names, or an empty list if the font could not be added.

If applicationFont is non-null, its properties list should be filled with information from the loaded fonts. This is exposed through FontLoader in Qt Quick where it is needed for disambiguating fonts in the same family. When the function exits, the applicationFont should contain an entry of properties per font in the file, or it should be empty if no font was loaded.

Note
The default implementation of this function does not add an application font. Subclasses should reimplement this function to perform the necessary loading and registration of fonts.

Reimplemented from QPlatformFontDatabase.

Definition at line 360 of file qwindowsdirectwritefontdatabase.cpp.

◆ fallbacksForFamily()

QStringList QWindowsDirectWriteFontDatabase::fallbacksForFamily ( const QString & family,
QFont::Style style,
QFont::StyleHint styleHint,
QFontDatabasePrivate::ExtendedScript script ) const
overridevirtual

Returns a list of alternative fonts for the specified family and style and script using the styleHint given.

Default implementation returns a list of fonts for which style and script support has been reported during the font database population.

Reimplemented from QPlatformFontDatabase.

Definition at line 344 of file qwindowsdirectwritefontdatabase.cpp.

◆ fontEngine() [1/2]

QFontEngine * QWindowsDirectWriteFontDatabase::fontEngine ( const QByteArray & fontData,
qreal pixelSize,
QFont::HintingPreference hintingPreference )
overridevirtual

Returns the font engine that will be used to back a QRawFont, based on the given \fontData, pixelSize, and hintingPreference.

This function is called by QRawFont, and does not play a part in the normal operations of QFontDatabase.

Reimplemented from QPlatformFontDatabase.

Definition at line 275 of file qwindowsdirectwritefontdatabase.cpp.

◆ fontEngine() [2/2]

QFontEngine * QWindowsDirectWriteFontDatabase::fontEngine ( const QFontDef & fontDef,
void * handle )
overridevirtual

Returns the font engine that can be used to render the font described by the font definition, fontDef, in the specified script.

This function is called by QFontDatabase both for system fonts provided by the platform font database, as well as for application fonts added by the application developer.

The handle is the QPlatformFontDatabase specific handle passed when registering the font family via QPlatformFontDatabase::registerFont.

The function is called for both fonts added via a filename as well as fonts added from QByteArray data. Subclasses will need to handle both cases via its platform specific handle.

Reimplemented from QPlatformFontDatabase.

Definition at line 283 of file qwindowsdirectwritefontdatabase.cpp.

◆ hasPopulatedFont()

bool QWindowsDirectWriteFontDatabase::hasPopulatedFont ( const QString & fontFamily) const
inline

Definition at line 60 of file qwindowsdirectwritefontdatabase_p.h.

◆ invalidate()

void QWindowsDirectWriteFontDatabase::invalidate ( )
overrideprotectedvirtual

This function is called whenever the font database is invalidated.

Reimplement this function to clear any internal data structures that will need to be rebuilt at the next call to populateFontDatabase().

Reimplemented from QPlatformFontDatabase.

Definition at line 749 of file qwindowsdirectwritefontdatabase.cpp.

◆ isPrivateFontFamily()

bool QWindowsDirectWriteFontDatabase::isPrivateFontFamily ( const QString & family) const
overridevirtual

Returns true if the font family is private.

For any given family name, the result is platform dependent.

Reimplemented from QPlatformFontDatabase.

Definition at line 632 of file qwindowsdirectwritefontdatabase.cpp.

◆ populateFamily()

void QWindowsDirectWriteFontDatabase::populateFamily ( const QString & familyName)
overridevirtual

This function is called whenever a lazily populated family, populated through registerFontFamily(), needs full population.

You are expected to fully populate the family by calling registerFont() for each font that matches the family name.

Reimplemented from QPlatformFontDatabase.

Definition at line 106 of file qwindowsdirectwritefontdatabase.cpp.

◆ populateFamilyAliases()

bool QWindowsDirectWriteFontDatabase::populateFamilyAliases ( const QString & missingFamily)
overridevirtual

Reimplemented from QPlatformFontDatabase.

Definition at line 269 of file qwindowsdirectwritefontdatabase.cpp.

◆ populateFontDatabase()

void QWindowsDirectWriteFontDatabase::populateFontDatabase ( )
overridevirtual

This function is called once at startup by Qt's internal font database.

Reimplement this function in a subclass for a convenient place to initialize the internal font database.

You may lazily populate the database by calling registerFontFamily() instead of registerFont(), in which case you'll get a callback to populateFamily() when the required family needs population. You then call registerFont() to finish population of the family.

The default implementation does nothing.

Reimplemented from QPlatformFontDatabase.

Definition at line 661 of file qwindowsdirectwritefontdatabase.cpp.

◆ registerBitmapFont()

void QWindowsDirectWriteFontDatabase::registerBitmapFont ( const QString & bitmapFont)
inline

Definition at line 55 of file qwindowsdirectwritefontdatabase_p.h.

◆ supportsVariableApplicationFonts()

bool QWindowsDirectWriteFontDatabase::supportsVariableApplicationFonts ( ) const
overridevirtual

Returns true if this font database supports loading named instances from variable application fonts.

Since
6.7

Reimplemented from QPlatformFontDatabase.

Definition at line 737 of file qwindowsdirectwritefontdatabase.cpp.

◆ QWindowsFontEngineDirectWrite

friend class QWindowsFontEngineDirectWrite
friend

Definition at line 69 of file qwindowsdirectwritefontdatabase_p.h.


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