Krita Source Code Documentation
Loading...
Searching...
No Matches
KisAssistantToolFactory Class Reference

#include <kis_assistant_tool.h>

+ Inheritance diagram for KisAssistantToolFactory:

Public Member Functions

KoToolBasecreateTool (KoCanvasBase *canvas) override
 
 KisAssistantToolFactory ()
 
 ~KisAssistantToolFactory () override
 
- Public Member Functions inherited from KoToolFactoryBase
QString activationShapeId () const
 
QList< QAction * > createActions (KisKActionCollection *actionCollection)
 
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 ()
 

Additional Inherited Members

- Public Attributes inherited from KoToolFactoryBase
QString activationId
 
QString iconName
 
const QString id
 
int priority
 
QString section
 
QKeySequence shortcut
 
QString tooltip
 
- Protected Member Functions inherited from KoToolFactoryBase
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)
 

Detailed Description

Definition at line 184 of file kis_assistant_tool.h.

Constructor & Destructor Documentation

◆ KisAssistantToolFactory()

KisAssistantToolFactory::KisAssistantToolFactory ( )
inline

Definition at line 187 of file kis_assistant_tool.h.

188 : KoToolFactoryBase("KisAssistantTool") {
189 setToolTip(i18n("Assistant Tool"));
191 setIconName(koIconNameCStr("krita_tool_assistant"));
192 setPriority(0);
194 }
void setSection(const QString &section)
void setActivationShapeId(const QString &activationShapeId)
void setIconName(const char *iconName)
KoToolFactoryBase(const QString &id)
void setToolTip(const QString &tooltip)
void setPriority(int newPriority)
#define koIconNameCStr(name)
Definition kis_icon.h:28
static const QString KRITA_TOOL_ACTIVATION_ID
Definition kis_tool.h:37
static const QString View
Assistance tools: guides, reference, etc.

References koIconNameCStr, KRITA_TOOL_ACTIVATION_ID, KoToolFactoryBase::setActivationShapeId(), KoToolFactoryBase::setIconName(), KoToolFactoryBase::setPriority(), KoToolFactoryBase::setSection(), KoToolFactoryBase::setToolTip(), and ToolBoxSection::View.

◆ ~KisAssistantToolFactory()

KisAssistantToolFactory::~KisAssistantToolFactory ( )
inlineoverride

Definition at line 197 of file kis_assistant_tool.h.

197{}

Member Function Documentation

◆ createTool()

KoToolBase * KisAssistantToolFactory::createTool ( KoCanvasBase * canvas)
inlineoverridevirtual

Instantiate a new tool

Parameters
canvasthe 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.

Implements KoToolFactoryBase.

Definition at line 199 of file kis_assistant_tool.h.

199 {
200 return new KisAssistantTool(canvas);
201 }
KisCanvas2 * canvas

References Private::canvas.


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