keyboardkey.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_INPUT_KEYBOARDKEY_H
#define SWIFT_MISC_INPUT_KEYBOARDKEY_H
 
#include <QList>
#include <QMetaType>
#include <QString>
 
#include "misc/input/keycodes.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::input, CKeyboardKey)
 
namespace swift::misc::input
{
    class SWIFT_MISC_EXPORT CKeyboardKey : public CValueObject<CKeyboardKey>
    {
    public:
        enum ColumnIndex
        {
            IndexKey = CPropertyIndexRef::GlobalIndexCKeyboardKey,
            IndexKeyAsString,
            IndexKeyObject, // just for updates
        };
 
        CKeyboardKey();
 
        CKeyboardKey(swift::misc::input::KeyCode keyCode);
 
        KeyCode getKey() const { return m_keyCode; }
 
        QString getKeyAsString() const;
 
        void setKey(KeyCode key) { m_keyCode = key; }
 
        void setKey(int key) { m_keyCode = static_cast<KeyCode>(key); }
 
        void setKey(char key) { m_keyCode = static_cast<KeyCode>(key); }
 
        bool isUnknown() const { return !this->hasKey(); }
 
        bool isModifier() const { return allModifiers().contains(m_keyCode); }
 
        bool hasKey() const { return !(m_keyCode == KeyCode::Key_Unknown); }
 
        void setKeyObject(CKeyboardKey key);
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        static const QList<KeyCode> &allModifiers();
 
        KeyCode m_keyCode; 
 
        SWIFT_METACLASS(
            CKeyboardKey,
            SWIFT_METAMEMBER(keyCode));
    };
} // namespace swift::misc::input
 
Q_DECLARE_METATYPE(swift::misc::input::CKeyboardKey)
 
#endif // SWIFT_MISC_INPUT_KEYBOARDKEY_H