A class encapsulating all settings for a single shortcut. More...

#include <kis_shortcut_configuration.h>

Classes
class	Private

Public Types
enum	MouseWheelMovement { NoMovement , WheelUp , WheelDown , WheelLeft , WheelRight , WheelReserved_0 }

enum	NativeGestureAction { NoNativeGesture = 0 , PinchGesture = 1 , SmartZoomGesture = 4 , TouchpadScroll = 5 , MaxNativeGesture }

enum	ShortcutType { UnknownType , KeyCombinationType , MouseButtonType , MouseWheelType , TouchGestureType , NativeGestureType }

enum	TouchGestureAction { NoGesture , OneFingerTap , TwoFingerTap , ThreeFingerTap , FourFingerTap , FiveFingerTap , OneFingerDrag , TwoFingerDrag , ThreeFingerDrag , FourFingerDrag , FiveFingerDrag , OneFingerHold , MaxGesture }

Public Member Functions
KisAbstractInputAction *	action () const

Qt::MouseButtons	buttons () const

QString	getInputText () const

bool	isNoOp () const

QList< Qt::Key >	keys () const

	KisShortcutConfiguration ()

	KisShortcutConfiguration (const KisShortcutConfiguration &other)

uint	mode () const

NativeGestureAction	nativeGesture () const

KisShortcutConfiguration &	operator= (const KisShortcutConfiguration &other)

bool	operator== (const KisShortcutConfiguration &other) const

QString	serialize ()

void	setAction (KisAbstractInputAction *newAction)

void	setButtons (Qt::MouseButtons newButtons)

void	setKeys (const QList< Qt::Key > &newKeys)

void	setMode (uint newMode)

void	setNativeGesture (NativeGestureAction type)

void	setTouchGesture (TouchGestureAction type)

void	setType (ShortcutType newType)

void	setWheel (MouseWheelMovement type)

TouchGestureAction	touchGesture () const

ShortcutType	type () const

bool	unserialize (const QString &serialized)

MouseWheelMovement	wheel () const

virtual	~KisShortcutConfiguration ()

Static Public Member Functions
static QString	buttonsInputToText (const QList< Qt::Key > &keys, Qt::MouseButtons buttons)

static QString	buttonsToText (Qt::MouseButtons buttons)

static QString	keysToText (const QList< Qt::Key > &keys)

static QString	nativeGestureToText (NativeGestureAction action)

static QString	shortcutTypeToText (ShortcutType type)

static QString	touchGestureToText (TouchGestureAction action)

static QString	wheelInputToText (const QList< Qt::Key > &keys, MouseWheelMovement wheel)

static QString	wheelToText (MouseWheelMovement wheel)

Private Attributes
Private *const	d

Detailed Description

A class encapsulating all settings for a single shortcut.

This class encapsulates mouse buttons, keyboard keys and other settings related to a single shortcut for a single action.

Note: Each action can have several modes that activate it with usually different behaviour for each mode. Different shortcuts can activate different modes.

Definition at line 29 of file kis_shortcut_configuration.h.

Member Enumeration Documentation

◆ MouseWheelMovement

enum KisShortcutConfiguration::MouseWheelMovement

The type of mouse wheel movement.

Enumerator
NoMovement	No movement.
WheelUp	Upwards movement, away from the user.
WheelDown	Downwards movement, toward the user.
WheelLeft	Left movement.
WheelRight	Right movement.
WheelReserved_0	Do not use! Previously was used for TouchpadScroll shortcut.

Definition at line 47 of file kis_shortcut_configuration.h.

                            {
        NoMovement, 
        WheelUp, 
        WheelDown, 
        WheelLeft, 
        WheelRight, 
        WheelReserved_0, 
    };

◆ NativeGestureAction

enum KisShortcutConfiguration::NativeGestureAction

Enumerator
NoNativeGesture	No gesture.
PinchGesture	Pinch gesture, a two finger gesture used for navigating the canvas.
SmartZoomGesture	Smart zoom gesture, typically a double tap that is a boolean zoom/unzoom.
TouchpadScroll	Two-dimensional pixel scrolling on a touchpad, supported on MacOS and Wayland only.
MaxNativeGesture

