KoFontGlyphModel Class Reference

The KoFontGlyphModel class Creates a tree model of all the glyphs in a given face. More...

#include <KoFontGlyphModel.h>

Inheritance diagram for KoFontGlyphModel:

Classes
struct	Private

Public Types
enum	GlyphType { Base , UnicodeVariationSelector , OpenType }
enum	Roles { OpenTypeFeatures = Qt::UserRole + 1 , GlyphLabel , ChildCount }

Public Member Functions
QVector< KoUnicodeBlockData >	blocks () const
	blocks
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
QMap< QString, KoOpenTypeFeatureInfo >	featureInfo () const
	featureInfo
bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
QModelIndex	indexForString (QString grapheme)
	KoFontGlyphModel (QObject *parent=nullptr)
QModelIndex	parent (const QModelIndex &child) const override
QHash< int, QByteArray >	roleNames () const override
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
void	setFace (FT_FaceSP face, QLatin1String language=QLatin1String(), bool samplesOnly=false)
	setFace set the face to retrieve glyph data for.
	~KoFontGlyphModel ()

Private Attributes
QScopedPointer< Private >	d

Detailed Description

The KoFontGlyphModel class Creates a tree model of all the glyphs in a given face.

The primary parents are the basic codepoints, the children of those parents (if any), are glyph variations.

Definition at line 23 of file KoFontGlyphModel.h.

Member Enumeration Documentation

GlyphType

enum KoFontGlyphModel::GlyphType

Enumerator
Base
UnicodeVariationSelector
OpenType

Definition at line 27 of file KoFontGlyphModel.h.

                   {
        Base,
        UnicodeVariationSelector,
        OpenType
    };

Roles

enum KoFontGlyphModel::Roles

Enumerator
OpenTypeFeatures
GlyphLabel
ChildCount

Definition at line 36 of file KoFontGlyphModel.h.

               {
        OpenTypeFeatures = Qt::UserRole + 1,
        GlyphLabel,
        ChildCount
    };

Constructor & Destructor Documentation

KoFontGlyphModel()

KoFontGlyphModel::KoFontGlyphModel

(

QObject *

parent = nullptr

)

Definition at line 363 of file KoFontGlyphModel.cpp.

    : QAbstractItemModel(parent)
    , d(new Private)
{
}

~KoFontGlyphModel()

KoFontGlyphModel::~KoFontGlyphModel

(

)

Definition at line 369 of file KoFontGlyphModel.cpp.

{
 
}

Member Function Documentation

blocks()

QVector< KoUnicodeBlockData > KoFontGlyphModel::blocks

(

)

const

blocks

Returns

list of Unicode blocks available in the font.

Definition at line 574 of file KoFontGlyphModel.cpp.

{
    return d->blocks;
}

References d.

columnCount()

int KoFontGlyphModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 504 of file KoFontGlyphModel.cpp.

{
    Q_UNUSED(parent);
    return 1;
}

References parent().

data()

QVariant KoFontGlyphModel::data ( const QModelIndex & index, int role = Qt::DisplayRole ) const

override

Definition at line 381 of file KoFontGlyphModel.cpp.

