KoFontFamily Class Reference

The KoFontFamily class Abstract representation of a Weight/Width/Slant font family, as determined by KoFFWWSConverter. More...

#include <KoFontFamily.h>

Inheritance diagram for KoFontFamily:

Classes
struct	Private

Public Member Functions
QList< KoSvgText::FontFamilyAxis >	axes () const
KoResourceSP	clone () const override
bool	colorBitmap () const
	Font has color bitmaps.
bool	colorClrV0 () const
	Font has colrv0 layers.
bool	colorClrV1 () const
	Font has colrv1 layers – doesn't yet work.
bool	colorSVG () const
	Font is SVG.
bool	isSerializable () const override
bool	isVariable () const
	Font is variable.
	KoFontFamily (const KoFontFamily &rhs)
	KoFontFamily (const QString &filename)
	KoFontFamily (KoFontFamilyWWSRepresentation representation)
QDateTime	lastModified () const
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
KoFontFamily &	operator= (const KoFontFamily &rhs)=delete
QPair< QString, QString >	resourceType () const override
QList< KoSvgText::FontFamilyStyleInfo >	styles () const
QString	translatedFontName (QStringList locales) const
	Return the translated name for a given locale...
QString	typographicFamily () const
	Returns the typographic family name, if any.
void	updateThumbnail () override
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.
	~KoFontFamily ()
Public Member Functions inherited from KoResource
bool	active () const
void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource
virtual void	clearSideLoadedResources ()
virtual QString	defaultFileExtension () const
virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const
QString	filename () const
QImage	image () const
bool	isDirty () const
virtual bool	isEphemeral () const
	KoResource ()
	KoResource (const KoResource &rhs)
	KoResource (const QString &filename)
virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const
bool	load (KisResourcesInterfaceSP resourcesInterface)
QString	md5Sum (bool generateIfEmpty=true) const
QMap< QString, QVariant >	metadata () const
	get a map with all the metadata
virtual QString	name () const
KoResource &	operator= (const KoResource &rhs)=delete
bool	permanent () const
virtual QList< int >	requiredCanvasResources () const
QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const
int	resourceId () const
bool	save ()
virtual bool	saveToDevice (QIODevice *dev) const
void	setActive (bool active)
void	setDirty (bool value)
	Mark the preset as modified but not saved.
void	setFilename (const QString &filename)
void	setImage (const QImage &image)
void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.
void	setName (const QString &name)
void	setPermanent (bool permanent)
void	setResourceId (int id)
void	setStorageLocation (const QString &location)
void	setValid (bool valid)
void	setVersion (int version)
virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const
KoResourceSignature	signature () const
QString	storageLocation () const
QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)
virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors
virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.
bool	valid () const
int	version () const
	Get the version of the resource.
virtual	~KoResource ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
QScopedPointer< Private >	d

Additional Inherited Members
Public Attributes inherited from KoResource
bool	active {true}
QString	filename
QImage	image
QString	md5sum
QMap< QString, QVariant >	metadata
bool	modified {false}
QString	name
bool	permanent {false}
int	resourceId {-1}
QString	storageLocation
bool	valid {false}
int	version {-1}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

The KoFontFamily class Abstract representation of a Weight/Width/Slant font family, as determined by KoFFWWSConverter.

Definition at line 19 of file KoFontFamily.h.

Constructor & Destructor Documentation

KoFontFamily() [1/3]

KoFontFamily::KoFontFamily ( KoFontFamilyWWSRepresentation representation )

explicit

Definition at line 93 of file KoFontFamily.cpp.

    : KoResource(representation.fontFamilyName)
    , d(new Private())
 
