#include <kis_single_action_shortcut.h>

Inheritance diagram for KisSingleActionShortcut:

Public Types
enum	WheelAction { WheelUp , WheelDown , WheelLeft , WheelRight , WheelTrackpad }

Public Member Functions
bool	conflictsWith (const QKeySequence &seq)

	KisSingleActionShortcut (KisAbstractInputAction *action, int index)

bool	match (const QSet< Qt::Key > &modifiers, Qt::Key key)

bool	match (const QSet< Qt::Key > &modifiers, WheelAction wheelAction)

int	priority () const override

void	setKey (const QSet< Qt::Key > &modifiers, Qt::Key key)

void	setWheel (const QSet< Qt::Key > &modifiers, WheelAction wheelAction)

	~KisSingleActionShortcut () override

Public Member Functions inherited from KisAbstractShortcut
KisAbstractInputAction *	action () const

bool	isAvailable (KisInputActionGroupsMask mask) const

	KisAbstractShortcut (KisAbstractInputAction *action, int index)

void	setAction (KisAbstractInputAction *action)

int	shortcutIndex () const

virtual	~KisAbstractShortcut ()

Public Attributes
Qt::Key	key

QSet< Qt::Key >	modifiers

bool	useWheel

WheelAction	wheelAction

Public Attributes inherited from KisAbstractShortcut
KisAbstractInputAction *	action

int	shortcutIndex

Private Attributes
Private *const	m_d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Protected Member Functions inherited from KisAbstractShortcut
bool	compareKeys (const QSet< Qt::Key > &keys1, const QSet< Qt::Key > &keys2)

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

This class represents a shortcut that executes a simple atomic action. It can be initiated either by a keyboard hotkey or by a mouse wheel rotation.

Definition at line 13 of file kis_single_action_shortcut.cpp.

Member Enumeration Documentation

◆ WheelAction

enum KisSingleActionShortcut::WheelAction

Enumerator
WheelUp	Mouse wheel moves up.
WheelDown	Mouse wheel moves down.
WheelLeft	Mouse wheel moves left.
WheelRight	Mouse wheel moves right.
WheelTrackpad	A pan movement on a trackpad.

Definition at line 21 of file kis_single_action_shortcut.h.

                     {
        WheelUp, 
        WheelDown, 
        WheelLeft, 
        WheelRight, 
        WheelTrackpad, 
    };

Constructor & Destructor Documentation

◆ KisSingleActionShortcut()

KisSingleActionShortcut::KisSingleActionShortcut	(	KisAbstractInputAction *	action,
		int	index )

Definition at line 23 of file kis_single_action_shortcut.cpp.

    : KisAbstractShortcut(action, index),
      m_d(new Private)
{
}

◆ ~KisSingleActionShortcut()

KisSingleActionShortcut::~KisSingleActionShortcut ( )

override

Definition at line 29 of file kis_single_action_shortcut.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ conflictsWith()

bool KisSingleActionShortcut::conflictsWith ( const QKeySequence & seq )

Check is the shortcut or the key sequence is a prefix of one another

Definition at line 65 of file kis_single_action_shortcut.cpp.

{
    if (seq.isEmpty()) return false;
 
    int seqMainKey = seq[0];
    QVector<int> sequenceKeys;
 
    if (seqMainKey & Qt::MetaModifier) {
        sequenceKeys.append(Qt::Key_Meta);
        seqMainKey &= ~Qt::MetaModifier;
    } else if (seqMainKey & Qt::ControlModifier) {
        sequenceKeys.append(Qt::Key_Control);
        seqMainKey &= ~Qt::ControlModifier;
    } else if (seqMainKey & Qt::ShiftModifier) {
        sequenceKeys.append(Qt::Key_Shift);
        seqMainKey &= ~Qt::ShiftModifier;
    } else if (seqMainKey & Qt::AltModifier) {
        sequenceKeys.append(Qt::Key_Alt);
        seqMainKey &= ~Qt::AltModifier;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(seqMainKey != 0, false);
    sequenceKeys.append(seqMainKey);
    std::sort(sequenceKeys.begin(), sequenceKeys.end());
 
    QVector<int> shortcutKeys;
    std::copy(m_d->modifiers.begin(), m_d->modifiers.end(), std::back_inserter(shortcutKeys));
    shortcutKeys.append(m_d->key);
    std::sort(shortcutKeys.begin(), shortcutKeys.end());
 
    return
        std::includes(sequenceKeys.begin(), sequenceKeys.end(),
                      shortcutKeys.begin(), shortcutKeys.end()) ||
        std::includes(shortcutKeys.begin(), shortcutKeys.end(),
                      sequenceKeys.begin(), sequenceKeys.end());
}

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and m_d.

◆ match() [1/2]

bool KisSingleActionShortcut::match	(	const QSet< Qt::Key > &	modifiers,
		Qt::Key	key )

Definition at line 53 of file kis_single_action_shortcut.cpp.

{
    return !m_d->useWheel && key == m_d->key &&
        compareKeys(modifiers, m_d->modifiers);
}

References KisAbstractShortcut::compareKeys(), key, m_d, and modifiers.

◆ match() [2/2]

bool KisSingleActionShortcut::match	(	const QSet< Qt::Key > &	modifiers,
		WheelAction	wheelAction )

Definition at line 59 of file kis_single_action_shortcut.cpp.

{
    return m_d->useWheel && wheelAction == m_d->wheelAction &&
        compareKeys(modifiers, m_d->modifiers);
}

References KisAbstractShortcut::compareKeys(), m_d, modifiers, and wheelAction.

◆ priority()

int KisSingleActionShortcut::priority ( ) const

overridevirtual

The priority of the shortcut. The shortcut with the greatest value will be chosen for execution

Implements KisAbstractShortcut.

Definition at line 34 of file kis_single_action_shortcut.cpp.

{
    return m_d->modifiers.size() * 2 + 1 + action()->priority();
}

References KisAbstractShortcut::action, m_d, and KisAbstractInputAction::priority().

◆ setKey()

void KisSingleActionShortcut::setKey	(	const QSet< Qt::Key > &	modifiers,
		Qt::Key	key )

Definition at line 39 of file kis_single_action_shortcut.cpp.

{
    m_d->modifiers = modifiers;
    m_d->key = key;
    m_d->useWheel = false;
}

References key, m_d, and modifiers.

◆ setWheel()

void KisSingleActionShortcut::setWheel	(	const QSet< Qt::Key > &	modifiers,
		WheelAction	wheelAction )

Definition at line 46 of file kis_single_action_shortcut.cpp.

{
    m_d->modifiers = modifiers;
    m_d->wheelAction = wheelAction;
    m_d->useWheel = true;
}

References m_d, modifiers, and wheelAction.

Member Data Documentation

◆ key

Qt::Key KisSingleActionShortcut::key

Definition at line 17 of file kis_single_action_shortcut.cpp.

◆ m_d

Private* const KisSingleActionShortcut::m_d

private

Definition at line 47 of file kis_single_action_shortcut.h.

◆ modifiers

QSet<Qt::Key> KisSingleActionShortcut::modifiers

Definition at line 16 of file kis_single_action_shortcut.cpp.

◆ useWheel

bool KisSingleActionShortcut::useWheel

Definition at line 18 of file kis_single_action_shortcut.cpp.

◆ wheelAction

WheelAction KisSingleActionShortcut::wheelAction

Definition at line 19 of file kis_single_action_shortcut.cpp.

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

libs/ui/input/kis_single_action_shortcut.cpp
libs/ui/input/kis_single_action_shortcut.h

Public Types

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members