{
    if (!index.isValid()) {
        return QVariant();
    }
    if (role == Qt::DisplayRole) {
        //qDebug() << Q_FUNC_INFO<< index << index.parent().isValid() << index.parent();
        if (!index.parent().isValid()) {
            return d->codePoints.value(index.row()).utfString;
        } else {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.parent().row());
            const Private::GlyphInfo &glyph = codePoint.glyphs.value(index.row());
            //qDebug () << index.parent().row() << index.row() << codePoint.utfString << codePoint.ucs;
            if (glyph.type == UnicodeVariationSelector) {
                return QString(codePoint.utfString + glyph.baseString);
            } else {
                return codePoint.utfString;
            }
        }
    } else if (role == Qt::ToolTipRole) {
        if (!index.parent().isValid()) {
            QStringList glyphNames;
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.row());
            QString base = codePoint.utfString;
            QVector<Private::GlyphInfo> glyphList = codePoint.glyphs;
            glyphNames.append(QString("%1 (%2)").arg(base).arg(unicodeHexFromUCS(codePoint.ucs)));
            if (glyphList.size() > 0) {
                glyphNames.append(i18nc("@info:tooltip", "%1 glyph variants.").arg(glyphList.size()));
            }
            return glyphNames.join(" ");
        } else {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.parent().row());
            const Private::GlyphInfo &glyph = codePoint.glyphs.value(index.row());
            if (glyph.type == OpenType) {
                KoOpenTypeFeatureInfo info = d->featureData.value(glyph.baseString);
                QString parameterString = info.namedParameters.value(glyph.featureIndex-1);
                if (parameterString.isEmpty()) {
                    return info.name.isEmpty()? glyph.baseString: info.name;
                } else {
                    return QString("%1: %2").arg(info.name).arg(parameterString);
                }
            } else {
                return QString(codePoint.utfString + glyph.baseString);
            }
        }
    } else if (role == OpenTypeFeatures) {
        QVariantMap features;
        if (index.parent().isValid()) {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.parent().row());
            const Private::GlyphInfo &glyph = codePoint.glyphs.value(index.row());
            //qDebug () << index.parent().row() << index.row() << codePoint.utfString << codePoint.ucs;
            if (glyph.type == OpenType) {
                features.insert(glyph.baseString, glyph.featureIndex);
            }
        }
        return features;
    } else if (role == GlyphLabel) {
        QString glyphId;
        if (!index.parent().isValid()) {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.row());
            glyphId = unicodeHexFromUCS(codePoint.ucs);
        } else {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.parent().row());
            const Private::GlyphInfo &glyph = codePoint.glyphs.value(index.row());
            if (glyph.type == OpenType) {
                glyphId = QString("'%1' %2").arg(glyph.baseString).arg(glyph.featureIndex);
            } else if (glyph.type == UnicodeVariationSelector)  {
                glyphId = unicodeHexFromUCS(glyph.baseString.toUcs4().first());
            } else {
                glyphId = unicodeHexFromUCS(codePoint.ucs);
            }
        }
        return glyphId;
    } else if (role == ChildCount) {
        int childCount = 0;
        if (!index.parent().isValid()) {
            const Private::CodePointInfo &codePoint = d->codePoints.value(index.row());
            childCount = codePoint.childCount();
        }
        return childCount;
    }
    return QVariant();
}

References KoFontGlyphModel::Private::GlyphInfo::baseString, KoFontGlyphModel::Private::CodePointInfo::childCount(), ChildCount, d, KoFontGlyphModel::Private::GlyphInfo::featureIndex, GlyphLabel, KoFontGlyphModel::Private::CodePointInfo::glyphs, index(), KoOpenTypeFeatureInfo::name, KoOpenTypeFeatureInfo::namedParameters, OpenType, OpenTypeFeatures, KoFontGlyphModel::Private::GlyphInfo::type, KoFontGlyphModel::Private::CodePointInfo::ucs, unicodeHexFromUCS(), UnicodeVariationSelector, and KoFontGlyphModel::Private::CodePointInfo::utfString.

featureInfo()

QMap< QString, KoOpenTypeFeatureInfo > KoFontGlyphModel::featureInfo

(

)

const

featureInfo

Returns

list of OpenTypeFeatures available in the font.

Definition at line 579 of file KoFontGlyphModel.cpp.

{
    return d->featureData;
}

References d.

hasChildren()

bool KoFontGlyphModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 510 of file KoFontGlyphModel.cpp.

{
    if (parent.isValid()) {
        return !d->codePoints.value(parent.row()).glyphs.isEmpty();
    }
    return false;
}

References d, and parent().

index()

