SvgTextLabel Class Reference

#include <SvgTextLabel.h>

Inheritance diagram for SvgTextLabel:

Public Slots
void	setFontAxesValues (QVariantMap fontAxesValues)
void	setFontFamilies (QStringList fontFamilies)
void	setFontSize (qreal fontSize)
void	setFontSlant (qreal fontSlant)
void	setFontStyle (QFont::Style fontStyle)
void	setFontWeight (qreal fontWeight)
void	setFontWidth (qreal fontWidth)
void	setLanguage (QString language)
void	setOpenTypeFeatures (QVariantMap openTypeFeatures)
void	setPadding (int padding)
void	setText (QString text)
void	setTextColor (QColor textColor)

Signals
void	fontAxesValuesChanged (QVariantMap fontAxesValues)
void	fontFamiliesChanged (QStringList)
void	fontSizeChanged (qreal fontSize)
void	fontSlantChanged (qreal fontSlant)
void	fontStyleChanged (QFont::Style fontStyle)
void	fontWeightChanged (qreal fontWeight)
void	fontWidthChanged (qreal fontWidth)
void	languageChanged (QString language)
void	minimumRectChanged ()
void	openTypeFeaturesChanged (QVariantMap openTypeFeatures)
void	paddingChanged (int padding)
void	textChanged (QString text)
void	textColorChanged (QColor textColor)

Public Member Functions
QVariantMap	fontAxesValues () const
QStringList	fontFamilies () const
qreal	fontSize () const
qreal	fontSlant () const
QFont::Style	fontStyle () const
qreal	fontWeight () const
qreal	fontWidth () const
QString	language () const
QRectF	minimumRect () const
QVariantMap	openTypeFeatures () const
int	padding () const
void	paint (QPainter *painter) override
	Private ()
	SvgTextLabel (QQuickItem *parent=nullptr)
QString	text () const
QColor	textColor () const
	~Private ()
	~SvgTextLabel ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
bool	addedShapeToPainter = false
int	bottomPadding = 2
int	leftPadding = 2
KoSvgTextProperties	props
int	rightPadding = 2
QScopedPointer< KoSvgTextShape >	shape
QScopedPointer< KoShapePainter >	shapePainter
int	topPadding = 2
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Protected Member Functions
void	componentComplete () override
	componentComplete called when all properties have been set. used to avoid relayout being called time and time again when the properties change.

Properties
QVariantMap	fontAxesValues
QML_ELEMENTQStringList	fontFamilies
qreal	fontSize
qreal	fontSlant
QFont::Style	fontStyle
qreal	fontWeight
qreal	fontWidth
QString	language
QRectF	minimumRect
QVariantMap	openTypeFeatures
int	padding
QString	text
QColor	textColor

Private Slots
void	updateShape ()

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

SvgTextLabel makes it possible to paint a KoSvgTextShape as a QML item. It will position and scale the text centered in the bounds of the items.

This is nowhere near as fast as a regular Text item, as Qt has a glyph cache, while Krita's system paints paths directly.

Definition at line 15 of file SvgTextLabel.cpp.

Constructor & Destructor Documentation

~Private()

SvgTextLabel::~Private ( )

inline

Definition at line 24 of file SvgTextLabel.cpp.

{}

SvgTextLabel()

SvgTextLabel::SvgTextLabel

(

QQuickItem *

parent = nullptr

)

Definition at line 44 of file SvgTextLabel.cpp.

    : QQuickPaintedItem(parent)
    , d(new Private())
{
    setImplicitSize(10, 10);
    setAntialiasing(true);
    setOpaquePainting(true);
 
    connect(this, SIGNAL(openTypeFeaturesChanged(QVariantMap)), this, SLOT(updateShape()));
}

References connect(), openTypeFeaturesChanged(), and updateShape().

~SvgTextLabel()

SvgTextLabel::~SvgTextLabel

(

)

