The OpenTypeFeatureModel class This model keeps track of the currently set font-feature-settings property on a given piece of text, and allows editing it. It also keeps track of the available features of a given font. More...

#include <OpenTypeFeatureModel.h>

Inheritance diagram for OpenTypeFeatureModel:

Classes
struct	Private

Public Types
enum	Roles { Tag = Qt::UserRole + 1 , Sample , Parameters , Max }

Signals
void	openTypeFeaturesChanged ()

Public Member Functions
Q_INVOKABLE void	addFeature (const QString &tag)

Q_INVOKABLE QAbstractItemModel *	allFeatureModel () const
	featureFilterModel

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

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

Qt::ItemFlags	flags (const QModelIndex &index) const override

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

	OpenTypeFeatureModel (QObject *parent=nullptr)

QVariantMap	openTypeFeatures () const

QModelIndex	parent (const QModelIndex &index) const override

Q_INVOKABLE void	removeFeature (const QString &tag)

QHash< int, QByteArray >	roleNames () const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

void	setFromTextProperties (const KoSvgTextProperties &props)

Q_INVOKABLE void	setFromTextPropertiesModel (KoSvgTextPropertiesModel *textPropertiesModel)
	setFromTextPropertiesModel Set the current glyph model font from the lager text properties model. This allows us to use this class from qml, with little fuss.

void	setOpenTypeFeatures (const QVariantMap &newOpenTypeFeatures)

	~OpenTypeFeatureModel ()

Properties
QVariantMap	openTypeFeatures

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The OpenTypeFeatureModel class This model keeps track of the currently set font-feature-settings property on a given piece of text, and allows editing it. It also keeps track of the available features of a given font.

Each feature is internally represented as a tag plus a number.

Definition at line 51 of file OpenTypeFeatureModel.h.

Member Enumeration Documentation

◆ Roles

enum OpenTypeFeatureModel::Roles

Enumerator
Tag	QString, opentype tag.
Sample	QString, the sample for this feature, may be empty.
Parameters	QVariantList, indices with names of the feature count.
Max	int, max count, default is 1, but can be larger depending on the font.

Definition at line 62 of file OpenTypeFeatureModel.h.

               {
        Tag = Qt::UserRole + 1, 
        Sample, 
        Parameters, 
        Max 
    };

Constructor & Destructor Documentation

◆ OpenTypeFeatureModel()

OpenTypeFeatureModel::OpenTypeFeatureModel ( QObject * parent = nullptr )

Definition at line 48 of file OpenTypeFeatureModel.cpp.

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

◆ ~OpenTypeFeatureModel()

OpenTypeFeatureModel::~OpenTypeFeatureModel ( )

Definition at line 54 of file OpenTypeFeatureModel.cpp.

55{

56}

Member Function Documentation

◆ addFeature()

void OpenTypeFeatureModel::addFeature ( const QString & tag )

Definition at line 212 of file OpenTypeFeatureModel.cpp.

{
    if (tag.isEmpty()) return;
    if (d->currentFeatures.keys().contains(tag)) return;
 
    QVariantMap dummy = d->currentFeatures;
    dummy.insert(tag, QVariant(1));
    const int index = dummy.keys().indexOf(tag);
 
    beginInsertRows(QModelIndex(), index, index);
    d->currentFeatures.insert(tag, QVariant(1));
    endInsertRows();
    emit openTypeFeaturesChanged();
}

References d, index(), and openTypeFeaturesChanged().

◆ allFeatureModel()

QAbstractItemModel * OpenTypeFeatureModel::allFeatureModel ( ) const

featureFilterModel

Returns: return the OpenTypeFeatureFilterModel that allows searching and sorting on all opentype features, whether available in the font or part of the standard.

Definition at line 239 of file OpenTypeFeatureModel.cpp.

{
    return d->allFeatures;
}

References d.

◆ columnCount()

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

override

Definition at line 78 of file OpenTypeFeatureModel.cpp.

{
    Q_UNUSED(parent)
    return 1;
}

References parent().

◆ data()

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

override

Definition at line 84 of file OpenTypeFeatureModel.cpp.

