KisAlternateInvocationAction Class Reference

Alternate Invocation implementation of KisAbstractInputAction. More...

#include <kis_alternate_invocation_action.h>

Inheritance diagram for KisAlternateInvocationAction:

Classes
struct	Private

Public Types
enum	Shortcut {   PrimaryAlternateModeShortcut , SecondaryAlternateModeShortcut , SampleColorFgLayerModeShortcut , SampleColorBgLayerModeShortcut ,   SampleColorFgImageModeShortcut , SampleColorBgImageModeShortcut , TertiaryAlternateModeShortcut }

Public Member Functions
void	activate (int shortcut) override
void	begin (int shortcut, QEvent *event) override
void	deactivate (int shortcut) override
void	end (QEvent *event) override
void	inputEvent (QEvent *event) override
	KisAlternateInvocationAction ()
int	priority () const override
bool	supportsHiResInputEvents (int shortcut) const override
	~KisAlternateInvocationAction () override
Public Member Functions inherited from KisAbstractInputAction
virtual bool	canIgnoreModifiers () const
virtual QString	description () const
virtual QString	id () const
virtual KisInputActionGroup	inputActionGroup (int shortcut) const
virtual bool	isAvailable () const
virtual bool	isShortcutRequired (int shortcut) const
	KisAbstractInputAction (const QString &id)
virtual QString	name () const
virtual QHash< QString, int >	shortcutIndexes () const
virtual	~KisAbstractInputAction ()

Private Member Functions
KisTool::ToolAction	shortcutToToolAction (int shortcut) const

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Attributes inherited from KisAbstractInputAction
QString	description
QString	id
QHash< QString, int >	indexes
QPointF	lastCursorPosition
QString	name
QPointF	startCursorPosition
Static Public Attributes inherited from KisAbstractInputAction
static KisInputManager *	inputManager
Protected Member Functions inherited from KisAbstractInputAction
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)

Detailed Description

Alternate Invocation implementation of KisAbstractInputAction.

The Alternate Invocation action performs an alternate action with the current tool. For example, using the brush tool it samples a color from the canvas.

Definition at line 21 of file kis_alternate_invocation_action.h.

Member Enumeration Documentation

Shortcut

enum KisAlternateInvocationAction::Shortcut

The different behaviours for this action.

Enumerator
PrimaryAlternateModeShortcut	Toggle Primary mode.
SecondaryAlternateModeShortcut	Toggle Secondary mode.
SampleColorFgLayerModeShortcut
SampleColorBgLayerModeShortcut
SampleColorFgImageModeShortcut
SampleColorBgImageModeShortcut
TertiaryAlternateModeShortcut	Warning: don't reorder the items of this enum, it breaks user configs!

Definition at line 27 of file kis_alternate_invocation_action.h.

                  {
        PrimaryAlternateModeShortcut, 
        SecondaryAlternateModeShortcut, 
        SampleColorFgLayerModeShortcut,
        SampleColorBgLayerModeShortcut,
        SampleColorFgImageModeShortcut,
        SampleColorBgImageModeShortcut,
        TertiaryAlternateModeShortcut 
    };

Constructor & Destructor Documentation

KisAlternateInvocationAction()

KisAlternateInvocationAction::KisAlternateInvocationAction ( )

explicit

Definition at line 25 of file kis_alternate_invocation_action.cpp.

    : KisAbstractInputAction("Alternate Invocation")
    , m_d(new Private)
{
    setName(i18n("Alternate Invocation"));
    setDescription(i18n("The <i>Alternate Invocation</i> action performs an alternate action with the current tool. For example, using the brush tool it samples a color from the canvas."));
    QHash<QString, int> shortcuts;
    shortcuts.insert(i18n("Primary Mode"), PrimaryAlternateModeShortcut);
    shortcuts.insert(i18n("Secondary Mode"), SecondaryAlternateModeShortcut);
    shortcuts.insert(i18n("Tertiary Mode"), TertiaryAlternateModeShortcut);
 
 
    shortcuts.insert(i18n("Sample Foreground Color from Current Layer"), SampleColorFgLayerModeShortcut);
    shortcuts.insert(i18n("Sample Background Color from Current Layer"), SampleColorBgLayerModeShortcut);
 
    shortcuts.insert(i18n("Sample Foreground Color from Merged Image"), SampleColorFgImageModeShortcut);
    shortcuts.insert(i18n("Sample Background Color from Merged Image"), SampleColorBgImageModeShortcut);
 
    setShortcutIndexes(shortcuts);
}

