actionhotkey.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_ACTIONHOTKEY_H
#define SWIFT_MISC_INPUT_ACTIONHOTKEY_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/identifier.h"
#include "misc/input/hotkeycombination.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::input, CActionHotkey)
 
namespace swift::misc::input
{
    class SWIFT_MISC_EXPORT CActionHotkey : public CValueObject<CActionHotkey>
    {
    public:
        enum ColumnIndex
        {
            IndexIdentifier = CPropertyIndexRef::GlobalIndexCSettingKeyboardHotkey,
            IndexIdentifierAsString,
            IndexCombination,
            IndexCombinationAsString,
            IndexAction,
            IndexActionAsString,
            IndexObject, // just for updates
        };
 
        CActionHotkey() = default;
 
        CActionHotkey(const QString &action);
 
        CActionHotkey(const CIdentifier &identifier, const CHotkeyCombination &combination, const QString &action);
 
        const CHotkeyCombination &getCombination() const { return m_combination; }
 
        void setCombination(const CHotkeyCombination &combination);
 
        const QString &getAction() const { return m_action; }
 
        void setAction(const QString &action) { m_action = action; }
 
        const CIdentifier &getIdentifier() const { return m_identifier; }
 
        void setApplicableMachine(const CIdentifier &identifier) { m_identifier = identifier; }
 
        const CIdentifier &getApplicableMachine() const { return m_identifier; }
 
        bool isForSameMachineId(const CActionHotkey &key) const;
 
        bool isForSameMachineName(const CActionHotkey &key) const;
 
        bool isForSameMachine(const CActionHotkey &key) const;
 
        void updateToCurrentMachine();
 
        void setObject(const CActionHotkey &obj);
 
        bool isValid() const
        {
            return !m_identifier.getMachineName().isEmpty() && !m_combination.isEmpty() && !m_action.isEmpty();
        }
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        CIdentifier m_identifier; 
        CHotkeyCombination m_combination; 
        QString m_action; 
 
        SWIFT_METACLASS(
            CActionHotkey,
            SWIFT_METAMEMBER(identifier),
            SWIFT_METAMEMBER(combination),
            SWIFT_METAMEMBER(action));
    };
} // namespace swift::misc::input
 
Q_DECLARE_METATYPE(swift::misc::input::CActionHotkey)
 
#endif // SWIFT_MISC_INPUT_ACTIONHOTKEY_H