Fix focus and simplify popup-opener menu items

Introduce a HmenuItemPopupSpawner component that takes care of reacting
to onTriggered signals and calling the utils.makePopup() function.

The combination of this new component used in HMenu to open a HPopup
now correctly takes and restore focus to the right element when closed.

TODO.md

@@ -48,13 +48,13 @@
 
 ## Issues
 
-- invisible uploaded mxc images?
-- first undecryptable message
-- Join button 502
-- Leave box button focus
+- `EventImage`s for `m.image` sometimes appear broken, can be made normal
+  by switching to another room and coming back
+- First sent message in E2E room is sometimes undecryptable
+- Handle matrix errors for accept/decline invite buttons and other
 
+- Pause upload, switch to other room, then come back → wrong state displayed
 - Pausing uploads doesn't work well, servers end up dropping the connection 
-- Pause upload, switch to other room, then come back, wrong state displayed
 
 - In the "Leave me" room, "join > Hi > left" aren't combined
 - When selecting text and scrolling up, selection stops working after a while

src/gui/Base/HMenu.qml

@@ -25,9 +25,17 @@ Menu {
         border.width: theme.controls.menu.borderWidth
     }
 
-    onAboutToShow: previouslyFocused = window.activeFocusItem
-    onClosed: if (previouslyFocused) previouslyFocused.forceActiveFocus()
+    onAboutToShow: {
+        previouslyFocused = window.activeFocusItem
+        focusOnClosed     = Qt.binding(() => previouslyFocused)
+    }
+    onClosed: if (focusOnClosed) focusOnClosed.forceActiveFocus()
 
 
     property var previouslyFocused: null
+
+    // MenuItems that open popups (or other elements taking focus when opened)
+    // should set this to null. It will be reset to previouslyFocus when
+    // the Menu is closed and opened again.
+    property Item focusOnClosed: previouslyFocused
 }

src/gui/Base/HMenuItem.qml

@@ -12,11 +12,6 @@ MenuItem {
     bottomPadding: topPadding
     height: visible ? implicitHeight : 0
 
-
-    readonly property alias iconItem: contentItem.icon
-    readonly property alias label: contentItem.label
-
-
     background: HButtonBackground {
         button: menuItem
         buttonTheme: theme.controls.menuItem
@@ -28,4 +23,8 @@ MenuItem {
         buttonTheme: theme.controls.menuItem
         label.horizontalAlignment: Label.AlignLeft
     }
+
+
+    readonly property alias iconItem: contentItem.icon
+    readonly property alias label: contentItem.label
 }

src/gui/Base/HMenuItemPopupSpawner.qml

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+import QtQuick 2.12
+import QtQuick.Controls 2.12
+
+HMenuItem {
+    onTriggered: {
+        print( parent.parent.parent)
+        menu.focusOnClosed = null
+
+        utils.makePopup(
+            popup,
+            popupParent,
+            utils.objectUpdate(
+                { focusOnClosed: menu.previouslyFocused }, properties,
+            ),
+            null,
+            autoDestruct,
+        )
+    }
+
+
+    property var popup  // url or HPopup Component
+    property QtObject popupParent: window
+    property bool autoDestruct: true
+    property var properties: ({})
+}

src/gui/Base/HPopup.qml

@@ -24,10 +24,11 @@ Popup {
     }
 
     onAboutToShow: previouslyFocused = window.activeFocusItem
-    onClosed: if (previouslyFocused) previouslyFocused.forceActiveFocus()
+    onClosed: if (focusOnClosed) focusOnClosed.forceActiveFocus()
 
 
     property var previouslyFocused: null
+    property Item focusOnClosed: previouslyFocused
 
     readonly property int maximumPreferredWidth:
         window.width - leftMargin - rightMargin - leftInset - rightInset

src/gui/MainPane/AccountDelegate.qml

@@ -110,15 +110,13 @@ HTileDelegate {
             onTriggered: Clipboard.text = model.data.user_id
         }
 
-        HMenuItem {
+        HMenuItemPopupSpawner {
             icon.name: "sign-out"
             icon.color: theme.colors.negativeBackground
             text: qsTr("Sign out")
-            onTriggered: utils.makePopup(
-                "Popups/SignOutPopup.qml",
-                window,
-                { "userId": model.data.user_id },
-            )
+
+            popup: "Popups/SignOutPopup.qml"
+            properties: { "userId": model.data.user_id }
         }
     }
 }