References PrimaryAlternateModeShortcut, SampleColorBgImageModeShortcut, SampleColorBgLayerModeShortcut, SampleColorFgImageModeShortcut, SampleColorFgLayerModeShortcut, SecondaryAlternateModeShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), KisAbstractInputAction::setShortcutIndexes(), and TertiaryAlternateModeShortcut.

~KisAlternateInvocationAction()

KisAlternateInvocationAction::~KisAlternateInvocationAction ( )

override

Definition at line 46 of file kis_alternate_invocation_action.cpp.

{
}

Member Function Documentation

activate()

void KisAlternateInvocationAction::activate ( int shortcut )

overridevirtual

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 from KisAbstractInputAction.

Definition at line 81 of file kis_alternate_invocation_action.cpp.

{
    KisTool::ToolAction action = shortcutToToolAction(shortcut);
    inputManager()->toolProxy()->activateToolAction(action);
}

References KisAbstractInputAction::inputManager, shortcutToToolAction(), and KisInputManager::toolProxy().

begin()

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

overridevirtual

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 from KisAbstractInputAction.

Definition at line 98 of file kis_alternate_invocation_action.cpp.

{
    if (!event) return;
 
    KisAbstractInputAction::begin(shortcut, event);
 
    QMouseEvent targetEvent(QEvent::MouseButtonPress, eventPosF(event), Qt::LeftButton, Qt::LeftButton, Qt::ControlModifier); // There must be a better way
 
    m_d->savedAction = shortcutToToolAction(shortcut);
 
    inputManager()->toolProxy()->forwardEvent(KisToolProxy::BEGIN, m_d->savedAction, &targetEvent, event);
}

References KisToolProxy::BEGIN, KisAbstractInputAction::begin(), KisAbstractInputAction::eventPosF(), KisAbstractInputAction::inputManager, m_d, shortcutToToolAction(), and KisInputManager::toolProxy().

deactivate()

void KisAlternateInvocationAction::deactivate ( int shortcut )

overridevirtual

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 from KisAbstractInputAction.

Definition at line 87 of file kis_alternate_invocation_action.cpp.

{
    KisTool::ToolAction action = shortcutToToolAction(shortcut);
    inputManager()->toolProxy()->deactivateToolAction(action);
}

References KisAbstractInputAction::inputManager, shortcutToToolAction(), and KisInputManager::toolProxy().

end()

void KisAlternateInvocationAction::end ( QEvent * event )

overridevirtual

End the action.

Parameters

event

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

Reimplemented from KisAbstractInputAction.

Definition at line 111 of file kis_alternate_invocation_action.cpp.

{
    if (!event) return;
 
    Qt::KeyboardModifiers modifiers;
 
    switch (m_d->savedAction) {
    case KisTool::AlternateSampleFgNode:
        modifiers = Qt::ControlModifier;
        break;
    case KisTool::AlternateThird:
        modifiers = Qt::ControlModifier | Qt::AltModifier;
        break;
    default:
        ;
    }
 
    QMouseEvent targetEvent = QMouseEvent(QEvent::MouseButtonRelease, eventPosF(event), Qt::LeftButton, Qt::LeftButton, modifiers);
    inputManager()->toolProxy()->forwardEvent(KisToolProxy::END, m_d->savedAction, &targetEvent, event);
 
    KisAbstractInputAction::end(event);
}

References KisTool::AlternateSampleFgNode, KisTool::AlternateThird, KisToolProxy::END, KisAbstractInputAction::end(), KisAbstractInputAction::eventPosF(), KisAbstractInputAction::inputManager, m_d, and KisInputManager::toolProxy().

inputEvent()