Definition at line 75 of file kis_shortcut_configuration.h.

                             {
        NoNativeGesture = 0, 
        PinchGesture = 1, 
 
        // WARNING: elements with indexes 1 and 2 are intentionally skipped,
        // they used to represent Qt::PanNativeGesture and Qt::RotateNativeGesture,
        // but now all three gestures are represented as a single PinchGesture.
 
        SmartZoomGesture = 4, 
        TouchpadScroll = 5, 
        MaxNativeGesture,
    };

◆ ShortcutType

enum KisShortcutConfiguration::ShortcutType

The type of shortcut, i.e. what kind of input does it expect.

Enumerator
UnknownType	Unknown, empty shortcut.
KeyCombinationType	A list of keys that should be pressed.
MouseButtonType	A mouse button, possibly with key modifiers.
MouseWheelType	Mouse wheel movement, possibly with key modifiers.
TouchGestureType	A touch gesture.
NativeGestureType	A macOS gesture.

Definition at line 35 of file kis_shortcut_configuration.h.

                      {
        UnknownType, 
        KeyCombinationType, 
        MouseButtonType, 
        MouseWheelType, 
        TouchGestureType, 
        NativeGestureType, 
    };

◆ TouchGestureAction

enum KisShortcutConfiguration::TouchGestureAction

The type of gesture.

Enumerator
NoGesture	No gesture.
OneFingerTap
TwoFingerTap
ThreeFingerTap
FourFingerTap
FiveFingerTap
OneFingerDrag
TwoFingerDrag
ThreeFingerDrag
FourFingerDrag
FiveFingerDrag
OneFingerHold
MaxGesture

Definition at line 59 of file kis_shortcut_configuration.h.

                            {
        NoGesture, 
        OneFingerTap,
        TwoFingerTap,
        ThreeFingerTap,
        FourFingerTap,
        FiveFingerTap,
        OneFingerDrag,
        TwoFingerDrag,
        ThreeFingerDrag,
        FourFingerDrag,
        FiveFingerDrag,
        OneFingerHold,
        MaxGesture,
    };

Constructor & Destructor Documentation

◆ KisShortcutConfiguration() [1/2]

KisShortcutConfiguration::KisShortcutConfiguration ( )

Constructor.

Definition at line 40 of file kis_shortcut_configuration.cpp.

    : d(new Private)
{
 
}

◆ KisShortcutConfiguration() [2/2]

KisShortcutConfiguration::KisShortcutConfiguration ( const KisShortcutConfiguration & other )

Copy constructor.

Definition at line 46 of file kis_shortcut_configuration.cpp.

    : d(new Private)
{
    d->action = other.action();
    d->type = other.type();
    d->mode = other.mode();
    d->keys = other.keys();
    d->buttons = other.buttons();
    d->wheel = other.wheel();
    d->touchGesture = other.touchGesture();
    d->nativeGesture = other.nativeGesture();
}

References KisShortcutConfiguration::Private::action, action(), KisShortcutConfiguration::Private::buttons, buttons(), d, KisShortcutConfiguration::Private::keys, keys(), KisShortcutConfiguration::Private::mode, mode(), KisShortcutConfiguration::Private::nativeGesture, nativeGesture(), KisShortcutConfiguration::Private::touchGesture, touchGesture(), KisShortcutConfiguration::Private::type, type(), KisShortcutConfiguration::Private::wheel, and wheel().

◆ ~KisShortcutConfiguration()

KisShortcutConfiguration::~KisShortcutConfiguration ( )

virtual

Destructor.

Definition at line 79 of file kis_shortcut_configuration.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ action()

KisAbstractInputAction * KisShortcutConfiguration::action ( ) const

Returns: The action this shortcut is associated with.

Definition at line 175 of file kis_shortcut_configuration.cpp.

{
    return d->action;
}

References KisShortcutConfiguration::Private::action, and d.

◆ buttons()

Qt::MouseButtons KisShortcutConfiguration::buttons ( ) const

Returns: The mouse buttons that will trigger this shortcut.

Note: Only applicable when type is MouseButtonType.

Definition at line 223 of file kis_shortcut_configuration.cpp.

{
    return d->buttons;
}

References KisShortcutConfiguration::Private::buttons, and d.

◆ buttonsInputToText()

QString KisShortcutConfiguration::buttonsInputToText	(	const QList< Qt::Key > &	keys,
		Qt::MouseButtons	buttons )

static

Convert a shortcut build of a set of keys and a set of mouse buttons into a user-readable string.

This will convert the given mouse buttons-based shortcut into a string that can be shown to a user. For example, the combination of Qt::Key_Control and Qt::LeftButton + Qt::RightButton will produce the string "Ctrl + Left + Right Button".