{
    if (!index.isValid())
        return QVariant();
 
    const QString feature = d->currentFeatures.keys().at(index.row());
    KoOpenTypeFeatureInfo info = d->featureByTag(QLatin1String(feature.toLatin1()));
    if (role == Qt::DisplayRole) {
        return info.name;
    } else if (role == Qt::ToolTipRole) {
        return info.description;
    } else if (role == Qt::EditRole) {
        return d->currentFeatures.value(feature, QVariant(0)).toInt();
    } else if (role == Tag) {
        return feature;
    } else if (role == Sample) {
        return info.sample;
    } else if (role == Parameters) {
        QVariantList features;
        for (int i = 0; i <= info.maxValue; i++) {
            QVariantMap map;
            map.insert("value", QVariant(i));
            QString entry = i > 0? info.namedParameters.value(i-1): QString();
            if (entry.isEmpty()) {
                if (i == 1 && info.maxValue == 1) {
                    entry = info.name + ": " + i18nc("Feature value toggle", "On");
                } else if (i == 0) {
                    entry = info.name + ": " + i18nc("Feature value toggle", "Off");
                } else {
                    entry = info.name + ": " + QString::number(i);
                }
            }
            map.insert("display", entry);
            features.append(map);
        }
        return features;
    } else if (role == Max) {
        return info.maxValue;
    }
    return QVariant();
}

References d, KoOpenTypeFeatureInfo::description, index(), Max, KoOpenTypeFeatureInfo::maxValue, KoOpenTypeFeatureInfo::name, KoOpenTypeFeatureInfo::namedParameters, Parameters, KoOpenTypeFeatureInfo::sample, Sample, and Tag.

◆ flags()

Qt::ItemFlags OpenTypeFeatureModel::flags ( const QModelIndex & index ) const

override

Definition at line 144 of file OpenTypeFeatureModel.cpp.

{
    Qt::ItemFlags flags = QAbstractItemModel::flags(index) | Qt::ItemNeverHasChildren | Qt::ItemIsEditable;
 
    return flags;
}

References flags(), and index().

◆ index()

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

override

Definition at line 58 of file OpenTypeFeatureModel.cpp.

{
    Q_UNUSED(parent)
    if (column != 0) return QModelIndex();
    if (row >= 0 && row < d->currentFeatures.size()) return createIndex(row, column, &row);
    return QModelIndex();
}

References parent().

◆ openTypeFeatures()

QVariantMap OpenTypeFeatureModel::openTypeFeatures ( ) const

Definition at line 197 of file OpenTypeFeatureModel.cpp.

{
    return d->currentFeatures;
}

References d.

◆ openTypeFeaturesChanged

void OpenTypeFeatureModel::openTypeFeaturesChanged ( )

signal

◆ parent()

QModelIndex OpenTypeFeatureModel::parent ( const QModelIndex & index ) const

override

Definition at line 66 of file OpenTypeFeatureModel.cpp.

{
    Q_UNUSED(index)
    return QModelIndex();
}

References index().

◆ removeFeature()

void OpenTypeFeatureModel::removeFeature ( const QString & tag )

Definition at line 227 of file OpenTypeFeatureModel.cpp.

{
    if (tag.isEmpty()) return;
    const int index = d->currentFeatures.keys().indexOf(tag);
    if (index < 0) return;
 
    beginRemoveRows(QModelIndex(), index, index);
    d->currentFeatures.remove(tag);
    endRemoveRows();
    emit openTypeFeaturesChanged();
}

References d, index(), and openTypeFeaturesChanged().

◆ roleNames()

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

override

Definition at line 151 of file OpenTypeFeatureModel.cpp.

{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
    roles[Tag] = "tag";
    roles[Sample] = "sample";
    roles[Parameters] = "parameters";
    roles[Max] = "max";
    return roles;
}

References Max, Parameters, Sample, and Tag.

◆ rowCount()

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

override

Definition at line 72 of file OpenTypeFeatureModel.cpp.

{
    Q_UNUSED(parent)
    return d->currentFeatures.size();
}

References d, and parent().

◆ setData()

bool OpenTypeFeatureModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = Qt::EditRole )

override

Definition at line 126 of file OpenTypeFeatureModel.cpp.

{
    if (data(index, role) != value) {
        // FIXME: Implement me!
 
        if (index.isValid() && role == Qt::EditRole) {
            const QString feature = d->currentFeatures.keys().at(index.row());
            d->currentFeatures.insert(feature, value.toInt());
            emit openTypeFeaturesChanged();
            emit dataChanged(index, index, {role});
            return true;
        }
        return false;
    }
 
    return false;
}

References d, data(), index(), openTypeFeaturesChanged(), and value().

◆ setFromTextProperties()