Definition at line 55 of file SvgTextLabel.cpp.

{
}

Member Function Documentation

componentComplete()

void SvgTextLabel::componentComplete ( )

overrideprotected

componentComplete called when all properties have been set. used to avoid relayout being called time and time again when the properties change.

Definition at line 294 of file SvgTextLabel.cpp.

{
    QQuickPaintedItem::componentComplete();
 
    if (this->window()) {
        const qreal pixelRatio = this->window()->effectiveDevicePixelRatio();
        d->shape->setResolution(pixelRatio*72, pixelRatio*72);
    }
    setOpaquePainting(fillColor().alpha() == 255);
    if (!d->shapePainter) {
        d->shapePainter.reset(new KoShapePainter());
        if (!d->shape->boundingRect().isEmpty()) {
            d->shapePainter->setShapes({d->shape.data()});
            d->addedShapeToPainter = true;
        }
    }
    updateShape();
}

References d, and updateShape().

fontAxesValues()

QVariantMap SvgTextLabel::fontAxesValues

(

)

const

Definition at line 115 of file SvgTextLabel.cpp.

{
    return d->props.propertyOrDefault(KoSvgTextProperties::FontVariationSettingsId).toMap();
}

References d, and KoSvgTextProperties::FontVariationSettingsId.

fontAxesValuesChanged

void SvgTextLabel::fontAxesValuesChanged ( QVariantMap fontAxesValues )

signal

fontFamilies()

QStringList SvgTextLabel::fontFamilies

(

)

const

Definition at line 89 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontFamiliesId).value<QStringList>();
}

References d, and KoSvgTextProperties::FontFamiliesId.

fontFamiliesChanged

void SvgTextLabel::fontFamiliesChanged ( QStringList )

signal

fontSize()

qreal SvgTextLabel::fontSize

(

)

const

Definition at line 120 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontSizeId).toReal();
}

References d, and KoSvgTextProperties::FontSizeId.

fontSizeChanged

void SvgTextLabel::fontSizeChanged ( qreal fontSize )

signal

fontSlant()

qreal SvgTextLabel::fontSlant

(

)

const

Definition at line 109 of file SvgTextLabel.cpp.

{
    KoSvgText::CssFontStyleData style = d->shape->textProperties().property(KoSvgTextProperties::FontStyleId).value<KoSvgText::CssFontStyleData>();
    return style.slantValue.isAuto? 14.0: style.slantValue.customValue;
}

References KoSvgText::AutoValue::customValue, d, KoSvgTextProperties::FontStyleId, KoSvgText::AutoValue::isAuto, and KoSvgText::CssFontStyleData::slantValue.

fontSlantChanged

void SvgTextLabel::fontSlantChanged ( qreal fontSlant )

signal

fontStyle()

QFont::Style SvgTextLabel::fontStyle

(

)

const

Definition at line 104 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontStyleId).value<KoSvgText::CssFontStyleData>().style;
}

References d, and KoSvgTextProperties::FontStyleId.

fontStyleChanged

void SvgTextLabel::fontStyleChanged ( QFont::Style fontStyle )

signal

fontWeight()

qreal SvgTextLabel::fontWeight

(

)

const

Definition at line 94 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontWeightId).toReal();
}

References d, and KoSvgTextProperties::FontWeightId.

fontWeightChanged

void SvgTextLabel::fontWeightChanged ( qreal fontWeight )

signal

fontWidth()

qreal SvgTextLabel::fontWidth

(

)

const

Definition at line 99 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontStretchId).toReal();
}

References d, and KoSvgTextProperties::FontStretchId.

fontWidthChanged

void SvgTextLabel::fontWidthChanged ( qreal fontWidth )

signal

language()

QString SvgTextLabel::language

(

)

const

Definition at line 149 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::TextLanguage).toString();
}

References d, and KoSvgTextProperties::TextLanguage.

languageChanged

void SvgTextLabel::languageChanged ( QString language )

