StarShapeFactory Class Reference

Factory for path shapes. More...

#include <StarShapeFactory.h>

Inheritance diagram for StarShapeFactory:

Public Member Functions
KoShape *	createDefaultShape (KoDocumentResourceManager *documentResources=0) const override
KoShape *	createShape (const KoProperties *params, KoDocumentResourceManager *documentResources=0) const override
QList< KoShapeConfigWidgetBase * >	createShapeOptionPanels () override
	StarShapeFactory ()
	constructor
bool	supports (const QDomElement &e, KoShapeLoadingContext &context) const override
	~StarShapeFactory () override
Public Member Functions inherited from KoShapeFactoryBase
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 path shapes.

Definition at line 15 of file StarShapeFactory.h.

Constructor & Destructor Documentation

StarShapeFactory()

StarShapeFactory::StarShapeFactory

(

)

constructor

Definition at line 24 of file StarShapeFactory.cpp.

    : KoShapeFactoryBase(StarShapeId, i18n("A star shape"))
{
    setToolTip(i18n("A star"));
    setIconName(koIconNameCStr("star-shape"));
    QStringList elementNames;
    elementNames << "regular-polygon" << "custom-shape";
    setXmlElementNames(KoXmlNS::draw, elementNames);
    setLoadingPriority(5);
 
    KoShapeTemplate t;
    t.id = KoPathShapeId;
    t.templateId = "star";
    t.name = i18n("Star");
    t.family = "geometric";
    t.toolTip = i18n("A star");
    t.iconName = koIconName("star-shape");
    KoProperties *props = new KoProperties();
    props->setProperty("corners", 5);
    QVariant v;
    v.setValue(QColor(Qt::yellow));
    props->setProperty("background", v);
    t.properties = props;
    addTemplate(t);
 
    t.id = KoPathShapeId;
    t.templateId = "flower";
    t.name = i18n("Flower");
    t.family = "funny";
    t.toolTip = i18n("A flower");
    t.iconName = koIconName("flower-shape");
    props = new KoProperties();
    props->setProperty("corners", 5);
    props->setProperty("baseRadius", 10.0);
    props->setProperty("tipRadius", 50.0);
    props->setProperty("baseRoundness", 0.0);
    props->setProperty("tipRoundness", 40.0);
    v.setValue(QColor(Qt::magenta));
    props->setProperty("background", v);
    t.properties = props;
    addTemplate(t);
 
    t.id = KoPathShapeId;
    t.templateId = "pentagon";
    t.name = i18n("Pentagon");
    t.family = "geometric";
    t.toolTip = i18n("A pentagon");
    t.iconName = koIconName("pentagon-shape");
    props = new KoProperties();
    props->setProperty("corners", 5);
    props->setProperty("convex", true);
    props->setProperty("tipRadius", 50.0);
    props->setProperty("tipRoundness", 0.0);
    v.setValue(QColor(Qt::blue));
    props->setProperty("background", v);
    t.properties = props;
    addTemplate(t);
 
    t.id = KoPathShapeId;
    t.templateId = "hexagon";
    t.name = i18n("Hexagon");
    t.family = "geometric";
    t.toolTip = i18n("A hexagon");
    t.iconName = koIconName("hexagon-shape");
    props = new KoProperties();
    props->setProperty("corners", 6);
    props->setProperty("convex", true);
    props->setProperty("tipRadius", 50.0);
    props->setProperty("tipRoundness", 0.0);
    v.setValue(QColor(Qt::blue));
    props->setProperty("background", v);
    t.properties = props;
    addTemplate(t);
}

References KoShapeFactoryBase::addTemplate(), KoXmlNS::draw, KoShapeTemplate::family, KoShapeTemplate::iconName, KoShapeTemplate::id, koIconName, koIconNameCStr, KoPathShapeId, KoShapeTemplate::name, KoShapeTemplate::properties, KoShapeFactoryBase::setIconName(), KoShapeFactoryBase::setLoadingPriority(), KoProperties::setProperty(), KoShapeFactoryBase::setToolTip(), KoShapeFactoryBase::setXmlElementNames(), KoShapeTemplate::templateId, KoShapeTemplate::toolTip, and v.

~StarShapeFactory()

StarShapeFactory::~StarShapeFactory ( )

inlineoverride

Definition at line 20 of file StarShapeFactory.h.

{}

Member Function Documentation

createDefaultShape()

KoShape * StarShapeFactory::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 99 of file StarShapeFactory.cpp.

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

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

createShape()

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

overridevirtual

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

Definition at line 109 of file StarShapeFactory.cpp.

{
    StarShape *star = new StarShape();
    if (!star) {
        return 0;
    }
 
    star->setCornerCount(params->intProperty("corners", 5));
    star->setConvex(params->boolProperty("convex", false));
    star->setBaseRadius(params->doubleProperty("baseRadius", 25.0));
    star->setTipRadius(params->doubleProperty("tipRadius", 50.0));
    star->setBaseRoundness(params->doubleProperty("baseRoundness", 0.0));
    star->setTipRoundness(params->doubleProperty("tipRoundness", 0.0));
    star->setStroke(toQShared(new KoShapeStroke(1.0)));
    star->setShapeId(KoPathShapeId);
    QVariant v;
    if (params->property("background", v)) {
        star->setBackground(QSharedPointer<KoColorBackground>(new KoColorBackground(v.value<QColor>())));
    }
 
    return star;
}

References KoProperties::boolProperty(), KoProperties::doubleProperty(), KoProperties::intProperty(), KoPathShapeId, KoProperties::property(), KoShape::setBackground(), StarShape::setBaseRadius(), StarShape::setBaseRoundness(), StarShape::setConvex(), StarShape::setCornerCount(), KoShape::setShapeId(), KoShape::setStroke(), StarShape::setTipRadius(), StarShape::setTipRoundness(), toQShared(), and v.

createShapeOptionPanels()

QList< KoShapeConfigWidgetBase * > StarShapeFactory::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 142 of file StarShapeFactory.cpp.

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

supports()

bool StarShapeFactory::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 132 of file StarShapeFactory.cpp.

{
    Q_UNUSED(context);
    if (e.localName() == "regular-polygon" && e.namespaceURI() == KoXmlNS::draw) {
        return true;
    }
    return (e.localName() == "custom-shape" && e.namespaceURI() == KoXmlNS::draw
            && e.attributeNS(KoXmlNS::draw, "engine", "") == "calligra:star");
}

References KoXmlNS::draw.

---

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

• plugins/flake/pathshapes/star/StarShapeFactory.h
• plugins/flake/pathshapes/star/StarShapeFactory.cpp