Abstract base class for input actions. More...

#include <kis_abstract_input_action.h>

Inheritance diagram for KisAbstractInputAction:

Public Member Functions
virtual void	activate (int shortcut)

virtual void	begin (int shortcut, QEvent *event)

virtual bool	canIgnoreModifiers () const

virtual void	deactivate (int shortcut)

virtual QString	description () const

virtual void	end (QEvent *event)

virtual QString	id () const

virtual KisInputActionGroup	inputActionGroup (int shortcut) const

virtual void	inputEvent (QEvent *event)

virtual bool	isAvailable () const

virtual bool	isShortcutRequired (int shortcut) const

	KisAbstractInputAction (const QString &id)

virtual QString	name () const

virtual int	priority () const

virtual QHash< QString, int >	shortcutIndexes () const

virtual bool	supportsHiResInputEvents (int shortcut) const

virtual bool	trySwitchShortcut (int oldShortcut, int newShortcut)

virtual	~KisAbstractInputAction ()

Public Attributes
QString	description

QString	id

QHash< QString, int >	indexes

QPointF	lastCursorPosition

QString	name

QPointF	startCursorPosition

Static Public Attributes
static KisInputManager *	inputManager

Protected Member Functions
virtual void	cursorMoved (const QPointF &lastPos, const QPointF &pos)

virtual void	cursorMovedAbsolute (const QPointF &startPos, const QPointF &pos)

QPoint	eventPos (const QEvent *event)

QPointF	eventPosF (const QEvent *event)

KisInputManager *	inputManager () const

void	setDescription (const QString &description)

void	setName (const QString &name)

void	setShortcutIndexes (const QHash< QString, int > &indexes)

Static Private Member Functions
static void	setInputManager (KisInputManager *manager)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Friends
class	KisInputManager

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

Detailed Description

Abstract base class for input actions.

Input actions represent actions to be performed when interacting with the canvas. They are managed by KisInputManager and activated when KisKeyShortcut or KisStrokeShortcut detects it matches a certain set of inputs.

The begin() method uses an index for the type of behaviour to activate. This index can be used to trigger behaviour when different events occur.

The events can be of two types: 1) Key events. The input manager calls begin() and end() sequentially with an index parameter to begin() representing the type of action that should be performed. The event parameter of both calls in null. 2) Stroke events. The input manager calls begin() and end() on the corresponding mouse down and up events. The event parameter will be of QMouseEvent type, representing the event happened. All the mouse move events between begin() and end() will be redirected to the inputEvent() method.

Definition at line 19 of file kis_abstract_input_action.cpp.

Constructor & Destructor Documentation

◆ KisAbstractInputAction()

KisAbstractInputAction::KisAbstractInputAction ( const QString & id )

explicit

Constructor.

Parameters

manager The InputManager this action belongs to.

Definition at line 35 of file kis_abstract_input_action.cpp.

    : d(new Private)
{
    d->id = id;
    d->indexes.insert(i18n("Activate"), 0);
}

References d, and id.

◆ ~KisAbstractInputAction()

KisAbstractInputAction::~KisAbstractInputAction ( )

virtual

Destructor.

Definition at line 42 of file kis_abstract_input_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ activate()

void KisAbstractInputAction::activate ( int shortcut )

virtual

The method is called when the action is yet to be started, that is, e.g. the user has pressed all the modifiers for the action but hasn't started painting yet. This method is a right place to show the user what is going to happen, e.g. change the cursor.

Reimplemented in KisAlternateInvocationAction, KisChangePrimarySettingAction, KisGammaExposureAction, KisPanAction, KisRotateCanvasAction, KisSelectLayerAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, and KisZoomAndRotateAction.

Definition at line 47 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
}

◆ begin()

void KisAbstractInputAction::begin	(	int	shortcut,
		QEvent *	event )

virtual

Begin the action.

Parameters

shortcut	The index of the behaviour to trigger.
event	The mouse event that has triggered this action. Is null for keyboard-activated actions.

Reimplemented in KisAlternateInvocationAction, KisChangeFrameAction, KisChangePrimarySettingAction, KisPanAction, KisRotateCanvasAction, KisSelectLayerAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAndRotateAction, KisTouchGestureAction, KisZoomAction, KisCanvasOnlyAction, and KisGammaExposureAction.

Definition at line 64 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
 
    if (event) {
        d->lastCursorPosition = eventPosF(event);
        d->startCursorPosition = d->lastCursorPosition;
    }
}

References d, and eventPosF().

◆ canIgnoreModifiers()

bool KisAbstractInputAction::canIgnoreModifiers ( ) const

virtual