src/gui/MainPane/RoomDelegate.qml

@@ -91,22 +91,19 @@ HTileDelegate {
     }
 
     contextMenu: HMenu {
-        HMenuItem {
+        HMenuItemPopupSpawner {
             visible: joined
             enabled: model.data.can_invite
             icon.name: "room-send-invite"
             text: qsTr("Invite members")
 
-            onTriggered: utils.makePopup(
-                "Popups/InviteToRoomPopup.qml",
-                window,
-                {
-                    userId: model.user_id,
-                    roomId: model.data.room_id,
-                    roomName: model.data.display_name,
-                    invitingAllowed: Qt.binding(() => model.data.can_invite)
-                }
-            )
+            popup: "Popups/InviteToRoomPopup.qml"
+            properties: ({
+                userId: model.user_id,
+                roomId: model.data.room_id,
+                roomName: model.data.display_name,
+                invitingAllowed: Qt.binding(() => model.data.can_invite)
+            })
         }
 
         HMenuItem {
@@ -129,39 +126,32 @@ HTileDelegate {
             )
         }
 
-        HMenuItem {
+        HMenuItemPopupSpawner {
             visible: invited || joined
             icon.name: invited ? "invite-decline" : "room-leave"
             icon.color: theme.colors.negativeBackground
             text: invited ? qsTr("Decline invite") : qsTr("Leave")
 
-            onTriggered: utils.makePopup(
-                "Popups/LeaveRoomPopup.qml",
-                window,
-                {
-                    userId: model.user_id,
-                    roomId: model.data.room_id,
-                    roomName: model.data.display_name,
-                }
-            )
+            popup: "Popups/LeaveRoomPopup.qml"
+            properties: ({
+                userId: model.user_id,
+                roomId: model.data.room_id,
+                roomName: model.data.display_name,
+            })
         }
 
-        HMenuItem {
+        HMenuItemPopupSpawner {
             icon.name: "room-forget"
             icon.color: theme.colors.negativeBackground
             text: qsTr("Forget")
 
-            onTriggered: utils.makePopup(
-                "Popups/ForgetRoomPopup.qml",
-                window,
-                {
-                    userId: model.user_id,
-                    roomId: model.data.room_id,
-                    roomName: model.data.display_name,
-                },
-                null,
-                false,
-            )
+            popup: "Popups/ForgetRoomPopup.qml"
+            autoDestruct: false
+            properties: ({
+                userId: model.user_id,
+                roomId: model.data.room_id,
+                roomName: model.data.display_name,
+            })
         }
     }
 }

src/gui/Pages/Chat/Timeline/EventDelegate.qml

@@ -170,14 +170,13 @@ HColumnLayout {
                 Clipboard.text = selectableLabelContainer.joinedSelection
         }
 
-        HMenuItem {
+        HMenuItemPopupSpawner {
             icon.name: "clear-messages"
             text: qsTr("Clear messages")
-            onTriggered: utils.makePopup(
-                "Popups/ClearMessagesPopup.qml",
-                chat,
-                {userId: chat.userId, roomId: chat.roomId},
-            )
+
+            popup: "Popups/ClearMessagesPopup.qml"
+            popupParent: chat
+            properties: ({userId: chat.userId, roomId: chat.roomId})
         }
     }
 }

src/gui/Utils.qml

@@ -68,6 +68,11 @@ QtObject {
     }
 
 
+    function objectUpdate(current, update) {
+        return Object.assign({}, current, update)
+    }
+
+
     function objectUpdateRecursive(current, update) {
         for (const key of Object.keys(update)) {
             if ((key in current) && typeof(current[key]) === "object" &&