QDoc port

.gitlab-ci.yml

@@ -7,6 +7,3 @@ include:
       - /gitlab-templates/reuse-lint.yml
       - /gitlab-templates/linux-qt6.yml
       - /gitlab-templates/freebsd-qt6.yml
-      - /gitlab-templates/xml-lint.yml
-      - /gitlab-templates/yaml-lint.yml
-      - /gitlab-templates/linux-qt6-next.yml

.kde-ci.yml

@@ -2,11 +2,11 @@
 # SPDX-License-Identifier: CC0-1.0
 
 Dependencies:
- - 'on': ['@all']
-   'require':
+- 'on': ['@all']
+  'require':
     'frameworks/extra-cmake-modules': '@latest-kf6'
     'third-party/wayland': '@latest'
     'third-party/wayland-protocols': '@latest'
 
 Options:
- require-passing-tests-on: ['Linux', 'FreeBSD', 'Windows']
+  require-passing-tests-on: ['Linux', 'FreeBSD', 'Windows']

CMakeLists.txt

@@ -4,13 +4,13 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(layershellqt)
-set(PROJECT_VERSION "6.3.80")
+set(PROJECT_VERSION "6.1.90")
 set(PROJECT_VERSION_MAJOR 6)
 
 set(CMAKE_C_STANDARD 99)
 
 set(QT_MIN_VERSION "6.7.0")
-set(KF6_MIN_VERSION "6.10.0")
+set(KF6_MIN_VERSION "6.5.0")
 set(KDE_COMPILERSETTINGS_LEVEL "5.82")
 
 set(CMAKE_CXX_STANDARD 20)
@@ -32,13 +32,9 @@ include(KDEClangFormat)
 include(ECMQtDeclareLoggingCategory)
 include(ECMQmlModule)
 include(KDEGitCommitHooks)
+include(ECMGenerateQDoc)
 
 find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS WaylandClient Qml)
-
-if (Qt6WaylandClient_VERSION VERSION_GREATER_EQUAL "6.10.0")
-    find_package(Qt6WaylandClientPrivate ${REQUIRED_QT_VERSION} REQUIRED NO_MODULE)
-endif()
-
 find_package(WaylandScanner REQUIRED)
 find_package(Wayland 1.3 COMPONENTS Client Server)
 find_package(WaylandProtocols REQUIRED)
@@ -60,8 +56,8 @@ kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
 
 kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT)
 
-ecm_set_disabled_deprecation_versions(QT 6.8.1
-    KF 6.9.0
+ecm_set_disabled_deprecation_versions(QT 6.5
+    KF 5.240
 )
 
 add_subdirectory(src)

metainfo.yaml

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: CC0-1.0
 
 maintainer:
-    - vladz
+- vladz
 description: Layer Shell Qt
 platforms:
     - name: Linux

src/CMakeLists.txt

@@ -68,6 +68,8 @@ generate_export_header(LayerShellQtInterface
     EXPORT_FILE_NAME LayerShellQt/layershellqt_export.h
 )
 
+ecm_generate_qdoc(LayerShellQtInterface layershellqt.qdocconf)
+
 install(TARGETS layer-shell
         LIBRARY DESTINATION ${KDE_INSTALL_QTPLUGINDIR}/wayland-shell-integration)
 

src/interfaces/shell.h

@@ -13,12 +13,18 @@
 
 namespace LayerShellQt
 {
-/**
- * Sets the right environment so the shells created from now on use wlr-layer-shell.
+/*!
+ * \class LayerShellQt::Shell
+ * \inmodule LayerShellQt
+ * \inheaderfile LayerShellQt/Shell
+ *
  */
 class LAYERSHELLQT_EXPORT Shell
 {
 public:
+    /*!
+     * Sets the right environment so the shells created from now on use wlr-layer-shell.
+     */
     static void useLayerShell();
 };
 

src/interfaces/window.cpp

@@ -34,7 +34,6 @@ public:
     QMargins margins;
     Window::ScreenConfiguration screenConfiguration = Window::ScreenFromQWindow;
     bool closeOnDismissed = true;
-    Window::AnchorRect anchorRect = Window::AnchorRectWorkArea;
 };
 
 static QMap<QWindow *, Window *> s_map;
@@ -85,21 +84,6 @@ Window::Anchor Window::exclusiveEdge() const
     return d->exclusiveEdge;
 }
 
