File indexing completed on 2024-11-24 05:00:37

 /*
     SPDX-FileCopyrightText: 2019 Harald Sitter <sitter@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */
 
 #pragma once
 
 #include "xkbobject.h"
 
 class Shape;
 
 // This is a fairly opinionated model of a key cap. We assume there won't
 // be any more than 4 levels.
 // This isn't necessarily the case since (e.g.) the NEO layout has 6 levels.
 // Since that is super niche and poses some complication as for how to
 // exactly render the levels we'll simply ignore this use case for now.
 // In the end the keyboard model display only needs to act as simple indicator
 // anyway.
 class KeyCap : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(QString topLeft MEMBER topLeft CONSTANT)
     Q_PROPERTY(QString topRight MEMBER topRight CONSTANT)
     Q_PROPERTY(QString bottomLeft MEMBER bottomLeft CONSTANT)
     Q_PROPERTY(QString bottomRight MEMBER bottomRight CONSTANT)
 public:
     enum Level {
         TopLeft = 1,
         TopRight = 3,
         BottomLeft = 0,
         BottomRight = 2,
     };
     Q_ENUM(Level)
     constexpr static int levelCount = 4;
 
     KeyCap(const QString symbols[KeyCap::levelCount], QObject *parent);
 
     QString topLeft;
     QString topRight;
     QString bottomLeft;
     QString bottomRight;
 };
 
 class Key : public XkbObject
 {
     Q_OBJECT
 #define K_P(type, name)                                                                                                                                        \
 private:                                                                                                                                                       \
     Q_PROPERTY(type name READ auto_prop_##name CONSTANT)                                                                                                       \
 public:                                                                                                                                                        \
     type auto_prop_##name() const                                                                                                                              \
     {                                                                                                                                                          \
         return key->name;                                                                                                                                      \
     }
 
     K_P(short, gap)
 
     Q_PROPERTY(Shape *shape MEMBER shape CONSTANT)
     Q_PROPERTY(KeyCap *cap MEMBER cap CONSTANT)
     Q_PROPERTY(bool pressed MEMBER pressed NOTIFY pressedChanged)
 
     constexpr static uint INVALID_KEYCODE = static_cast<uint>(-1);
 
 public:
     Key(XkbKeyPtr key_, XkbDescPtr xkb_, QObject *parent = nullptr);
     uint nativeScanCodeFromName(const QByteArray &needle);
     KeyCap *resolveCap();
 
     XkbKeyPtr key = nullptr;
     Shape *shape = nullptr;
     QByteArray name; // Internal name in the geometry.
     quint32 nativeScanCode = INVALID_KEYCODE;
     KeyCap *cap = nullptr;
     bool pressed = false;
 
 Q_SIGNALS:
     void pressedChanged();
 };