libs/flake

KoShapeConfigFactory Class Reference

A factory that creates config panels (widgets) for just a created shape. More...

#include <KoShapeConfigFactory.h>

List of all members.

Public Member Functions

 KoShapeConfigFactory ()
virtual ~KoShapeConfigFactory ()
virtual KoShapeConfigWidgetBasecreateConfigWidget (KoShape *shape)=0
virtual QString name () const =0
virtual bool showForShapeId (const QString &id) const
virtual int sortingOrder () const

Static Public Member Functions

static bool compare (KoShapeConfigFactory *f1, KoShapeConfigFactory *f2)

Detailed Description

A factory that creates config panels (widgets) for just a created shape.

The KoCreateShapesTool is able to show a number of configuration panels after it created a shape via user interaction. Each shape configuration panel type has its own factory, which will inherit from this class.

See also:
KoShapeFactory::panelFactories()
KoShapeConfigWidgetBase

Definition at line 38 of file KoShapeConfigFactory.h.


Constructor & Destructor Documentation

KoShapeConfigFactory::KoShapeConfigFactory (  )  [inline]

default constructor

Definition at line 42 of file KoShapeConfigFactory.h.

virtual KoShapeConfigFactory::~KoShapeConfigFactory (  )  [inline, virtual]

Definition at line 43 of file KoShapeConfigFactory.h.


Member Function Documentation

static bool KoShapeConfigFactory::compare ( KoShapeConfigFactory f1,
KoShapeConfigFactory f2 
) [inline, static]

For internal use only.

a compare for sorting.

Definition at line 74 of file KoShapeConfigFactory.h.

virtual KoShapeConfigWidgetBase* KoShapeConfigFactory::createConfigWidget ( KoShape shape  )  [pure virtual]

create a new config widget, intialized with the param shape

Parameters:
shape the shape that will be configured in the config widget.
See also:
KoShapeConfigWidgetBase::open()
virtual QString KoShapeConfigFactory::name (  )  const [pure virtual]

return the (translated) name of this configuration

virtual bool KoShapeConfigFactory::showForShapeId ( const QString id  )  const [inline, virtual]

Return true if the createConfigWidget() should be called at all for a shape of the specified type.

Parameters:
id an ID like the KoShapeFactory::shapeId()

Definition at line 68 of file KoShapeConfigFactory.h.

virtual int KoShapeConfigFactory::sortingOrder (  )  const [inline, virtual]

Return a sorting ordering to specify where in the list of config widgets this one will be shown.

Higher sorting numbers will be shown first. The default is 1.

Definition at line 59 of file KoShapeConfigFactory.h.


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