{
    setName(representation.fontFamilyName);
    addMetaData(TYPOGRAPHIC_NAME, representation.typographicFamilyName);
    addMetaData(LOCALIZED_FONT_FAMILY, localeHashtoVariantMap(representation.localizedFontFamilyNames));
    addMetaData(LOCALIZED_TYPOGRAPHIC_NAME, localeHashtoVariantMap(representation.localizedTypographicFamily));
    addMetaData(LOCALIZED_TYPOGRAPHIC_STYLE, localeHashtoVariantMap(representation.localizedTypographicStyles));
 
    addMetaData(LAST_MODIFIED, representation.lastModified);
 
    QMap<QString, QVariant> samples;
    Q_FOREACH(const QString key, representation.sampleStrings.keys()) {
        samples.insert(key, QVariant::fromValue(representation.sampleStrings.value(key)));
    }
    addMetaData(SAMPLE_STRING, samples);
    QList<QVariant> supportedLanguages;
    Q_FOREACH(const QLocale l, representation.supportedLanguages) {
        QString val = l.bcp47Name();
        val.replace("_", "-");
        supportedLanguages.append(QVariant::fromValue(val));
    }
    addMetaData(SUPPORTED_LANGUAGES, supportedLanguages);
 
    addMetaData(FONT_TYPE, representation.type);
    addMetaData(IS_VARIABLE, representation.isVariable);
    addMetaData(COLOR_BITMAP, representation.colorBitMap);
    addMetaData(COLOR_CLRV0, representation.colorClrV0);
    addMetaData(COLOR_CLRV1, representation.colorClrV1);
    addMetaData(COLOR_SVG, representation.colorSVG);
    QVariantHash axes;
    Q_FOREACH(const QString key, representation.axes.keys()) {
        axes.insert(key, QVariant::fromValue(representation.axes.value(key)));
    }
    addMetaData(AXES, axes);
    QVariantList styles;
    Q_FOREACH(const KoSvgText::FontFamilyStyleInfo style, representation.styles) {
        styles.append(QVariant::fromValue(style));
    }
    addMetaData(STYLES, styles);
    setMD5Sum(KoMD5Generator::generateHash(representation.fontFamilyName.toUtf8()));
    setValid(true);
}

References KoResource::addMetaData(), AXES, axes(), KoFontFamilyWWSRepresentation::axes, COLOR_BITMAP, COLOR_CLRV0, COLOR_CLRV1, COLOR_SVG, KoFontFamilyWWSRepresentation::colorBitMap, KoFontFamilyWWSRepresentation::colorClrV0, KoFontFamilyWWSRepresentation::colorClrV1, KoFontFamilyWWSRepresentation::colorSVG, FONT_TYPE, KoFontFamilyWWSRepresentation::fontFamilyName, KoMD5Generator::generateHash(), IS_VARIABLE, KoFontFamilyWWSRepresentation::isVariable, LAST_MODIFIED, KoFontFamilyWWSRepresentation::lastModified, localeHashtoVariantMap(), LOCALIZED_FONT_FAMILY, LOCALIZED_TYPOGRAPHIC_NAME, LOCALIZED_TYPOGRAPHIC_STYLE, KoFontFamilyWWSRepresentation::localizedFontFamilyNames, KoFontFamilyWWSRepresentation::localizedTypographicFamily, KoFontFamilyWWSRepresentation::localizedTypographicStyles, SAMPLE_STRING, KoFontFamilyWWSRepresentation::sampleStrings, KoResource::setMD5Sum(), KoResource::setName(), KoResource::setValid(), STYLES, styles(), KoFontFamilyWWSRepresentation::styles, SUPPORTED_LANGUAGES, KoFontFamilyWWSRepresentation::supportedLanguages, KoFontFamilyWWSRepresentation::type, TYPOGRAPHIC_NAME, and KoFontFamilyWWSRepresentation::typographicFamilyName.

KoFontFamily() [2/3]

KoFontFamily::KoFontFamily

(

const QString &

filename

)

Definition at line 139 of file KoFontFamily.cpp.

    :KoResource(filename)
{
    setMD5Sum(KoMD5Generator::generateHash(ResourceType::FontFamilies.toUtf8()));
    setValid(false);
}

