QGIS API Documentation 3.41.0-Master (45a0abf3bec)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsFontDownloadDetails Class Reference

Encapsulates details required for downloading a font. More...

#include <qgsfontmanager.h>

Public Member Functions

 QgsFontDownloadDetails ()
 Constructor for an invalid QgsFontDownloadDetails.
 
 QgsFontDownloadDetails (const QString &family, const QStringList &fontUrls, const QString &licenseUrl=QString())
 Constructor for QgsFontDownloadDetails.
 
QString family () const
 Returns the font family.
 
QStringList fontUrls () const
 Returns a list of download URLs for all files associated with the font family.
 
bool isValid () const
 Returns true if the details represent a valid downloadable font.
 
QString licenseUrl () const
 Returns the optional URL for downloading the font license details.
 
QString standardizedFamily () const
 Returns the cleaned, standardized font family name.
 

Static Public Member Functions

static QString standardizeFamily (const QString &family)
 Returns a cleaned, standardized version of a font family name.
 

Detailed Description

Encapsulates details required for downloading a font.

Since
QGIS 3.38

Definition at line 36 of file qgsfontmanager.h.

Constructor & Destructor Documentation

◆ QgsFontDownloadDetails() [1/2]

QgsFontDownloadDetails::QgsFontDownloadDetails ( )
default

Constructor for an invalid QgsFontDownloadDetails.

◆ QgsFontDownloadDetails() [2/2]

QgsFontDownloadDetails::QgsFontDownloadDetails ( const QString &  family,
const QStringList &  fontUrls,
const QString &  licenseUrl = QString() 
)

Constructor for QgsFontDownloadDetails.

Parameters
familyFont family name
fontUrlsList of URLS to download for complete set of the font family resources
licenseUrloptional URL to download the font license

Definition at line 43 of file qgsfontmanager.cpp.

Member Function Documentation

◆ family()

QString QgsFontDownloadDetails::family ( ) const
inline

Returns the font family.

See also
standardizedFamily()

Definition at line 69 of file qgsfontmanager.h.

◆ fontUrls()

QStringList QgsFontDownloadDetails::fontUrls ( ) const
inline

Returns a list of download URLs for all files associated with the font family.

Definition at line 79 of file qgsfontmanager.h.

◆ isValid()

bool QgsFontDownloadDetails::isValid ( ) const
inline

Returns true if the details represent a valid downloadable font.

Definition at line 62 of file qgsfontmanager.h.

◆ licenseUrl()

QString QgsFontDownloadDetails::licenseUrl ( ) const
inline

Returns the optional URL for downloading the font license details.

Definition at line 84 of file qgsfontmanager.h.

◆ standardizedFamily()

QString QgsFontDownloadDetails::standardizedFamily ( ) const
inline

Returns the cleaned, standardized font family name.

Definition at line 74 of file qgsfontmanager.h.

◆ standardizeFamily()

QString QgsFontDownloadDetails::standardizeFamily ( const QString &  family)
static

Returns a cleaned, standardized version of a font family name.

Definition at line 51 of file qgsfontmanager.cpp.


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