#include <KoShapeFactoryBase.h>

Inheritance diagram for KoShapeFactoryBase:

Public Member Functions
virtual KoShape *	createDefaultShape (KoDocumentResourceManager *documentResources=0) const

virtual KoShape *	createShape (const KoProperties params, KoDocumentResourceManager documentResources=0) const

virtual QList< KoShapeConfigWidgetBase * >	createShapeOptionPanels ()

QString	family () const

bool	hidden () const

QString	iconName () const

QString	id () const

	KoShapeFactoryBase (const QString &id, const QString &name, const QString &deferredPluginName=QString())

int	loadingPriority () const
	lower prio means the shape is more generic and will be checked later

QString	name () const

virtual void	newDocumentResourceManager (KoDocumentResourceManager *manager) const

QList< QPair< QString, QStringList > >	odfElements () const

	Private (const QString &_id, const QString &_name, const QString &_deferredPluginName)

virtual bool	supports (const QDomElement &element, KoShapeLoadingContext &context) const =0

QList< KoShapeTemplate >	templates () const

QString	toolTip () const

	~KoShapeFactoryBase () override

	~Private ()

Public Attributes
KoDeferredShapeFactoryBase *	deferredFactory

QString	deferredPluginName

QString	family

bool	hidden

QString	iconName

const QString	id

int	loadingPriority

const QString	name

QMutex	pluginLoadingMutex

QList< QPointer< KoDocumentResourceManager > >	resourceManagers

QList< KoShapeTemplate >	templates

QString	tooltip

QList< QPair< QString, QStringList > >	xmlElements

Protected Member Functions
void	addTemplate (const KoShapeTemplate &params)

void	setFamily (const QString &family)

void	setHidden (bool hidden)

void	setIconName (const char *iconName)

void	setLoadingPriority (int priority)

void	setToolTip (const QString &tooltip)

void	setXmlElementNames (const QString &nameSpace, const QStringList &elementNames)

void	setXmlElements (const QList< QPair< QString, QStringList > > &elementNamesList)

Private Slots
void	pruneDocumentResourceManager (QObject *)
	called whenever a document KoDocumentResourceManager is deleted

Private Member Functions
void	getDeferredPlugin ()

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

A factory for KoShape objects. The baseclass for all shape plugins. Each plugin that ships a KoShape should also ship a factory. That factory will extend this class and set variable data like a toolTip and icon in the constructor of that extending class.

An example usage would be:

class MyShapeFactory : public KoShapeFactoryBase {
public:
    MyShapeFactory()
        : KoShapeFactoryBase("MyShape", i18n("My Shape")) {
        setToolTip(i18n("A nice shape"));
    }
    ~MyShapeFactory() {}
    // more methods here
};

After you created the factory you should create a plugin that can announce the factory to the KoShapeRegistry. See the KoPluginLoader as well.

Definition at line 31 of file KoShapeFactoryBase.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoShapeFactoryBase::~Private ( )

inline

Definition at line 44 of file KoShapeFactoryBase.cpp.

               {
        Q_FOREACH (const KoShapeTemplate & t, templates)
            delete t.properties;
        templates.clear();
    }

References KoShapeTemplate::properties.

◆ KoShapeFactoryBase()

KoShapeFactoryBase::KoShapeFactoryBase	(	const QString &	id,
		const QString &	name,
		const QString &	deferredPluginName = QString() )

Create the new factory

Parameters

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

Definition at line 66 of file KoShapeFactoryBase.cpp.

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

◆ ~KoShapeFactoryBase()

KoShapeFactoryBase::~KoShapeFactoryBase ( )

override

Definition at line 71 of file KoShapeFactoryBase.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addTemplate()

void KoShapeFactoryBase::addTemplate ( const KoShapeTemplate & params )

protected

Add a template with the properties of a specific type of shape this factory can generate using the createShape() method. The factory will take ownership of the properties object to which the member properties of params points to and destroy it only in its own destructor.

Parameters

params the new template this factory knows to produce

Definition at line 106 of file KoShapeFactoryBase.cpp.

{
    KoShapeTemplate tmplate = params;
    tmplate.id = d->id;
    d->templates.append(tmplate);
}

References d, and KoShapeTemplate::id.

◆ createDefaultShape()

KoShape * KoShapeFactoryBase::createDefaultShape ( KoDocumentResourceManager * documentResources = 0 ) const

virtual

This method should be implemented by factories to create a shape that the user gets when doing a base insert. For example from a script. The created shape should have its values set to good defaults that the user can then adjust further if needed. Including the KoShape:setShapeId(), with the Id from this factory The default shape position is not relevant, it will be moved by the caller.

Parameters

documentResources the resources manager that has all the document wide resources which can be used to create the object.

Returns: a new shape