References ResourceType::FontFamilies, KoMD5Generator::generateHash(), KoResource::setMD5Sum(), and KoResource::setValid().

~KoFontFamily()

KoFontFamily::~KoFontFamily

(

)

Definition at line 146 of file KoFontFamily.cpp.

{
}

KoFontFamily() [3/3]

KoFontFamily::KoFontFamily

(

const KoFontFamily &

rhs

)

Definition at line 150 of file KoFontFamily.cpp.

    : KoResource(QString())
    , d(new Private(*rhs.d))
{
    setFilename(rhs.filename());
    QMap<QString, QVariant> meta = metadata();
    Q_FOREACH(const QString key, meta.keys()) {
        addMetaData(key, meta.value(key));
    }
    setValid(true);
}

References KoResource::addMetaData(), KoResource::filename, KoResource::metadata, KoResource::setFilename(), and KoResource::setValid().

Member Function Documentation

axes()

QList< KoSvgText::FontFamilyAxis > KoFontFamily::axes

(

)

const

Definition at line 249 of file KoFontFamily.cpp.

{
    QVariantHash axes = metadata().value(AXES).toHash();
    QList<KoSvgText::FontFamilyAxis> converted;
    Q_FOREACH(const QString key, axes.keys()) {
        converted.append(axes.value(key).value<KoSvgText::FontFamilyAxis>());
    }
    return converted;
}

References AXES, axes(), and KoResource::metadata.

clone()

KoResourceSP KoFontFamily::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 162 of file KoFontFamily.cpp.

{
    return KoResourceSP(new KoFontFamily(*this));
}

References KoFontFamily().

colorBitmap()

bool KoFontFamily::colorBitmap

(

)

const

Font has color bitmaps.

Definition at line 229 of file KoFontFamily.cpp.

{
    return metadata().value(COLOR_BITMAP).toBool();
}

References COLOR_BITMAP, and KoResource::metadata.

colorClrV0()

bool KoFontFamily::colorClrV0

(

)

const

Font has colrv0 layers.

Definition at line 234 of file KoFontFamily.cpp.

{
    return metadata().value(COLOR_CLRV0).toBool();
}

References COLOR_CLRV0, and KoResource::metadata.

colorClrV1()

bool KoFontFamily::colorClrV1

(

)

const

Font has colrv1 layers – doesn't yet work.

Definition at line 239 of file KoFontFamily.cpp.

{
    return metadata().value(COLOR_CLRV1).toBool();
}

References COLOR_CLRV1, and KoResource::metadata.

colorSVG()

bool KoFontFamily::colorSVG

(

)

const

Font is SVG.

Definition at line 244 of file KoFontFamily.cpp.

{
    return metadata().value(COLOR_SVG).toBool();
}

References COLOR_SVG, and KoResource::metadata.

isSerializable()

bool KoFontFamily::isSerializable ( ) const

overridevirtual

Serializable resource is the one which can be saved/loaded into a specific storage via saveToDevice()/loadFromDevice() methods. Some resources, like KisAbrBrush or KisPsdLayerStyle, are stored in specific libraries in "batches". Such resources cannot be saved individually. They are created by the corresponding factories.

In contrast to ephemeral resource, non-serializable resource will always have a correct md5Sum() and may be stored in the resources database.

Reimplemented from KoResource.

Definition at line 174 of file KoFontFamily.cpp.

{
    return false;
}

isVariable()

bool KoFontFamily::isVariable

(

)

const

Font is variable.

Definition at line 224 of file KoFontFamily.cpp.

{
    return metadata().value(IS_VARIABLE).toBool();
}

References IS_VARIABLE, and KoResource::metadata.

lastModified()

QDateTime KoFontFamily::lastModified

(

)

const

Definition at line 269 of file KoFontFamily.cpp.

{
    return metadata().value(LAST_MODIFIED).toDateTime();
}

References LAST_MODIFIED, and KoResource::metadata.