Parameters

keys	The keys to convert.
buttons	The mouse buttons to convert.

Returns: A string representing the shortcut that can be shown to a user.

Note: An empty set of buttons will appear as the string "None".

Definition at line 442 of file kis_shortcut_configuration.cpp.

{
    QString buttonsText = KisShortcutConfiguration::buttonsToText(buttons);
 
    if (keys.size() > 0) {
        return i18nc(
            "%1 = modifier keys in shortcut; %2 = mouse buttons in shortcut",
            "%1 + %2",
            KisShortcutConfiguration::keysToText(keys),
            buttonsText);
    }
    else {
        return buttonsText;
    }
}

References buttons(), buttonsToText(), keys(), and keysToText().

◆ buttonsToText()

QString KisShortcutConfiguration::buttonsToText ( Qt::MouseButtons buttons )

static

Convert a set of mouse buttons into a user-readable string.

This will convert the given set of buttons into a string that can be shown to a user. For example, the combination Qt::LeftButton + Qt::RightButton will produce the string "Left + Right Button".

Parameters

buttons The buttons to convert.

Returns: A string representing the buttons that can be shown to a user.

Note: An empty set will produce the string "None".

Definition at line 297 of file kis_shortcut_configuration.cpp.

{
    QString text;
    QString sep = i18nc("Separator in the list of mouse buttons for shortcut", " + ");
 
    int buttonCount = 0;
 
    if (buttons & Qt::LeftButton) {
        text.append(i18nc("Left Mouse Button", "Left"));
        buttonCount++;
    }
 
    if (buttons & Qt::RightButton) {
        if (buttonCount++ > 0) {
            text.append(sep);
        }
 
        text.append(i18nc("Right Mouse Button", "Right"));
    }
 
    if (buttons & Qt::MiddleButton) {
        if (buttonCount++ > 0) {
            text.append(sep);
        }
 
        text.append(i18nc("Middle Mouse Button", "Middle"));
    }
 
    if (buttons & Qt::BackButton) {
        if (buttonCount++ > 0) {
            text.append(sep);
        }
 
        text.append(i18nc("Mouse Back Button", "Back"));
    }
 
    if (buttons & Qt::ForwardButton) {
        if (buttonCount++ > 0) {
            text.append(sep);
        }
 
        text.append(i18nc("Mouse Forward Button", "Forward"));
    }
 
    if (buttons & Qt::TaskButton) {
        if (buttonCount++ > 0) {
            text.append(sep);
        }
 
        text.append(i18nc("Mouse Task Button", "Task"));
    }
 
// Qt supports up to ExtraButton24 so include those
#define EXTRA_BUTTON(z, n, _)\
    if (buttons & Qt::ExtraButton##n) { \
        if (buttonCount++ > 0) { text.append(sep); } \
        text.append(i18nc("Mouse Button", "Mouse %1", n + 3)); \
    }
BOOST_PP_REPEAT_FROM_TO(4, 25, EXTRA_BUTTON, _)
#undef EXTRA_BUTTON
 
    if (buttonCount == 0) {
        text.append(i18nc("No mouse buttons for shortcut", "None"));
    }
    else {
        text = i18ncp(
            "%1 = List of mouse buttons for shortcut. "
            "Plural form is chosen upon the number of buttons in that list.",
            "%1 Button", "%1 Buttons", text, buttonCount);
    }
 
    return text;
}

References buttons(), and EXTRA_BUTTON.

◆ getInputText()

QString KisShortcutConfiguration::getInputText ( ) const

Returns: an input string for the shortcut type.

Definition at line 279 of file kis_shortcut_configuration.cpp.

{
    switch (d->type) {
        case KeyCombinationType:
            return keysToText(d->keys);
        case MouseButtonType:
            return buttonsInputToText(d->keys, d->buttons);
        case MouseWheelType:
            return wheelInputToText(d->keys, d->wheel);
        case TouchGestureType:
            return touchGestureToText(d->touchGesture);
        case NativeGestureType:
            return nativeGestureToText(d->nativeGesture);
        default:
            return QString();
    }
}

