Merge pull request #5930 from opengisch/focusstack_object

Generalize the focus stack to also handle popups
opengisch · Jan 4, 2025 · 4a9ab89 · 4a9ab89 · qfield-fairy · Jan 4, 2025
2 parents 4be990c + aacbfe2
commit 4a9ab89
Show file tree

Hide file tree

Showing 22 changed files with 154 additions and 108 deletions.
diff --git a/src/core/focusstack.cpp b/src/core/focusstack.cpp
@@ -15,37 +15,73 @@
  ***************************************************************************/
 #include "focusstack.h"
 
-void FocusStack::addFocusTaker( QQuickItem *item )
+void FocusStack::addFocusTaker( QObject *object )
 {
-  connect( item, &QQuickItem::activeFocusChanged, this, &FocusStack::itemFocusChanged );
+  QVariant visible = object->property( "visible" );
+  QVariant opened = object->property( "opened" );
+  if ( opened.isValid() )
+  {
+    connect( object, SIGNAL( opened() ), this, SLOT( popupOpened() ) );
+    connect( object, SIGNAL( closed() ), this, SLOT( popupClosed() ) );
+  }
+  else if ( visible.isValid() )
+  {
+    connect( object, SIGNAL( activeFocusChanged( bool ) ), this, SLOT( itemFocusChanged( bool ) ) );
+  }
+}
+
+void FocusStack::popupOpened()
+{
+  setFocused( sender() );
+}
+
+void FocusStack::popupClosed()
+{
+  setUnfocused( sender() );
 }
 
 void FocusStack::itemFocusChanged( bool itemActiveFocus )
 {
   if ( itemActiveFocus )
   {
-    setFocused( qobject_cast<QQuickItem *>( sender() ) );
+    setFocused( sender() );
   }
   else
   {
-    setUnfocused( qobject_cast<QQuickItem *>( sender() ) );
+    setUnfocused( sender() );
   }
 }
 
-void FocusStack::setFocused( QQuickItem *item )
+void FocusStack::setFocused( QObject *object )
 {
-  mStackList.removeAll( item );
-  mStackList.append( item );
+  mStackList.removeAll( object );
+  mStackList.append( object );
 }
 
-void FocusStack::setUnfocused( QQuickItem *item )
+void FocusStack::setUnfocused( QObject *object )
 {
-  if ( !item->isVisible() )
+  QVariant visible = object->property( "visible" );
+  QVariant opened = object->property( "opened" );
+  if ( opened.isValid() )
+  {
+    if ( !opened.toBool() )
+    {
+      mStackList.removeAll( object );
+      if ( !mStackList.isEmpty() )
+      {
+        QMetaObject::invokeMethod( mStackList.last(), "forceActiveFocus", Qt::DirectConnection );
+      }
+    }
+  }
+  else if ( visible.isValid() )
   {
-    mStackList.removeAll( item );
-    if ( !mStackList.isEmpty() )
+    if ( !visible.toBool() )
     {
-      mStackList.last()->forceActiveFocus();
+      mStackList.removeAll( object );
+      if ( !mStackList.isEmpty() )
+      {
+        QMetaObject::invokeMethod( mStackList.last(), "forceActiveFocus", Qt::DirectConnection );
+      }
     }
   }
 }
@@ -55,5 +91,5 @@ void FocusStack::forceActiveFocusOnLastTaker() const
   if ( mStackList.isEmpty() )
     return;
 
-  mStackList.last()->forceActiveFocus();
+  QMetaObject::invokeMethod( mStackList.last(), "forceActiveFocus", Qt::DirectConnection );
 }
diff --git a/src/core/focusstack.h b/src/core/focusstack.h
@@ -27,16 +27,18 @@ class FocusStack : public QObject
     Q_OBJECT
 
   public:
-    Q_INVOKABLE void addFocusTaker( QQuickItem *item );
+    Q_INVOKABLE void addFocusTaker( QObject *object );
     Q_INVOKABLE void forceActiveFocusOnLastTaker() const;
 
   private slots:
     void itemFocusChanged( bool itemActiveFocus );
+    void popupOpened();
+    void popupClosed();
 
   private:
