CssQmlUnitConverter Class Reference

The CssQmlUnitConverter class. More...

#include <CssQmlUnitConverter.h>

Inheritance diagram for CssQmlUnitConverter:

Classes
struct	Private

Public Types
enum	UserUnits {   Px , Pt , Mm , Cm ,   Inch , Percentage , Em , Ex ,   Cap , Ch , Ic , Lh ,   Lines , Spaces }

Signals
void	dataMultiplierChanged ()
void	dataUnitChanged ()
void	dataValueChanged ()
void	dpiChanged ()
void	percentageReferenceChanged ()
void	userUnitChanged ()
void	userUnitModelChanged ()
void	userValueChanged ()

Public Member Functions
	CssQmlUnitConverter (QObject *parent=nullptr)
qreal	dataMultiplier () const
int	dataUnit () const
qreal	dataValue () const
qreal	dpi () const
qreal	percentageReference () const
void	setDataMultiplier (qreal newDataMultiplier)
void	setDataUnit (int newDataUnit)
Q_INVOKABLE void	setDataUnitMap (const QVariantList &unitMap)
	setDataUnitMap
void	setDataValue (qreal newDataValue)
Q_INVOKABLE void	setDataValueAndUnit (const qreal value, const int unit)
	setDataValueAndUnit set data unit and value in one go.
void	setDpi (qreal newDpi)
Q_INVOKABLE void	setFontMetricsFromTextPropertiesModel (KoSvgTextPropertiesModel *textPropertiesModel, bool isFontSize=false, bool isLineHeight=false)
	setFontMetricsFromTextPropertiesModel Set the current font metrics from the text properties model.
Q_INVOKABLE void	setFromNormalLineHeight ()
	setFromNormalLineHeight set the current value from line-height:normal metrics.
void	setPercentageReference (qreal newPercentageReference)
void	setUserUnit (int newUserUnit)
void	setUserValue (qreal newUserValue)
QString	symbol () const
int	userUnit () const
QVariantList	userUnitModel () const
qreal	userValue () const
	~CssQmlUnitConverter ()

Properties
qreal	dataMultiplier
	Data multiplier is used if for some reason the user-value needs to be multiplied by a certain factor.
int	dataUnit
qreal	dataValue
	dataValue and dataUnit represent the data as used by the text properties.
qreal	dpi
	The DPI used to calculate pixel to physical properties.
qreal	percentageReference
	value to represent 100%
QString	symbol
	The symbol.
int	userUnit
QVariantList	userUnitModel
	A model for the available user units.
qreal	userValue
	userValue and userUnit represent the user-visible data. This can include synthetic units like px and mm from pt.

Private Member Functions
qreal	convertFromRelativeValue (const qreal value, const UserUnits type) const
qreal	convertToRelativeValue (const qreal value, const UserUnits type) const

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The CssQmlUnitConverter class.

This handles converter to and from various units. For the absolute units, KoUnit is used internally. For the font-relative units, it will use the fontMetrics;

Definition at line 19 of file CssQmlUnitConverter.h.

Member Enumeration Documentation

UserUnits

enum CssQmlUnitConverter::UserUnits

Enumerator
Px	Pixels, dpi relative.
Pt	Points, 1/72th.
Mm	Millimeters.
Cm	Centimeters.
Inch	Inches.
Percentage
Em	FontSize.
Ex	Font x-height.
Cap	Cap height.
Ch	average proportional advance
Ic	average full-width advance
Lh	line-height
Lines	Used by lineHeight.
Spaces	Used by tabs.

Definition at line 51 of file CssQmlUnitConverter.h.

                   {
        Px, 
        Pt, 
        Mm, 
        Cm, 
        Inch,
        //
        Percentage,
        // Font Relative
        Em, 
        Ex, 
        Cap,
        Ch, 
        Ic, 
        Lh, 
        // unique for certain properties
        Lines,  
        Spaces, 
    };

Constructor & Destructor Documentation

CssQmlUnitConverter()

CssQmlUnitConverter::CssQmlUnitConverter

(

QObject *

parent = nullptr

)

Definition at line 44 of file CssQmlUnitConverter.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->absoluteUnitConverter = KoUnit(KoUnit::Point, d->dpi);
    d->fontInfo = KoSvgTextProperties::defaultProperties().cssFontInfo();
    d->metrics = KoSvgTextProperties::defaultProperties().metrics(false);
}

