kis_shortcut_configuration.h

Go to the documentation of this file.

/*
 * This file is part of the KDE project
 * SPDX-FileCopyrightText: 2013 Arjen Hiemstra <ahiemstra@heimr.nl>
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef KISSHORTCUTCONFIGURATION_H
#define KISSHORTCUTCONFIGURATION_H
 
#include <kritaui_export.h>
 
#include <QList>
#include <QMetaType>
 
class QString;
class KisAbstractInputAction;
 
class KRITAUI_EXPORT KisShortcutConfiguration
{
public:
    enum ShortcutType {
        UnknownType, 
        KeyCombinationType, 
        MouseButtonType, 
        MouseWheelType, 
        TouchGestureType, 
        NativeGestureType, 
    };
 
    enum MouseWheelMovement {
        NoMovement, 
        WheelUp, 
        WheelDown, 
        WheelLeft, 
        WheelRight, 
        WheelReserved_0, 
    };
 
    enum TouchGestureAction {
        NoGesture, 
        OneFingerTap,
        TwoFingerTap,
        ThreeFingerTap,
        FourFingerTap,
        FiveFingerTap,
        OneFingerDrag,
        TwoFingerDrag,
        ThreeFingerDrag,
        FourFingerDrag,
        FiveFingerDrag,
        OneFingerHold,
        MaxGesture,
    };
 
    enum NativeGestureAction {
        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,
    };
 
    KisShortcutConfiguration();
    KisShortcutConfiguration(const KisShortcutConfiguration &other);
    KisShortcutConfiguration &operator=(const KisShortcutConfiguration &other);
 
    bool operator==(const KisShortcutConfiguration &other) const;
 
    virtual ~KisShortcutConfiguration();
 
    QString serialize();
    bool unserialize(const QString &serialized);
 
    KisAbstractInputAction *action() const;
    void setAction(KisAbstractInputAction *newAction);
 
    ShortcutType type() const;
    void setType(ShortcutType newType);
 
    uint mode() const;
    void setMode(uint newMode);
 
    QList<Qt::Key> keys() const;
    void setKeys(const QList<Qt::Key> &newKeys);
 
    Qt::MouseButtons buttons() const;
    void setButtons(Qt::MouseButtons newButtons);
 
    MouseWheelMovement wheel() const;
    void setWheel(MouseWheelMovement type);
 
    TouchGestureAction touchGesture() const;
 
    void setTouchGesture(TouchGestureAction type);
 
    NativeGestureAction nativeGesture() const;
 
    void setNativeGesture(NativeGestureAction type);
 
    bool isNoOp() const;
 
    QString getInputText() const;
 
    static QString buttonsToText(Qt::MouseButtons buttons);
    static QString keysToText(const QList<Qt::Key> &keys);
    static QString wheelToText(MouseWheelMovement wheel);
    static QString buttonsInputToText(const QList<Qt::Key> &keys, Qt::MouseButtons buttons);
    static QString wheelInputToText(const QList<Qt::Key> &keys, MouseWheelMovement wheel);
 
    static QString touchGestureToText(TouchGestureAction action);
    static QString nativeGestureToText(NativeGestureAction action);
    static QString shortcutTypeToText(ShortcutType type);
 
private:
    class Private;
    Private *const d;
};
 
Q_DECLARE_METATYPE(KisShortcutConfiguration *);
 
#endif // KISSHORTCUTCONFIGURATION_H