signal

minimumRect()

QRectF SvgTextLabel::minimumRect

(

)

const

Definition at line 313 of file SvgTextLabel.cpp.

{
    if (d->shape) {
        const QRectF bbox = d->shape->selectionBoxes(0, d->shape->posForIndex(d->shape->plainText().size())).boundingRect();
        return bbox.adjusted(-d->leftPadding, -d->topPadding, d->rightPadding, d->bottomPadding);
    }
    return QRectF();
}

References d.

minimumRectChanged

void SvgTextLabel::minimumRectChanged ( )

signal

openTypeFeatures()

QVariantMap SvgTextLabel::openTypeFeatures

(

)

const

Definition at line 134 of file SvgTextLabel.cpp.

{
    return d->shape->textProperties().property(KoSvgTextProperties::FontFeatureSettingsId).toMap();
}

References d, and KoSvgTextProperties::FontFeatureSettingsId.

openTypeFeaturesChanged

void SvgTextLabel::openTypeFeaturesChanged ( QVariantMap openTypeFeatures )

signal

padding()

int SvgTextLabel::padding

(

)

const

Definition at line 144 of file SvgTextLabel.cpp.

{
    return (d->leftPadding+d->rightPadding+d->topPadding+d->bottomPadding)/4;
}

References d.

paddingChanged

void SvgTextLabel::paddingChanged ( int padding )

signal

paint()

void SvgTextLabel::paint ( QPainter * painter )

override

Definition at line 59 of file SvgTextLabel.cpp.

{
    // the QML item must be finalized before paint() is called
    KIS_SAFE_ASSERT_RECOVER_RETURN(d->shapePainter);
 
    if (width() == 0 || height() == 0) return;
    if (!painter->isActive()) return;
    painter->save();
    if (d->shape->boundingRect().isEmpty()) {
        painter->restore();
        return;
    }
 
    QRectF bbox = d->shape->selectionBoxes(0, d->shape->posForIndex(d->shape->plainText().size())).boundingRect();
    bbox = bbox.isEmpty()? d->shape->boundingRect(): bbox;
 
    // Scale padding so that it is relative to the width and height.
    const double newWidth = width()-(d->leftPadding+d->rightPadding);
    const double newLeftPadding = (d->leftPadding / newWidth) * bbox.width();
    const double newRightPadding = (d->rightPadding / newWidth) * bbox.width();
    const double newHeight = height()-(d->topPadding+d->bottomPadding);
    const double newTopPadding = (d->topPadding / newHeight) * bbox.height();
    const double newBottomPadding = (d->bottomPadding / newHeight) * bbox.height();
 
    d->shapePainter->paint(*painter,
                           QRectF(0, 0, width(), height()).toAlignedRect(),
                           bbox.adjusted(-newLeftPadding, -newTopPadding, newRightPadding, newBottomPadding));
    painter->restore();
}

References d, and KIS_SAFE_ASSERT_RECOVER_RETURN.

Private()

SvgTextLabel::Private ( )

inline

Definition at line 17 of file SvgTextLabel.cpp.

        : shape(new KoSvgTextShape())
    {
        shape->setResolution(72, 72);
        shape->setRelayoutBlocked(true);
        shape->setFontMatchingDisabled(true);
    }

setFontAxesValues

void SvgTextLabel::setFontAxesValues ( QVariantMap fontAxesValues )

slot

Definition at line 209 of file SvgTextLabel.cpp.

{
    QVariantMap current = d->props.property(KoSvgTextProperties::FontVariationSettingsId).toMap();
    if (current == fontAxesValues)
        return;
 
    d->props.setProperty(KoSvgTextProperties::FontVariationSettingsId, QVariant::fromValue(fontAxesValues));
    emit fontAxesValuesChanged(fontAxesValues);
}

References d, fontAxesValues, fontAxesValuesChanged(), and KoSvgTextProperties::FontVariationSettingsId.