-    QList<QQuickItem *> mStackList;
-    void setFocused( QQuickItem *item );
-    void setUnfocused( QQuickItem *item );
+    QList<QObject *> mStackList;
+    void setFocused( QObject *object );
+    void setUnfocused( QObject *object );
 };
 
 #endif // FOCUSSTACK_H
diff --git a/src/qml/About.qml b/src/qml/About.qml
@@ -10,6 +10,9 @@ import Theme
 Item {
   id: aboutPanel
 
+  visible: false
+  focus: visible
+
   Rectangle {
     color: "black"
     opacity: 0.8
@@ -208,4 +211,11 @@ Item {
       }
     }
   }
+
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      visible = false;
+    }
+  }
 }
diff --git a/src/qml/BookmarkProperties.qml b/src/qml/BookmarkProperties.qml
@@ -19,6 +19,7 @@ Popup {
   x: (parent.width - width) / 2
   y: (parent.height - height) / 2
   padding: 0
+  focus: visible
 
   onAboutToShow: {
     nameField.text = bookmarkName;
@@ -193,4 +194,11 @@ Popup {
       bookmarkProperties.close();
     }
   }
+
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      visible = false;
+    }
+  }
 }
diff --git a/src/qml/BrowserPanel.qml b/src/qml/BrowserPanel.qml
@@ -27,6 +27,7 @@ Popup {
   padding: 0
   modal: true
   closePolicy: Popup.CloseOnEscape
+  focus: visible
 
   Page {
     id: browserContainer

diff --git a/src/qml/Changelog.qml b/src/qml/Changelog.qml
@@ -17,7 +17,7 @@ Popup {
   height: parent.height - Theme.popupScreenEdgeMargin * 2
   padding: 0
   modal: true
-  closePolicy: Popup.CloseOnEscape | Popup.CloseOnPressOutside
+  closePolicy: Popup.CloseOnEscape
   focus: visible
 
   Page {

diff --git a/src/qml/DashBoard.qml b/src/qml/DashBoard.qml
@@ -38,7 +38,7 @@ Drawer {
   property bool preventFromOpening: overlayFeatureFormDrawer.visible
 
   position: 0
-  focus: opened
+  focus: visible
   clip: true
 
   onShowMenu: mainMenu.popup(settingsButton.x + 2, mainWindow.sceneTopMargin + settingsButton.y + 2)
@@ -374,7 +374,7 @@ Drawer {
     id: temporalProperties
     mapSettings: dashBoard.mapSettings
     modal: true
-    closePolicy: Popup.CloseOnEscape | Popup.CloseOnPressOutside
+    closePolicy: Popup.CloseOnEscape
     parent: mainWindow.contentItem
   }
 }
diff --git a/src/qml/EmbeddedFeatureForm.qml b/src/qml/EmbeddedFeatureForm.qml
@@ -46,7 +46,7 @@ Popup {
   signal featureCancelled
 
   parent: mainWindow.contentItem
-  closePolicy: Popup.NoAutoClose // prevent accidental feature addition and editing
+  closePolicy: form.state === "ReadOnly" ? Popup.CloseOnEscape : Popup.NoAutoClose // prevent accidental feature addition and editing
 
   x: Theme.popupScreenEdgeMargin / 2
   y: Theme.popupScreenEdgeMargin
@@ -56,6 +56,7 @@ Popup {
   width: parent.width - Theme.popupScreenEdgeMargin
   height: parent.height - Theme.popupScreenEdgeMargin * 2
   modal: true
+  focus: visible
 
   FeatureForm {
     id: form
@@ -73,8 +74,6 @@ Popup {
       }
     }
 
-    focus: true
-
     embedded: true
     toolbarVisible: true
 

diff --git a/src/qml/LayerTreeItemProperties.qml b/src/qml/LayerTreeItemProperties.qml
@@ -29,6 +29,9 @@ Popup {
   x: (mainWindow.width - width) / 2
   y: (mainWindow.height - height) / 2
   padding: 0
+  modal: true
+  closePolicy: Popup.CloseOnEscape | Popup.CloseOnPressOutside
+  focus: visible
 
   onClosed: {
     index = undefined;

diff --git a/src/qml/Legend.qml b/src/qml/Legend.qml
@@ -26,7 +26,6 @@ ListView {
   function openProperties(index) {
     itemProperties.index = legend.model.index(index, 0);
     itemProperties.open();
-    itemProperties.forceActiveFocus();
   }
 
   delegate: Rectangle {
@@ -339,7 +338,5 @@ ListView {
   LayerTreeItemProperties {
     id: itemProperties
     layerTree: legend.model
-    modal: true
-    closePolicy: Popup.CloseOnEscape | Popup.CloseOnPressOutside
   }
 }
diff --git a/src/qml/LocatorItem.qml b/src/qml/LocatorItem.qml
@@ -557,4 +557,11 @@ Item {
       }
     }
   }
+
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      state = "off";
+    }
+  }
 }
diff --git a/src/qml/LocatorSettings.qml b/src/qml/LocatorSettings.qml
@@ -17,6 +17,10 @@ Popup {
   x: (parent.width - width) / 2
   y: (parent.height - height) / 2
   padding: 0
+  modal: true
+  closePolicy: Popup.CloseOnEscape
+  parent: Overlay.overlay
+  focus: visible
 
   Page {
     id: page
@@ -103,4 +107,11 @@ Popup {
       }
     }
   }
+
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      visible = false;
+    }
+  }
 }
diff --git a/src/qml/MessageLog.qml b/src/qml/MessageLog.qml
@@ -15,6 +15,9 @@ Page {
 
   signal finished
 
+  visible: false
+  focus: visible
+
   header: QfPageHeader {
     title: qsTr('Message Logs')
 
@@ -218,4 +221,11 @@ Page {
     if (visible)
       unreadMessages = false;
   }
+
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      visible = false;
+    }
+  }
 }
diff --git a/src/qml/OverlayFeatureFormDrawer.qml b/src/qml/OverlayFeatureFormDrawer.qml
@@ -19,6 +19,7 @@ Drawer {
 
   edge: parent.width < parent.height ? Qt.BottomEdge : Qt.RightEdge
   closePolicy: Popup.NoAutoClose // prevent accidental feature addition when clicking outside of the popup drawer
+  focus: visible
 
   width: {
     if (qfieldSettings.fullScreenIdentifyView || parent.width < parent.height || parent.width < 300) {
@@ -93,8 +94,6 @@ Drawer {
 
     state: "Add"
 
-    focus: overlayFeatureFormDrawer.opened
-
     onConfirmed: {
       displayToast(qsTr("Changes saved"));
       //close drawer if still open
@@ -132,10 +131,6 @@ Drawer {
         event.accepted = true;
       }
     }
-
-    Component.onCompleted: {
-      focusstack.addFocusTaker(this);
-    }
   }
 
   Component.onCompleted: {

diff --git a/src/qml/PluginManagerSettings.qml b/src/qml/PluginManagerSettings.qml
@@ -16,6 +16,10 @@ Popup {
   x: (parent.width - width) / 2
   y: (parent.height - height) / 2
   padding: 0
+  modal: true
+  closePolicy: Popup.CloseOnEscape
+  parent: Overlay.overlay
+  focus: visible
 
   Page {
     id: page
@@ -399,6 +403,13 @@ Popup {
     }
   }
 
+  Keys.onReleased: event => {
+    if (event.key === Qt.Key_Back || event.key === Qt.Key_Escape) {
+      event.accepted = true;
+      visible = false;
+    }
+  }
+
   Component.onCompleted: {
     refreshAppPluginsList();
   }

diff --git a/src/qml/PositioningDeviceSettings.qml b/src/qml/PositioningDeviceSettings.qml
@@ -19,6 +19,7 @@ Popup {
   x: Theme.popupScreenEdgeMargin
   y: Theme.popupScreenEdgeMargin
   padding: 0
+  focus: visible
 
   property alias name: positioningDeviceName.text
   property alias type: positioningDeviceType.currentValue

diff --git a/src/qml/QFieldLocalDataPickerScreen.qml b/src/qml/QFieldLocalDataPickerScreen.qml
@@ -16,6 +16,8 @@ Page {
 
   signal finished(var loading)
 
+  focus: visible
+
   header: QfPageHeader {
     title: projectFolderView ? qsTr("Project Folder") : qsTr("Local Projects & Datasets")
 
@@ -705,8 +707,4 @@ Page {
       }
     }
   }
-
-  onVisibleChanged: {
-    focus = visible;
-  }
 }