KisBrushFactory Class Reference

#include <kis_brush_factory.h>

Inheritance diagram for KisBrushFactory:

Public Member Functions
virtual KoResourceLoadResult	createBrush (const KisBrushModel::BrushData &data, KisResourcesInterfaceSP resourcesInterface)=0
virtual KoResourceLoadResult	createBrush (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)=0
virtual std::optional< KisBrushModel::BrushData >	createBrushModel (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)=0
virtual QString	id () const =0
	KisBrushFactory ()
virtual QString	name () const
virtual void	toXML (QDomDocument &doc, QDomElement &element, const KisBrushModel::BrushData &model)=0
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_brush_factory.h.

Constructor & Destructor Documentation

KisBrushFactory()

KisBrushFactory::KisBrushFactory ( )

inline

Definition at line 24 of file kis_brush_factory.h.

{}

~KisBrushFactory()

virtual KisBrushFactory::~KisBrushFactory ( )

inlinevirtual

Definition at line 25 of file kis_brush_factory.h.

{}

Member Function Documentation

createBrush() [1/2]

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

pure virtual

Implemented in KisPredefinedBrushFactory, KisAutoBrushFactory, and KisTextBrushFactory.

createBrush() [2/2]

virtual KoResourceLoadResult KisBrushFactory::createBrush ( const QDomElement & element, KisResourcesInterfaceSP resourcesInterface )

pure virtual

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.

Implemented in KisAutoBrushFactory, KisPredefinedBrushFactory, and KisTextBrushFactory.

createBrushModel()

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

pure virtual

Implemented in KisAutoBrushFactory, KisPredefinedBrushFactory, and KisTextBrushFactory.

id()

virtual QString KisBrushFactory::id ( ) const

pure virtual

Implemented in KisAutoBrushFactory, KisPredefinedBrushFactory, and KisTextBrushFactory.

name()

virtual QString KisBrushFactory::name ( ) const

inlinevirtual

Definition at line 30 of file kis_brush_factory.h.

                                 {
        return QString();
    }

toXML()

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

pure virtual

Implemented in KisAutoBrushFactory, KisPredefinedBrushFactory, and KisTextBrushFactory.

---

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

• libs/brush/kis_brush_factory.h