References KisShortcutConfiguration::Private::buttons, buttonsInputToText(), d, KeyCombinationType, KisShortcutConfiguration::Private::keys, keysToText(), MouseButtonType, MouseWheelType, KisShortcutConfiguration::Private::nativeGesture, nativeGestureToText(), NativeGestureType, KisShortcutConfiguration::Private::touchGesture, touchGestureToText(), TouchGestureType, KisShortcutConfiguration::Private::type, KisShortcutConfiguration::Private::wheel, and wheelInputToText().

◆ isNoOp()

bool KisShortcutConfiguration::isNoOp ( ) const

Returns: True if shortcut is a no-op, that is it isn't bound to any input which can be performed by the user.

Definition at line 267 of file kis_shortcut_configuration.cpp.

{
    return d->type == UnknownType || (d->type == KeyCombinationType && d->keys.isEmpty())
        || (d->type == MouseButtonType && d->buttons.testFlag(Qt::NoButton))
        || (d->type == MouseWheelType && d->wheel == NoMovement)
        || (d->type == TouchGestureType
            && (d->touchGesture == NoGesture || d->touchGesture == MaxGesture))
        || (d->type == NativeGestureType
            && (d->nativeGesture == NoNativeGesture || d->nativeGesture == MaxNativeGesture));
 
}

References KisShortcutConfiguration::Private::buttons, d, KeyCombinationType, KisShortcutConfiguration::Private::keys, MaxGesture, MaxNativeGesture, MouseButtonType, MouseWheelType, KisShortcutConfiguration::Private::nativeGesture, NativeGestureType, NoGesture, NoMovement, NoNativeGesture, KisShortcutConfiguration::Private::touchGesture, TouchGestureType, KisShortcutConfiguration::Private::type, UnknownType, and KisShortcutConfiguration::Private::wheel.

◆ keys()

QList< Qt::Key > KisShortcutConfiguration::keys ( ) const

Returns: The list of keys that will trigger this shortcut.

Note: Not applicable when type is GestureType.

Definition at line 211 of file kis_shortcut_configuration.cpp.

{
    return d->keys;
}

References d, and KisShortcutConfiguration::Private::keys.

◆ keysToText()

QString KisShortcutConfiguration::keysToText ( const QList< Qt::Key > & keys )

static

Convert a list of keys to a user-readable string.

This will convert the given list of keys into a string that can be shown to a user. For example, the list [Qt::Key_Shift, Qt::Key_Space] will produce the string "Shift + Space".

Parameters

keys	The keys to convert.

Returns: A string representing the keys that can be shown to a user.

Note: An empty list will produce the string "None".

Definition at line 371 of file kis_shortcut_configuration.cpp.

{
    QString output;
 
    Q_FOREACH (Qt::Key key, keys) {
#if defined(Q_OS_MAC)
        // This works for modifier keys on macOS but not other platforms.
        // They are shown with symbols, so no translation or separators needed.
        output.append(QKeySequence(key).toString(QKeySequence::NativeText));
#else
        if (output.size() > 0) {
            output.append(i18nc("Separator in the list of keys for shortcut", " + "));
        }
 
        switch (key) { //Because QKeySequence fails for Ctrl, Alt, Shift and Meta
        case Qt::Key_Control:
            output.append(i18nc("Ctrl key", "Ctrl"));
            break;
 
        case Qt::Key_Meta:
            output.append(i18nc("Meta key", "Meta"));
            break;
 
        case Qt::Key_Alt:
            output.append(i18nc("Alt key", "Alt"));
            break;
 
        case Qt::Key_Shift:
            output.append(i18nc("Shift key", "Shift"));
            break;
 
        default:
            QKeySequence s(key);
            output.append(s.toString(QKeySequence::NativeText));
            break;
        }
#endif
    }
 
    if (output.size() == 0) {
        output = i18nc("No keys for shortcut", "None");
    }
 
    return output;
}

References keys().

◆ mode()

uint KisShortcutConfiguration::mode ( ) const

Returns: The mode of the action this shortcut will trigger.

Definition at line 199 of file kis_shortcut_configuration.cpp.

{
    return d->mode;
}

References d, and KisShortcutConfiguration::Private::mode.

◆ nativeGesture()

KisShortcutConfiguration::NativeGestureAction KisShortcutConfiguration::nativeGesture ( ) const

Returns: The native gesture that will trigger this shortcut.

Note: Only applicable when type is MacOSGestureType.

Definition at line 257 of file kis_shortcut_configuration.cpp.

{
    return d->nativeGesture;
}

References d, and KisShortcutConfiguration::Private::nativeGesture.

