#include <KoToolFactoryBase.h>

Inheritance diagram for KoToolFactoryBase:

Public Member Functions
QString	activationShapeId () const

QList< QAction * >	createActions (KisKActionCollection *actionCollection)

virtual KoToolBase *	createTool (KoCanvasBase *canvas)=0

QString	iconName () const

QString	id () const

	KoToolFactoryBase (const QString &id)

int	priority () const

	Private (const QString &i)

QString	section () const

QKeySequence	shortcut () const

QString	toolTip () const

virtual	~KoToolFactoryBase ()

Public Attributes
QString	activationId

QString	iconName

const QString	id

int	priority

QString	section

QKeySequence	shortcut

QString	tooltip

Protected Member Functions
virtual QList< QAction * >	createActionsImpl ()
	createActionsImpl should be reimplemented if the tool needs any actions. The actions should have a valid objectName().

void	setActivationShapeId (const QString &activationShapeId)

void	setIconName (const char *iconName)

void	setIconName (const QString &iconName)

void	setPriority (int newPriority)

void	setSection (const QString &section)

void	setShortcut (const QKeySequence &shortcut)

void	setToolTip (const QString &tooltip)

Private Slots
void	activateTool ()

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

A factory for KoToolBase objects.

The baseclass for all tool plugins. Each plugin that ships a KoToolBase 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 MyToolFactory : public KoToolFactoryBase {
   public:
     MyToolFactory(const QStringList&)
         : KoToolFactoryBase("MyTool") {
         setToolTip(i18n("Create object"));
         setSection("main");
         setPriority(5);
     }
     ~MyToolFactory() {}
     KoToolBase *createTool(KoCanvasBase *canvas);
   };
   K_PLUGIN_FACTORY_WITH_JSON((MyToolFactoryFactory, "mytool.json", registerPlugin<MyToolFactory>();)

Definition at line 19 of file KoToolFactoryBase.cpp.

Constructor & Destructor Documentation

◆ KoToolFactoryBase()

KoToolFactoryBase::KoToolFactoryBase ( const QString & id )

explicit

Create the new factory

Parameters

id	a string that will be used internally for referencing the tool

Definition at line 37 of file KoToolFactoryBase.cpp.

    : d(new Private(id))
{
}

◆ ~KoToolFactoryBase()

KoToolFactoryBase::~KoToolFactoryBase ( )

virtual

Definition at line 42 of file KoToolFactoryBase.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ activateTool

void KoToolFactoryBase::activateTool ( )

privateslot

Definition at line 208 of file KoToolFactoryBase.cpp.

{
    KoToolManager::instance()->switchToolRequested(sender()->objectName());
}

References KoToolManager::instance(), and KoToolManager::switchToolRequested().

◆ activationShapeId()

QString KoToolFactoryBase::activationShapeId ( ) const

Return the id of the shape we can process. This is the shape Id the tool we create is associated with. So a TextTool for a TextShape.

See also: KoShapeFactoryBase::shapeId(); setActivationShapeId()

Returns: the id of a shape, or an empty string for all shapes.

Definition at line 158 of file KoToolFactoryBase.cpp.

{
    return d->activationId;
}

References d.

◆ createActions()

QList< QAction * > KoToolFactoryBase::createActions ( KisKActionCollection * actionCollection )

Create the actions for this tool. Actions are unique per window, not per tool instance; tool instances are unique per view/canvas.

Definition at line 47 of file KoToolFactoryBase.cpp.

{
    QList<QAction *> toolActions;
 
    KisActionRegistry *actionRegistry = KisActionRegistry::instance();
    QList<QAction*> actions = createActionsImpl();
    QAction *action = actionRegistry->makeQAction(id(), this);
    actionCollection->addAction(id(), action);
    connect(action, SIGNAL(triggered()), SLOT(activateTool()));
    //qDebug() << action << action->shortcut();
 
 
    Q_FOREACH(QAction *action, actions) {
        if (action->objectName().isEmpty()) {
            qWarning() << "Tool" << id() << "tries to add an action without a name";
            continue;
        }
        QAction *existingAction = actionCollection->action(action->objectName());
        if (existingAction) {
            delete action;
            action = existingAction;
        }
 
        QStringList tools;
        if (action->property("tool_action").isValid()) {
            tools = action->property("tool_action").toStringList();
        }
        tools << id();
        action->setProperty("tool_action", tools);
        if (!existingAction) {
            actionCollection->addAction(action->objectName(), action);
        }
        toolActions << action;
    }
 
    // Enable this to easily generate action files for tools
 #if 0
    if (toolActions.size() > 0) {
 
        QDomDocument doc;
        QDomElement e = doc.createElement("Actions");
        e.setAttribute("name", id);
        e.setAttribute("version", "2");
        doc.appendChild(e);
 
        Q_FOREACH (QAction *action, toolActions) {
            QDomElement a = doc.createElement("Action");
            a.setAttribute("name", action->objectName());
 
            // But seriously, XML is the worst format ever designed
            auto addElement = [&](QString title, QString content) {
                QDomElement newNode = doc.createElement(title);
                QDomText    newText = doc.createTextNode(content);
                newNode.appendChild(newText);
                a.appendChild(newNode);
            };
 
            addElement("icon", action->icon().name());
            addElement("text", action->text());
            addElement("whatsThis" , action->whatsThis());
            addElement("toolTip" , action->toolTip());
            addElement("iconText" , action->iconText());
            addElement("shortcut" , action->shortcut().toString());
            addElement("isCheckable" , QString((action->isChecked() ? "true" : "false")));
            addElement("statusTip", action->statusTip());
            e.appendChild(a);
        }
        QFile f(id()z + ".action");
        f.open(QFile::WriteOnly);
        f.write(doc.toString().toUtf8());
        f.close();
 
    }
 
    else {
        debugFlake << "Tool" << id() << "has no actions";
    }
#endif
 
//    qDebug() << "Generated actions for tool factory" << id();
//    Q_FOREACH(QAction *action, toolActions) {
//        qDebug() << "\taction:" << action->objectName() << "shortcut" << action->shortcuts() << "tools" << action->property("tool_action").toStringList();
//    }
    return toolActions;
}

References KisKActionCollection::action(), activateTool(), KisKActionCollection::addAction(), connect(), createActionsImpl(), debugFlake, id, KisActionRegistry::instance(), and KisActionRegistry::makeQAction().

◆ createActionsImpl()

QList< QAction * > KoToolFactoryBase::createActionsImpl ( )

protectedvirtual

createActionsImpl should be reimplemented if the tool needs any actions. The actions should have a valid objectName().

Returns: the list of actions this tool wishes to be available.

Reimplemented in KoPathToolFactory, KisSelectionToolFactoryBase, KisToolPolyLineFactoryBase, KisToolPaintFactoryBase, KisToolBrushFactory, KisToolMoveFactory, DefaultToolFactory, ToolReferenceImagesFactory, KarbonCalligraphyToolFactory, KisToolSelectPolygonalFactory, KisToolSelectMagneticFactory, SvgTextToolFactory, and KisToolTransformFactory.

Definition at line 203 of file KoToolFactoryBase.cpp.

{
    return QList<QAction *>();
}

◆ createTool()

virtual KoToolBase * KoToolFactoryBase::createTool ( KoCanvasBase * canvas )

pure virtual

Instantiate a new tool

Parameters

canvas the canvas that the new tool will work on. Should be passed to the constructor of the tool.

Returns: a new KoToolBase instance, or zero if the tool doesn't want to show up.

Implemented in KoPathToolFactory, KoZoomToolFactory, KisAssistantToolFactory, KisToolBrushFactory, KisToolColorSamplerFactory, KisToolEllipseFactory, KisToolFillFactory, KisToolGradientFactory, KisToolLineFactory, KisToolMeasureFactory, KisToolMoveFactory, KisToolMultiBrushFactory, KisToolPanFactory, KisToolPathFactory, KisToolPencilFactory, KisToolRectangleFactory, DefaultToolFactory, ToolReferenceImagesFactory, KarbonCalligraphyToolFactory, KisToolSelectContiguousFactory, KisToolSelectEllipticalFactory, KisToolSelectOutlineFactory, KisToolSelectPathFactory, KisToolSelectPolygonalFactory, KisToolSelectRectangularFactory, KisToolSelectSimilarFactory, KisToolSelectMagneticFactory, SvgTextToolFactory, KisToolCropFactory, KisToolDynaFactory, KisToolEncloseAndFillFactory, KisToolLazyBrushFactory, KisToolPolygonFactory, KisToolPolylineFactory, KisToolSmartPatchFactory, and KisToolTransformFactory.

◆ iconName()

QString KoToolFactoryBase::iconName ( ) const

return the basename of the icon for this tool

Returns: the basename of the icon for this tool

◆ id()

QString KoToolFactoryBase::id ( ) const

return the id for the tool this factory creates.

Returns: the id for the tool this factory creates.

◆ priority()

int KoToolFactoryBase::priority ( ) const

Returns The priority of this tool in its section in the toolbox

Returns: The priority of this tool.

◆ Private()

KoToolFactoryBase::Private ( const QString & i )

inline

Definition at line 22 of file KoToolFactoryBase.cpp.

        : priority(100),
          id(i)
    {
    }

◆ section()

QString KoToolFactoryBase::section ( ) const

returns the section used to group tools in the toolbox

Returns: the section

◆ setActivationShapeId()

void KoToolFactoryBase::setActivationShapeId ( const QString & activationShapeId )

protected

Set the id of the shape we can process. This is the Id, as passed to the constructor of a KoShapeFactoryBase, that the tool we create is associated with. This means that if a KoTextShape is selected, then all tools that have its id set here will be added to the dynamic part of the toolbox.

Parameters

activationShapeId the Id of the shape

See also: activationShapeId()

Definition at line 168 of file KoToolFactoryBase.cpp.

{
    d->activationId = activationShapeId;
}

References activationShapeId(), and d.

◆ setIconName() [1/2]

void KoToolFactoryBase::setIconName ( const char * iconName )

protected

Set an icon to be used in the toolBox.

Parameters

iconName the basename (without extension) of the icon

Definition at line 183 of file KoToolFactoryBase.cpp.

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

References d, and iconName.

◆ setIconName() [2/2]

void KoToolFactoryBase::setIconName ( const QString & iconName )

protected

Definition at line 188 of file KoToolFactoryBase.cpp.

{
    d->iconName = iconName;
}

References d, and iconName.

◆ setPriority()

void KoToolFactoryBase::setPriority ( int newPriority )

protected

Set the priority of this tool, as it is shown in the toolBox; lower number means it will be show more to the front of the list.

Parameters

newPriority the priority

Definition at line 193 of file KoToolFactoryBase.cpp.

{
    d->priority = newPriority;
}

References d.

◆ setSection()

void KoToolFactoryBase::setSection ( const QString & section )

protected

Set the section used to group tools in the toolbox

Parameters

section the section

Definition at line 178 of file KoToolFactoryBase.cpp.

{
    d->section = section;
}

References d, and section.

◆ setShortcut()

void KoToolFactoryBase::setShortcut ( const QKeySequence & shortcut )

protected

Set the default shortcut for activation of this tool.

Definition at line 198 of file KoToolFactoryBase.cpp.

{
    d->shortcut = shortcut;
}

References d, and shortcut.

◆ setToolTip()

void KoToolFactoryBase::setToolTip ( const QString & tooltip )

protected

Set the tooltip to be used for this tool

Parameters

tooltip the tooltip

Definition at line 173 of file KoToolFactoryBase.cpp.

{
    d->tooltip = tooltip;
}

References d, and tooltip.

◆ shortcut()

QKeySequence KoToolFactoryBase::shortcut ( ) const

Return the default keyboard shortcut for activation of this tool (if the shape this tool belongs to is active).

See KoToolManager for use.

Returns: the shortcut

◆ toolTip()

QString KoToolFactoryBase::toolTip ( ) const

return a translated tooltip Text

Returns: a translated tooltip Text

Definition at line 148 of file KoToolFactoryBase.cpp.

{
    return d->tooltip;
}

References d.

Member Data Documentation

◆ activationId

QString KoToolFactoryBase::activationId

Definition at line 30 of file KoToolFactoryBase.cpp.

◆ d

Private* const KoToolFactoryBase::d

private

Definition at line 188 of file KoToolFactoryBase.h.

◆ iconName

QString KoToolFactoryBase::iconName

Definition at line 31 of file KoToolFactoryBase.cpp.

◆ id

QString KoToolFactoryBase::id

Definition at line 32 of file KoToolFactoryBase.cpp.

◆ priority

int KoToolFactoryBase::priority

Definition at line 27 of file KoToolFactoryBase.cpp.

◆ section

QString KoToolFactoryBase::section

Definition at line 28 of file KoToolFactoryBase.cpp.

◆ shortcut

QKeySequence KoToolFactoryBase::shortcut

Definition at line 33 of file KoToolFactoryBase.cpp.

◆ tooltip

QString KoToolFactoryBase::tooltip

Definition at line 29 of file KoToolFactoryBase.cpp.

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

libs/flake/KoToolFactoryBase.cpp
libs/flake/KoToolFactoryBase.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoToolFactoryBase()

◆ ~KoToolFactoryBase()

Member Function Documentation

◆ activateTool

◆ activationShapeId()

◆ createActions()

◆ createActionsImpl()

◆ createTool()

◆ iconName()

◆ id()

◆ priority()

◆ Private()

◆ section()

◆ setActivationShapeId()

◆ setIconName() [1/2]

◆ setIconName() [2/2]

◆ setPriority()

◆ setSection()

◆ setShortcut()

◆ setToolTip()

◆ shortcut()

◆ toolTip()

Member Data Documentation

◆ activationId

◆ d

◆ iconName

◆ id

◆ priority

◆ section

◆ shortcut

◆ tooltip