QModelIndex KoFontGlyphModel::index ( int row, int column, const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 465 of file KoFontGlyphModel.cpp.

{
    if (parent.isValid() && parent.row() >= 0 && parent.row() < d->codePoints.size()) {
        const Private::CodePointInfo &info = d->codePoints.at(parent.row());
        if (row >= 0 && row < info.glyphs.size()) {
            const Private::GlyphInfo &glyphInfo = info.glyphs.at(row);
            return createIndex(row, column, static_cast<quintptr>(glyphInfo.ucs));
        }
 
    } else if (row >= 0 && row < d->codePoints.size()) {
        return createIndex(row, column, static_cast<quintptr>(invalidUnicodeCodePoint));
    }
    return QModelIndex();
}

References d, KoFontGlyphModel::Private::CodePointInfo::glyphs, invalidUnicodeCodePoint, parent(), and KoFontGlyphModel::Private::GlyphInfo::ucs.

indexForString()

QModelIndex KoFontGlyphModel::indexForString

(

QString

grapheme

)

Definition at line 518 of file KoFontGlyphModel.cpp.

{
    for (int i = 0; i < d->codePoints.size(); i++) {
        if (grapheme.toUcs4().startsWith(d->codePoints.at(i).ucs)) {
            QModelIndex idx = index(i, 0, QModelIndex());
            return idx;
        }
    }
    return QModelIndex();
}

References d, and index().

parent()

QModelIndex KoFontGlyphModel::parent ( const QModelIndex & child ) const

override

Definition at line 480 of file KoFontGlyphModel.cpp.

{
    if (!child.isValid() || child.internalId() == invalidUnicodeCodePoint) {
        return QModelIndex();
    }
    const uint targetUcs = static_cast<uint>(child.internalId());
    for(int i = 0; i < d->codePoints.size(); i++) {
        const Private::CodePointInfo &info = d->codePoints.at(i);
        if (info.ucs == targetUcs) {
            return createIndex(i, 0);
        }
    }
 
    return QModelIndex();
}

References d, invalidUnicodeCodePoint, and KoFontGlyphModel::Private::CodePointInfo::ucs.

roleNames()

QHash< int, QByteArray > KoFontGlyphModel::roleNames ( ) const

override

Definition at line 565 of file KoFontGlyphModel.cpp.

{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
    roles[OpenTypeFeatures] = "openType";
    roles[GlyphLabel] = "glyphLabel";
    roles[ChildCount] = "childCount";
    return roles;
}

References ChildCount, GlyphLabel, and OpenTypeFeatures.

rowCount()

int KoFontGlyphModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 496 of file KoFontGlyphModel.cpp.

{
    if (parent.isValid()) {
        return d->codePoints.value(parent.row()).glyphs.size();
    }
    return d->codePoints.size();
}

References d, and parent().

setFace()

void KoFontGlyphModel::setFace	(	FT_FaceSP	face,
		QLatin1String	language = QLatin1String(),
		bool	samplesOnly = false )

setFace set the face to retrieve glyph data for.

Parameters

face	– the face.
language	– the language for which to retrieve data for, OpenType data can have different glyphs depending on the language.
samplesOnly	– Whether to only retrieve enough data for 6 samples, or to retrieve the full glyph layout. Turning this on speeds up loading.

Definition at line 533 of file KoFontGlyphModel.cpp.

{
    beginResetModel();
    d->codePoints = Private::charMap(face);
    d->blocks.clear();
    QMap<uint, QVector<Private::GlyphInfo>> VSData = Private::getVSData(face);
    KoUnicodeBlockDataFactory blockFactory;
 
    for(auto it = d->codePoints.begin(); it != d->codePoints.end(); it++) {
        it->glyphs.append(VSData.value(it->ucs));
 
        auto block = d->blocks.begin();
        for (; block != d->blocks.end(); block++) {
            if (block->match(it->ucs)) {
                break;
            }
        }
        if (block == d->blocks.end()) {
            KoUnicodeBlockData newBlock = blockFactory.blockForUCS(it->ucs);
            if (newBlock != KoUnicodeBlockDataFactory::noBlock()) {
                d->blocks.append(newBlock);
            }
        }
    }
    std::sort(d->blocks.begin(), d->blocks.end(), sortBlocks);
 
    d->featureData = Private::getOpenTypeTables(face, d->codePoints, QMap<QString, KoOpenTypeFeatureInfo>() , false, samplesOnly, KLocalizedString::languages(), language);
    d->featureData = Private::getOpenTypeTables(face, d->codePoints, d->featureData, true, samplesOnly, KLocalizedString::languages(), language);
 
    endResetModel();
}

References KoUnicodeBlockDataFactory::blockForUCS(), KoFontGlyphModel::Private::charMap(), d, KoFontGlyphModel::Private::getOpenTypeTables(), KoFontGlyphModel::Private::getVSData(), KoUnicodeBlockDataFactory::noBlock(), and sortBlocks().

Member Data Documentation

d

QScopedPointer<Private> KoFontGlyphModel::d

private

Definition at line 77 of file KoFontGlyphModel.h.

---

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

• libs/flake/text/KoFontGlyphModel.h
• libs/flake/text/KoFontGlyphModel.cpp