◆ nativeGestureToText()

QString KisShortcutConfiguration::nativeGestureToText ( NativeGestureAction action )

static

Definition at line 474 of file kis_shortcut_configuration.cpp.

{
    switch (action) {
    case PinchGesture:
        return i18n("Pinch Gesture");
    case SmartZoomGesture:
        return i18n("Smart Zoom Gesture");
    case TouchpadScroll:
        return i18n("Touchpad Scroll Gesture");
    default:
        return i18n("No Gesture");
    }
}

References action(), PinchGesture, SmartZoomGesture, and TouchpadScroll.

◆ operator=()

KisShortcutConfiguration & KisShortcutConfiguration::operator= ( const KisShortcutConfiguration & other )

Copy assignment.

Definition at line 59 of file kis_shortcut_configuration.cpp.

{
    d->action = other.action();
    d->type = other.type();
    d->mode = other.mode();
    d->keys = other.keys();
    d->buttons = other.buttons();
    d->wheel = other.wheel();
    d->touchGesture = other.touchGesture();
    d->nativeGesture = other.nativeGesture();
 
    return *this;
}

References KisShortcutConfiguration::Private::action, action(), KisShortcutConfiguration::Private::buttons, buttons(), d, KisShortcutConfiguration::Private::keys, keys(), KisShortcutConfiguration::Private::mode, mode(), KisShortcutConfiguration::Private::nativeGesture, nativeGesture(), KisShortcutConfiguration::Private::touchGesture, touchGesture(), KisShortcutConfiguration::Private::type, type(), KisShortcutConfiguration::Private::wheel, and wheel().

◆ operator==()

bool KisShortcutConfiguration::operator== ( const KisShortcutConfiguration & other ) const

Checks whether two configurations have the same input config.

Note: This does not compare the action or the modes the Shortcut is mapped to. This is because those fields are what the input mapping should do and not what an input mapping is. That is: this will return true even if two profiles have different actions.

Definition at line 73 of file kis_shortcut_configuration.cpp.

{
    return d->type == other.d->type && d->keys == other.d->keys && d->buttons == other.d->buttons
        && d->wheel == other.d->wheel && d->touchGesture == other.d->touchGesture && d->nativeGesture == other.d->nativeGesture;
}

References KisShortcutConfiguration::Private::buttons, d, KisShortcutConfiguration::Private::keys, KisShortcutConfiguration::Private::nativeGesture, KisShortcutConfiguration::Private::touchGesture, KisShortcutConfiguration::Private::type, and KisShortcutConfiguration::Private::wheel.

◆ serialize()

QString KisShortcutConfiguration::serialize ( )

Serialize the data of this shortcut into a string that can be saved into a configuration file.

The string will have the following format:

{mode;type;[key,key];buttons;wheel;gesture}

with each property serialized into a base-16 integer.

Returns: A serialized representation of this shortcut.

Definition at line 84 of file kis_shortcut_configuration.cpp.

{
    QString serialized("{");
 
    serialized.append(QString::number(d->mode, 16));
    serialized.append(';');
    serialized.append(QString::number(d->type, 16));
    serialized.append(";[");
 
    for (QList<Qt::Key>::iterator itr = d->keys.begin(); itr != d->keys.end(); ++itr) {
        serialized.append(QString::number(*itr, 16));
 
        if (itr + 1 != d->keys.end()) {
            serialized.append(',');
        }
    }
 
    serialized.append("];");
 
    serialized.append(QString::number(d->buttons, 16));
    serialized.append(';');
    serialized.append(QString::number(d->wheel, 16));
    serialized.append(';');
    if (d->type == NativeGestureType) {
        serialized.append(QString::number(d->nativeGesture, 16));
    } else {
        serialized.append(QString::number(d->touchGesture, 16));
    }
    serialized.append('}');
 
    return serialized;
}

References KisShortcutConfiguration::Private::buttons, d, KisShortcutConfiguration::Private::keys, KisShortcutConfiguration::Private::mode, KisShortcutConfiguration::Private::nativeGesture, NativeGestureType, KisShortcutConfiguration::Private::touchGesture, KisShortcutConfiguration::Private::type, and KisShortcutConfiguration::Private::wheel.

◆ setAction()

void KisShortcutConfiguration::setAction ( KisAbstractInputAction * newAction )

Set the action this shortcut should be associated with.

Parameters

newAction The action to set.

Definition at line 180 of file kis_shortcut_configuration.cpp.

