feat: activate tool while a key is pressed

- add UBActionGroupHistory - listen for key release events to return to previous tool
OpenBoard-org · Aug 16, 2024 · bdaf1bf · bdaf1bf
1 parent d501638
commit bdaf1bf
Show file tree

Hide file tree

Showing 5 changed files with 146 additions and 3 deletions.
diff --git a/src/core/UBApplication.cpp b/src/core/UBApplication.cpp
@@ -707,6 +707,15 @@ bool UBApplication::eventFilter(QObject *obj, QEvent *event)
         }
     }
 
+    else if (event->type() == QEvent::KeyRelease)
+    {
+        // intercept key release events for shortcut handler
+        QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
+
+        return UBShortcutManager::shortcutManager()->handleKeyReleaseEvent(keyEvent)
+                    || result;
+    }
+
     return result;
 }
 

diff --git a/src/core/UBPreferencesController.cpp b/src/core/UBPreferencesController.cpp
@@ -119,7 +119,7 @@ bool UBPreferencesController::handleKeyEvent(QKeyEvent *event)
 
     int keys = mods;
 
-    if (key < Qt::Key_Shift || key > Qt::Key_Alt)
+    if (key < Qt::Key_Shift || key > Qt::Key_ScrollLock)
     {
         keys += key;
     }

diff --git a/src/core/UBShortcutManager.cpp b/src/core/UBShortcutManager.cpp
@@ -294,6 +294,20 @@ void UBShortcutManager::addMainActions(UBMainWindow *mainWindow)
     ignoreCtrl(UBSettings::settings()->value("Shortcut/IgnoreCtrl").toBool());
 }
 
+void UBShortcutManager::addActionGroup(QActionGroup *actionGroup)
+{
+    mActionGroupHistoryMap[actionGroup] = new UBActionGroupHistory(actionGroup);
+}
+
+void UBShortcutManager::removeActionGroup(QActionGroup *actionGroup)
+{
+    if (mActionGroupHistoryMap.contains(actionGroup))
+    {
+        delete mActionGroupHistoryMap[actionGroup];
+        mActionGroupHistoryMap.remove(actionGroup);
+    }
+}
+
 bool UBShortcutManager::handleMouseEvent(QMouseEvent *event)
 {
     if (mMouseActions.contains(event->button()))
@@ -328,6 +342,18 @@ bool UBShortcutManager::handleTabletEvent(QTabletEvent *event)
     return false;
 }
 