Returns true if an action can run with any modifiers pressed (the shortcut's modifiers list must be empty for that). That is used for making one type of actions default one.

Reimplemented in KisToolInvocationAction.

Definition at line 133 of file kis_abstract_input_action.cpp.

{
    return false;
}

◆ cursorMoved()

void KisAbstractInputAction::cursorMoved	(	const QPointF &	lastPos,
		const QPointF &	pos )

protectedvirtual

Convenience method for handling cursor movement for tablet, mouse and touch. The default implementation of inputEvent calls this function.

Definition at line 89 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(lastPos);
    Q_UNUSED(pos);
}

◆ cursorMovedAbsolute()

void KisAbstractInputAction::cursorMovedAbsolute	(	const QPointF &	startPos,
		const QPointF &	pos )

protectedvirtual

Reimplemented in KisGammaExposureAction, KisPanAction, KisZoomAndRotateAction, KisRotateCanvasAction, and KisZoomAction.

Definition at line 95 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(startPos);
    Q_UNUSED(pos);
}

◆ deactivate()

void KisAbstractInputAction::deactivate ( int shortcut )

virtual

The method is called when the action is not a candidate for the starting anymore. The action should revert everything that was done in activate() method.

See also: activate()

Reimplemented in KisAlternateInvocationAction, KisChangePrimarySettingAction, KisGammaExposureAction, KisPanAction, KisRotateCanvasAction, KisSelectLayerAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, and KisZoomAndRotateAction.

Definition at line 52 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
}

◆ description()

virtual QString KisAbstractInputAction::description ( ) const

virtual

A short description of this action.

◆ end()

void KisAbstractInputAction::end ( QEvent * event )

virtual

End the action.

Parameters

event The mouse event that has finished this action. Is null for keyboard-activated actions.

Reimplemented in KisPopupWidgetAction, KisAlternateInvocationAction, KisChangePrimarySettingAction, KisPanAction, KisRotateCanvasAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, KisZoomAndRotateAction, and KisTouchGestureAction.

Definition at line 84 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(event);
}

◆ eventPos()

QPoint KisAbstractInputAction::eventPos ( const QEvent * event )

protected

Convenience method to extract the position from a cursor movement event.

Parameters

event A mouse or tablet event.

