wayland/shortcuts-inhibitor: fix rest

Author: outfoxxed

changelog/next.md

@@ -14,6 +14,7 @@ set shell id.
 - Added support for creating Polkit agents.
 - Added support for creating wayland idle inhibitors.
 - Added support for wayland idle timeouts.
+- Added support for inhibiting wayland compositor shortcuts for focused windows.
 - Added the ability to override Quickshell.cacheDir with a custom path.
 
 ## Other Changes

src/wayland/shortcuts_inhibit/inhibitor.cpp

@@ -1,9 +1,12 @@
 #include "inhibitor.hpp"
 
 #include <private/qwaylandwindow_p.h>
+#include <qguiapplication.h>
 #include <qlogging.h>
 #include <qloggingcategory.h>
 #include <qobject.h>
+#include <qtmetamacros.h>
+#include <qwindow.h>
 
 #include "../../window/proxywindow.hpp"
 #include "../../window/windowinterface.hpp"
@@ -19,8 +22,19 @@ ShortcutInhibitor::ShortcutInhibitor() {
 
 	this->bActive.setBinding([this]() {
 		auto* inhibitor = this->bInhibitor.value();
-		return inhibitor ? inhibitor->bindableActive().value() : false;
+		if (!inhibitor) return false;
+		if (!inhibitor->bindableActive().value()) return false;
+		return this->bWindow.value() == this->bFocusedWindow;
 	});
+
+	QObject::connect(
+	    dynamic_cast<QGuiApplication*>(QGuiApplication::instance()),
+	    &QGuiApplication::focusWindowChanged,
+	    this,
+	    &ShortcutInhibitor::onFocusedWindowChanged
+	);
+
+	this->onFocusedWindowChanged(QGuiApplication::focusWindow());
 }
 
 ShortcutInhibitor::~ShortcutInhibitor() {
@@ -32,7 +46,7 @@ ShortcutInhibitor::~ShortcutInhibitor() {
 	manager->unrefShortcutsInhibitor(this->bInhibitor);
 }
 
-void ShortcutInhibitor::boundWindowChanged() {
+void ShortcutInhibitor::onBoundWindowChanged() {
 	auto* window = this->bBoundWindow.value();
 	auto* proxyWindow = qobject_cast<ProxyWindowBase*>(window);
 
@@ -44,17 +58,17 @@ void ShortcutInhibitor::boundWindowChanged() {
 
 	if (proxyWindow == this->proxyWindow) return;
 
+	if (this->proxyWindow) {
+		QObject::disconnect(this->proxyWindow, nullptr, this, nullptr);
+		this->proxyWindow = nullptr;
+	}
+
 	if (this->mWaylandWindow) {
 		QObject::disconnect(this->mWaylandWindow, nullptr, this, nullptr);
 		this->mWaylandWindow = nullptr;
 		this->onWaylandSurfaceDestroyed();
 	}
 
-	if (this->proxyWindow) {
-		QObject::disconnect(this->proxyWindow, nullptr, this, nullptr);
-		this->proxyWindow = nullptr;
-	}
-
 	if (proxyWindow) {
 		this->proxyWindow = proxyWindow;
 
@@ -74,7 +88,6 @@ void ShortcutInhibitor::boundWindowChanged() {
 void ShortcutInhibitor::onWindowDestroyed() {
 	this->proxyWindow = nullptr;
 	this->onWaylandSurfaceDestroyed();
-	this->bWindowObject = nullptr;
 }
 
 void ShortcutInhibitor::onWindowVisibilityChanged() {
@@ -90,6 +103,7 @@ void ShortcutInhibitor::onWindowVisibilityChanged() {
 	}
 	if (waylandWindow == this->mWaylandWindow) return;
 	this->mWaylandWindow = waylandWindow;
+	this->bWindow = window;
 
 	QObject::connect(
 	    waylandWindow,
@@ -144,7 +158,7 @@ void ShortcutInhibitor::onWaylandSurfaceDestroyed() {
 	this->bInhibitor = nullptr;
 }
 
-void ShortcutInhibitor::inhibitorChanged() {
+void ShortcutInhibitor::onInhibitorChanged() {
 	auto* inhibitor = this->bInhibitor.value();
 	if (inhibitor) {
 		QObject::connect(
@@ -162,7 +176,12 @@ void ShortcutInhibitor::onInhibitorActiveChanged() {
 		// Compositor has deactivated the inhibitor, making it invalid.
 		// Set enabled to false so the user can enable it again to create a new inhibitor.
 		this->bEnabled = false;
+		emit this->cancelled();
 	}
 }
 
+void ShortcutInhibitor::onFocusedWindowChanged(QWindow* focusedWindow) {
+	this->bFocusedWindow = focusedWindow;
+}
+
 } // namespace qs::wayland::shortcuts_inhibit

src/wayland/shortcuts_inhibit/inhibitor.hpp

@@ -5,6 +5,7 @@
 #include <qqmlintegration.h>
 #include <qtclasshelpermacros.h>
 #include <qtmetamacros.h>
+#include <qwindow.h>
 
 #include "../../window/proxywindow.hpp"
 #include "proto.hpp"
@@ -29,11 +30,12 @@ class ShortcutInhibitor: public QObject {
 	/// If the shortcuts inhibitor should be enabled. Defaults to false.
 	Q_PROPERTY(bool enabled READ default WRITE default NOTIFY enabledChanged BINDABLE bindableEnabled);
 	/// The window to associate the shortcuts inhibitor with.
+  /// The inhibitor will only inhibit shortcuts pressed while this window has keyboard focus.
 	///
   /// Must be set to a non null value to enable the inhibitor.
 	Q_PROPERTY(QObject* window READ default WRITE default NOTIFY windowChanged BINDABLE bindableWindow);
-	/// Whether the inhibitor is currently active. The inhibitor is only active when the
-	/// compositor has granted the request.
+	/// Whether the inhibitor is currently active. The inhibitor is only active if @@enabled is true,
+  /// @@window has keyboard focus, and the compositor grants the inhibit request.
 	///
 	/// The compositor may deactivate the inhibitor at any time (for example, if the user requests
 	/// normal shortcuts to be restored). When deactivated by the compositor, the inhibitor cannot be
@@ -54,6 +56,8 @@ class ShortcutInhibitor: public QObject {
 	void enabledChanged();
 	void windowChanged();
 	void activeChanged();
+	/// Sent if the compositor cancels the inhibitor while it is active.
+	void cancelled();
 
 private slots:
 	void onWindowDestroyed();
@@ -64,16 +68,20 @@ private slots:
 	void onInhibitorActiveChanged();
 
 private:
-	void boundWindowChanged();
-	void inhibitorChanged();
+	void onBoundWindowChanged();
+	void onInhibitorChanged();
+	void onFocusedWindowChanged(QWindow* focusedWindow);
+
 	ProxyWindowBase* proxyWindow = nullptr;
 	QtWaylandClient::QWaylandWindow* mWaylandWindow = nullptr;
 
 	// clang-format off
 	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, bool, bEnabled, &ShortcutInhibitor::enabledChanged);
 	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, QObject*, bWindowObject, &ShortcutInhibitor::windowChanged);
-	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, QObject*, bBoundWindow, &ShortcutInhibitor::boundWindowChanged);
-	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, impl::ShortcutsInhibitor*, bInhibitor, &ShortcutInhibitor::inhibitorChanged);
+	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, QObject*, bBoundWindow, &ShortcutInhibitor::onBoundWindowChanged);
+	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, impl::ShortcutsInhibitor*, bInhibitor, &ShortcutInhibitor::onInhibitorChanged);
+	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, QWindow*, bWindow);
+	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, QWindow*, bFocusedWindow);
 	Q_OBJECT_BINDABLE_PROPERTY(ShortcutInhibitor, bool, bActive, &ShortcutInhibitor::activeChanged);
 	// clang-format on
 };

src/wayland/shortcuts_inhibit/test/manual/test.qml

@@ -4,26 +4,62 @@ import QtQuick.Controls
 import Quickshell
 import Quickshell.Wayland
 
-FloatingWindow {
-	id: w
-	color: contentItem.palette.window
+Scope {
+	Timer {
+		id: toggleTimer
+		interval: 100
+		onTriggered: windowLoader.active = true
+	}
 
-	ColumnLayout {
-		anchors.centerIn: parent
+	LazyLoader {
+		id: windowLoader
+		active: true
 
-		CheckBox {
-			id: enabledCb
-			text: "Enabled"
-		}
+		property bool enabled: false
 
-		Label {
-			text: `Active: ${inhibitor.active}`
-		}
-	}
+		FloatingWindow {
+			id: w
+			color: contentItem.palette.window
+
+			ColumnLayout {
+				anchors.centerIn: parent
+
+				CheckBox {
+					id: loadedCb
+					text: "Loaded"
+					checked: true
+				}
 
-	ShortcutInhibitor {
-		id: inhibitor
-		window: w
-		enabled: enabledCb.checked
+				CheckBox {
+					id: enabledCb
+					text: "Enabled"
+					checked: windowLoader.enabled
+					onCheckedChanged: windowLoader.enabled = checked
+				}
+
+				Label {
+					text: `Active: ${inhibitorLoader.item?.active ?? false}`
+				}
+
+				Button {
+					text: "Toggle Window"
+					onClicked: {
+						windowLoader.active = false;
+						toggleTimer.start();
+					}
+				}
+			}
+
+			LazyLoader {
+				id: inhibitorLoader
+				active: loadedCb.checked
+
+				ShortcutInhibitor {
+					window: w
+					enabled: enabledCb.checked
+					onCancelled: enabledCb.checked = false
+				}
+			}
+		}
 	}
 }