+bool UBShortcutManager::handleKeyReleaseEvent(QKeyEvent *event)
+{
+    for (UBActionGroupHistory* actionGroupHistory : mActionGroupHistoryMap.values())
+    {
+        if (actionGroupHistory->keyReleased(event)) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 int UBShortcutManager::rowCount(const QModelIndex &parent) const
 {
     Q_UNUSED(parent);
@@ -479,13 +505,33 @@ bool UBShortcutManager::setData(const QModelIndex &index, const QVariant &value,
 
     case 3:
         action->setProperty(mouseButtonProperty, value);
+
+        for (Qt::MouseButton key : mMouseActions.keys())
+        {
+            if (mMouseActions[key] == action)
+            {
+                mMouseActions.remove(key);
+                break;
+            }
+        }
+
         mMouseActions[static_cast<Qt::MouseButton>(value.toInt())] = action;
         updateSettings(action);
         emit dataChanged(index, index);
         return true;
 
     case 4:
         action->setProperty(tabletButtonProperty, value);
+
+        for (Qt::MouseButton key : mTabletActions.keys())
+        {
+            if (mTabletActions[key] == action)
+            {
+                mTabletActions.remove(key);
+                break;
+            }
+        }
+
         mTabletActions[static_cast<Qt::MouseButton>(value.toInt())] = action;
         updateSettings(action);
         emit dataChanged(index, index);
@@ -749,3 +795,59 @@ void UBShortcutManager::updateSettings(const QAction *action) const
         UBSettings::settings()->setValue(key, list);
     }
 }
+
+// ---------- UBActionGroupHistory ----------
+
+UBActionGroupHistory::UBActionGroupHistory(QActionGroup *parent)
+    : QObject(parent)
+    , mActionGroup(parent)
+    , mCurrentAction(parent->checkedAction())
+    , mPreviousAction(nullptr)
+    , mRevertingAction(nullptr)
+{
+    connect(parent, &QActionGroup::triggered, this, &UBActionGroupHistory::triggered);
+}
+
+void UBActionGroupHistory::triggered(QAction *action)
+{
+    if (mCurrentAction != action)
+    {
+        mPreviousAction = mCurrentAction;
+        mCurrentAction = action;
+    }
+}
+
+bool UBActionGroupHistory::keyReleased(QKeyEvent *event)
+{
+    int key = event->key() & ~Qt::KeyboardModifierMask;
+
+    for (QAction* action : mActionGroup->actions())
+    {
+        QKeySequence keySequence = action->shortcut();
+
+        if (keySequence.count() > 0)
+        {
+            int actionKey = action->shortcut()[0] & ~Qt::KeyboardModifierMask;
+
+            if (key == actionKey)
+            {
+                if (event->isAutoRepeat())
+                {
+                    if (!mRevertingAction)
+                    {
+                        mRevertingAction = mPreviousAction;;
+                    }
+                }
+                else if (mRevertingAction)
+                {
+                    mRevertingAction->trigger();
+                    mRevertingAction = nullptr;
+                }
+
+                return true;
+            }
+        }
+    }
+
+    return false;
+}
diff --git a/src/core/UBShortcutManager.h b/src/core/UBShortcutManager.h
@@ -36,11 +36,13 @@
 #include <QTabletEvent>
 
 class QAction;
+class QActionGroup;
 class UBMainWindow;
+class UBActionGroupHistory;
 
 class UBShortcutManager : public QAbstractTableModel
 {
-    Q_OBJECT;
+    Q_OBJECT
 
 private:
     UBShortcutManager();
@@ -57,8 +59,12 @@ class UBShortcutManager : public QAbstractTableModel
     void addActions(const QString& group, const QList<QAction*> actions, QWidget* widget = nullptr);
     void addMainActions(UBMainWindow* mainWindow);
 
+    void addActionGroup(QActionGroup* actionGroup);
+    void removeActionGroup(QActionGroup* actionGroup);
+
     bool handleMouseEvent(QMouseEvent* event);
     bool handleTabletEvent(QTabletEvent* event);
+    bool handleKeyReleaseEvent(QKeyEvent* event);
 
     // QAbstractTableModel overrides
     virtual int rowCount(const QModelIndex &parent = QModelIndex()) const Q_DECL_OVERRIDE;
@@ -87,9 +93,28 @@ public slots:
     QList<QPair<QString,QList<QAction*>>> mActionGroups;
     QMap<Qt::MouseButton, QAction*> mMouseActions;
     QMap<Qt::MouseButton, QAction*> mTabletActions;
+    QMap<QActionGroup*, UBActionGroupHistory*> mActionGroupHistoryMap;
     bool mIgnoreCtrl;
 
     static UBShortcutManager* sShortcutManager;
 };
 
+class UBActionGroupHistory : public QObject
+{
+    Q_OBJECT
+
+public:
+    UBActionGroupHistory(QActionGroup* parent);
+
+public slots:
+    void triggered(QAction* action);
+    bool keyReleased(QKeyEvent* event);
+
+private:
+    QActionGroup* mActionGroup;
+    QAction* mCurrentAction;
+    QAction* mPreviousAction;
+    QAction* mRevertingAction;
+};
+
 #endif // UBSHORTCUTMANAGER_H
diff --git a/src/gui/UBStylusPalette.cpp b/src/gui/UBStylusPalette.cpp
@@ -36,6 +36,8 @@
 #include "core/UBApplication.h"
 #include "core/UBSettings.h"
 #include "core/UBApplicationController.h"
+#include "core/UBShortcutManager.h"
+
 
 #include "board/UBDrawingController.h"
 
@@ -87,6 +89,8 @@ UBStylusPalette::UBStylusPalette(QWidget *parent, Qt::Orientation orient)
         connect(mActionGroup, SIGNAL(triggered(QAction*)), this, SIGNAL(buttonGroupClicked(QAction*)));
     }
 
+    UBShortcutManager::shortcutManager()->addActionGroup(mActionGroup);
+
     adjustSizeAndPosition();
 
     initPosition();
@@ -126,7 +130,10 @@ void UBStylusPalette::initPosition()
 
 UBStylusPalette::~UBStylusPalette()
 {
-
+    if (mActionGroup)
+    {
+        UBShortcutManager::shortcutManager()->removeActionGroup(mActionGroup);
+    }
 }
 
 void UBStylusPalette::stylusToolDoubleClicked()