linux: Use kirigami mouse handling if available

Qt6 changed the mouse scroll wheel handling for QtQuick to a type that mimics how touch pads/screens work, which most people find feels very poor. KDE fixes this by creating a custom type which re-implements the QtWidgets handling (see https://invent.kde.org/frameworks/kirigami/-/merge_requests/415). On Matrix Nico has expressed a desire not to have to deal with compiling Kirigami for Windows and Mac, which is understandable. Linux users on the other hand almost always have kirigami available in their package repos which sidesteps that particular issue. We can search for Kirigami at build time and if present define a QML context property to allow it to be used, which should fix this issue for Linux users at least. Helps with nheko-reborn/nheko#1819 (which won't be completely resolved until this is working for Windows and Mac as well). Signed-off-by: Reilly Brogan <reilly@reillybrogan.com>
2024-11-23 19:38:48 +03:00 · 2024-06-12 15:24:53 -05:00 · 2024-06-12 15:24:53 -05:00 · c9f1a449d8
commit c9f1a449d8
parent 1a00d91316
22 changed files with 116 additions and 2 deletions
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -277,6 +277,20 @@ else()
    find_package(KDSingleApplication-qt6 REQUIRED)
 endif()

+if(UNIX)
+    set(KF_MIN_VERSION "6.0.0")
+    find_package(ECM ${KF_MIN_VERSION})
+    if(ECM_FOUND)
+        list(APPEND CMAKE_MODULE_PATH ${ECM_MODULE_PATH})
+        find_package(KF6 COMPONENTS
+            Kirigami
+        )
+        if(KF6_FOUND)
+            add_compile_definitions(NHEKO_USE_KIRIGAMI)
+        endif()
+    endif()
+endif()
+
 if(Qt6Widgets_FOUND)
    if(Qt6Widgets_VERSION VERSION_LESS 6.5.0)
        message(STATUS "Qt version ${Qt6Widgets_VERSION}")
@ -821,12 +835,20 @@ set(QML_SOURCES
    resources/qml/delegates/EncryptionEnabled.qml
    resources/qml/ui/TimelineEffects.qml
 )
+set(QML_DEPENDENCIES
+    QtQuick
+    QtQml.Models
+)
+if(KF6_FOUND)
+    list(APPEND QML_SOURCES "resources/qml/components/KirigamiWheelHandler.qml")
+    list(APPEND QML_DEPENDENCIES "org.kde.kirigami")
+endif()
 qt_add_qml_module(nheko
    URI im.nheko
    NO_RESOURCE_TARGET_PATH
    RESOURCE_PREFIX "/"
    VERSION 1.1
-    DEPENDENCIES QtQuick QtQml.Models
+    DEPENDENCIES ${QML_DEPENDENCIES}
    QML_FILES
    ${QML_SOURCES}
    SOURCES
--- a/resources/qml/CommunitiesList.qml
+++ b/resources/qml/CommunitiesList.qml
@ -38,6 +38,10 @@ Page {
        model: Communities.filtered()
        boundsBehavior: Flickable.StopAtBounds

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "components/KirigamiWheelHandler.qml" : ""
+        }
+
        ScrollBar.vertical: ScrollBar {
            id: scrollbar

--- a/resources/qml/Completer.qml
+++ b/resources/qml/Completer.qml
@ -93,6 +93,10 @@ Control {
    contentItem: ListView {
        id: listView

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "components/KirigamiWheelHandler.qml" : ""
+        }
+
        clip: true
        displayMarginBeginning: height / 2
        displayMarginEnd: height / 2
--- a/resources/qml/MessageView.qml
+++ b/resources/qml/MessageView.qml
@ -65,6 +65,10 @@ Item {
        spacing: 2
        verticalLayoutDirection: ListView.BottomToTop

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "components/KirigamiWheelHandler.qml" : ""
+        }
+
        property int lastScrollPos: 0

        // Fixup the scroll position when the height changes. Without this, the view is kept around the center of the currently visible content, while we usually want to stick to the bottom.
--- a/resources/qml/RoomList.qml
+++ b/resources/qml/RoomList.qml
@ -446,6 +446,10 @@ Page {
        model: Rooms
        boundsBehavior: Flickable.StopAtBounds

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "components/KirigamiWheelHandler.qml" : ""
+        }
+
        //reuseItems: true
        ScrollBar.vertical: ScrollBar {
            id: scrollbar
--- a/resources/qml/UploadBox.qml
+++ b/resources/qml/UploadBox.qml
@ -22,6 +22,10 @@ Page {
    contentItem: ListView {
        id: uploadsList

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "components/KirigamiWheelHandler.qml" : ""
+        }
+
        anchors.horizontalCenter: parent.horizontalCenter
        boundsBehavior: Flickable.StopAtBounds
        model: room ? room.input.uploads : undefined
--- a/resources/qml/components/AdaptiveLayout.qml
+++ b/resources/qml/components/AdaptiveLayout.qml
@ -122,6 +122,10 @@ Container {
    contentItem: ListView {
        id: view

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "KirigamiWheelHandler.qml" : ""
+        }
+
        model: container.contentModel
        snapMode: ListView.SnapOneItem
        orientation: ListView.Horizontal
--- a/resources/qml/components/KirigamiWheelHandler.qml
+++ b/resources/qml/components/KirigamiWheelHandler.qml
@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: Nheko Contributors
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+import org.kde.kirigami as Kirigami
+
+Kirigami.WheelHandler {
+    id: wheelHandler
+    target: parent
+    filterMouseEvents: true
+    keyNavigationEnabled: true
+}
--- a/resources/qml/components/ReorderableListview.qml
+++ b/resources/qml/components/ReorderableListview.qml
@ -100,6 +100,10 @@ Item {
        ListView {
            id: view

+            Loader {
+                source: NHEKO_USE_KIRIGAMI ? "KirigamiWheelHandler.qml" : ""
+            }
+
            clip: true

            anchors { fill: parent; margins: 2 }
--- a/resources/qml/dialogs/AliasEditor.qml
+++ b/resources/qml/dialogs/AliasEditor.qml
@ -52,6 +52,9 @@ ApplicationWindow {

            clip: true

+            Loader {
+                source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+            }

            model: editingModel
            spacing: 4
--- a/resources/qml/dialogs/AllowedRoomsSettingsDialog.qml
+++ b/resources/qml/dialogs/AllowedRoomsSettingsDialog.qml
@ -51,6 +51,9 @@ ApplicationWindow {

            clip: true

+            Loader {
+                source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+            }

            model: roomSettings.allowedRoomsModel
            spacing: 4
--- a/resources/qml/dialogs/IgnoredUsers.qml
+++ b/resources/qml/dialogs/IgnoredUsers.qml
@ -26,6 +26,10 @@ Window {
        spacing: Nheko.paddingMedium
        footerPositioning: ListView.OverlayFooter

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+        }
+
        model: TimelineManager.ignoredUsers
        header: ColumnLayout {
            Text {
--- a/resources/qml/dialogs/ImagePackEditorDialog.qml
+++ b/resources/qml/dialogs/ImagePackEditorDialog.qml
@ -49,6 +49,9 @@ ApplicationWindow {

                model: imagePack

+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }

                header: AvatarListTile {
                    title: imagePack.packname
--- a/resources/qml/dialogs/ImagePackSettingsDialog.qml
+++ b/resources/qml/dialogs/ImagePackSettingsDialog.qml
@ -59,7 +59,9 @@ ApplicationWindow {
                model: packlist
                clip: true

-                
+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }

                footer: ColumnLayout {
                    Button {
--- a/resources/qml/dialogs/InviteDialog.qml
+++ b/resources/qml/dialogs/InviteDialog.qml
@ -166,6 +166,9 @@ ApplicationWindow {
                Layout.fillWidth: true
                Layout.fillHeight: true
                clip: true
+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }
                delegate: UserListRow {
                    id: del2
                    width: ListView.view.width
@ -192,6 +195,10 @@ ApplicationWindow {
                clip: true
                visible: inviteDialogRoot.width >= 500

+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }
+
                delegate: UserListRow {
                    id: del
                    hoverEnabled: true
--- a/resources/qml/dialogs/PowerLevelSpacesApplyDialog.qml
+++ b/resources/qml/dialogs/PowerLevelSpacesApplyDialog.qml
@ -86,6 +86,10 @@ ApplicationWindow {
            spacing: 4
            cacheBuffer: 50

+            Loader {
+                source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+            }
+
            delegate: RowLayout {
                anchors.left: parent.left
                anchors.right: parent.right
--- a/resources/qml/dialogs/ReadReceipts.qml
+++ b/resources/qml/dialogs/ReadReceipts.qml
@ -54,6 +54,10 @@ ApplicationWindow {
                boundsBehavior: Flickable.StopAtBounds
                model: readReceipts

+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }
+
                delegate: ItemDelegate {
                    id: del

--- a/resources/qml/dialogs/RoomDirectory.qml
+++ b/resources/qml/dialogs/RoomDirectory.qml
@ -34,6 +34,10 @@ ApplicationWindow {
        anchors.fill: parent
        model: publicRooms

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+        }
+
        delegate: Rectangle {
            id: roomDirDelegate

--- a/resources/qml/dialogs/RoomMembers.qml
+++ b/resources/qml/dialogs/RoomMembers.qml
@ -108,6 +108,9 @@ ApplicationWindow {
                boundsBehavior: Flickable.StopAtBounds
                model: members

+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }

                delegate: ItemDelegate {
                    id: del
--- a/resources/qml/dialogs/UserProfile.qml
+++ b/resources/qml/dialogs/UserProfile.qml
@ -45,6 +45,10 @@ ApplicationWindow {
        anchors.margins: 10
        footerPositioning: ListView.OverlayFooter

+        Loader {
+            source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+        }
+
        header: ColumnLayout {
            id: contentL

--- a/resources/qml/emoji/StickerPicker.qml
+++ b/resources/qml/emoji/StickerPicker.qml
@ -116,6 +116,10 @@ Menu {
                clip: true
                currentIndex: -1 // prevent sorting from stealing focus

+                Loader {
+                    source: NHEKO_USE_KIRIGAMI ? "../components/KirigamiWheelHandler.qml" : ""
+                }
+
                section.property: "packname"
                section.criteria: ViewSection.FullString
                section.delegate: Rectangle {
--- a/src/MainWindow.cpp
+++ b/src/MainWindow.cpp
@ -4,6 +4,7 @@

 #include <QApplication>
 #include <QMessageBox>
+#include <QQmlContext>

 #include <mtx/events/collections.hpp>
 #include <mtx/requests.hpp>
@ -123,6 +124,12 @@ MainWindow::registerQmlTypes()
            nhlog::ui()->warn("Could not connect to D-Bus!");
    }
 #endif
+
+#ifdef NHEKO_USE_KIRIGAMI
+    engine()->rootContext()->setContextProperty("NHEKO_USE_KIRIGAMI", QVariant(true));
+#else
+    engine()->rootContext()->setContextProperty("NHEKO_USE_KIRIGAMI", QVariant(false));
+#endif
 }

 void