{
    if (d->action != newAction) {
        d->action = newAction;
    }
}

References KisShortcutConfiguration::Private::action, and d.

◆ setButtons()

void KisShortcutConfiguration::setButtons ( Qt::MouseButtons newButtons )

Set the mouse buttons that will trigger this shortcut.

Parameters

newButtons The mouse buttons to use.

Note: Only applicable when type is MouseButtonType.

Definition at line 228 of file kis_shortcut_configuration.cpp.

{
    if (d->buttons != newButtons) {
        d->buttons = newButtons;
    }
}

References KisShortcutConfiguration::Private::buttons, and d.

◆ setKeys()

void KisShortcutConfiguration::setKeys ( const QList< Qt::Key > & newKeys )

Set the list of keys that will trigger this shortcut.

Parameters

newKeys The list of keys to use.

Note: Not applicable when type is GestureType.

Definition at line 216 of file kis_shortcut_configuration.cpp.

{
    if (d->keys != newKeys) {
        d->keys = newKeys;
    }
}

References d, and KisShortcutConfiguration::Private::keys.

◆ setMode()

void KisShortcutConfiguration::setMode ( uint newMode )

Set the mode of the action this shortcut will trigger.

Parameters

newMode The mode to set.

Definition at line 204 of file kis_shortcut_configuration.cpp.

{
    if (d->mode != newMode) {
        d->mode = newMode;
    }
}

References d, and KisShortcutConfiguration::Private::mode.

◆ setNativeGesture()

void KisShortcutConfiguration::setNativeGesture ( NativeGestureAction type )

Set the native gesture that will trigger this shortcut.

Parameters

type	The native gesture to use.

Note: Only applicable when type is MacOSGestureType.

Definition at line 262 of file kis_shortcut_configuration.cpp.

{
    d->nativeGesture = type;
}

References d, KisShortcutConfiguration::Private::nativeGesture, and type().

◆ setTouchGesture()

void KisShortcutConfiguration::setTouchGesture ( KisShortcutConfiguration::TouchGestureAction type )

Set the gesture that will trigger this shortcut.

Parameters

type	The gesture to use.

Note: Only applicable when type is GestureType.

Definition at line 252 of file kis_shortcut_configuration.cpp.

{
    d->touchGesture = type;
}

References d, KisShortcutConfiguration::Private::touchGesture, and type().

◆ setType()

void KisShortcutConfiguration::setType ( KisShortcutConfiguration::ShortcutType newType )

Set the type of shortcut.

Parameters

newType The type to set.

Definition at line 192 of file kis_shortcut_configuration.cpp.

{
    if (d->type != newType) {
        d->type = newType;
    }
}

References d, and KisShortcutConfiguration::Private::type.

◆ setWheel()

void KisShortcutConfiguration::setWheel ( KisShortcutConfiguration::MouseWheelMovement type )

Set the mouse wheel movement that will trigger this shortcut.

Parameters

type	The wheel movement to use.

Note: Only applicable when type is MouseWheelType.

Definition at line 240 of file kis_shortcut_configuration.cpp.

{
    if (d->wheel != type) {
        d->wheel = type;
    }
}

References d, type(), and KisShortcutConfiguration::Private::wheel.

◆ shortcutTypeToText()

QString KisShortcutConfiguration::shortcutTypeToText ( ShortcutType type )

static

Definition at line 518 of file kis_shortcut_configuration.cpp.

{
    switch (type) {
    case KisShortcutConfiguration::KeyCombinationType:
        return i18nc("Shortcut type", "Key Combination");
 
    case KisShortcutConfiguration::MouseButtonType:
        return i18nc("Shortcut type", "Mouse Button");
 
    case KisShortcutConfiguration::MouseWheelType:
        return i18nc("Shortcut type", "Mouse Wheel");
 
    case KisShortcutConfiguration::TouchGestureType:
        return i18nc("Shortcut type", "Touch Gesture");
 
    case KisShortcutConfiguration::NativeGestureType:
        return i18nc("Shortcut type", "Touchpad Gesture");
 
    default:
        return i18n("Unknown Input");
    }
}

References KeyCombinationType, MouseButtonType, MouseWheelType, NativeGestureType, TouchGestureType, and type().

◆ touchGesture()

KisShortcutConfiguration::TouchGestureAction KisShortcutConfiguration::touchGesture ( ) const