-Window::AnchorRect Window::anchorRect() const
-{
-    return d->anchorRect;
-}
-
-void Window::setAnchorRect(Window::AnchorRect anchorRect)
-{
-    if (d->anchorRect == anchorRect) {
-        return;
-    }
-
-    d->anchorRect = anchorRect;
-    Q_EMIT anchorRectChanged();
-}
-
 void Window::setMargins(const QMargins &margins)
 {
     if (d->margins != margins) {

src/interfaces/window.h

@@ -18,14 +18,21 @@ namespace LayerShellQt
 {
 class WindowPrivate;
 
+/*!
+ * \class LayerShellQt::Window
+ * \inmodule LayerShellQt
+ * \inheaderfile LayerShellQt/Window
+ *
+ * \brief A window.
+ */
 class LAYERSHELLQT_EXPORT Window : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(Anchors anchors READ anchors WRITE setAnchors NOTIFY anchorsChanged)
+    /*! \property LayerShellQt::Window::scope */
     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(AnchorRect anchorRect READ anchorRect WRITE setAnchorRect NOTIFY anchorRectChanged)
     Q_PROPERTY(Layer layer READ layer WRITE setLayer NOTIFY layerChanged)
     Q_PROPERTY(KeyboardInteractivity keyboardInteractivity READ keyboardInteractivity WRITE setKeyboardInteractivity NOTIFY keyboardInteractivityChanged)
     Q_PROPERTY(ScreenConfiguration screenConfiguration READ screenConfiguration WRITE setScreenConfiguration)
@@ -33,23 +40,24 @@ class LAYERSHELLQT_EXPORT Window : public QObject
 public:
     ~Window() override;
 
+    /*!
+     * \value AnchorNone
+     * \value AnchorTop The top edge of the anchor rectangle
+     * \value AnchorBottom The bottom edge of the anchor rectangle
+     * \value AnchorLeft The left edge of the anchor rectangle
+     * \value AnchorRight The right edge of the anchor rectangle
+     */
     enum Anchor {
         AnchorNone = 0,
-        AnchorTop = 1, ///< The top edge of the anchor rectangle
-        AnchorBottom = 2, ///< The bottom edge of the anchor rectangle
-        AnchorLeft = 4, ///< The left edge of the anchor rectangle
-        AnchorRight = 8, ///< The right edge of the anchor rectangle
+        AnchorTop = 1,
+        AnchorBottom = 2,
+        AnchorLeft = 4,
+        AnchorRight = 8,
     };
     Q_ENUM(Anchor);
     Q_DECLARE_FLAGS(Anchors, Anchor)
 
-    /**
-     * This enum is used to choose between anchoring to work area or screen area
-     */
-    enum AnchorRect { AnchorRectWorkArea = 0, AnchorRectFullArea = 1 };
-    Q_ENUM(AnchorRect);
-
-    /**
+    /*!
      * This enum type is used to specify the layer where a surface can be put in.
      */
     enum Layer {
@@ -60,7 +68,7 @@ public:
     };
     Q_ENUM(Layer)
 
-    /**
+    /*!
      * This enum type is used to specify how the layer surface handles keyboard focus.
      */
     enum KeyboardInteractivity {
@@ -70,7 +78,7 @@ public:
     };
     Q_ENUM(KeyboardInteractivity)
 
-    /**
+    /*!
      * This enum type is used to specify which screen to place the surface on.
      * ScreenFromQWindow (the default) reads QWindow::screen() while ScreenFromCompositor
      * passes nil and lets the compositor decide.
@@ -90,9 +98,6 @@ public:
     void setExclusiveEdge(Window::Anchor edge);
     Window::Anchor exclusiveEdge() const;
 
-    AnchorRect anchorRect() const;
-    void setAnchorRect(AnchorRect anchorRect);
-
     void setMargins(const QMargins &margins);
     QMargins margins() const;
 
@@ -105,7 +110,7 @@ public:
     void setScreenConfiguration(ScreenConfiguration screenConfiguration);
     ScreenConfiguration screenConfiguration() const;
 
-    /**
+    /*!
      * Sets a string based identifier for this window.
      * This may be used by a compositor to determine stacking
      * order within a given layer.
@@ -113,9 +118,17 @@ public:
      * May also be referred to as a role
      */
     void setScope(const QString &scope);
+
+    /*!
+     * A string based identifier for this window.
+     * This may be used by a compositor to determine stacking
+     * order within a given layer.
+     *
+     * May also be referred to as a role
+     */
     QString scope() const;
 
-    /**
+    /*!
      * Whether the QWindow should be closed when the layer surface is dismissed by the compositor.
      * For example, if the associated screen has been removed.
      *
@@ -124,7 +137,7 @@ public:
     void setCloseOnDismissed(bool close);
     bool closeOnDismissed() const;
 
-    /**
+    /*!
      * Gets the LayerShell Window for a given Qt Window
      * Ownership is not transferred
      */
@@ -136,7 +149,6 @@ Q_SIGNALS:
     void anchorsChanged();
     void exclusionZoneChanged();
     void exclusiveEdgeChanged();
-    void anchorRectChanged();
     void marginsChanged();
     void keyboardInteractivityChanged();
     void layerChanged();

src/layershellqt.qdoc

@@ -0,0 +1,72 @@
+/*!
+    \module LayerShellQt
+    \title LayerShellQt C++ Classes
+
+    \cmakepackage LayerShellQt
+    \cmaketargetitem LayerShellQt::Interface
+*/
+
+/*!
+    \namespace LayerShellQt
+    \inmodule LayerShellQt
+
+    Stuff
+*/
+
+/*!
+    \qmlmodule org.kde.layershell
+    \title LayerShellQt QML Types
+*/
+
+/*!
+    \qmltype Window
+    \inqmlmodule org.kde.layershell
+
+    \nativetype LayerShellQt::Window
+*/
+
+/*!
+    \qmlproperty string Window::scope
+
+    A scope.
+*/
+
+/*!
+    \qmlproperty int Window::margins.top
+    \qmlproperty int Window::margins.bottom
+    \qmlproperty int Window::margins.left
+    \qmlproperty int Window::margins.right
+
+    Margins
+*/
+
+/*!
+    \qmlproperty int Window::exclusionZone
+*/
+
+/*!
+    \page layershellqt-index.html
+    \title LayerShellQt
+
+    Layer Shell
+
+    \section1 Using the Module
+
+    \include {module-use.qdocinc} {using the c++ api}
+
+    \section2 Building with CMake
+
+    \include {module-use.qdocinc} {building with cmake} {Widgets}
+
+    \section1 API Reference
+
+    \list
+        \li \l{LayerShellQt C++ Classes}
+        \li \l{LayerShellQt QML Types}
+    \endlist
+
+    \section1 Licenses
+
+    TODO
+*/
+

src/layershellqt.qdocconf

@@ -0,0 +1,30 @@
+include($KDE_DOCS/global/qt-module-defaults.qdocconf)
+
+project = LayerShellQt
+description = Qt component to allow applications to make use of the Wayland wl-layer-shell protocol
+
+documentationinheaders = true
+
+headerdirs = .
+
+headers.fileextensions = "*.qdoc *.h"
+
+outputdir  = doc/html
+outputformats = HTML
+
+depends += \
+    qtcore
+
+qhp.projects            = LayerShellQt
+
+qhp.LayerShellQt.file                = layershellqt.qhp
+qhp.LayerShellQt.namespace           = org.kde.layershellqt.$QT_VERSION_TAG
+qhp.LayerShellQt.virtualFolder       = layershellqt
+qhp.LayerShellQt.indexTitle          = LayerShellQt
+qhp.LayerShellQt.indexRoot           =
+
+qhp.LayerShellQt.subprojects         = classes
+qhp.LayerShellQt.subprojects.classes.title = C++ Classes
+qhp.LayerShellQt.subprojects.classes.indexTitle = LayerShellQt C++ Classes
+qhp.LayerShellQt.subprojects.classes.selectors = class fake:headerfile
+qhp.LayerShellQt.subprojects.classes.sortPages = true

src/qwaylandlayershellintegration.cpp

@@ -15,7 +15,7 @@
 namespace LayerShellQt
 {
 QWaylandLayerShellIntegration::QWaylandLayerShellIntegration()
-    : QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>(6)
+    : QWaylandShellIntegrationTemplate<QWaylandLayerShellIntegration>(5)
     , m_xdgActivation(new QWaylandXdgActivationV1)
 {
 }

src/qwaylandlayersurface.cpp

@@ -56,11 +56,6 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
         setExclusiveEdge(m_interface->exclusiveEdge());
     });
 
-    setAnchorRect(m_interface->anchorRect());
-    connect(m_interface, &Window::anchorRectChanged, this, [this]() {
-        setAnchorRect(m_interface->anchorRect());
-    });
-
     setMargins(m_interface->margins());
     connect(m_interface, &Window::marginsChanged, this, [this]() {
         setMargins(m_interface->margins());
@@ -156,13 +151,6 @@ void QWaylandLayerSurface::setExclusiveEdge(uint32_t edge)
     }
 }
 
-void QWaylandLayerSurface::setAnchorRect(int32_t anchorRect)
-{
-    if (zwlr_layer_surface_v1_get_version(object()) >= ZWLR_LAYER_SURFACE_V1_SET_ANCHOR_RECT_SINCE_VERSION) {
-        set_anchor_rect(anchorRect);
-    }
-}
-
 void QWaylandLayerSurface::setMargins(const QMargins &margins)
 {
     set_margin(margins.top(), margins.right(), margins.bottom(), margins.left());

src/qwaylandlayersurface_p.h

@@ -8,7 +8,6 @@
 #ifndef _LAYERSURFACE_H
 #define _LAYERSURFACE_H
 
-#include <cstdint>
 #include <wayland-client.h>
 
 #include "qwaylandlayershellintegration_p.h"
@@ -39,7 +38,6 @@ public:
     void setAnchor(uint32_t anchor);
     void setExclusiveZone(int32_t zone);
     void setExclusiveEdge(uint32_t edge);
-    void setAnchorRect(int32_t anchorRect);
     void setMargins(const QMargins &margins);
     void setKeyboardInteractivity(uint32_t interactivity);
     void setLayer(uint32_t layer);

src/wlr-layer-shell-unstable-v1.xml

@@ -25,7 +25,7 @@
     THIS SOFTWARE.
   </copyright>
 
-  <interface name="zwlr_layer_shell_v1" version="6">
+  <interface name="zwlr_layer_shell_v1" version="5">
     <description summary="create surfaces that are layers of the desktop">
       Clients can use this interface to assign the surface_layer role to
       wl_surfaces. Such surfaces are assigned to a "layer" of the output and
@@ -100,7 +100,7 @@
     </request>
   </interface>
 
-  <interface name="zwlr_layer_surface_v1" version="6">
+  <interface name="zwlr_layer_surface_v1" version="5">
     <description summary="layer metadata interface">
       An interface that may be implemented by a wl_surface, for surfaces that
       are designed to be rendered as a layer of a stacked desktop-like
@@ -168,25 +168,21 @@
         Surfaces that do not wish to have an exclusive zone may instead specify
         how they should interact with surfaces that do. If set to zero, the
         surface indicates that it would like to be moved to avoid occluding
-        surfaces with a positive exclusive zone.
+        surfaces with a positive exclusive zone. If set to -1, the surface
+        indicates that it would not like to be moved to accommodate for other
+        surfaces, and the compositor should extend it all the way to the edges
+        it is anchored to.
 
         For example, a panel might set its exclusive zone to 10, so that
         maximized shell surfaces are not shown on top of it. A notification
         might set its exclusive zone to 0, so that it is moved to avoid
-        occluding the panel, but shell surfaces are shown underneath it.
+        occluding the panel, but shell surfaces are shown underneath it. A
+        wallpaper or lock screen might set their exclusive zone to -1, so that
+        they stretch below or over the panel.
 
         The default value is 0.
 
         Exclusive zone is double-buffered, see wl_surface.commit.
-
-        Since version 6 It must be a value of 0 or more, otherwise the error
-        invalid_exclusive_zone will be triggered.
-
-        Until version 5 if set to -1, the surface indicates that it would not
-        like to be moved to accommodate for other surfaces, and the compositor
-        should extend it all the way to the edges it is anchored to.
-        A wallpaper or lock screen might set their exclusive zone to -1, so that
-        they stretch below or over the panel.
       </description>
       <arg name="zone" type="int"/>
     </request>
@@ -372,7 +368,6 @@
       <entry name="invalid_anchor" value="2" summary="anchor bitfield is invalid"/>
       <entry name="invalid_keyboard_interactivity" value="3" summary="keyboard interactivity is invalid"/>
       <entry name="invalid_exclusive_edge" value="4" summary="exclusive edge is invalid given the surface anchors"/>
-      <entry name="invalid_exclusive_zone" value="5" summary="exclusive zone value is invalid, since version 6 it can't be less than zero"/>
     </enum>
 
     <enum name="anchor" bitfield="true">
@@ -408,33 +403,5 @@
       </description>
       <arg name="edge" type="uint"/>
     </request>
-
-    <!-- Version 6 additions -->
-
-    <enum name="anchor_rect">
-      <entry name="full_area" value="0" summary="the full area anchor rect">
-        <description summary="the full area anchor rect">
-          Place the layer_surface_v1 relative to the full output area.
-        </description>
-      </entry>
-      <entry name="work_area" value="1" summary="the work area anchor rect">
-        <description summary="the work area anchor rect">
-          Place the layer_surface_v1 relative to the output area while taking
-          the exclusive zone of other surfaces into account.
-        </description>
-      </entry>
-    </enum>
-
-    <request name="set_anchor_rect" since="6">
-      <description summary="set the anchor rect">
-        Set the anchor rectangle relative to which the anchors are applied.
-
-        By default, the layer_surface_v1 is anchored to the 'work_area'.
-
-        Anchor rect is double-buffered, see wl_surface.commit.
-      </description>
-      <arg name="rect" type="uint" enum="anchor_rect"/>
-    </request>
-
   </interface>
 </protocol>