#include <kis_simple_paintop_factory.h>

Inheritance diagram for KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >:

Public Member Functions
QString	category () const override

KisPaintOpConfigWidget *	createConfigWidget (QWidget *parent, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface) override

KisInterstrokeDataFactory *	createInterstrokeDataFactory (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface) const override

KisPaintOp *	createOp (const KisPaintOpSettingsSP settings, KisPainter *painter, KisNodeSP node, KisImageSP image) override

KisPaintOpSettingsSP	createSettings (KisResourcesInterfaceSP resourcesInterface) override

QIcon	icon () override
	icon

QString	id () const override

	KisSimplePaintOpFactory (const QString &id, const QString &name, const QString &category, const QString &pixmap, const QString &model=QString(), const QStringList &whiteListedCompositeOps=QStringList(), int priority=100, bool lodSizeThresholdSupported=true)

bool	lodSizeThresholdSupported () const override

QString	name () const override

QList< KoResourceLoadResult >	prepareEmbeddedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface) override

QList< KoResourceLoadResult >	prepareLinkedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface) override

	~KisSimplePaintOpFactory () override

Public Member Functions inherited from KisPaintOpFactory
	KisPaintOpFactory (const QStringList &whiteListedCompositeOps=QStringList())

int	priority () const

void	setPriority (int newPriority)

QStringList	whiteListedCompositeOps () const

	~KisPaintOpFactory () override

Private Attributes
QString	m_category

QString	m_id

bool	m_lodSizeThresholdSupported

QString	m_model

QString	m_name

QString	m_pixmap

Additional Inherited Members
Public Types inherited from KisPaintOpFactory
enum	PaintopVisibility { AUTO , ALWAYS , NEVER }

Static Public Member Functions inherited from KisPaintOpFactory
static QString	categoryStable ()

Detailed Description

template<class Op, class OpSettings, class OpSettingsWidget>
class KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >

Base template class for simple paintop factories

Definition at line 157 of file kis_simple_paintop_factory.h.

Constructor & Destructor Documentation

◆ KisSimplePaintOpFactory()

template<class Op , class OpSettings , class OpSettingsWidget >

KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::KisSimplePaintOpFactory	(	const QString &	id,
		const QString &	name,
		const QString &	category,
		const QString &	pixmap,
		const QString &	model = QString(),
		const QStringList &	whiteListedCompositeOps = QStringList(),
		int	priority = 100,
		bool	lodSizeThresholdSupported = true )

inline

Definition at line 162 of file kis_simple_paintop_factory.h.

        : KisPaintOpFactory(whiteListedCompositeOps)
        , m_id(id)
        , m_name(name)
        , m_category(category)
        , m_pixmap(pixmap)
        , m_model(model)
        , m_lodSizeThresholdSupported(lodSizeThresholdSupported)
    {
        setPriority(priority);
    }

References KisPaintOpFactory::priority(), and KisPaintOpFactory::setPriority().

◆ ~KisSimplePaintOpFactory()

template<class Op , class OpSettings , class OpSettingsWidget >

KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::~KisSimplePaintOpFactory ( )

inlineoverride

Definition at line 177 of file kis_simple_paintop_factory.h.

177 {

178 }

Member Function Documentation

◆ category()

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::category ( ) const

inlineoverridevirtual

Implements KisPaintOpFactory.

Definition at line 226 of file kis_simple_paintop_factory.h.

                                      {
        return m_category;
    }

References KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_category.

◆ createConfigWidget()

template<class Op , class OpSettings , class OpSettingsWidget >

KisPaintOpConfigWidget * KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::createConfigWidget	(	QWidget *	parent,
		KisResourcesInterfaceSP	resourcesInterface,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface )

inlineoverridevirtual

create a widget that can display paintop settings

Implements KisPaintOpFactory.

Definition at line 210 of file kis_simple_paintop_factory.h.

                                                                                                                                                                            {
        return detail::createConfigWidget<OpSettingsWidget>(parent, resourcesInterface, canvasResourcesInterface);
    }

◆ createInterstrokeDataFactory()

template<class Op , class OpSettings , class OpSettingsWidget >

KisInterstrokeDataFactory * KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::createInterstrokeDataFactory	(	const KisPaintOpSettingsSP	settings,
		KisResourcesInterfaceSP	resourcesInterface ) const

inlineoverridevirtual

Reimplemented from KisPaintOpFactory.

Definition at line 200 of file kis_simple_paintop_factory.h.

                                                                                                                                                            {
        return detail::createInterstrokeDataFactory<Op>(settings, resourcesInterface);
    }

◆ createOp()

template<class Op , class OpSettings , class OpSettingsWidget >

KisPaintOp * KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::createOp	(	const KisPaintOpSettingsSP	settings,
		KisPainter *	painter,
		KisNodeSP	node,
		KisImageSP	image )

inlineoverridevirtual

Create a KisPaintOp with the given settings and painter.

Parameters

