joystickbutton.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_JOYSTICKBUTTON_H
#define SWIFT_MISC_INPUT_JOYSTICKBUTTON_H
 
#include <QMetaType>
#include <QString>
#include <QtGlobal>
 
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::input, CJoystickButton)
 
namespace swift::misc::input
{
    class SWIFT_MISC_EXPORT CJoystickButton : public CValueObject<CJoystickButton>
    {
    public:
        enum ColumnIndex
        {
            IndexDeviceName = CPropertyIndexRef::GlobalIndexCJoystickButton,
            IndexButton,
            IndexButtonAsString,
            IndexButtonObject, // just for updates
        };
 
        CJoystickButton() = default;
 
        CJoystickButton(const QString &deviceName, int index);
 
        QString getDeviceName() const { return m_deviceName; }
 
        int getButtonIndex() const { return m_buttonIndex; }
 
        QString getButtonAsString() const { return buttonIndexToString(m_buttonIndex); }
 
        QString getButtonAsStringWithDeviceName() const;
 
        void setDeviceName(const QString &deviceName) { m_deviceName = deviceName; }
 
        void setButtonIndex(int buttonIndex);
 
        bool isValid() const;
 
        void setButtonObject(CJoystickButton button);
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        static QString buttonIndexToString(qint32 buttonIndex);
 
        static int buttonIndexFromString(const QString &button);
 
        static int getInvalidIndex() { return InvalidButtonIndex; }
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        static const QString &buttonIndentifier()
        {
            static const QString bn("Button");
            return bn;
        }
        static constexpr int InvalidButtonIndex = -1;
 
        QString m_deviceName;
        int m_buttonIndex = InvalidButtonIndex;
 
        SWIFT_METACLASS(
            CJoystickButton,
            SWIFT_METAMEMBER(deviceName),
            SWIFT_METAMEMBER(buttonIndex));
    };
} // namespace swift::misc::input
 
Q_DECLARE_METATYPE(swift::misc::input::CJoystickButton)
 
#endif // SWIFT_MISC_INPUT_JOYSTICKBUTTON_H