void KisAlternateInvocationAction::inputEvent ( QEvent * event )

overridevirtual

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 from KisAbstractInputAction.

Definition at line 134 of file kis_alternate_invocation_action.cpp.

{
    if (event
        && ((event->type() == QEvent::MouseMove) || (event->type() == QEvent::TabletMove)
            || (event->type() == QEvent::TouchUpdate))) {
        Qt::KeyboardModifiers modifiers;
        switch (m_d->savedAction) {
        case KisTool::AlternateSampleFgNode:
            modifiers =  Qt::ControlModifier;
            break;
        case KisTool::AlternateThird:
            modifiers = Qt::ControlModifier | Qt::AltModifier;
            break;
        default:
            modifiers = Qt::ShiftModifier;
        }
 
        QMouseEvent targetEvent(QEvent::MouseMove, eventPosF(event), Qt::LeftButton, Qt::LeftButton, modifiers);
        inputManager()->toolProxy()->forwardEvent(KisToolProxy::CONTINUE, m_d->savedAction, &targetEvent, event);
    }
}

References KisTool::AlternateSampleFgNode, KisTool::AlternateThird, KisToolProxy::CONTINUE, KisAbstractInputAction::eventPosF(), KisAbstractInputAction::inputManager, m_d, and KisInputManager::toolProxy().

priority()

int KisAlternateInvocationAction::priority ( ) const

overridevirtual

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 from KisAbstractInputAction.

Definition at line 93 of file kis_alternate_invocation_action.cpp.

{
    return 9;
}

shortcutToToolAction()

KisTool::ToolAction KisAlternateInvocationAction::shortcutToToolAction ( int shortcut ) const

private

Definition at line 50 of file kis_alternate_invocation_action.cpp.

{
    KisTool::ToolAction action = KisTool::Alternate_NONE;
 
    switch ((Shortcut)shortcut) {
    case SampleColorFgLayerModeShortcut:
        action = KisTool::AlternateSampleFgNode;
        break;
    case SampleColorBgLayerModeShortcut:
        action = KisTool::AlternateSampleBgNode;
        break;
    case SampleColorFgImageModeShortcut:
        action = KisTool::AlternateSampleFgImage;
        break;
    case SampleColorBgImageModeShortcut:
        action = KisTool::AlternateSampleBgImage;
        break;
    case PrimaryAlternateModeShortcut:
        action = KisTool::AlternateSecondary;
        break;
    case SecondaryAlternateModeShortcut:
        action = KisTool::AlternateThird;
        break;
    case TertiaryAlternateModeShortcut:
        action = KisTool::AlternateFourth;
        break;
    }
 
    return action;
}

References KisTool::Alternate_NONE, KisTool::AlternateFourth, KisTool::AlternateSampleBgImage, KisTool::AlternateSampleBgNode, KisTool::AlternateSampleFgImage, KisTool::AlternateSampleFgNode, KisTool::AlternateSecondary, KisTool::AlternateThird, PrimaryAlternateModeShortcut, SampleColorBgImageModeShortcut, SampleColorBgLayerModeShortcut, SampleColorFgImageModeShortcut, SampleColorFgLayerModeShortcut, SecondaryAlternateModeShortcut, and TertiaryAlternateModeShortcut.

supportsHiResInputEvents()

bool KisAlternateInvocationAction::supportsHiResInputEvents ( int shortcut ) const

overridevirtual

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 from KisAbstractInputAction.

Definition at line 156 of file kis_alternate_invocation_action.cpp.

{
    return inputManager()->toolProxy()->alternateActionSupportsHiResEvents(
        KisTool::actionToAlternateAction(shortcutToToolAction(shortcut)));
}

References KisTool::actionToAlternateAction(), KisAbstractInputAction::inputManager, shortcutToToolAction(), and KisInputManager::toolProxy().

Member Data Documentation

m_d

const QScopedPointer<Private> KisAlternateInvocationAction::m_d

private

Definition at line 57 of file kis_alternate_invocation_action.h.

---

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

• libs/ui/input/kis_alternate_invocation_action.h
• libs/ui/input/kis_alternate_invocation_action.cpp