See also: createShape() newDocumentResourceManager()

Reimplemented in KoPathShapeFactory, KoSvgTextShapeFactory, KisShapeSelectionFactory, ImageShapeFactory, EllipseShapeFactory, EnhancedPathShapeFactory, RectangleShapeFactory, SpiralShapeFactory, StarShapeFactory, and KarbonCalligraphicShapeFactory.

Definition at line 170 of file KoShapeFactoryBase.cpp.

{
    if (!d->deferredPluginName.isEmpty()) {
        const_cast<KoShapeFactoryBase*>(this)->getDeferredPlugin();
        Q_ASSERT(d->deferredFactory);
        if (d->deferredFactory) {
            return d->deferredFactory->createDefaultShape(documentResources);
        }
    }
    return 0;
}

References d, and getDeferredPlugin().

◆ createShape()

KoShape * KoShapeFactoryBase::createShape	(	const KoProperties *	params,
		KoDocumentResourceManager *	documentResources = 0 ) const

virtual

This method should be implemented by factories to create a shape based on a set of properties that are specifically made for this shape-type. This method should also set this factories shapeId on the shape using KoShape::setShapeId() The default implementation just ignores 'params' and calls createDefaultShape()

Returns: a new shape

Parameters

params	the parameters to use when creating the shape
documentResources	the resources manager that has all the document wide resources which can be used to create the object.

See also: createDefaultShape() newDocumentResourceManager() addTemplate(); KoShapeTemplate::properties

Reimplemented in ImageShapeFactory, KoSvgTextShapeFactory, EnhancedPathShapeFactory, RectangleShapeFactory, and StarShapeFactory.

Definition at line 182 of file KoShapeFactoryBase.cpp.

{
    if (!d->deferredPluginName.isEmpty()) {
        const_cast<KoShapeFactoryBase*>(this)->getDeferredPlugin();
        Q_ASSERT(d->deferredFactory);
        if (d->deferredFactory) {
            return d->deferredFactory->createShape(properties, documentResources);
        }
    }
    return createDefaultShape(documentResources);
}

References createDefaultShape(), d, and getDeferredPlugin().

◆ createShapeOptionPanels()

virtual QList< KoShapeConfigWidgetBase * > KoShapeFactoryBase::createShapeOptionPanels ( )

inlinevirtual

Create a list of option panels to show on creating a new shape. The shape type this factory creates may have general or specific setting panels that will be shown after inserting a new shape. The first item in the list will be shown as the first tab in the list of panels, behind all app specific panels. This is a separate list as set by setOptionPanels() and fetched by panelFactories()

Reimplemented in ImageShapeFactory, EllipseShapeFactory, RectangleShapeFactory, SpiralShapeFactory, and StarShapeFactory.

Definition at line 95 of file KoShapeFactoryBase.h.

                                                                      {
        return QList<KoShapeConfigWidgetBase*>();
    }

◆ family()

QString KoShapeFactoryBase::family ( ) const

return the non-visible name of the family the default shape belongs to.

Returns: the family name.

◆ getDeferredPlugin()

void KoShapeFactoryBase::getDeferredPlugin ( )

private

Definition at line 195 of file KoShapeFactoryBase.cpp.

{
    QMutexLocker(&d->pluginLoadingMutex);
    if (d->deferredFactory) return;
 
    const QList<KoJsonTrader::Plugin> offers =
        KoJsonTrader::instance()->query("Krita/Deferred", QString());
    Q_ASSERT(offers.size() > 0);
 
    Q_FOREACH (const KoJsonTrader::Plugin &pluginLoader, offers) {
        KPluginFactory *factory = qobject_cast<KPluginFactory *>(pluginLoader.instance());
        KoDeferredShapeFactoryBase *plugin = factory->create<KoDeferredShapeFactoryBase>(this, QVariantList());
 
        if (plugin && plugin->deferredPluginName() == d->deferredPluginName) {
            d->deferredFactory = plugin;
        }
    }
}

References d, KoDeferredShapeFactoryBase::deferredPluginName(), KoJsonTrader::instance(), KoJsonTrader::Plugin::instance(), and KoJsonTrader::query().

◆ hidden()

bool KoShapeFactoryBase::hidden ( ) const

The hidden boolean requests if the shape should be hidden in the shape selector or shown with all its templates. The default is false

See also: setHidden()

◆ iconName()

QString KoShapeFactoryBase::iconName ( ) const

return the basename of the icon for a selector of shapes

Returns: the basename of the icon for a selector of shapes

◆ id()

QString KoShapeFactoryBase::id ( ) const

return the id for the shape this factory creates.

Returns: the id for the shape this factory creates.

◆ loadingPriority()

int KoShapeFactoryBase::loadingPriority ( ) const

lower prio means the shape is more generic and will be checked later

◆ name()

