hotkeycombination.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_INPUT_HOTKEYCOMBINATION_H
#define SWIFT_MISC_INPUT_HOTKEYCOMBINATION_H
 
#include <QMetaType>
#include <QStringList>
 
#include "misc/input/joystickbutton.h"
#include "misc/input/joystickbuttonlist.h"
#include "misc/input/keyboardkey.h"
#include "misc/input/keyboardkeylist.h"
#include "misc/metaclass.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::input, CHotkeyCombination)
 
namespace swift::misc::input
{
    class SWIFT_MISC_EXPORT CHotkeyCombination : public CValueObject<CHotkeyCombination>
    {
    public:
        CHotkeyCombination() = default;
 
        CHotkeyCombination(CKeyboardKey key);
 
        CHotkeyCombination(const CKeyboardKeyList &keys);
 
        void setKeyboardKeys(const CKeyboardKeyList &keys) { m_keyboardKeys = keys; }
 
        CKeyboardKeyList getKeyboardKeys() const { return m_keyboardKeys; }
 
        QStringList getKeyStrings() const { return m_keyboardKeys.getKeyStrings(); }
 
        void setJoystickButtons(const CJoystickButtonList &list) { m_joystickButtons = list; }
 
        CJoystickButtonList getJoystickButtons() const { return m_joystickButtons; }
 
        void addKeyboardKey(const CKeyboardKey &key);
 
        void addJoystickButton(const CJoystickButton &button);
 
        bool containsKeyboardKey(const CKeyboardKey &key) const;
 
        bool containsJoystickButton(const CJoystickButton &button) const;
 
        void replaceKey(CKeyboardKey oldKey, CKeyboardKey newKey);
 
        void replaceButton(CJoystickButton oldButton, CJoystickButton newButton);
 
        void removeKeyboardKey(CKeyboardKey key);
 
        void removeJoystickButton(CJoystickButton button);
 
        bool isEmpty() const { return m_keyboardKeys.isEmpty() && m_joystickButtons.isEmpty(); }
 
        int size() const { return m_keyboardKeys.size() + m_joystickButtons.size(); }
 
        bool isSubsetOf(const CHotkeyCombination &other) const;
 
        CHotkeyCombination getDeltaComparedTo(const CHotkeyCombination &other) const;
 
        QString convertToQString(bool i18n = false) const;
 
        QString asStringWithDeviceNames() const;
 
    private:
        CKeyboardKeyList m_keyboardKeys;
        CJoystickButtonList m_joystickButtons;
 
        SWIFT_METACLASS(
            CHotkeyCombination,
            SWIFT_METAMEMBER(keyboardKeys),
            SWIFT_METAMEMBER(joystickButtons));
    };
} // namespace swift::misc::input
 
Q_DECLARE_METATYPE(swift::misc::input::CHotkeyCombination)
 
#endif // SWIFT_MISC_INPUT_HOTKEYCOMBINATION_H