setFontFamilies

void SvgTextLabel::setFontFamilies ( QStringList fontFamilies )

slot

Definition at line 154 of file SvgTextLabel.cpp.

{
    QStringList current = d->props.property(KoSvgTextProperties::FontFamiliesId).value<QStringList>();
    if (current == fontFamilies)
        return;
 
    d->props.setProperty(KoSvgTextProperties::FontFamiliesId, fontFamilies);
    emit fontFamiliesChanged(fontFamilies);
}

References d, fontFamilies, fontFamiliesChanged(), and KoSvgTextProperties::FontFamiliesId.

setFontSize

void SvgTextLabel::setFontSize ( qreal fontSize )

slot

Definition at line 219 of file SvgTextLabel.cpp.

{
    KoSvgText::CssLengthPercentage current = d->props.property(KoSvgTextProperties::FontSizeId).value<KoSvgText::CssLengthPercentage>();
    if (qFuzzyCompare(current.value, fontSize))
        return;
 
    current.value = fontSize;
    d->props.setProperty(KoSvgTextProperties::FontSizeId, QVariant::fromValue(current));
    emit fontSizeChanged(fontSize);
}

References d, fontSize, fontSizeChanged(), KoSvgTextProperties::FontSizeId, qFuzzyCompare(), and KoSvgText::CssLengthPercentage::value.

setFontSlant

void SvgTextLabel::setFontSlant ( qreal fontSlant )

slot

Definition at line 195 of file SvgTextLabel.cpp.

{
    KoSvgText::CssFontStyleData current = d->props.property(KoSvgTextProperties::FontStyleId).value<KoSvgText::CssFontStyleData>();
    if (current.slantValue.isAuto && qFuzzyCompare(fontSlant, 14))
        return;
    if (!current.slantValue.isAuto && qFuzzyCompare(fontSlant, current.slantValue.customValue))
        return;
 
    current.slantValue.customValue = fontSlant;
    current.slantValue.isAuto = false;
    d->props.setProperty(KoSvgTextProperties::FontStyleId, QVariant::fromValue(current));
    emit fontSlantChanged(fontSlant);
}

References KoSvgText::AutoValue::customValue, d, fontSlant, fontSlantChanged(), KoSvgTextProperties::FontStyleId, KoSvgText::AutoValue::isAuto, and KoSvgText::CssFontStyleData::slantValue.

setFontStyle

void SvgTextLabel::setFontStyle ( QFont::Style fontStyle )

slot

Definition at line 184 of file SvgTextLabel.cpp.

{
    KoSvgText::CssFontStyleData current = d->props.property(KoSvgTextProperties::FontStyleId).value<KoSvgText::CssFontStyleData>();
    if (current.style == fontStyle)
        return;
 
    current.style = fontStyle;
    d->props.setProperty(KoSvgTextProperties::FontStyleId, QVariant::fromValue(current));
    emit fontStyleChanged(fontStyle);
}

References d, fontStyle, fontStyleChanged(), KoSvgTextProperties::FontStyleId, and KoSvgText::CssFontStyleData::style.

setFontWeight

void SvgTextLabel::setFontWeight ( qreal fontWeight )

slot

Definition at line 164 of file SvgTextLabel.cpp.

{
    qreal current = d->props.property(KoSvgTextProperties::FontWeightId).toReal();
    if (qFuzzyCompare(current, fontWeight))
        return;
 
    d->props.setProperty(KoSvgTextProperties::FontWeightId, fontWeight);
    emit fontWeightChanged(fontWeight);
}

References d, fontWeight, fontWeightChanged(), KoSvgTextProperties::FontWeightId, and qFuzzyCompare().

setFontWidth

void SvgTextLabel::setFontWidth ( qreal fontWidth )

slot

Definition at line 174 of file SvgTextLabel.cpp.

