KoFilterEffectFactoryBase Class Reference

API docs go here. More...

#include <KoFilterEffectFactoryBase.h>

Inheritance diagram for KoFilterEffectFactoryBase:

Public Member Functions
virtual KoFilterEffectConfigWidgetBase *	createConfigWidget () const =0
virtual KoFilterEffect *	createFilterEffect () const =0
QString	id () const
	KoFilterEffectFactoryBase (const QString &id, const QString &name)
QString	name () const
	Private (const QString &_id, const QString &_name)
virtual	~KoFilterEffectFactoryBase ()

Public Attributes
const QString	id
const QString	name

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

API docs go here.

Definition at line 10 of file KoFilterEffectFactoryBase.cpp.

Constructor & Destructor Documentation

KoFilterEffectFactoryBase()

KoFilterEffectFactoryBase::KoFilterEffectFactoryBase	(	const QString &	id,
		const QString &	name )

Create the new factory

Parameters

id	a string that will be used internally for referencing the filter effect
name	the user visible name of the filter effect this factory creates

Definition at line 20 of file KoFilterEffectFactoryBase.cpp.

    : d(new Private(id, name))
{
}

~KoFilterEffectFactoryBase()

KoFilterEffectFactoryBase::~KoFilterEffectFactoryBase ( )

virtual

Definition at line 25 of file KoFilterEffectFactoryBase.cpp.

{
    delete d;
}

References d.

Member Function Documentation

createConfigWidget()

virtual KoFilterEffectConfigWidgetBase * KoFilterEffectFactoryBase::createConfigWidget ( ) const

pure virtual

This method should be implemented by factories to create a filter effect config widget.

Returns

the filter effect options widget

createFilterEffect()

virtual KoFilterEffect * KoFilterEffectFactoryBase::createFilterEffect ( ) const

pure virtual

This method should be implemented by factories to create a filter effect.

Returns

a new filter effect

id()

QString KoFilterEffectFactoryBase::id

(

)

const

Returns the id for the filter this factory creates.

Returns

the id for the filter this factory creates

name()

QString KoFilterEffectFactoryBase::name

(

)

const

Returns the user visible (and translated) name to be seen by the user.

Returns

the user visible (and translated) name to be seen by the user

Private()

KoFilterEffectFactoryBase::Private ( const QString & _id, const QString & _name )

inline

Definition at line 13 of file KoFilterEffectFactoryBase.cpp.

                                                      : id(_id), name(_name)
    {
    }

Member Data Documentation

d

Private* const KoFilterEffectFactoryBase::d

private

Definition at line 55 of file KoFilterEffectFactoryBase.h.

id

QString KoFilterEffectFactoryBase::id

Definition at line 16 of file KoFilterEffectFactoryBase.cpp.

name

QString KoFilterEffectFactoryBase::name

Definition at line 17 of file KoFilterEffectFactoryBase.cpp.

---

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

• libs/flake/KoFilterEffectFactoryBase.cpp
• libs/flake/KoFilterEffectFactoryBase.h