References KoSvgTextProperties::cssFontInfo(), d, KoSvgTextProperties::defaultProperties(), KoSvgTextProperties::metrics(), and KoUnit::Point.

~CssQmlUnitConverter()

CssQmlUnitConverter::~CssQmlUnitConverter

(

)

Definition at line 53 of file CssQmlUnitConverter.cpp.

{
}

Member Function Documentation

convertFromRelativeValue()

qreal CssQmlUnitConverter::convertFromRelativeValue ( const qreal value, const UserUnits type ) const

private

Definition at line 365 of file CssQmlUnitConverter.cpp.

{
    return value * metricsMultiplier(type, d->metrics, d->fontInfo.size, d->percentageReference);
}

References d, metricsMultiplier(), and value().

convertToRelativeValue()

qreal CssQmlUnitConverter::convertToRelativeValue ( const qreal value, const UserUnits type ) const

private

Definition at line 360 of file CssQmlUnitConverter.cpp.

{
    return value / metricsMultiplier(type, d->metrics, d->fontInfo.size, d->percentageReference);
}

References d, metricsMultiplier(), and value().

dataMultiplier()

qreal CssQmlUnitConverter::dataMultiplier

(

)

const

Definition at line 155 of file CssQmlUnitConverter.cpp.

{
    return d->dataMultiplier;
}

References d.

dataMultiplierChanged

void CssQmlUnitConverter::dataMultiplierChanged ( )

signal

dataUnit()

int CssQmlUnitConverter::dataUnit

(

)

const

Definition at line 182 of file CssQmlUnitConverter.cpp.

{
    return d->dataUnit;
}

References d.

dataUnitChanged

void CssQmlUnitConverter::dataUnitChanged ( )

signal

dataValue()

qreal CssQmlUnitConverter::dataValue

(

)

const

Definition at line 168 of file CssQmlUnitConverter.cpp.

{
    return d->dataValue;
}

References d.

dataValueChanged

void CssQmlUnitConverter::dataValueChanged ( )

signal

dpi()

qreal CssQmlUnitConverter::dpi

(

)

const

Definition at line 140 of file CssQmlUnitConverter.cpp.

{
    return d->dpi;
}

References d.

dpiChanged

void CssQmlUnitConverter::dpiChanged ( )

signal

percentageReference()

qreal CssQmlUnitConverter::percentageReference

(

)

const

Definition at line 323 of file CssQmlUnitConverter.cpp.

{
    return d->percentageReference;
}

References d.

percentageReferenceChanged

void CssQmlUnitConverter::percentageReferenceChanged ( )

signal

setDataMultiplier()

void CssQmlUnitConverter::setDataMultiplier

(

qreal

newDataMultiplier

)

Definition at line 160 of file CssQmlUnitConverter.cpp.

{
    if (qFuzzyCompare(d->dataMultiplier, newDataMultiplier))
        return;
    d->dataMultiplier = newDataMultiplier;
    emit dataMultiplierChanged();
}

References d, dataMultiplierChanged(), and qFuzzyCompare().

setDataUnit()

void CssQmlUnitConverter::setDataUnit

(

int

newDataUnit

)

Definition at line 187 of file CssQmlUnitConverter.cpp.

{
    if (d->dataUnit == newDataUnit)
        return;
    if (d->dataUnitMap.key(d->dataUnit) == d->userUnit)
        return;
    setUserUnit(d->dataUnitMap.key(d->dataUnit));
}

References d, and setUserUnit().

setDataUnitMap()

void CssQmlUnitConverter::setDataUnitMap

(

const QVariantList &

unitMap

)

setDataUnitMap

Parameters

map	– variant list of VariantMaps, where "data" is an int representing a dataUnit, and "user" is an int representing a value in the UserUnits enum.

Definition at line 57 of file CssQmlUnitConverter.cpp.

{
    QMap<int, int> map;
    Q_FOREACH(QVariant var, unitMap) {
        QVariantMap m = var.toMap();
        bool ok = false;
        const int user = m.value("user").toInt(&ok);
        const int data = m.value("data").toInt(&ok);
        if (!ok) {
            qWarning() << Q_FUNC_INFO << "unitMap has wrong format";
            return;
        }
        map.insert(user, data);
    }
 
    if (d->dataUnitMap != map) {
        d->dataUnitMap = map;
        emit userUnitModelChanged();
    }
}

References d, and userUnitModelChanged().

setDataValue()

void CssQmlUnitConverter::setDataValue

(

qreal

newDataValue

)

