Factory for spiral shapes. More...

#include <SpiralShapeFactory.h>

Inheritance diagram for SpiralShapeFactory:

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

QList< KoShapeConfigWidgetBase * >	createShapeOptionPanels () override

	SpiralShapeFactory ()
	constructor

bool	supports (const QDomElement &e, KoShapeLoadingContext &context) const override

	~SpiralShapeFactory () override

Public Member Functions inherited from KoShapeFactoryBase
virtual KoShape *	createShape (const KoProperties params, KoDocumentResourceManager documentResources=0) const

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)

QList< KoShapeTemplate >	templates () const

QString	toolTip () const

	~KoShapeFactoryBase () override

	~Private ()

Additional Inherited Members
Public Attributes inherited from KoShapeFactoryBase
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 inherited from KoShapeFactoryBase
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)

Detailed Description

Factory for spiral shapes.

Definition at line 15 of file SpiralShapeFactory.h.

Constructor & Destructor Documentation

◆ SpiralShapeFactory()

SpiralShapeFactory::SpiralShapeFactory ( )

constructor

Definition at line 18 of file SpiralShapeFactory.cpp.

    : KoShapeFactoryBase(SpiralShapeId, i18n("Spiral"))
{
    setToolTip(i18n("A spiral shape"));
    setIconName(koIconNameCStr("spiral-shape"));
    setFamily("geometric");
    setLoadingPriority(1);
}

References koIconNameCStr, KoShapeFactoryBase::setFamily(), KoShapeFactoryBase::setIconName(), KoShapeFactoryBase::setLoadingPriority(), and KoShapeFactoryBase::setToolTip().

◆ ~SpiralShapeFactory()

SpiralShapeFactory::~SpiralShapeFactory ( )

inlineoverride

Definition at line 20 of file SpiralShapeFactory.h.

20{}

Member Function Documentation

◆ createDefaultShape()

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

overridevirtual

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 from KoShapeFactoryBase.

Definition at line 27 of file SpiralShapeFactory.cpp.

{
    SpiralShape *spiral = new SpiralShape();
 
    spiral->setStroke(toQShared(new KoShapeStroke(1.0)));
    spiral->setShapeId(KoPathShapeId);
 
    return spiral;
}

References KoPathShapeId, KoShape::setShapeId(), KoShape::setStroke(), and toQShared().

◆ createShapeOptionPanels()

QList< KoShapeConfigWidgetBase * > SpiralShapeFactory::createShapeOptionPanels ( )

overridevirtual

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 from KoShapeFactoryBase.

Definition at line 44 of file SpiralShapeFactory.cpp.

{
    QList<KoShapeConfigWidgetBase *> panels;
    panels.append(new SpiralShapeConfigWidget());
    return panels;
}

◆ supports()

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

overridevirtual

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

Implements KoShapeFactoryBase.

Definition at line 37 of file SpiralShapeFactory.cpp.

{
    Q_UNUSED(e);
    Q_UNUSED(context);
    return false;
}

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

plugins/flake/pathshapes/spiral/SpiralShapeFactory.h
plugins/flake/pathshapes/spiral/SpiralShapeFactory.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpiralShapeFactory()

◆ ~SpiralShapeFactory()

Member Function Documentation

◆ createDefaultShape()

◆ createShapeOptionPanels()

◆ supports()