Native gesture event has an issue in Qt on MacOS, its event->position() method returns an incorrect value (not in the widget's coordinates). So we should manually map it from global.

Definition at line 174 of file kis_abstract_input_action.cpp.

{
    if(!event) {
        return QPoint();
    }
 
    switch (event->type()) {
    case QEvent::MouseMove:
    case QEvent::MouseButtonPress:
    case QEvent::MouseButtonDblClick:
    case QEvent::MouseButtonRelease:
        return static_cast<const QMouseEvent*>(event)->pos();
 
    case QEvent::TabletMove:
    case QEvent::TabletPress:
    case QEvent::TabletRelease:
        return static_cast<const QTabletEvent*>(event)->pos();
 
    case QEvent::TouchBegin:
    case QEvent::TouchUpdate:
    case QEvent::TouchEnd:
        return static_cast<const QTouchEvent *>(event)->touchPoints().at(0).pos().toPoint();
 
    case QEvent::Wheel:
        return static_cast<const QWheelEvent*>(event)->position().toPoint();
 
    case QEvent::NativeGesture: {
        KisCanvas2 *canvas = d->inputManager->canvas();
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(canvas, QPoint());
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
        return canvas->canvasWidget()->mapFromGlobal(QPointF(static_cast<const QNativeGestureEvent*>(event)->globalPos())).toPoint();
#else
        return canvas->canvasWidget()->mapFromGlobal(static_cast<const QNativeGestureEvent*>(event)->globalPos());
#endif
    }
 
    default:
        warnUI << "KisAbstractInputAction" << d->name << "tried to process event data from an unhandled event type" << event->type();
        return QPoint();
    }
}

References Private::canvas, KisCanvas2::canvasWidget, d, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and warnUI.

◆ eventPosF()

QPointF KisAbstractInputAction::eventPosF ( const QEvent * event )

protected

Convenience method to extract the floating point position from a cursor movement event.

Parameters

event A mouse or tablet event.

Native gesture event has an issue in Qt on MacOS, its event->position() method returns an incorrect value (not in the widget's coordinates). So we should manually map it from global.

Definition at line 223 of file kis_abstract_input_action.cpp.

                                                             {
 
    if(!event) {
        return QPoint();
    }
 
    switch (event->type()) {
    case QEvent::MouseMove:
    case QEvent::MouseButtonPress:
    case QEvent::MouseButtonDblClick:
    case QEvent::MouseButtonRelease:
        return static_cast<const QMouseEvent*>(event)->localPos();
 
    case QEvent::TabletMove:
    case QEvent::TabletPress:
    case QEvent::TabletRelease:
        return static_cast<const QTabletEvent*>(event)->posF();
 
    case QEvent::TouchBegin:
    case QEvent::TouchUpdate:
    case QEvent::TouchEnd:
        return static_cast<const QTouchEvent *>(event)->touchPoints().at(0).pos();
 
    case QEvent::Wheel:
        return static_cast<const QWheelEvent*>(event)->position();
 
    case QEvent::NativeGesture: {
        KisCanvas2 *canvas = d->inputManager->canvas();
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(canvas, QPointF());
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
        return canvas->canvasWidget()->mapFromGlobal(QPointF(static_cast<const QNativeGestureEvent*>(event)->globalPos()));
#else
        return canvas->canvasWidget()->mapFromGlobal(static_cast<const QNativeGestureEvent*>(event)->globalPos());
#endif
    }
    default:
        warnUI << "KisAbstractInputAction" << d->name << "tried to process event data from an unhandled event type" << event->type();
        return QPointF();
    }
}

References Private::canvas, KisCanvas2::canvasWidget, d, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and warnUI.

◆ id()

virtual QString KisAbstractInputAction::id ( ) const

virtual

The id of this action.

◆ inputActionGroup()

KisInputActionGroup KisAbstractInputAction::inputActionGroup ( int shortcut ) const

virtual

Returns: the group of the action the specified shortcut belongs to

Reimplemented in KisPanAction, KisRotateCanvasAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, and KisZoomAndRotateAction.

Definition at line 107 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
    return ModifyingActionGroup;
}

References ModifyingActionGroup.

◆ inputEvent()

void KisAbstractInputAction::inputEvent ( QEvent * event )

virtual

Process an input event.

By default handles MouseMove events and passes the data to a convenience cursorMoved() method

Parameters

event An event to process.

Reimplemented in KisAlternateInvocationAction, KisChangePrimarySettingAction, KisPanAction, KisRotateCanvasAction, KisSelectLayerAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, and KisZoomAndRotateAction.

Definition at line 74 of file kis_abstract_input_action.cpp.

{
    if (event) {
        QPointF newPosition = eventPosF(event);
        cursorMoved(d->lastCursorPosition, newPosition);
        cursorMovedAbsolute(d->startCursorPosition, newPosition);
        d->lastCursorPosition = newPosition;
    }
}

References cursorMoved(), cursorMovedAbsolute(), d, and eventPosF().

◆ inputManager()

KisInputManager * KisAbstractInputAction::inputManager ( ) const

protected

The input manager this action belongs to.

◆ isAvailable()

bool KisAbstractInputAction::isAvailable ( ) const

virtual

Some of the actions are available in particular situations only. E.g. switch frame action is available iff an animated layer is selected. If isAvailable() returns true then the action will not be triggered by the shortcut matcher.

Reimplemented in KisChangeFrameAction, and KisTemporaryStraightRulerAction.

Definition at line 271 of file kis_abstract_input_action.cpp.

{
    return true;
}

◆ isShortcutRequired()

bool KisAbstractInputAction::isShortcutRequired ( int shortcut ) const

virtual

Return true when the specified shortcut is required for basic user interaction. This is used by the configuration system to prevent basic actions like painting from being removed.

Parameters

shortcut The shortcut index to check.

Returns: True if the shortcut is required, false if not.

Reimplemented in KisGammaExposureAction, KisPanAction, KisToolInvocationAction, and KisZoomAction.

Definition at line 168 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
    return false;
}

◆ name()

virtual QString KisAbstractInputAction::name ( ) const

virtual

The translated name of this action.

◆ priority()

int KisAbstractInputAction::priority ( ) const

virtual

The priority for this action.

Priority determines how "important" the action is and is used to resolve conflicts when multiple actions can be activated.

Reimplemented in KisAlternateInvocationAction, KisChangePrimarySettingAction, KisGammaExposureAction, KisPanAction, KisRotateCanvasAction, KisSelectLayerAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, KisZoomAction, KisZoomAndRotateAction, KisCanvasOnlyAction, KisPopupWidgetAction, and KisTouchGestureAction.

Definition at line 128 of file kis_abstract_input_action.cpp.

{
    return 0;
}

◆ setDescription()

void KisAbstractInputAction::setDescription ( const QString & description )

protected

Set the description of this action.

Parameters

description The new description.

Definition at line 153 of file kis_abstract_input_action.cpp.

{
    d->description = description;
}

References d, and description.

◆ setInputManager()