QString KoShapeFactoryBase::name ( ) const

return 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.

◆ newDocumentResourceManager()

void KoShapeFactoryBase::newDocumentResourceManager ( KoDocumentResourceManager * manager ) const

virtual

This method is called whenever there is a new document resource manager that is created. The factory may reimplement this in order to get existing resources or put factory specific resources in. In case the factory creates new resources it is advised to parent them to the manager (which is a QObject) for memory management purposes.

FIXME: this method is only used by Tables. We should refactor so it is no longer necessary.

NOTE: this actually is also used somehow to create the image collection for the picture shape?

NOTE: we store the documentmanagers in a list, and remove them from the list on delete.

Parameters

manager the new manager

Reimplemented in KoPathShapeFactory.

Definition at line 164 of file KoShapeFactoryBase.cpp.

{
    d->resourceManagers.append(manager);
    connect(manager, SIGNAL(destroyed(QObject*)), this, SLOT(pruneDocumentResourceManager(QObject*)));
}

References connect(), d, and pruneDocumentResourceManager().

◆ odfElements()

QList< QPair< QString, QStringList > > KoShapeFactoryBase::odfElements ( ) const

The list of namespaces to the supported elements the factory supports.

Definition at line 101 of file KoShapeFactoryBase.cpp.

{
    return d->xmlElements;
}

References d.

◆ Private()

KoShapeFactoryBase::Private	(	const QString &	_id,
		const QString &	_name,
		const QString &	_deferredPluginName )

inline

Definition at line 34 of file KoShapeFactoryBase.cpp.

        : deferredFactory(0),
          deferredPluginName(_deferredPluginName),
          id(_id),
          name(_name),
          loadingPriority(0),
          hidden(false)
    {
    }

◆ pruneDocumentResourceManager

void KoShapeFactoryBase::pruneDocumentResourceManager ( QObject * )

privateslot

called whenever a document KoDocumentResourceManager is deleted

Definition at line 214 of file KoShapeFactoryBase.cpp.

{
    QList<QPointer<KoDocumentResourceManager> > rms;
    Q_FOREACH(QPointer<KoDocumentResourceManager> rm, d->resourceManagers) {
        if (rm) {
            rms << rm;
        }
    }
    d->resourceManagers = rms;
}

References d.

◆ setFamily()

void KoShapeFactoryBase::setFamily ( const QString & family )

protected

Set the family name of the default shape

Parameters

family the family name of the default shape this factory creates. for example "funny", "arrows", "geometrics". Use "" for default

Definition at line 123 of file KoShapeFactoryBase.cpp.

{
    d->family = family;
}

References d, and family.

◆ setHidden()

void KoShapeFactoryBase::setHidden ( bool hidden )

protected

The hidden boolean requests if the shape should be hidden in the shape selector or shown with all its templates. The default is false

See also: hidden()

Definition at line 159 of file KoShapeFactoryBase.cpp.

{
    d->hidden = hidden;
}

References d, and hidden.

◆ setIconName()

void KoShapeFactoryBase::setIconName ( const char * iconName )

protected

Set an icon to be used in a selector of shapes

Parameters

iconName the basename (without extension) of the icon

Definition at line 118 of file KoShapeFactoryBase.cpp.

{
    d->iconName = QLatin1String(iconName);
}

References d, and iconName.

◆ setLoadingPriority()

void KoShapeFactoryBase::setLoadingPriority ( int priority )

protected

Set the loading priority for this icon; higher priority means the shape is more specific which means it will be earlier in the queue to try loading a particular odf element.

Definition at line 138 of file KoShapeFactoryBase.cpp.

{
    d->loadingPriority = priority;
}

References d.

◆ setToolTip()

void KoShapeFactoryBase::setToolTip ( const QString & tooltip )

protected

Set the tooltip to be used for a selector of shapes

Parameters

tooltip the tooltip

Definition at line 113 of file KoShapeFactoryBase.cpp.

{
    d->tooltip = tooltip;
}

References d, and tooltip.

◆ setXmlElementNames()

void KoShapeFactoryBase::setXmlElementNames	(	const QString &	nameSpace,
		const QStringList &	elementNames )

protected

Set the namespace and element tags used for quick checking whether this shapefactory is able to create a shape from xml identified by this element name.

Parameters

nameSpace	the ODF name space (like urn:oasis:names:tc:opendocument:xmlns:text:1.0, take it from KoXmlNS.h)
elementNames	the name of the element itself, like "path"

Definition at line 143 of file KoShapeFactoryBase.cpp.

{
    d->xmlElements.clear();
    d->xmlElements.append(QPair<QString, QStringList>(nameSpace, names));
}

References d.

◆ setXmlElements()

void KoShapeFactoryBase::setXmlElements ( const QList< QPair< QString, QStringList > > & elementNamesList )