{
    qreal current = d->props.property(KoSvgTextProperties::FontStretchId).toReal();
    if (qFuzzyCompare(current, fontWidth))
        return;
 
    d->props.setProperty(KoSvgTextProperties::FontStretchId, fontWidth);
    emit fontWidthChanged(fontWidth);
}

References d, KoSvgTextProperties::FontStretchId, fontWidth, fontWidthChanged(), and qFuzzyCompare().

setLanguage

void SvgTextLabel::setLanguage ( QString language )

slot

Definition at line 284 of file SvgTextLabel.cpp.

{
    const QString lang = d->props.property(KoSvgTextProperties::TextLanguage).toString();
    if (lang == language) {
        return;
    }
    d->props.setProperty(KoSvgTextProperties::TextLanguage, language);
    emit languageChanged(language);
}

References d, language, languageChanged(), and KoSvgTextProperties::TextLanguage.

setOpenTypeFeatures

void SvgTextLabel::setOpenTypeFeatures ( QVariantMap openTypeFeatures )

slot

Definition at line 248 of file SvgTextLabel.cpp.

{
    QVariantMap otf = d->props.property(KoSvgTextProperties::FontFeatureSettingsId).toMap();
    if (otf == openTypeFeatures)
        return;
 
    d->props.setProperty(KoSvgTextProperties::FontFeatureSettingsId, QVariant::fromValue(openTypeFeatures));
    emit openTypeFeaturesChanged(openTypeFeatures);
}

References d, KoSvgTextProperties::FontFeatureSettingsId, openTypeFeatures, and openTypeFeaturesChanged().

setPadding

void SvgTextLabel::setPadding ( int padding )

slot

Definition at line 270 of file SvgTextLabel.cpp.

{
    const int currentPadding = (d->leftPadding+d->rightPadding+d->topPadding+d->bottomPadding)/4;
    if (currentPadding == padding)
        return;
 
    d->leftPadding = padding;
    d->rightPadding = padding;
    d->topPadding = padding;
    d->bottomPadding = padding;
    emit paddingChanged(padding);
    emit minimumRectChanged();
}

References d, minimumRectChanged(), padding, and paddingChanged().

setText

void SvgTextLabel::setText ( QString text )

slot

Definition at line 258 of file SvgTextLabel.cpp.

{
    if (d->shape->plainText() == text)
        return;
 
    int length = d->shape->plainText().size();
    int start = 0;
    d->shape->removeText(start, length);
    d->shape->insertText(0, text);
    emit textChanged(d->shape->plainText());
}

References d, length(), text, and textChanged().

setTextColor

void SvgTextLabel::setTextColor ( QColor textColor )

slot

Definition at line 230 of file SvgTextLabel.cpp.

{
    if (d->props.hasProperty(KoSvgTextProperties::FillId)) {
        KoColorBackground *bg = dynamic_cast<KoColorBackground*>(d->shape->background().data());
        if (bg) {
            if (bg->color() == textColor)
                return;
        }
    }
 
    d->shape->setBackground(QSharedPointer<KoColorBackground>(new KoColorBackground(textColor)));
    d->props.setProperty(KoSvgTextProperties::FillId, d->shape->textProperties().property(KoSvgTextProperties::FillId));
    emit textColorChanged(textColor);
    if (!opaquePainting() && isComponentComplete()) {
        update(boundingRect().toAlignedRect());
    }
}

References KoColorBackground::color(), d, KoSvgTextProperties::FillId, textColor, and textColorChanged().

text()

QString SvgTextLabel::text

(

)

const

Definition at line 139 of file SvgTextLabel.cpp.

{
    return d->shape->plainText();
}

References d.

textChanged

void SvgTextLabel::textChanged ( QString text )

signal

textColor()

QColor SvgTextLabel::textColor

(

)

const

Definition at line 125 of file SvgTextLabel.cpp.

{
    KoColorBackground *bg = dynamic_cast<KoColorBackground*>(d->shape->background().data());
    if (bg) {
        return bg->color();
    }
    return Qt::black;
}