settings	the settings associated with the input device
painter	the painter used to draw
node	the node used to draw
image	the image used to draw

Implements KisPaintOpFactory.

Definition at line 186 of file kis_simple_paintop_factory.h.

                                                                                                                              {
        KisPaintOp * op = new Op(settings, painter, node, image);
        Q_CHECK_PTR(op);
        return op;
    }

◆ createSettings()

template<class Op , class OpSettings , class OpSettingsWidget >

KisPaintOpSettingsSP KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::createSettings ( KisResourcesInterfaceSP resourcesInterface )

inlineoverridevirtual

Create and return an settings object for this paintop.

Implements KisPaintOpFactory.

Definition at line 204 of file kis_simple_paintop_factory.h.

                                                                                             {
        KisPaintOpSettingsSP settings = new OpSettings(resourcesInterface);
        settings->setModelName(m_model);
        return settings;
    }

References KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_model.

◆ icon()

template<class Op , class OpSettings , class OpSettingsWidget >

QIcon KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::icon ( )

inlineoverridevirtual

icon

Returns: the icon to represent this paintop.

Reimplemented from KisPaintOpFactory.

Definition at line 222 of file kis_simple_paintop_factory.h.

                          {
        return KisIconUtils::loadIcon(id());
    }

References KisIconUtils::loadIcon().

◆ id()

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::id ( ) const

inlineoverridevirtual

Implements KisPaintOpFactory.

Definition at line 214 of file kis_simple_paintop_factory.h.

                                {
        return m_id;
    }

References KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_id.

◆ lodSizeThresholdSupported()

template<class Op , class OpSettings , class OpSettingsWidget >

bool KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::lodSizeThresholdSupported ( ) const

inlineoverridevirtual

Implements KisPaintOpFactory.

Definition at line 230 of file kis_simple_paintop_factory.h.

                                                    {
        return m_lodSizeThresholdSupported;
    }

References KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_lodSizeThresholdSupported.

◆ name()

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::name ( ) const

inlineoverridevirtual

Implements KisPaintOpFactory.

Definition at line 218 of file kis_simple_paintop_factory.h.

                                  {
        return m_name;
    }

References KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_name.

◆ prepareEmbeddedResources()

template<class Op , class OpSettings , class OpSettingsWidget >

QList< KoResourceLoadResult > KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::prepareEmbeddedResources	(	const KisPaintOpSettingsSP	settings,
		KisResourcesInterfaceSP	resourcesInterface )

inlineoverridevirtual

Returns: all the resources embedded into settings. The resources are first tried to be loaded from resourcesInterface, and, if it fails, loaded from the embedded data.

Implements KisPaintOpFactory.

Definition at line 196 of file kis_simple_paintop_factory.h.

                                                                                                                                                   {
        return detail::prepareEmbeddedResources<Op>(settings, resourcesInterface);
    }

◆ prepareLinkedResources()

template<class Op , class OpSettings , class OpSettingsWidget >

QList< KoResourceLoadResult > KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::prepareLinkedResources	(	const KisPaintOpSettingsSP	settings,
		KisResourcesInterfaceSP	resourcesInterface )

inlineoverridevirtual

Returns: all the resources linked to settings.

Implements KisPaintOpFactory.

Definition at line 192 of file kis_simple_paintop_factory.h.

                                                                                                                                                 {
        return detail::prepareLinkedResources<Op>(settings, resourcesInterface);
    }

Member Data Documentation

◆ m_category

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_category

private

Definition at line 237 of file kis_simple_paintop_factory.h.

◆ m_id

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_id

private

Definition at line 235 of file kis_simple_paintop_factory.h.

◆ m_lodSizeThresholdSupported

template<class Op , class OpSettings , class OpSettingsWidget >

bool KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_lodSizeThresholdSupported

private

Definition at line 240 of file kis_simple_paintop_factory.h.

◆ m_model

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_model

private

Definition at line 239 of file kis_simple_paintop_factory.h.

◆ m_name

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_name

private

Definition at line 236 of file kis_simple_paintop_factory.h.

◆ m_pixmap

template<class Op , class OpSettings , class OpSettingsWidget >

QString KisSimplePaintOpFactory< Op, OpSettings, OpSettingsWidget >::m_pixmap

private

Definition at line 238 of file kis_simple_paintop_factory.h.

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

plugins/paintops/libpaintop/kis_simple_paintop_factory.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisSimplePaintOpFactory()

◆ ~KisSimplePaintOpFactory()

Member Function Documentation

◆ category()

◆ createConfigWidget()

◆ createInterstrokeDataFactory()

◆ createOp()

◆ createSettings()

◆ icon()

◆ id()

◆ lodSizeThresholdSupported()

◆ name()

◆ prepareEmbeddedResources()

◆ prepareLinkedResources()

Member Data Documentation

◆ m_category

◆ m_id

◆ m_lodSizeThresholdSupported

◆ m_model

◆ m_name

◆ m_pixmap