KisTextBrushFactory Class Reference

#include <kis_text_brush_factory.h>

Inheritance diagram for KisTextBrushFactory:

Public Member Functions
KoResourceLoadResult	createBrush (const KisBrushModel::BrushData &data, KisResourcesInterfaceSP resourcesInterface) override
KoResourceLoadResult	createBrush (const QDomElement &brushDefinition, KisResourcesInterfaceSP resourcesInterface) override
std::optional< KisBrushModel::BrushData >	createBrushModel (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface) override
QString	id () const override
	KisTextBrushFactory ()
void	toXML (QDomDocument &doc, QDomElement &element, const KisBrushModel::BrushData &model) override
	~KisTextBrushFactory () override
Public Member Functions inherited from KisBrushFactory
	KisBrushFactory ()
virtual QString	name () const
virtual	~KisBrushFactory ()

Detailed Description

A brush factory can create a new brush instance based on a properties object that contains a serialized representation of the object.

Definition at line 19 of file kis_text_brush_factory.h.

Constructor & Destructor Documentation

KisTextBrushFactory()

KisTextBrushFactory::KisTextBrushFactory ( )

inline

Definition at line 24 of file kis_text_brush_factory.h.

{}

~KisTextBrushFactory()

KisTextBrushFactory::~KisTextBrushFactory ( )

inlineoverride

Definition at line 25 of file kis_text_brush_factory.h.

{}

Member Function Documentation

createBrush() [1/2]

KoResourceLoadResult KisTextBrushFactory::createBrush ( const KisBrushModel::BrushData & data, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KisBrushFactory.

Definition at line 27 of file kis_text_brush_factory.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    KisTextBrushSP brush = KisTextBrushSP(new KisTextBrush());
 
    QFont font;
    font.fromString(data.textBrush.font);
 
    brush->setText(data.textBrush.text);
    brush->setFont(font);
    brush->setPipeMode(data.textBrush.usePipeMode);
    brush->setSpacing(data.common.spacing);
    brush->updateBrush();
 
    return brush;
}

References KisBrushModel::BrushData::common, KisBrushModel::TextBrushData::font, KisBrushModel::CommonData::spacing, KisBrushModel::TextBrushData::text, KisBrushModel::BrushData::textBrush, and KisBrushModel::TextBrushData::usePipeMode.

createBrush() [2/2]

KoResourceLoadResult KisTextBrushFactory::createBrush ( const QDomElement & brushDefinition, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Create a new brush from the given data or return an existing KisBrush object. If this call leads to the creation of a resource, it should be added to the resource provider, too.

Implements KisBrushFactory.

Definition at line 14 of file kis_text_brush_factory.cpp.

{
    std::optional<KisBrushModel::BrushData> data =
        createBrushModel(brushDefinition, resourcesInterface);
 
    if (data) {
        return createBrush(*data, resourcesInterface);
    }
 
    // fallback, should never reach!
    return KoResourceSignature(ResourceType::Brushes, "", "", "");
}

References ResourceType::Brushes, createBrush(), and createBrushModel().

createBrushModel()

std::optional< KisBrushModel::BrushData > KisTextBrushFactory::createBrushModel ( const QDomElement & element, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KisBrushFactory.

Definition at line 46 of file kis_text_brush_factory.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    KisBrushModel::BrushData brush;
 
    brush.type = KisBrushModel::Text;
 
    brush.common.spacing = KisDomUtils::toDouble(element.attribute("spacing", "1.0"));
 
    // TODO: these options are not yet present in the file format for the text brush!
    //brush.common.angle = KisDomUtils::toDouble(brushDefinition.attribute("angle", "0.0"));
    //brush.common.useAutoSpacing = KisDomUtils::toInt(brushDefinition.attribute("useAutoSpacing", "0"));
    //brush.common.autoSpacingCoeff = KisDomUtils::toDouble(brushDefinition.attribute("autoSpacingCoeff", "1.0"));
 
    brush.textBrush.text = element.attribute("text", "The quick brown fox ate your text");
    brush.textBrush.font = element.attribute("font");
    brush.textBrush.usePipeMode = element.attribute("pipe", "false") == "true";
 
    // TODO: how to get the size of the brush without its creation? lazy evaluation?
    // brush.textBrush.baseSize = {66, 77};
 
    brush.textBrush.scale = 1.0;
 
    return {brush};
}

References KisBrushModel::BrushData::common, KisBrushModel::TextBrushData::font, KisBrushModel::TextBrushData::scale, KisBrushModel::CommonData::spacing, KisBrushModel::TextBrushData::text, KisBrushModel::Text, KisBrushModel::BrushData::textBrush, KisDomUtils::toDouble(), KisBrushModel::BrushData::type, and KisBrushModel::TextBrushData::usePipeMode.

id()

QString KisTextBrushFactory::id ( ) const

inlineoverridevirtual

Implements KisBrushFactory.

Definition at line 27 of file kis_text_brush_factory.h.

                                {
        return "kis_text_brush";
    }

toXML()

void KisTextBrushFactory::toXML ( QDomDocument & doc, QDomElement & element, const KisBrushModel::BrushData & model )

overridevirtual

Implements KisBrushFactory.

Definition at line 73 of file kis_text_brush_factory.cpp.

{
    Q_UNUSED(doc);
 
    e.setAttribute("type", id());
    e.setAttribute("BrushVersion", "2");
 
    e.setAttribute("spacing", KisDomUtils::toString(model.common.spacing));
    e.setAttribute("text", model.textBrush.text);
    e.setAttribute("font", model.textBrush.font);
    e.setAttribute("pipe", model.textBrush.usePipeMode ? "true" : "false");
    // TODO: scale is not saved
}

References KisBrushModel::BrushData::common, KisBrushModel::TextBrushData::font, KisBrushModel::CommonData::spacing, KisBrushModel::TextBrushData::text, KisBrushModel::BrushData::textBrush, KisDomUtils::toString(), and KisBrushModel::TextBrushData::usePipeMode.

---

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

• libs/brush/kis_text_brush_factory.h
• libs/brush/kis_text_brush_factory.cpp