Returns: The gesture that will trigger this shortcut.

Note: Only applicable when type is GestureType.

Definition at line 247 of file kis_shortcut_configuration.cpp.

{
    return d->touchGesture;
}

References d, and KisShortcutConfiguration::Private::touchGesture.

◆ touchGestureToText()

QString KisShortcutConfiguration::touchGestureToText ( TouchGestureAction action )

static

Definition at line 488 of file kis_shortcut_configuration.cpp.

{
    switch (action) {
    case OneFingerTap:
        return i18n("One Finger Tap");
    case TwoFingerTap:
        return i18n("Two Finger Tap");
    case ThreeFingerTap:
        return i18n("Three Finger Tap");
    case FourFingerTap:
        return i18n("Four Finger Tap");
    case FiveFingerTap:
        return i18n("Five Finger Tap");
    case OneFingerDrag:
        return i18n("One Finger Drag");
    case TwoFingerDrag:
        return i18n("Two Finger Drag");
    case ThreeFingerDrag:
        return i18n("Three Finger Drag");
    case FourFingerDrag:
        return i18n("Four Finger Drag");
    case FiveFingerDrag:
        return i18n("Five Finger Drag");
    case OneFingerHold:
        return i18n("One Finger Hold");
    default:
        return i18n("No Gesture");
    }
}

References action(), FiveFingerDrag, FiveFingerTap, FourFingerDrag, FourFingerTap, OneFingerDrag, OneFingerHold, OneFingerTap, ThreeFingerDrag, ThreeFingerTap, TwoFingerDrag, and TwoFingerTap.

◆ type()

KisShortcutConfiguration::ShortcutType KisShortcutConfiguration::type ( ) const

Returns: The type of shortcut.

Definition at line 187 of file kis_shortcut_configuration.cpp.

{
    return d->type;
}

References d, and KisShortcutConfiguration::Private::type.

◆ unserialize()

bool KisShortcutConfiguration::unserialize ( const QString & serialized )

Apply the data from a serialized shortcut to this shortcut.

This method expects a string as described in serialize().

Parameters

serialized The serialized shortcut.

Returns: true if successful, false if an error occurred.

See also: serialize()

Definition at line 117 of file kis_shortcut_configuration.cpp.

{
    if (!serialized.startsWith('{'))
        return false;
 
    //Parse the serialized data and apply it to the current shortcut
    QString remainder = serialized;
 
    //Remove brackets
    remainder.remove('{').remove('}');
 
    //Split the remainder by ;
    QStringList parts = remainder.split(';');
 
    if (parts.size() < 6)
        return false; //Invalid input, abort
 
    //First entry in the list is the mode
    d->mode = parts.at(0).toUInt(nullptr, 16);
 
    //Second entry is the shortcut type
    d->type = static_cast<ShortcutType>(parts.at(1).toInt(nullptr, 16));
 
    if (d->type == UnknownType) {
        //Reject input that would set this shortcut to "Unknown"
        return false;
    }
 
    //Third entry is the list of keys
    QString serializedKeys = parts.at(2);
    //Remove brackets
    serializedKeys.remove('[').remove(']');
    //Split by , and add each entry as a key
    QStringList keylist = serializedKeys.split(',');
    Q_FOREACH(QString key, keylist) {
        if (!key.isEmpty()) {
            d->keys.append(static_cast<Qt::Key>(key.toUInt(nullptr, 16)));
        }
    }
 
    //Fourth entry is the button mask
    d->buttons = static_cast<Qt::MouseButtons>(parts.at(3).toInt(nullptr, 16));
    d->wheel = static_cast<MouseWheelMovement>(parts.at(4).toUInt(nullptr, 16));
 
    if (d->type == MouseWheelType && d->wheel == WheelReserved_0) {
        qWarning() << "WARNING: input profile contains deprecated Mouse Wheel shortcut (WheelReserved_0), skipping...";
        return false;
    }
 
    if (d->type == NativeGestureType) {
        d->nativeGesture = static_cast<NativeGestureAction>(parts.at(5).toUInt(nullptr, 16));
    } else {
        d->touchGesture = static_cast<TouchGestureAction>(parts.at(5).toUInt(nullptr, 16));
    }
 
    return true;
}