Definition at line 173 of file CssQmlUnitConverter.cpp.

{
    if (qFuzzyCompare(d->dataValue, newDataValue))
        return;
    d->dataValue = newDataValue;
    emit dataValueChanged();
    emit userValueChanged();
}

References d, dataValueChanged(), qFuzzyCompare(), and userValueChanged().

setDataValueAndUnit()

void CssQmlUnitConverter::setDataValueAndUnit	(	const qreal	value,
		const int	unit )

setDataValueAndUnit set data unit and value in one go.

Definition at line 119 of file CssQmlUnitConverter.cpp.

{
    const bool updateVal = !qFuzzyCompare(d->dataValue, value);
    const bool updateUnit = d->dataUnit != unit;
    if (!updateVal && !updateUnit) {
        return;
    }
 
    d->dataUnit = unit;
    d->dataValue = value;
    d->userUnit = d->dataUnitMap.key(d->dataUnit, UserUnits::Pt);
    if (koUnitMap.values().contains(UserUnits(d->userUnit))) {
        d->absoluteUnitConverter = KoUnit(koUnitMap.key(UserUnits(d->userUnit)), d->dpi * koUnitFactor);
    }
 
    emit dataUnitChanged();
    emit userUnitChanged();
    emit dataValueChanged();
    emit userValueChanged();
}

References d, dataUnitChanged(), dataValueChanged(), koUnitFactor, koUnitMap, Pt, qFuzzyCompare(), userUnitChanged(), userValueChanged(), and value().

setDpi()

void CssQmlUnitConverter::setDpi

(

qreal

newDpi

)

Definition at line 145 of file CssQmlUnitConverter.cpp.

{
    if (qFuzzyCompare(d->dpi, newDpi))
        return;
    d->dpi = newDpi;
    d->absoluteUnitConverter.setFactor(newDpi * koUnitFactor);
    emit dpiChanged();
    emit userValueChanged();
}

References d, dpiChanged(), koUnitFactor, qFuzzyCompare(), and userValueChanged().

setFontMetricsFromTextPropertiesModel()

void CssQmlUnitConverter::setFontMetricsFromTextPropertiesModel	(	KoSvgTextPropertiesModel *	textPropertiesModel,
		bool	isFontSize = false,
		bool	isLineHeight = false )

setFontMetricsFromTextPropertiesModel Set the current font metrics from the text properties model.

Parameters

textPropertiesModel

Definition at line 78 of file CssQmlUnitConverter.cpp.

{
    KoSvgTextProperties main;
    int parentLineHeight = -1;
    if (textPropertiesModel) {
        KoSvgTextPropertyData data = textPropertiesModel->textData.get();
        // remove fontsize or lineheight for those specific properties, so the calculation is normal.
        if (isFontSize) {
            main = data.inheritedProperties;
            main.inheritFrom(KoSvgTextProperties::defaultProperties());
        } else {
            main = data.commonProperties;
            main.inheritFrom(data.inheritedProperties);
        }
        if (isLineHeight) {
            KoSvgText::FontMetrics m = main.metrics(true);
            parentLineHeight = m.ascender-m.descender + m.lineGap;
        }
    }
    KoCSSFontInfo info = main.cssFontInfo();
    if (info.size < 0) return;
    if (d->fontInfo == info) {
        return;
    }
    d->fontInfo = main.cssFontInfo();
    d->metrics = main.metrics(false);
    d->fontLineGap = d->metrics.lineGap;
    if (isLineHeight) {
        d->metrics = main.applyLineHeight(d->metrics);
    } else {
        d->metrics.lineGap = parentLineHeight - (d->metrics.ascender-d->metrics.descender);
    }
}

References KoSvgText::FontMetrics::ascender, KoSvgTextPropertyData::commonProperties, d, KoSvgTextProperties::defaultProperties(), KoSvgText::FontMetrics::descender, KoSvgTextPropertyData::inheritedProperties, KoSvgTextProperties::inheritFrom(), KoSvgText::FontMetrics::lineGap, main(), KoCSSFontInfo::size, and KoSvgTextPropertiesModel::textData.

setFromNormalLineHeight()

void CssQmlUnitConverter::setFromNormalLineHeight

(

)

setFromNormalLineHeight set the current value from line-height:normal metrics.

Definition at line 112 of file CssQmlUnitConverter.cpp.

