Expose the Window interface to QML

If we are designing our UI's windows from QML, it makes sense that we
might want to configure how they're placed from the same place.

Everything was already in place but for a few technical bits which this
change adds.

Signed-off-by: Victoria Fischer <victoria.fischer@mbition.io>

.gitlab-ci.yml

@@ -2,6 +2,8 @@
 # SPDX-License-Identifier: CC0-1.0
 
 include:
+  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/reuse-lint.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/freebsd.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux-qt6.yml
+  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/freebsd-qt6.yml

CMakeLists.txt

@@ -4,13 +4,13 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "5.25.2")
+set(PROJECT_VERSION "5.27.6")
 set(PROJECT_VERSION_MAJOR 5)
 
 set(CMAKE_C_STANDARD 99)
 
 set(QT_MIN_VERSION "5.15.2")
-set(KF5_MIN_VERSION "5.94")
+set(KF5_MIN_VERSION "5.102.0")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 17)
@@ -23,13 +23,16 @@ include(KDEInstallDirs)
 include(KDECMakeSettings)
 include(KDECompilerSettings NO_POLICY_SCOPE)
 include(ECMSetupVersion)
+include(ECMDeprecationSettings)
 include(ECMGenerateHeaders)
 include(CMakePackageConfigHelpers)
 include(FeatureSummary)
 include(GenerateExportHeader)
 include(KDEClangFormat)
+include(ECMQmlModule)
 include(ECMQtDeclareLoggingCategory)
 