loadFromDevice()

bool KoFontFamily::loadFromDevice ( QIODevice * dev, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KoResource.

Definition at line 167 of file KoFontFamily.cpp.

{
    Q_UNUSED(dev)
    Q_UNUSED(resourcesInterface);
    return false;
}

operator=()

KoFontFamily & KoFontFamily::operator= ( const KoFontFamily & rhs )

delete

resourceType()

QPair< QString, QString > KoFontFamily::resourceType ( ) const

overridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 179 of file KoFontFamily.cpp.

{
    return QPair<QString, QString>(ResourceType::FontFamilies, "");
}

References ResourceType::FontFamilies.

styles()

QList< KoSvgText::FontFamilyStyleInfo > KoFontFamily::styles

(

)

const

Definition at line 259 of file KoFontFamily.cpp.

{
    QVariantList styles = metadata().value(STYLES).toList();
    QList<KoSvgText::FontFamilyStyleInfo> converted;
    Q_FOREACH(const QVariant val, styles) {
        converted.append(val.value<KoSvgText::FontFamilyStyleInfo>());
    }
    return converted;
}

References KoResource::metadata, STYLES, and styles().

translatedFontName()

QString KoFontFamily::translatedFontName

(

QStringList

locales

)

const

Return the translated name for a given locale...

Definition at line 211 of file KoFontFamily.cpp.

{
    QMap<QString, QVariant> names = metadata().value(LOCALIZED_FONT_FAMILY).toMap();
    QString name = filename();
    Q_FOREACH(const QString locale, locales) {
        if (names.keys().contains(locale)) {
            name = names.value(locale).toString();
            break;
        }
    }
    return name;
}

References KoResource::filename, LOCALIZED_FONT_FAMILY, KoResource::metadata, and KoResource::name.

typographicFamily()

QString KoFontFamily::typographicFamily

(

)

const

Returns the typographic family name, if any.

Definition at line 206 of file KoFontFamily.cpp.

{
    return metadata().value(TYPOGRAPHIC_NAME).toString();
}

References KoResource::metadata, and TYPOGRAPHIC_NAME.

updateThumbnail()

void KoFontFamily::updateThumbnail ( )

overridevirtual

updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

Reimplemented from KoResource.

Definition at line 184 of file KoFontFamily.cpp.

{
    QHash<QString, QVariant> samples = metadata().value(SAMPLE_STRING).toHash();
    QMap<QString, QVariant> sampleSVG;
    QMap<QString, QVariant> sampleSVGBbox;
 
    Q_FOREACH (const QString key, samples.keys()) {
        QString sample = samples.value(key).toString();
        QRectF sampleBBox;
        QString lang = key.startsWith("l_")? key.right(key.size() - 2): "";
        sampleSVG.insert(key, QVariant::fromValue(generateSVG(sample, filename(), sampleBBox, lang)));
        sampleSVGBbox.insert(key, QVariant::fromValue(sampleBBox));
    }
 
    addMetaData(SAMPLE_SVG, sampleSVG);
    addMetaData(SAMPLE_BBOX, sampleSVGBbox);
    const QString sample = samples.isEmpty()? "AaBbGg"
                                            : samples.value("s_Latn", samples.values().first()).toString();
    bool isColor = (metadata().value(COLOR_BITMAP).toBool() || metadata().value(COLOR_CLRV0).toBool());
    setImage(generateImage(sample, filename(), isColor));
}

References KoResource::addMetaData(), COLOR_BITMAP, COLOR_CLRV0, KoResource::filename, generateImage(), generateSVG(), KoResource::metadata, SAMPLE_BBOX, SAMPLE_STRING, SAMPLE_SVG, and KoResource::setImage().

Member Data Documentation

d

QScopedPointer<Private> KoFontFamily::d

private

Definition at line 62 of file KoFontFamily.h.

---

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

• libs/flake/resources/KoFontFamily.h
• libs/flake/resources/KoFontFamily.cpp