References KisShortcutConfiguration::Private::buttons, d, KisShortcutConfiguration::Private::keys, KisShortcutConfiguration::Private::mode, MouseWheelType, KisShortcutConfiguration::Private::nativeGesture, NativeGestureType, KisShortcutConfiguration::Private::touchGesture, KisShortcutConfiguration::Private::type, UnknownType, KisShortcutConfiguration::Private::wheel, and WheelReserved_0.

◆ wheel()

KisShortcutConfiguration::MouseWheelMovement KisShortcutConfiguration::wheel ( ) const

Returns: The mouse wheel movement that will trigger this shortcut.

Note: Only applicable when type is MouseWheelType.

Definition at line 235 of file kis_shortcut_configuration.cpp.

{
    return d->wheel;
}

References d, and KisShortcutConfiguration::Private::wheel.

◆ wheelInputToText()

QString KisShortcutConfiguration::wheelInputToText	(	const QList< Qt::Key > &	keys,
		KisShortcutConfiguration::MouseWheelMovement	wheel )

static

Convert a shortcut build of a set of keys and a set of mouse wheel buttons into a user-readable string.

This will convert the given mouse wheel-based shortcut into a string that can be shown to a user. For example, the combination of Qt::Key_Control and WheelUp will produce the string "Ctrl + Mouse Wheel Up".

Parameters

keys	The keys to convert.
wheel	The mouse wheel buttons to convert.

Returns: A string representing the shortcut that can be shown to a user.

Note: An empty set of wheel buttons will appear as the string "None".

Definition at line 458 of file kis_shortcut_configuration.cpp.

{
    QString wheelText = KisShortcutConfiguration::wheelToText(wheel);
 
    if (keys.size() > 0) {
        return i18nc(
            "%1 = modifier keys in shortcut; %2 = mouse wheel buttons in shortcut",
            "%1 + %2",
            KisShortcutConfiguration::keysToText(keys),
            wheelText);
    }
    else {
        return wheelText;
    }
}

References keys(), keysToText(), wheel(), and wheelToText().

◆ wheelToText()

QString KisShortcutConfiguration::wheelToText ( KisShortcutConfiguration::MouseWheelMovement wheel )

static

Convert the given mouse wheel movement to a string.

This will convert the given mouse wheel movement into a string that can be shown to a user. For example, WheelUp will produce the string "Mouse Wheel Up".

Parameters

wheel The mouse wheel movement to convert.

Returns: A string representing the mouse wheel movement that can be shown to a user.

Note: NoMovement will produce the string "None".

Definition at line 417 of file kis_shortcut_configuration.cpp.

{
    switch (wheel) {
    case KisShortcutConfiguration::WheelUp:
        return i18n("Mouse Wheel Up");
        break;
 
    case KisShortcutConfiguration::WheelDown:
        return i18n("Mouse Wheel Down");
        break;
 
    case KisShortcutConfiguration::WheelLeft:
        return i18n("Mouse Wheel Left");
        break;
 
    case KisShortcutConfiguration::WheelRight:
        return i18n("Mouse Wheel Right");
        break;
 
    default:
        return i18nc("No mouse wheel buttons for shortcut", "None");
        break;
    }
}

References wheel(), WheelDown, WheelLeft, WheelRight, and WheelUp.

Member Data Documentation

◆ d

Private* const KisShortcutConfiguration::d

private

Definition at line 354 of file kis_shortcut_configuration.h.

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

libs/ui/input/kis_shortcut_configuration.h
libs/ui/input/kis_shortcut_configuration.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ MouseWheelMovement

◆ NativeGestureAction

◆ ShortcutType

◆ TouchGestureAction

Constructor & Destructor Documentation

◆ KisShortcutConfiguration() [1/2]

◆ KisShortcutConfiguration() [2/2]

◆ ~KisShortcutConfiguration()

Member Function Documentation

◆ action()

◆ buttons()

◆ buttonsInputToText()

◆ buttonsToText()

◆ getInputText()

◆ isNoOp()

◆ keys()

◆ keysToText()

◆ mode()

◆ nativeGesture()

◆ nativeGestureToText()

◆ operator=()

◆ operator==()

◆ serialize()

◆ setAction()

◆ setButtons()

◆ setKeys()

◆ setMode()

◆ setNativeGesture()

◆ setTouchGesture()

◆ setType()

◆ setWheel()

◆ shortcutTypeToText()

◆ touchGesture()

◆ touchGestureToText()

◆ type()

◆ unserialize()

◆ wheel()

◆ wheelInputToText()

◆ wheelToText()

Member Data Documentation

◆ d