{
    const qreal multiplier = d->fontInfo.size / d->metrics.fontSize;
    qreal normalLineHeight = (d->metrics.ascender - d->metrics.descender + d->fontLineGap)*multiplier;
    setDataValue(convertToRelativeValue(normalLineHeight, UserUnits(d->dataUnitMap.key(d->dataUnit))));
}

References convertToRelativeValue(), d, setDataValue(), and KoCSSFontInfo::size.

setPercentageReference()

void CssQmlUnitConverter::setPercentageReference

(

qreal

newPercentageReference

)

Definition at line 328 of file CssQmlUnitConverter.cpp.

{
    if (qFuzzyCompare(d->percentageReference, newPercentageReference))
        return;
    d->percentageReference = newPercentageReference;
    emit percentageReferenceChanged();
}

References d, percentageReferenceChanged(), and qFuzzyCompare().

setUserUnit()

void CssQmlUnitConverter::setUserUnit

(

int

newUserUnit

)

Definition at line 217 of file CssQmlUnitConverter.cpp.

{
    if (d->userUnit == newUserUnit)
        return;
    UserUnits newType = UserUnits(newUserUnit);
    const bool newIsAbsolute = koUnitMap.values().contains(newType);
    const bool oldIsAbsolute = koUnitMap.values().contains(UserUnits(d->userUnit));
 
    const qreal currentAbsoluteValue = oldIsAbsolute?
                d->absoluteUnitConverter.fromUserValue(d->dataValue):
                convertFromRelativeValue(d->dataValue, UserUnits(d->userUnit));
 
    if (newIsAbsolute && oldIsAbsolute) {
        KoUnit newUnitConverter(koUnitMap.key(newType), d->dpi * koUnitFactor);
        d->absoluteUnitConverter = newUnitConverter;
        emit userValueChanged();
    } else if (newIsAbsolute) {
        KoUnit newUnitConverter(koUnitMap.key(newType), d->dpi* koUnitFactor);
        d->absoluteUnitConverter = newUnitConverter;
        d->dataUnit = d->dataUnitMap.value(UserUnits::Pt);
        emit dataUnitChanged();
        setDataValue(currentAbsoluteValue);
    } else { // old value was absolute, and new value is relative, or both values are relative.
        d->dataUnit = d->dataUnitMap.value(newUserUnit);
        emit dataUnitChanged();
        setDataValue(convertToRelativeValue(currentAbsoluteValue, newType));
    }
 
    d->userUnit = newUserUnit;
    emit userUnitChanged();
}

References convertFromRelativeValue(), convertToRelativeValue(), d, dataUnitChanged(), koUnitFactor, koUnitMap, Pt, setDataValue(), userUnitChanged(), and userValueChanged().

setUserValue()

void CssQmlUnitConverter::setUserValue

(

qreal

newUserValue

)

Definition at line 202 of file CssQmlUnitConverter.cpp.

{
    if (qFuzzyCompare(userValue(), newUserValue))
        return;
    const bool isAbsolute = koUnitMap.values().contains(UserUnits(d->userUnit));
    d->dataValue = isAbsolute? d->absoluteUnitConverter.fromUserValue(newUserValue/d->dataMultiplier): (newUserValue/d->dataMultiplier);
    emit userValueChanged();
    emit dataValueChanged();
}

References d, dataValueChanged(), koUnitMap, qFuzzyCompare(), userValue, and userValueChanged().

symbol()

QString CssQmlUnitConverter::symbol

(

)

const

Definition at line 294 of file CssQmlUnitConverter.cpp.

{
    UserUnits unit = UserUnits(d->userUnit);
    const bool isAbsolute = koUnitMap.values().contains(unit);
    if (isAbsolute) {
        return d->absoluteUnitConverter.symbol();
    }
    if (unit == Em) {
        return QString("em");
    } else if (unit == Ex) {
        return QString("ex");
    } else if (unit == Cap) {
        return QString("cap");
    } else if (unit == Ch) {
        return QString("ch");
    } else if (unit == Ic) {
        return QString("ic");
    } else if (unit == Lh) {
        return QString("lh");
    } else if (unit == Lines) {
        return QString("Ln");
    } else if (unit == Spaces) {
        return QString("Sp");
    } else if (unit == Percentage) {
        return QString("%");
    }
    return QString();
}

References Cap, Ch, d, Em, Ex, Ic, koUnitMap, Lh, Lines, Percentage, and Spaces.

userUnit()

int CssQmlUnitConverter::userUnit

(

)

const

Definition at line 212 of file CssQmlUnitConverter.cpp.

{
    return d->userUnit;
}