void OpenTypeFeatureModel::setFromTextProperties ( const KoSvgTextProperties & props )

Definition at line 161 of file OpenTypeFeatureModel.cpp.

{
    const bool changeFont = props.cssFontInfo() != d->fontInfo;
    const QVariantMap newFeatures = props.propertyOrDefault(KoSvgTextProperties::FontFeatureSettingsId).toMap();
    const bool changeFeatures = d->currentFeatures != newFeatures;
 
    if (!changeFont && !changeFeatures) return;
 
    beginResetModel();
    if (changeFont) {
        const qreal res = 72.0;
        QVector<int> lengths;
        const KoCSSFontInfo info = props.cssFontInfo();
        const std::vector<FT_FaceSP> faces = KoFontRegistry::instance()->facesForCSSValues(
                    lengths,
                    info,
                    QString(),
                    static_cast<quint32>(res),
                    static_cast<quint32>(res));
 
        if (!faces.empty()) {
            QString language = props.propertyOrDefault(KoSvgTextProperties::TextLanguage).toString();
            // NOTE: We're retrieving only enough data for 6 samples here, to speed up loading.
            d->glyphModel->setFace(faces.front(), QLatin1String(language.toLatin1()), true);
            d->allFeatures->setAvailableFeatures(d->availableFeatures());
            d->fontInfo = props.cssFontInfo();
        }
    }
 
    if (changeFeatures) {
        d->currentFeatures = newFeatures;
        emit openTypeFeaturesChanged();
    }
    endResetModel();
}

References KoSvgTextProperties::cssFontInfo(), d, KoFontRegistry::facesForCSSValues(), KoSvgTextProperties::FontFeatureSettingsId, KoFontRegistry::instance(), openTypeFeaturesChanged(), KoSvgTextProperties::propertyOrDefault(), and KoSvgTextProperties::TextLanguage.

◆ setFromTextPropertiesModel()

void OpenTypeFeatureModel::setFromTextPropertiesModel ( KoSvgTextPropertiesModel * textPropertiesModel )

setFromTextPropertiesModel Set the current glyph model font from the lager text properties model. This allows us to use this class from qml, with little fuss.

Parameters

newTextProperties – the lager model to set from.

Definition at line 244 of file OpenTypeFeatureModel.cpp.

{
    KoSvgTextProperties main;
    if (textPropertiesModel) {
        KoSvgTextPropertyData data = textPropertiesModel->textData.get();
        main = data.commonProperties;
        main.inheritFrom(data.inheritedProperties);
    }
    setFromTextProperties(main);
}

References data(), main(), setFromTextProperties(), and KoSvgTextPropertiesModel::textData.

◆ setOpenTypeFeatures()

void OpenTypeFeatureModel::setOpenTypeFeatures ( const QVariantMap & newOpenTypeFeatures )

Definition at line 202 of file OpenTypeFeatureModel.cpp.

{
    if (d->currentFeatures == newOpenTypeFeatures)
        return;
    beginResetModel();
    d->currentFeatures = newOpenTypeFeatures;
    endResetModel();
    emit openTypeFeaturesChanged();
}

References d, and openTypeFeaturesChanged().

Member Data Documentation

◆ d

const QScopedPointer<Private> OpenTypeFeatureModel::d

private

Definition at line 121 of file OpenTypeFeatureModel.h.

Property Documentation

◆ openTypeFeatures

QVariantMap OpenTypeFeatureModel::openTypeFeatures

readwrite

Definition at line 56 of file OpenTypeFeatureModel.h.

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

plugins/dockers/textproperties/OpenTypeFeatureModel.h
plugins/dockers/textproperties/OpenTypeFeatureModel.cpp

Classes

Public Types

Signals

Public Member Functions

Properties

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Roles

Constructor & Destructor Documentation

◆ OpenTypeFeatureModel()

◆ ~OpenTypeFeatureModel()

Member Function Documentation

◆ addFeature()

◆ allFeatureModel()

◆ columnCount()

◆ data()

◆ flags()

◆ index()

◆ openTypeFeatures()

◆ openTypeFeaturesChanged

◆ parent()

◆ removeFeature()

◆ roleNames()

◆ rowCount()

◆ setData()

◆ setFromTextProperties()

◆ setFromTextPropertiesModel()

◆ setOpenTypeFeatures()

Member Data Documentation

◆ d

Property Documentation

◆ openTypeFeatures