protected

Set the namespaces and according element tags used for quick checking whether this shapefactory is able to create a shape from xml identified by this element name.

Parameters

elementNamesList containing a list of namespace (like urn:oasis:names:tc:opendocument:xmlns:text:1.0, take it from KoXmlNS.h) to a list of elementName of the element itself, like "path"

Definition at line 149 of file KoShapeFactoryBase.cpp.

{
    d->xmlElements = elementNamesList;
}

References d.

◆ supports()

virtual bool KoShapeFactoryBase::supports	(	const QDomElement &	element,
		KoShapeLoadingContext &	context ) const

pure virtual

returns true if this shapeFactory is able to load the ODF type started at argument element. ('draw:line' / 'draw:frame' / etc)

Implemented in KoSvgTextShapeFactory, KisShapeSelectionFactory, ImageShapeFactory, EllipseShapeFactory, EnhancedPathShapeFactory, RectangleShapeFactory, SpiralShapeFactory, StarShapeFactory, KarbonCalligraphicShapeFactory, and KoPathShapeFactory.

◆ templates()

QList< KoShapeTemplate > KoShapeFactoryBase::templates ( ) const

Return all the templates this factory knows about. Each template shows a different way to create a shape this factory is specialized in.

◆ toolTip()

QString KoShapeFactoryBase::toolTip ( ) const

return a translated tooltip Text for a selector of shapes

Returns: a translated tooltip Text

Definition at line 76 of file KoShapeFactoryBase.cpp.

{
    return d->tooltip;
}

References d.

Member Data Documentation

◆ d

Private* const KoShapeFactoryBase::d

private

Definition at line 277 of file KoShapeFactoryBase.h.

◆ deferredFactory

KoDeferredShapeFactoryBase* KoShapeFactoryBase::deferredFactory

Definition at line 50 of file KoShapeFactoryBase.cpp.

◆ deferredPluginName

QString KoShapeFactoryBase::deferredPluginName

Definition at line 52 of file KoShapeFactoryBase.cpp.

◆ family

QString KoShapeFactoryBase::family

Definition at line 56 of file KoShapeFactoryBase.cpp.

◆ hidden

bool KoShapeFactoryBase::hidden

Definition at line 61 of file KoShapeFactoryBase.cpp.

◆ iconName

QString KoShapeFactoryBase::iconName

Definition at line 58 of file KoShapeFactoryBase.cpp.

◆ id

QString KoShapeFactoryBase::id

Definition at line 54 of file KoShapeFactoryBase.cpp.

◆ loadingPriority

int KoShapeFactoryBase::loadingPriority

Definition at line 59 of file KoShapeFactoryBase.cpp.

◆ name

QString KoShapeFactoryBase::name

Definition at line 55 of file KoShapeFactoryBase.cpp.

◆ pluginLoadingMutex

QMutex KoShapeFactoryBase::pluginLoadingMutex

Definition at line 51 of file KoShapeFactoryBase.cpp.

◆ resourceManagers

QList<QPointer<KoDocumentResourceManager> > KoShapeFactoryBase::resourceManagers

Definition at line 62 of file KoShapeFactoryBase.cpp.

◆ templates

QList< KoShapeTemplate > KoShapeFactoryBase::templates

Definition at line 53 of file KoShapeFactoryBase.cpp.

◆ tooltip

QString KoShapeFactoryBase::tooltip

Definition at line 57 of file KoShapeFactoryBase.cpp.

◆ xmlElements

QList<QPair<QString, QStringList> > KoShapeFactoryBase::xmlElements

Definition at line 60 of file KoShapeFactoryBase.cpp.

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

libs/flake/KoShapeFactoryBase.cpp
libs/flake/KoShapeFactoryBase.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoShapeFactoryBase()

◆ ~KoShapeFactoryBase()

Member Function Documentation

◆ addTemplate()

◆ createDefaultShape()

◆ createShape()

◆ createShapeOptionPanels()

◆ family()

◆ getDeferredPlugin()

◆ hidden()

◆ iconName()

◆ id()

◆ loadingPriority()

◆ name()

◆ newDocumentResourceManager()

◆ odfElements()

◆ Private()

◆ pruneDocumentResourceManager

◆ setFamily()

◆ setHidden()

◆ setIconName()

◆ setLoadingPriority()

◆ setToolTip()

◆ setXmlElementNames()

◆ setXmlElements()

◆ supports()

◆ templates()

◆ toolTip()

Member Data Documentation

◆ d

◆ deferredFactory

◆ deferredPluginName

◆ family

◆ hidden

◆ iconName

◆ id

◆ loadingPriority

◆ name

◆ pluginLoadingMutex

◆ resourceManagers

◆ templates

◆ tooltip

◆ xmlElements