KoPathShapeFactory Class Reference

Factory for path shapes. More...

#include <KoPathShapeFactory.h>

Inheritance diagram for KoPathShapeFactory:

Public Member Functions
KoShape *	createDefaultShape (KoDocumentResourceManager *documentResources=0) const override
	KoPathShapeFactory (const QStringList &)
	constructor
void	newDocumentResourceManager (KoDocumentResourceManager *manager) const override
	reimplemented
bool	supports (const QDomElement &element, KoShapeLoadingContext &context) const override
	~KoPathShapeFactory () override
Public Member Functions inherited from KoShapeFactoryBase
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
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 path shapes.

Definition at line 16 of file KoPathShapeFactory.h.

Constructor & Destructor Documentation

KoPathShapeFactory()

KoPathShapeFactory::KoPathShapeFactory

(

const QStringList &

)

constructor

Definition at line 22 of file KoPathShapeFactory.cpp.

        : KoShapeFactoryBase(KoPathShapeId, i18n("Simple path shape"))
{
    setToolTip(i18n("A simple path shape"));
    setIconName(koIconNameCStr("pathshape"));
    QStringList elementNames;
    elementNames << "path" << "line" << "polyline" << "polygon";
    setXmlElementNames(KoXmlNS::draw, elementNames);
    setLoadingPriority(0);
}

References KoXmlNS::draw, koIconNameCStr, KoShapeFactoryBase::setIconName(), KoShapeFactoryBase::setLoadingPriority(), KoShapeFactoryBase::setToolTip(), and KoShapeFactoryBase::setXmlElementNames().

~KoPathShapeFactory()

KoPathShapeFactory::~KoPathShapeFactory ( )

inlineoverride

Definition at line 21 of file KoPathShapeFactory.h.

{}

Member Function Documentation

createDefaultShape()

KoShape * KoPathShapeFactory::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 33 of file KoPathShapeFactory.cpp.

{
    KoPathShape* path = new KoPathShape();
    path->moveTo(QPointF(0, 50));
    path->curveTo(QPointF(0, 120), QPointF(50, 120), QPointF(50, 50));
    path->curveTo(QPointF(50, -20), QPointF(100, -20), QPointF(100, 50));
    path->normalize();
    path->setStroke(toQShared(new KoShapeStroke(1.0)));
    return path;
}

References toQShared().

newDocumentResourceManager()

void KoPathShapeFactory::newDocumentResourceManager ( KoDocumentResourceManager * manager ) const

overridevirtual

reimplemented

Reimplemented from KoShapeFactoryBase.

Definition at line 61 of file KoPathShapeFactory.cpp.

{
    // we also need a MarkerCollection so add if it is not there yet
    if (!manager->hasResource(KoDocumentResourceManager::MarkerCollection)) {
        KoMarkerCollection *markerCollection = new KoMarkerCollection(manager);
        manager->setResource(KoDocumentResourceManager::MarkerCollection, QVariant::fromValue(markerCollection));
    }
}

References KoDocumentResourceManager::hasResource(), KoDocumentResourceManager::MarkerCollection, and KoDocumentResourceManager::setResource().

supports()

bool KoPathShapeFactory::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 44 of file KoPathShapeFactory.cpp.

{
    Q_UNUSED(context);
    if (e.namespaceURI() == KoXmlNS::draw) {
        if (e.localName() == "path")
            return true;
        if (e.localName() == "line")
            return true;
        if (e.localName() == "polyline")
            return true;
        if (e.localName() == "polygon")
            return true;
    }
 
    return false;
}

References KoXmlNS::draw.

---

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

• libs/flake/KoPathShapeFactory.h
• libs/flake/KoPathShapeFactory.cpp