+
 find_package(Qt${QT_MAJOR_VERSION} ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
 if (QT_MAJOR_VERSION EQUAL "5")
     find_package(Qt5XkbCommonSupport REQUIRED PRIVATE)
@@ -53,10 +56,15 @@ ecm_setup_version(${PROJECT_VERSION} VARIABLE_PREFIX LAYERSHELLQT
 
 file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h)
 kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
+
+ecm_set_disabled_deprecation_versions(QT 5.15.2
+    KF 5.101
+)
+
 add_subdirectory(src)
 add_subdirectory(tests)
 
-set(CMAKECONFIG_INSTALL_DIR ${KDE_INSTALL_LIBDIR}/cmake/LayerShellQt)
+set(CMAKECONFIG_INSTALL_DIR ${KDE_INSTALL_CMAKEPACKAGEDIR}/LayerShellQt)
 install(EXPORT LayerShellQtTargets
         NAMESPACE LayerShellQt::
         DESTINATION ${CMAKECONFIG_INSTALL_DIR}

metainfo.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: None
+# SPDX-License-Identifier: CC0-1.0
+
 maintainer:
 - vladz
 description: Layer Shell Qt

src/CMakeLists.txt

@@ -24,7 +24,8 @@ ecm_qt_declare_logging_category(LAYER_SHELL_SOURCES
 )
 
 target_sources(LayerShellQtInterface PRIVATE qwaylandlayersurface.cpp interfaces/window.cpp interfaces/shell.cpp qwaylandlayershellintegration.cpp qwaylandlayershell.cpp ${LAYER_SHELL_SOURCES})
-target_link_libraries(LayerShellQtInterface PRIVATE Qt::Gui Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
+target_link_libraries(LayerShellQtInterface PUBLIC Qt::Gui)
+target_link_libraries(LayerShellQtInterface PRIVATE Qt::WaylandClientPrivate Wayland::Client PkgConfig::XKBCOMMON)
 if (TARGET Qt::XkbCommonSupportPrivate)
     target_link_libraries(LayerShellQtInterface PRIVATE Qt::XkbCommonSupportPrivate)
 endif()
@@ -68,3 +69,5 @@ install(FILES
     ${CMAKE_CURRENT_BINARY_DIR}/LayerShellQt/layershellqt_export.h
     DESTINATION ${KDE_INSTALL_INCLUDEDIR}/LayerShellQt COMPONENT Devel
 )
+
+add_subdirectory(declarative)

src/declarative/CMakeLists.txt

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+# SPDX-License-Identifier: BSD-3-Clause
+
+ecm_add_qml_module(LayerShellQtQml URI "org.kde.layershell")
+target_sources(LayerShellQtQml PRIVATE layershellqtplugin.cpp)
+target_link_libraries(LayerShellQtQml PRIVATE Qt::Qml LayerShellQtInterface)
+
+ecm_finalize_qml_module(LayerShellQtQml DESTINATION ${KDE_INSTALL_QMLDIR})

src/declarative/layershellqtplugin.cpp

@@ -0,0 +1,24 @@
+/*
+ *   SPDX-FileCopyrightText: 2023 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+ *
+ *   SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+#include <QQmlExtensionPlugin>
+#include "../interfaces/window.h"
+#include <qqml.h>
+
+QML_DECLARE_TYPEINFO(LayerShellQt::Window, QML_HAS_ATTACHED_PROPERTIES)
+
+class Plugin : public QQmlExtensionPlugin
+{
+    Q_PLUGIN_METADATA(IID "org.kde.layershellqt")
+    Q_OBJECT
+public:
+    void registerTypes(const char *uri) override {
+        Q_ASSERT(QLatin1String(uri) == QLatin1String("org.kde.layershell"));
+        qmlRegisterType<LayerShellQt::Window>(uri, 1, 0, "Window");
+    }
+};
+
+#include "layershellqtplugin.moc"

src/interfaces/window.cpp

@@ -5,10 +5,10 @@
  */
 
 #include "window.h"
-#include "../qwaylandlayersurface_p.h"
 #include <layershellqt_logging.h>
-#include <private/qwaylandshellsurface_p.h>
-#include <private/qwaylandwindow_p.h>
+
+#include <QPointer>
+#include <optional>
 
 using namespace LayerShellQt;
 
@@ -27,8 +27,7 @@ public:
     Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityExclusive;
     Window::Layer layer = Window::LayerTop;
     QMargins margins;
-    QWaylandLayerSurface *getSurface() const;
-    QPointer<QScreen> desiredOutput;
+    std::optional<QPointer<QScreen>> desiredOutput;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -41,9 +40,7 @@ Window::~Window()
 void Window::setAnchors(Anchors anchors)
 {
     d->anchors = anchors;
-    if (auto surface = d->getSurface()) {
-        surface->setAnchor(anchors);
-    }
+    Q_EMIT anchorsChanged();
 }
 
 Window::Anchors Window::anchors() const
@@ -54,9 +51,7 @@ Window::Anchors Window::anchors() const
 void Window::setExclusiveZone(int32_t zone)
 {
     d->exclusionZone = zone;
-    if (auto surface = d->getSurface()) {
-        surface->setExclusiveZone(zone);
-    }
+    Q_EMIT exclusionZoneChanged();
 }
 
 int32_t Window::exclusionZone() const
@@ -67,9 +62,7 @@ int32_t Window::exclusionZone() const
 void Window::setMargins(const QMargins &margins)
 {
     d->margins = margins;
-    if (auto surface = d->getSurface()) {
-        surface->setMargins(margins);
-    }
+    Q_EMIT marginsChanged();
 }
 
 QMargins Window::margins() const
@@ -80,9 +73,7 @@ QMargins Window::margins() const
 void Window::setKeyboardInteractivity(KeyboardInteractivity interactivity)
 {
     d->keyboardInteractivity = interactivity;
-    if (auto surface = d->getSurface()) {
-        surface->setKeyboardInteractivity(interactivity);
-    }
+    Q_EMIT keyboardInteractivityChanged();
 }
 
 Window::KeyboardInteractivity Window::keyboardInteractivity() const
@@ -93,9 +84,6 @@ Window::KeyboardInteractivity Window::keyboardInteractivity() const
 void Window::setLayer(Layer layer)
 {
     d->layer = layer;
-    if (auto surface = d->getSurface()) {
-        surface->setLayer(layer);
-    }
 }
 
 void Window::setScope(const QString &scope)
@@ -116,7 +104,12 @@ Window::Layer Window::layer() const
 
 QScreen *Window::desiredOutput() const
 {
-    return d->desiredOutput;
+    // Don't use .value_or here to avoid a temporary QPointer
+    if (d->desiredOutput.has_value()) {
+        return d->desiredOutput.value();
+    }
+
+    return d->parentWindow->screen();
 }
 
 void Window::setDesiredOutput(QScreen *output)
@@ -133,6 +126,10 @@ Window::Window(QWindow *window)
 
 Window *Window::get(QWindow *window)
 {
+    if (!window) {
+        return nullptr;
+    }
+
     auto layerShellWindow = s_map.value(window);
     if (layerShellWindow) {
         return layerShellWindow;
@@ -140,20 +137,7 @@ Window *Window::get(QWindow *window)
     return new Window(window);
 }
 
-QWaylandLayerSurface *WindowPrivate::getSurface() const
+Window *Window::qmlAttachedProperties(QObject *object)
 {
-    if (!parentWindow) {
-        return nullptr;
-    }
-    auto ww = dynamic_cast<QtWaylandClient::QWaylandWindow *>(parentWindow->handle());
-    if (!ww) {
-        qCDebug(LAYERSHELLQT) << "window not a wayland window" << parentWindow;
-        return nullptr;
-    }
-    QWaylandLayerSurface *s = qobject_cast<QWaylandLayerSurface *>(ww->shellSurface());
-    if (!s) {
-        qCDebug(LAYERSHELLQT) << "window not using wlr-layer-shell" << parentWindow << ww->shellSurface();
-        return nullptr;
-    }
-    return s;
+    return get(qobject_cast<QWindow *>(object));
 }

src/interfaces/window.h

@@ -21,7 +21,15 @@ class WindowPrivate;
 class LAYERSHELLQT_EXPORT Window : public QObject
 {
     Q_OBJECT
+    Q_PROPERTY(int anchors READ anchors WRITE setAnchorsInt NOTIFY anchorsChanged)
+    Q_PROPERTY(QString scope READ scope WRITE setScope)
+    Q_PROPERTY(QMargins margins READ margins WRITE setMargins NOTIFY marginsChanged)
+    Q_PROPERTY(qint32 exclusionZone READ exclusionZone WRITE setExclusiveZone NOTIFY exclusionZoneChanged)
+    Q_PROPERTY(Layer layer READ layer WRITE setLayer NOTIFY layerChanged)
+    Q_PROPERTY(KeyboardInteractivity keyboardInteractivity READ keyboardInteractivity WRITE setKeyboardInteractivity NOTIFY keyboardInteractivityChanged)
+
 public:
+    Window(QWindow *window = nullptr);
     ~Window() override;
 
     enum Anchor {
@@ -87,14 +95,25 @@ public:
     void setScope(const QString &scope);
     QString scope() const;
 
+    /// Workaround needed for Qt 5 not to get confused with types, not necessary on Qt 6
+    void setAnchorsInt(int x) { setAnchors(Anchors(x)); }
+
     /**
      * Gets the LayerShell Window for a given Qt Window
      * Ownership is not transferred
      */
     static Window *get(QWindow *window);
 
+    static Window *qmlAttachedProperties(QObject *object);
+
+Q_SIGNALS:
+    void anchorsChanged();
+    void exclusionZoneChanged();
+    void marginsChanged();
+    void keyboardInteractivityChanged();
+    void layerChanged();
+
 private:
-    Window(QWindow *window);
     QScopedPointer<WindowPrivate> d;
 };
 

src/qwaylandlayersurface.cpp

@@ -36,15 +36,31 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShell *shell, QtWaylandC
         }
     }
     init(shell->get_layer_surface(window->waylandSurface()->object(), output, interface->layer(), interface->scope()));
-
-    Window::Anchors anchors = interface->anchors();
+    connect(interface, &Window::layerChanged, this, [this, interface]() {
+        setLayer(interface->layer());
+    });
 
     set_anchor(interface->anchors());
-    setMargins(interface->margins());
-    setKeyboardInteractivity(interface->keyboardInteractivity());
+    connect(interface, &Window::anchorsChanged, this, [this, interface]() {
+        set_anchor(interface->anchors());
+    });
     setExclusiveZone(interface->exclusionZone());
+    connect(interface, &Window::exclusionZoneChanged, this, [this, interface]() {
+        setExclusiveZone(interface->exclusionZone());
+    });
+
+    setMargins(interface->margins());
+    connect(interface, &Window::marginsChanged, this, [this, interface]() {
+        setMargins(interface->margins());
+    });
+
+    setKeyboardInteractivity(interface->keyboardInteractivity());
+    connect(interface, &Window::keyboardInteractivityChanged, this, [this, interface]() {
+        setKeyboardInteractivity(interface->keyboardInteractivity());
+    });
 
     QSize size = window->surfaceSize();
+    const Window::Anchors anchors = interface->anchors();
     if ((anchors & Window::AnchorLeft) && (anchors & Window::AnchorRight)) {
         size.setWidth(0);
     }

tests/quicktest.qml

@@ -0,0 +1,115 @@
+/*
+ *   SPDX-FileCopyrightText: 2021 Aleix Pol Gonzalez <aleix.pol_gonzalez@mercedes-benz.com>
+ *
+ *   SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+import QtQuick 2.15
+import QtQuick.Window 2.15
+import org.kde.layershell 1.0 as LayerShell
+
+Item
+{
+    Text {
+        text: "A normal Window"
+        anchors.centerIn: parent
+    }
+
+    Window {
+        LayerShell.Window.anchors: LayerShell.Window.AnchorLeft
+        LayerShell.Window.layer: LayerShell.Window.LayerBackground
+        LayerShell.Window.exclusionZone: -1
+
+        Component.onCompleted: {
+            console.log("xxxx", LayerShell.Window.AnchorLeft, LayerShell.Window.anchors)
+        }
+
+        width: 200
+        height: 150
+        Rectangle {
+            anchors.fill: parent
+            color: "green"
+
+            Text {
+                anchors.centerIn: parent
+                text: "left bg"
+            }
+        }
+        visible: true
+    }
+
+
+    Window {
+        LayerShell.Window.scope: "dock"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorLeft
+        LayerShell.Window.layer: LayerShell.Window.LayerTop
+        LayerShell.Window.exclusionZone: width
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "left"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorRight
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "right"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorTop
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "top"
+            }
+        }
+        visible: true
+    }
+
+    Window {
+        LayerShell.Window.scope: "normal"
+        LayerShell.Window.anchors: LayerShell.Window.AnchorBottom
+
+        width: 100
+        height: 100
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+
+            Text {
+                anchors.centerIn: parent
+                text: "bottom"
+            }
+        }
+        visible: true
+    }
+}