References KoColorBackground::color(), and d.

textColorChanged

void SvgTextLabel::textColorChanged ( QColor textColor )

signal

updateShape

void SvgTextLabel::updateShape ( )

privateslot

Definition at line 322 of file SvgTextLabel.cpp.

{
    if (d->shape->textProperties() == d->props) {
        return;
    }
    d->shape->setPropertiesAtPos(-1, d->props);
    d->shape->relayout();
    if (!d->addedShapeToPainter && d->shapePainter && !d->shape->boundingRect().isEmpty()) {
        d->shapePainter->setShapes({d->shape.data()});
        d->addedShapeToPainter = true;
    }
    if (isVisible()) {
        update(boundingRect().toAlignedRect());
    }
    emit minimumRectChanged();
}

References d, and minimumRectChanged().

Member Data Documentation

addedShapeToPainter

bool SvgTextLabel::addedShapeToPainter = false

Definition at line 41 of file SvgTextLabel.cpp.

bottomPadding

int SvgTextLabel::bottomPadding = 2

Definition at line 37 of file SvgTextLabel.cpp.

d

const QScopedPointer<Private> SvgTextLabel::d

private

Definition at line 136 of file SvgTextLabel.h.

leftPadding

int SvgTextLabel::leftPadding = 2

Definition at line 38 of file SvgTextLabel.cpp.

props

KoSvgTextProperties SvgTextLabel::props

Definition at line 34 of file SvgTextLabel.cpp.

rightPadding

int SvgTextLabel::rightPadding = 2

Definition at line 39 of file SvgTextLabel.cpp.

shape

QScopedPointer<KoSvgTextShape> SvgTextLabel::shape

Definition at line 26 of file SvgTextLabel.cpp.

shapePainter

QScopedPointer<KoShapePainter> SvgTextLabel::shapePainter

The shape painter is initialized only after QML item loading is completed

Definition at line 32 of file SvgTextLabel.cpp.

topPadding

int SvgTextLabel::topPadding = 2

Definition at line 36 of file SvgTextLabel.cpp.

Property Documentation

fontAxesValues

QVariantMap SvgTextLabel::fontAxesValues

readwrite

Definition at line 30 of file SvgTextLabel.h.

fontFamilies

QML_ELEMENTQStringList SvgTextLabel::fontFamilies

readwrite

Definition at line 25 of file SvgTextLabel.h.

fontSize

qreal SvgTextLabel::fontSize

readwrite

Definition at line 31 of file SvgTextLabel.h.

fontSlant

qreal SvgTextLabel::fontSlant

readwrite

Definition at line 29 of file SvgTextLabel.h.

fontStyle

QFont::Style SvgTextLabel::fontStyle

readwrite

Definition at line 28 of file SvgTextLabel.h.

fontWeight

qreal SvgTextLabel::fontWeight

readwrite

Definition at line 26 of file SvgTextLabel.h.

fontWidth

qreal SvgTextLabel::fontWidth

readwrite

Definition at line 27 of file SvgTextLabel.h.

language

QString SvgTextLabel::language

readwrite

Definition at line 36 of file SvgTextLabel.h.

minimumRect

QRectF SvgTextLabel::minimumRect

read

Definition at line 37 of file SvgTextLabel.h.

openTypeFeatures

QVariantMap SvgTextLabel::openTypeFeatures

readwrite

Definition at line 33 of file SvgTextLabel.h.

padding

int SvgTextLabel::padding

readwrite

Definition at line 35 of file SvgTextLabel.h.

text

QString SvgTextLabel::text

readwrite

Definition at line 34 of file SvgTextLabel.h.

textColor

QColor SvgTextLabel::textColor

readwrite

Definition at line 32 of file SvgTextLabel.h.

---

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

• qmlmodules/components/SvgTextLabel.cpp
• qmlmodules/components/SvgTextLabel.h