References d.

userUnitChanged

void CssQmlUnitConverter::userUnitChanged ( )

signal

userUnitModel()

QVariantList CssQmlUnitConverter::userUnitModel

(

)

const

Definition at line 249 of file CssQmlUnitConverter.cpp.

{
    QVariantList userUnitModel;
 
    const QString descriptionKey = "description";
    const QString valueKey = "value";
    Q_FOREACH(const int key, d->dataUnitMap.keys()) {
        UserUnits keyUnit = UserUnits(key);
 
        if (keyUnit == Pt) {
            Q_FOREACH(KoUnit::Type koUnitKey, koUnitMap.keys()) {
                QVariantMap unit;
                unit.insert(descriptionKey, KoUnit::unitDescription(koUnitKey));
                unit.insert(valueKey, koUnitMap.value(koUnitKey));
                userUnitModel.append(unit);
            }
        } else {
            QVariantMap unit;
            if (keyUnit == Em) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Font Size (em)"));
            } else if (keyUnit == Ex) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "X Height (ex)"));
            } else if (keyUnit == Cap) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Cap Height (cap)"));
            } else if (keyUnit == Ch) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Proportional Advance (ch)"));
            } else if (keyUnit == Ic) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Ideographic Advance (ic)"));
            } else if (keyUnit == Lh) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Line Height (lh)"));
            } else if (keyUnit == Spaces) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Spaces (Sp)"));
            } else if (keyUnit == Lines) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Lines (Ln)"));
            } else if (keyUnit == Percentage) {
                unit.insert(descriptionKey, i18nc("@label:inlistbox", "Percentage (%)"));
            }
            unit.insert(valueKey, keyUnit);
            userUnitModel.append(unit);
        }
    }
 
    return userUnitModel;
}

References Cap, Ch, d, Em, Ex, Ic, koUnitMap, Lh, Lines, Percentage, Pt, Spaces, KoUnit::unitDescription(), and userUnitModel.

userUnitModelChanged

void CssQmlUnitConverter::userUnitModelChanged ( )

signal

userValue()

qreal CssQmlUnitConverter::userValue

(

)

const

Definition at line 196 of file CssQmlUnitConverter.cpp.

{
    const bool isAbsolute = koUnitMap.values().contains(UserUnits(d->userUnit));
    return (isAbsolute? d->absoluteUnitConverter.toUserValue(d->dataValue): d->dataValue) * d->dataMultiplier;
}

References d, and koUnitMap.

userValueChanged

void CssQmlUnitConverter::userValueChanged ( )

signal

Member Data Documentation

d

const QScopedPointer<Private> CssQmlUnitConverter::d

private

Definition at line 148 of file CssQmlUnitConverter.h.

Property Documentation

dataMultiplier

qreal CssQmlUnitConverter::dataMultiplier

readwrite

Data multiplier is used if for some reason the user-value needs to be multiplied by a certain factor.

Definition at line 27 of file CssQmlUnitConverter.h.

dataUnit

int CssQmlUnitConverter::dataUnit

readwrite

Definition at line 31 of file CssQmlUnitConverter.h.

dataValue

qreal CssQmlUnitConverter::dataValue

readwrite

dataValue and dataUnit represent the data as used by the text properties.

Definition at line 30 of file CssQmlUnitConverter.h.

dpi

qreal CssQmlUnitConverter::dpi

readwrite

The DPI used to calculate pixel to physical properties.

Definition at line 24 of file CssQmlUnitConverter.h.

percentageReference

qreal CssQmlUnitConverter::percentageReference

readwrite

value to represent 100%

Definition at line 44 of file CssQmlUnitConverter.h.

symbol

QString CssQmlUnitConverter::symbol

read

The symbol.

Definition at line 41 of file CssQmlUnitConverter.h.

userUnit

int CssQmlUnitConverter::userUnit

readwrite

Definition at line 35 of file CssQmlUnitConverter.h.

userUnitModel

QVariantList CssQmlUnitConverter::userUnitModel

read

A model for the available user units.

Definition at line 38 of file CssQmlUnitConverter.h.

userValue

qreal CssQmlUnitConverter::userValue

readwrite

userValue and userUnit represent the user-visible data. This can include synthetic units like px and mm from pt.

Definition at line 34 of file CssQmlUnitConverter.h.

---

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

• plugins/dockers/textproperties/CssQmlUnitConverter.h
• plugins/dockers/textproperties/CssQmlUnitConverter.cpp