void KisAbstractInputAction::setInputManager ( KisInputManager * manager )

staticprivate

Definition at line 163 of file kis_abstract_input_action.cpp.

{
    Private::inputManager = manager;
}

◆ setName()

void KisAbstractInputAction::setName ( const QString & name )

protected

Set the name of this action.

Parameters

name	The new name.

Definition at line 148 of file kis_abstract_input_action.cpp.

{
    d->name = name;
}

References d, and name.

◆ setShortcutIndexes()

void KisAbstractInputAction::setShortcutIndexes ( const QHash< QString, int > & indexes )

protected

Set the available indexes of shortcut behaviours.

Parameters

indexes The new indexes.

Definition at line 158 of file kis_abstract_input_action.cpp.

{
    d->indexes = indexes;
}

References d, and indexes.

◆ shortcutIndexes()

QHash< QString, int > KisAbstractInputAction::shortcutIndexes ( ) const

virtual

The indexes of shortcut behaviours available.

Definition at line 138 of file kis_abstract_input_action.cpp.

{
    return d->indexes;
}

References d.

◆ supportsHiResInputEvents()

bool KisAbstractInputAction::supportsHiResInputEvents ( int shortcut ) const

virtual

Returns true if the action can handle HiRes flow of move events which is generated by the tablet. If the function returns false, some of the events will be dropped or postponed. For most of the actions in Krita (except of real painting) it is perfectly acceptable, so 'false' is the default value.

Reimplemented in KisAlternateInvocationAction, KisChangePrimarySettingAction, KisPanAction, KisRotateCanvasAction, KisTemporaryStraightRulerAction, KisToolInvocationAction, and KisZoomAction.

Definition at line 101 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(shortcut);
    return false;
}

◆ trySwitchShortcut()

bool KisAbstractInputAction::trySwitchShortcut	(	int	oldShortcut,
		int	newShortcut )

virtual

Switch the active shortcut mode without deactivating the action.

Called when modifier keys change while the action is active. Override this to update action state in-place without resetting ongoing interaction.

Returns: true if the switch was handled and the action remains active; false to fall back to standard deactivate() / activate().

Reimplemented in KisTemporaryStraightRulerAction.

Definition at line 57 of file kis_abstract_input_action.cpp.

{
    Q_UNUSED(oldShortcut);
    Q_UNUSED(newShortcut);
    return false;
}

Friends And Related Symbol Documentation

◆ KisInputManager

friend class KisInputManager

friend

Definition at line 225 of file kis_abstract_input_action.h.

Member Data Documentation

◆ d

Private* const KisAbstractInputAction::d

private

Definition at line 229 of file kis_abstract_input_action.h.

◆ description

QString KisAbstractInputAction::description

Definition at line 24 of file kis_abstract_input_action.cpp.

◆ id

QString KisAbstractInputAction::id

Definition at line 22 of file kis_abstract_input_action.cpp.

◆ indexes

QHash<QString, int> KisAbstractInputAction::indexes

Definition at line 25 of file kis_abstract_input_action.cpp.

◆ inputManager

KisInputManager * KisAbstractInputAction::inputManager

static

Definition at line 30 of file kis_abstract_input_action.cpp.

◆ lastCursorPosition

QPointF KisAbstractInputAction::lastCursorPosition

Definition at line 27 of file kis_abstract_input_action.cpp.

◆ name

QString KisAbstractInputAction::name

Definition at line 23 of file kis_abstract_input_action.cpp.

◆ startCursorPosition

QPointF KisAbstractInputAction::startCursorPosition

Definition at line 28 of file kis_abstract_input_action.cpp.

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

libs/ui/input/kis_abstract_input_action.cpp
libs/ui/input/kis_abstract_input_action.h

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisAbstractInputAction()

◆ ~KisAbstractInputAction()

Member Function Documentation

◆ activate()

◆ begin()

◆ canIgnoreModifiers()

◆ cursorMoved()

◆ cursorMovedAbsolute()

◆ deactivate()

◆ description()

◆ end()

◆ eventPos()

◆ eventPosF()

◆ id()

◆ inputActionGroup()

◆ inputEvent()

◆ inputManager()

◆ isAvailable()

◆ isShortcutRequired()

◆ name()

◆ priority()

◆ setDescription()

◆ setInputManager()

◆ setName()

◆ setShortcutIndexes()

◆ shortcutIndexes()

◆ supportsHiResInputEvents()

◆ trySwitchShortcut()

Friends And Related Symbol Documentation

◆ KisInputManager

Member Data Documentation

◆ d

◆ description

◆ id

◆ indexes

◆ inputManager

◆ lastCursorPosition

◆ name

◆ startCursorPosition