src/qml/controls: make modifier searches trigger on press

Make it so modifier searches trigger when a modifier key is pressed.
Previously modifier searches only triggered on a hover index change.
This created an issue where if the cursor was already over the search
target, the search wouldn't occur. This fixes the issue by making
KeyTracker an event filter for QGuiApplication that looks for KeyPress
and KeyRelease events and triggers a signal when modifiers change. Some
additional code is added to Player, SearchableText, and ManualSearchPage
to handle this modifiersChanged signal and start a search.

Author: ripose-jp

src/main.cpp

@@ -246,7 +246,7 @@ static void registerQmlTypes(Context &context)
         MEMENTO_URI, 1, 0, "FileOpenHandler", context.fileOpenHandler()
     );
     qmlRegisterSingletonInstance<KeyTracker>(
-        MEMENTO_URI, 1, 0, "KeyTracker", new KeyTracker(&context)
+        MEMENTO_URI, 1, 0, "KeyTracker", context.keyTracker()
     );
     qmlRegisterSingletonInstance<Paths>(
         MEMENTO_URI, 1, 0, "MementoPaths", new Paths(&context)
@@ -435,9 +435,8 @@ static int runApplication()
     QQmlApplicationEngine::setObjectOwnership(
         &context, QQmlEngine::CppOwnership
     );
-    QCoreApplication::instance()->installEventFilter(
-        context.fileOpenHandler()
-    );
+    QCoreApplication::instance()->installEventFilter(context.fileOpenHandler());
+    QCoreApplication::instance()->installEventFilter(context.keyTracker());
 
     QTranslator translator;
     installTranslator(translator, context);

src/qml/controls/ManualSearchPage.qml

@@ -36,7 +36,7 @@ Page {
                  */
                 function searchIndex(index) {
                     dictionarySearch.clearResults();
-                    if (index < text.length)
+                    if (index >= 0 && index < text.length)
                     {
                         dictionarySearch.searchTerms(text.substring(index), text, index);
                         dictionarySearch.searchKanji(text.charAt(index), text, index);
@@ -45,6 +45,7 @@ Page {
 
                 Layout.fillWidth: true
                 Layout.margins: 5
+                hoverEnabled: true
                 placeholderText: qsTr("Search")
                 onTextChanged: Qt.callLater(searchTextField.searchIndex, 0)
                 onHoverIndexChanged: {
@@ -54,6 +55,17 @@ Page {
                     }
                 }
 
+                Connections {
+                    target: KeyTracker
+                    function onModifiersChanged() {
+                        if (searchTextField.hovered &&
+                                KeyTracker.modifierHeld(MementoSettings.searchModifier))
+                        {
+                            Qt.callLater(searchTextField.searchIndex, searchTextField.hoverIndex);
+                        }
+                    }
+                }
+
                 MouseArea {
                     anchors.fill: parent
                     acceptedButtons: Qt.MiddleButton

src/qml/controls/Player.qml

@@ -644,6 +644,18 @@ MpvPlayer {
                 Qt.callLater(definitionPopup.search, subtitleText.hoverIndex);
             }
         }
+
+        Connections {
+            target: KeyTracker
+            function onModifiersChanged() {
+                if (MementoSettings.searchMethod === MementoSetting.SearchMethodModifier &&
+                        subtitleHover.hovered &&
+                        KeyTracker.modifierHeld(MementoSettings.searchModifier))
+                {
+                    Qt.callLater(definitionPopup.search, subtitleText.hoverIndex);
+                }
+            }
+        }
     }
 
     PlayerMenu {

src/qml/controls/SearchableText.qml

@@ -79,6 +79,32 @@ TextEdit {
         popupLoader.item.y = y;
     }
 
+    readOnly: true
+    selectByMouse: false
+    selectByKeyboard: false
+    textFormat: TextEdit.PlainText
+    color: MementoPalette.text
+    selectionColor: MementoPalette.highlight
+
+    onHoverIndexChanged: {
+        if (!KeyTracker.modifierHeld(MementoSettings.searchModifier))
+        {
+            return;
+        }
+        Qt.callLater(root.searchIndex, root.hoverIndex);
+    }
+
+    Connections {
+        target: KeyTracker
+        function onModifiersChanged() {
+            if (hoverHandler.hovered &&
+                    KeyTracker.modifierHeld(MementoSettings.searchModifier))
+            {
+                Qt.callLater(root.searchIndex, root.hoverIndex);
+            }
+        }
+    }
+
     Connections {
         target: popupLoader.item
         function onClosed() {
@@ -100,19 +126,8 @@ TextEdit {
         }
     }
 
-    readOnly: true
-    selectByMouse: false
-    selectByKeyboard: false
-    textFormat: TextEdit.PlainText
-    color: MementoPalette.text
-    selectionColor: MementoPalette.highlight
-
-    onHoverIndexChanged: {
-        if (!KeyTracker.modifierHeld(MementoSettings.searchModifier))
-        {
-            return;
-        }
-        Qt.callLater(root.searchIndex, root.hoverIndex);
+    HoverHandler {
+        id: hoverHandler
     }
 
     MouseArea {

src/quick/keytracker.cpp

@@ -21,6 +21,7 @@
 #include "quick/keytracker.h"
 
 #include <QGuiApplication>
+#include <QKeyEvent>
 #include <QKeySequence>
 
 KeyTracker::KeyTracker(QObject *parent) : QObject(parent)
@@ -33,12 +34,22 @@ KeyTracker::~KeyTracker()
 
 }
 
-Qt::KeyboardModifiers KeyTracker::modifiers()
+Qt::KeyboardModifiers KeyTracker::modifiers() const
 {
-    return QGuiApplication::keyboardModifiers();
+    return m_modifiers;
 }
 
-bool KeyTracker::modifierHeld(Setting::Modifier key)
+void KeyTracker::setModifiers(Qt::KeyboardModifiers value)
+{
+    if (m_modifiers == value)
+    {
+        return;
+    }
+    m_modifiers = value;
+    emit modifiersChanged(m_modifiers);
+}
+
+bool KeyTracker::modifierHeld(Setting::Modifier key) const
 {
     switch (key)
     {
@@ -58,3 +69,34 @@ QString KeyTracker::keyComboToString(int key, int modifiers)
 {
     return QKeySequence(key | modifiers).toString();
 }
+
+bool KeyTracker::eventFilter(QObject *obj, QEvent *event)
+{
+    switch (event->type())
+    {
+        case QEvent::KeyPress:
+        case QEvent::KeyRelease:
+        {
+            QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
+            setModifiers(keyEvent->modifiers());
+            break;
+        }
+
+        case QEvent::ApplicationDeactivate:
+        case QEvent::WindowDeactivate:
+        case QEvent::FocusOut:
+            setModifiers(Qt::NoModifier);
+            break;
+
+        case QEvent::ApplicationActivate:
+        case QEvent::WindowActivate:
+        case QEvent::FocusIn:
+            setModifiers(QGuiApplication::queryKeyboardModifiers());
+            break;
+
+        default:
+            break;
+    }
+
+    return QObject::eventFilter(obj, event);
+}

src/quick/keytracker.h

@@ -31,6 +31,12 @@ class KeyTracker : public QObject
 {
     Q_OBJECT
 
+    Q_PROPERTY(
+        Qt::KeyboardModifiers modifiers
+        READ modifiers
+        NOTIFY modifiersChanged
+    )
+
 public:
     KeyTracker(QObject *parent = nullptr);
     ~KeyTracker();
@@ -41,7 +47,7 @@ class KeyTracker : public QObject
      * @return The currently held modifiers.
      */
     [[nodiscard]]
-    Q_INVOKABLE static Qt::KeyboardModifiers modifiers();
+    Q_INVOKABLE Qt::KeyboardModifiers modifiers() const;
 
     /**
      * @brief Get if the modifier is held.
@@ -51,7 +57,7 @@ class KeyTracker : public QObject
      * @return false otherwise.
      */
     [[nodiscard]]
-    Q_INVOKABLE static bool modifierHeld(Setting::Modifier key);
+    Q_INVOKABLE bool modifierHeld(Setting::Modifier key) const;
 
     /**
      * @brief Get a sequence string from a key combination.
@@ -62,4 +68,33 @@ class KeyTracker : public QObject
      */
     [[nodiscard]]
     Q_INVOKABLE static QString keyComboToString(int key, int modifiers);
+
+    /**
+     * @brief Filter events to find key presses and releases.
+     *
+     * @param obj The object this event came from.
+     * @param event The event to filter.
+     * @return Always returns false so as to not filter any events.
+     */
+    bool eventFilter(QObject *obj, QEvent *event) override;
+
+signals:
+    /**
+     * @brief Emitted when the held modifiers changes.
+     *
+     * @param modifiers The newly held modifiers
+     */
+    void modifiersChanged(Qt::KeyboardModifiers modifiers);
+
+private:
+    /**
+     * @brief Set the currently held modifiers and notify if modifiers have been
+     * updated.
+     *
+     * @param value The new modifiers to set.
+     */
+    void setModifiers(Qt::KeyboardModifiers value);
+
+    /* The currently held modifiers */
+    Qt::KeyboardModifiers m_modifiers{};
 };

src/state/CMakeLists.txt

@@ -12,6 +12,7 @@ target_link_libraries(
     PUBLIC audioplayer
     PUBLIC dictionary
     PUBLIC fileopenhandler
+    PUBLIC keytracker
     PUBLIC mpvplayer
     PUBLIC Qt6::Core
     PUBLIC settings

src/state/context.cpp

@@ -65,6 +65,11 @@ FileOpenHandler *Context::fileOpenHandler() const noexcept
     return m_fileOpenHandler;
 }
 
+KeyTracker *Context::keyTracker() const noexcept
+{
+    return m_keyTracker;
+}
+
 MpvPlayer *Context::player() const noexcept
 {
     return m_player;

src/state/context.h

@@ -28,6 +28,7 @@
 #include "dict/dictionarycontroller.h"
 #include "player/mpvplayer.h"
 #include "quick/fileopenhandler.h"
+#include "quick/keytracker.h"
 #include "setting/settings.h"
 #include "subtitle/subtitlelists.h"
 #include "util/utils.h"
@@ -99,6 +100,14 @@ class Context : public QObject
     [[nodiscard]]
     FileOpenHandler *fileOpenHandler() const noexcept;
 
+    /**
+     * @brief Get the global key tracker.
+     *
+     * @return The global key tracker.
+     */
+    [[nodiscard]]
+    KeyTracker *keyTracker() const noexcept;
+
     /**
      * @brief Get the application MpvPlayer instance.
      *
@@ -140,6 +149,9 @@ class Context : public QObject
     /* The application file open handler. Has ownership. */
     FileOpenHandler *m_fileOpenHandler{new FileOpenHandler(this)};
 
+    /* The application key tracker. Has ownership. */
+    KeyTracker *m_keyTracker{new KeyTracker(this)};
+
     /* The main application MpvPlayer. Does not have ownership. */
     MpvPlayer *m_player{nullptr};
 };