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.90")
+set(PROJECT_VERSION "6.1.90")
 set(PROJECT_VERSION_MAJOR 6)
 
 set(CMAKE_C_STANDARD 99)
 
-set(QT_MIN_VERSION "6.8.0")
-set(KF6_MIN_VERSION "6.14.0")
+set(QT_MIN_VERSION "6.7.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

@@ -32,7 +32,6 @@ public:
     Window::KeyboardInteractivity keyboardInteractivity = Window::KeyboardInteractivityOnDemand;
     Window::Layer layer = Window::LayerTop;
     QMargins margins;
-    QSize desiredSize = QSize(0, 0);
     Window::ScreenConfiguration screenConfiguration = Window::ScreenFromQWindow;
     bool closeOnDismissed = true;
 };
@@ -98,21 +97,6 @@ QMargins Window::margins() const
     return d->margins;
 }
 
-void Window::setDesiredSize(const QSize &size)
-{
-    if (size == d->desiredSize) {
-        return;
-    }
-
-    d->desiredSize = size;
-    Q_EMIT desiredSizeChanged();
-}
-
-QSize Window::desiredSize() const
-{
-    return d->desiredSize;
-}
-
 void Window::setKeyboardInteractivity(KeyboardInteractivity interactivity)
 {
     if (d->keyboardInteractivity != interactivity) {

src/interfaces/window.h

@@ -18,10 +18,18 @@ 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)
@@ -32,17 +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 type is used to specify the layer where a surface can be put in.
      */
     enum Layer {
@@ -53,7 +68,7 @@ public:
     };
     Q_ENUM(Layer)
 
-    /**
+    /*!
      * This enum type is used to specify how the layer surface handles keyboard focus.
      */
     enum KeyboardInteractivity {
@@ -63,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.
@@ -86,9 +101,6 @@ public:
     void setMargins(const QMargins &margins);
     QMargins margins() const;
 
-    void setDesiredSize(const QSize &size);
-    QSize desiredSize() const;
-
     void setKeyboardInteractivity(KeyboardInteractivity interactivity);
     KeyboardInteractivity keyboardInteractivity() const;
 
@@ -98,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.
@@ -106,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.
      *
@@ -117,7 +137,7 @@ public:
     void setCloseOnDismissed(bool close);
     bool closeOnDismissed() const;
 
-    /**
+    /*!
      * Gets the LayerShell Window for a given Qt Window
      * Ownership is not transferred
      */
@@ -130,7 +150,6 @@ Q_SIGNALS:
     void exclusionZoneChanged();
     void exclusiveEdgeChanged();
     void marginsChanged();
-    void desiredSizeChanged();
     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/qwaylandlayersurface.cpp

@@ -44,11 +44,7 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
     setAnchor(m_interface->anchors());
     connect(m_interface, &Window::anchorsChanged, this, [this]() {
         setAnchor(m_interface->anchors());
-        if (m_interface->desiredSize().isNull()) {
-            setDesiredSize(m_window->windowContentGeometry().size());
-        } else {
-            setDesiredSize(m_interface->desiredSize());
-        }
+        setDesiredSize(m_window->windowContentGeometry().size());
     });
 
     setExclusiveZone(m_interface->exclusionZone());
@@ -65,22 +61,12 @@ QWaylandLayerSurface::QWaylandLayerSurface(QWaylandLayerShellIntegration *shell,
         setMargins(m_interface->margins());
     });
 
-    connect(m_interface, &Window::desiredSizeChanged, this, [this]() {
-        if (!m_interface->desiredSize().isNull()) {
-            setDesiredSize(m_interface->desiredSize());
-        }
-    });
-
     setKeyboardInteractivity(m_interface->keyboardInteractivity());
     connect(m_interface, &Window::keyboardInteractivityChanged, this, [this]() {
         setKeyboardInteractivity(m_interface->keyboardInteractivity());
     });
 
-    if (m_interface->desiredSize().isNull()) {
-        setDesiredSize(window->windowContentGeometry().size());
-    } else {
-        setDesiredSize(m_interface->desiredSize());
-    }
+    setDesiredSize(window->windowContentGeometry().size());
 }
 
 QWaylandLayerSurface::~QWaylandLayerSurface()
@@ -188,16 +174,12 @@ void QWaylandLayerSurface::setWindowGeometry(const QRect &geometry)
         return;
     }
 
-    if (m_interface->desiredSize().isNull()) {
-        setDesiredSize(geometry.size());
-    }
+    setDesiredSize(geometry.size());
 }
 #else
 void QWaylandLayerSurface::setWindowSize(const QSize &size)
 {
-    if (m_interface->desiredSize().isNull()) {
-        setDesiredSize(size);
-    }
+    setDesiredSize(size);
 }
 #endif