KoToolAction Class Reference

#include <KoToolManager.h>

Inheritance diagram for KoToolAction:

Public Slots
void	trigger ()
	Request the activation of the tool.

Signals
void	changed ()
	Emitted when a property changes (shortcut ATM)

Public Member Functions
int	buttonGroupId () const
	A unique ID for this tool as passed by changedTool(), >= 0.
QString	iconName () const
	The icon name of the tool.
QString	iconText () const
	The icontext of the tool.
QString	id () const
	The id of the tool.
	KoToolAction (KoToolFactoryBase *toolFactory)
int	priority () const
	Lower number (higher priority) means coming first in the section.
QString	section () const
	The section the tool wants to be in.
QKeySequence	shortcut () const
	The shortcut to activate the tool.
KoToolFactoryBase *	toolFactory () const
	Factory to create new tool object instances.
QString	toolTip () const
	The tooltip of the tool.
QString	visibilityCode () const
	This tool should become visible when we Q_EMIT this string in toolCodesSelected()
	~KoToolAction () override

Public Attributes
KoToolFactoryBase *	toolFactory

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

This class serves as a QAction-like control object for activation of a tool.

It allows to implement a custom UI to control the activation of tools. See KoToolBox & KoModeBox in the kowidgets library.

KoToolAction objects are owned by the KoToolManager singleton and live until the end of its lifetime.

Definition at line 40 of file KoToolManager.h.

Constructor & Destructor Documentation

KoToolAction()

KoToolAction::KoToolAction ( KoToolFactoryBase * toolFactory )

explicit

Definition at line 23 of file KoToolManager_p.cpp.

    : d(new Private)
{
    d->toolFactory = toolFactory;
}

References d, and toolFactory.

~KoToolAction()

KoToolAction::~KoToolAction ( )

override

Definition at line 29 of file KoToolManager_p.cpp.

{
    delete d;
}

References d.

Member Function Documentation

buttonGroupId()

int KoToolAction::buttonGroupId

(

)

const

A unique ID for this tool as passed by changedTool(), >= 0.

changed

void KoToolAction::changed ( )

signal

Emitted when a property changes (shortcut ATM)

iconName()

QString KoToolAction::iconName

(

)

const

The icon name of the tool.

Definition at line 56 of file KoToolManager_p.cpp.

{
    return d->toolFactory->iconName();
}

References d.

iconText()

QString KoToolAction::iconText

(

)

const

The icontext of the tool.

Definition at line 40 of file KoToolManager_p.cpp.

{
    // There is no specific iconText in KoToolFactoryBase
    return d->toolFactory->toolTip();
}

References d.

id()

QString KoToolAction::id

(

)

const

The id of the tool.

Definition at line 51 of file KoToolManager_p.cpp.

{
    return d->toolFactory->id();
}

References d.

priority()

int KoToolAction::priority

(

)

const

Lower number (higher priority) means coming first in the section.

Definition at line 72 of file KoToolManager_p.cpp.

{
    return d->toolFactory->priority();
}

References d.

section()

QString KoToolAction::section

(

)

const

The section the tool wants to be in.

Definition at line 67 of file KoToolManager_p.cpp.

{
    return d->toolFactory->section();
}

References d.

shortcut()

QKeySequence KoToolAction::shortcut

(

)

const

The shortcut to activate the tool.

Definition at line 61 of file KoToolManager_p.cpp.

{
    return d->toolFactory->shortcut();
}

References d.

toolFactory()

KoToolFactoryBase * KoToolAction::toolFactory

(

)

const

Factory to create new tool object instances.

toolTip()

QString KoToolAction::toolTip

(

)

const

The tooltip of the tool.

Definition at line 46 of file KoToolManager_p.cpp.

{
    return d->toolFactory->toolTip();
}

References d.

trigger

void KoToolAction::trigger ( )

slot

Request the activation of the tool.

Definition at line 34 of file KoToolManager_p.cpp.

{
    KoToolManager::instance()->switchToolRequested(id());
}

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

visibilityCode()

QString KoToolAction::visibilityCode

(

)

const

This tool should become visible when we Q_EMIT this string in toolCodesSelected()

Definition at line 77 of file KoToolManager_p.cpp.

{
    return d->toolFactory->activationShapeId();
}

References d.

Member Data Documentation

d

Private* const KoToolAction::d

private

Definition at line 69 of file KoToolManager.h.

toolFactory

KoToolFactoryBase * KoToolAction::toolFactory

Definition at line 20 of file KoToolManager_p.cpp.

---

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

• libs/flake/KoToolManager.h
• libs/flake/KoToolManager_p.cpp