wip

KDAB · Jan 25, 2025 · 5a15069 · 5a15069
1 parent 6c7ce9d
commit 5a15069
Show file tree

Hide file tree

Showing 28 changed files with 151 additions and 67 deletions.
diff --git a/.gitignore b/.gitignore
@@ -115,3 +115,5 @@ generated_plugins.cmake
 /book/
 /src/flutter/dart/build/
 /tests/flutter/linux/flutter/ephemeral
+/src/.qmlls.ini
+/.qmlls.ini
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -125,6 +125,7 @@ option(KDDockWidgets_FLUTTER_TESTS_AOT "Flutter tests will be built in AOT mode"
 option(KDDockWidgets_NO_SPDLOG "Don't use spdlog, even if it is found." OFF)
 option(KDDockWidgets_USE_LLD "Use lld for linking" OFF)
 option(KDDockWidgets_USE_VALGRIND "Runs the tests under valgrind" OFF)
+option(KDDockWidgets_QML_MODULE "The QtQuick support will be built as a QML module" ON) # change to off!
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/ECM/modules")
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/KDAB/modules")
@@ -245,6 +246,10 @@ if(KDDW_FRONTEND_QTWIDGETS OR KDDW_FRONTEND_QTQUICK)
     set(KDDW_FRONTEND_QT ON)
 endif()
 
+if(KDDockWidgets_QML_MODULE AND (NOT KDDW_FRONTEND_QTQUICK OR NOT KDDockWidgets_QT6))
+    message(WARNING "KDDockWidgets_QML_MODULE=ON ignored. Only available for QtQuick on Qt6.")
+endif()
+
 if(KDDW_FRONTEND_FLUTTER)
     if(KDDW_FRONTEND_QT)
         message(FATAL_ERROR "The flutter frontend is not compatible with the Qt frontends. Chose a single one.")

diff --git a/code.code-workspace b/code.code-workspace
@@ -41,7 +41,12 @@
     "files.insertFinalNewline": true,
     "files.associations": {
       "*.code-workspace.template": "json"
-    }
+    },
+    "qt-qml.qmlls.customExePath": "/data/secured/home/serj/Qt/6.8.1/gcc_64/bin/qmlls",
+    "qt-qml.qmlls.verboseOutput": true,
+    "qt-qml.qmlls.additionalImportPaths": [
+      "/data/sources/kddockwidgets/build-dev6/com/kdab/kddockwidgets/"
+    ]
   },
   "launch": {
     "version": "0.2.0",

diff --git a/examples/qtquick/customplayground/main.qml b/examples/qtquick/customplayground/main.qml
@@ -29,7 +29,7 @@ ApplicationWindow {
             uniqueName: "dock4"
             source: "qrc:/Guest4.qml"
             onIsFocusedChanged: {
-              console.log("Dock4 focus changed to: " + isFocused);
+                console.log("Dock4 focus changed to: " + isFocused);
             }
         }
 

diff --git a/examples/qtquick/customseparator/main.qml b/examples/qtquick/customseparator/main.qml
@@ -29,7 +29,7 @@ ApplicationWindow {
             uniqueName: "dock4"
             source: "qrc:/Guest4.qml"
             onIsFocusedChanged: {
-              console.log("Dock4 focus changed to: " + isFocused);
+                console.log("Dock4 focus changed to: " + isFocused);
             }
         }
 

diff --git a/examples/qtquick/customtabbar/MyTabBar.qml b/examples/qtquick/customtabbar/MyTabBar.qml
@@ -33,7 +33,7 @@ KDDW.TabBarBase {
         Rectangle {
             id: addButton
             width: 50
-            color: addButtonMouseArea.containsMouse ? (addButtonMouseArea.pressed ? "#d6ce93" : "#ffecd1" ) : "#ffecd1"
+            color: addButtonMouseArea.containsMouse ? (addButtonMouseArea.pressed ? "#d6ce93" : "#ffecd1") : "#ffecd1"
             anchors {
                 right: parent.right
                 top: parent.top
@@ -103,7 +103,7 @@ KDDW.TabBarBase {
         spacing: 2
 
         /// Needed only if you want to style hovered tabs differently
-        property int hoveredIndex: -1;
+        property int hoveredIndex: -1
 
         /// ##HERE## The list of tabs is stored in a C++ model. This repeater populates our tab bar
         Repeater {
@@ -112,7 +112,7 @@ KDDW.TabBarBase {
                 id: tab
                 height: parent.height
                 width: 150
-                readonly property bool isCurrent: index == root.groupCpp.currentIndex;
+                readonly property bool isCurrent: index == root.groupCpp.currentIndex
                 color: (tabBarRow.hoveredIndex == index) ? "#d6ce93" : (isCurrent ? "#d6ce93" : "#ffecd1")
                 border.color: "black"
 

diff --git a/examples/qtquick/customtabbar/main.qml b/examples/qtquick/customtabbar/main.qml
@@ -27,7 +27,7 @@ ApplicationWindow {
                 // For demonstration purposes, show how to change title:
                 text: qsTr("Change title of #4")
                 onTriggered: {
-                  dock4.title = "new title";
+                    dock4.title = "new title";
                 }
             }
         }
@@ -51,13 +51,13 @@ ApplicationWindow {
         id: dock5
         uniqueName: "dock5"
         Rectangle {
-          color: "#85baa1"
-          anchors.fill: parent
-          Text {
-              font.pixelSize: 25
-              text: "Five"
-              anchors.centerIn: parent
-          }
+            color: "#85baa1"
+            anchors.fill: parent
+            Text {
+                font.pixelSize: 25
+                text: "Five"
+                anchors.centerIn: parent
+            }
         }
     }
 
@@ -68,8 +68,8 @@ ApplicationWindow {
         uniqueName: "MyMainLayout"
 
         Component.onCompleted: {
-           addDockWidget(dock4, KDDW.KDDockWidgets.Location_OnBottom);
-           dock4.addDockWidgetAsTab(dock5);
+            addDockWidget(dock4, KDDW.KDDockWidgets.Location_OnBottom);
+            dock4.addDockWidgetAsTab(dock5);
         }
     }
 }
diff --git a/examples/qtquick/customtitlebar/main.qml b/examples/qtquick/customtitlebar/main.qml
@@ -29,7 +29,7 @@ ApplicationWindow {
             uniqueName: "dock4"
             source: "qrc:/Guest4.qml"
             onIsFocusedChanged: {
-              console.log("Dock4 focus changed to: " + isFocused);
+                console.log("Dock4 focus changed to: " + isFocused);
             }
         }
 

diff --git a/examples/qtquick/dockwidgets/main.qml b/examples/qtquick/dockwidgets/main.qml
@@ -86,20 +86,21 @@ ApplicationWindow {
             Action {
                 text: qsTr("Close All")
                 onTriggered: {
-                   _kddwDockRegistry.clear();
+                    _kddwDockRegistry.clear();
                 }
             }
 
             Action {
                 // Shows how to use direct deletion
                 text: qsTr("Delete widget #5")
                 onTriggered: {
-                   dock5.deleteDockWidget();
+                    dock5.deleteDockWidget();
                 }
             }
 
-            MenuSeparator { }
-            Action { text: qsTr("&Quit")
+            MenuSeparator {}
+            Action {
+                text: qsTr("&Quit")
                 onTriggered: {
                     Qt.quit();
                 }
@@ -129,7 +130,7 @@ ApplicationWindow {
 
             onIsOpenChanged: {
                 // Just an example of detecting when a dockwidget is closed
-                console.log("Dock4 is open ? " + isOpen)
+                console.log("Dock4 is open ? " + isOpen);
             }
         }
 
@@ -186,9 +187,7 @@ ApplicationWindow {
             // Adds dock6 but specifies a preferred initial size and it starts hidden
             // When toggled it will be shown on the desired dock location.
             // See MainWindowInstantiator_p.h for the API
-            addDockWidget(dock6, KDDW.KDDockWidgets.Location_OnLeft, null,
-                                 Qt.size(500, 100), KDDW.KDDockWidgets.StartHidden);
-
+            addDockWidget(dock6, KDDW.KDDockWidgets.Location_OnLeft, null, Qt.size(500, 100), KDDW.KDDockWidgets.StartHidden);
 
             // dock7 will be tabbed with dock7:
             dock5.addDockWidgetAsTab(dock7);

diff --git a/examples/qtquick/mdi_with_docking/main.qml b/examples/qtquick/mdi_with_docking/main.qml
@@ -25,12 +25,13 @@ ApplicationWindow {
             Action {
                 text: qsTr("Close All")
                 onTriggered: {
-                   _kddwDockRegistry.clear();
+                    _kddwDockRegistry.clear();
                 }
             }
 
-            MenuSeparator { }
-            Action { text: qsTr("&Quit")
+            MenuSeparator {}
+            Action {
+                text: qsTr("&Quit")
                 onTriggered: {
                     Qt.quit();
                 }

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -135,7 +135,6 @@ set(KDDW_FRONTEND_QTQUICK_SRCS
     qtquick/Helpers.cpp
     qtquick/ViewFactory.cpp
     qtquick/LayoutSaverInstantiator.cpp
-    qtquick/MainWindowInstantiator.cpp
     qtquick/MainWindowMDIInstantiator.cpp
     qtquick/DockWidgetInstantiator.cpp
     qtquick/QmlTypes.cpp
@@ -257,7 +256,7 @@ endif()
 include(ECMGenerateHeaders)
 ecm_generate_headers(camelcase_HEADERS ORIGINAL CAMELCASE HEADER_NAMES Config LayoutSaver)
 
-add_library(kddockwidgets ${KDDockWidgets_LIBRARY_MODE} ${DOCKSLIBS_SRCS} ${KDDW_PUBLIC_HEADERS})
+qt_add_library(kddockwidgets ${KDDockWidgets_LIBRARY_MODE} ${DOCKSLIBS_SRCS} ${KDDW_PUBLIC_HEADERS})
 
 add_library(KDAB::kddockwidgets ALIAS kddockwidgets)
 set_target_properties(kddockwidgets PROPERTIES OUTPUT_NAME "kddockwidgets${KDDockWidgets_LIBRARY_QTID}")
@@ -285,7 +284,10 @@ if(KDDW_FRONTEND_QTWIDGETS)
 endif()
 
 if(KDDW_FRONTEND_QTQUICK)
-    target_include_directories(kddockwidgets PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/fwd_headers/qtquick>)
+    target_include_directories(
+        kddockwidgets PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/fwd_headers/qtquick>
+                             $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/qtquick>
+    )
 endif()
 
 if(KDDW_FRONTEND_FLUTTER)
@@ -559,6 +561,62 @@ if(KDDW_FRONTEND_QTQUICK)
         qtquick/views/TitleBar.h
     )
 
+    if(KDDockWidgets_QML_MODULE)
+        qt_policy(SET QTP0001 NEW)
+        function(fix_resource_paths)
+            foreach(SOURCE_FILE IN LISTS ARGN)
+                get_filename_component(FILENAME ${SOURCE_FILE} NAME)
+                set_source_files_properties(${SOURCE_FILE} PROPERTIES QT_RESOURCE_ALIAS ${FILENAME})
+            endforeach()
+        endfunction()
+
+        set(KDDW_QML_FILES
+            qtquick/views/qml/DockWidget.qml
+            qtquick/views/qml/DropArea.qml
+            qtquick/views/qml/TitleBarBase.qml
+            qtquick/views/qml/TitleBar.qml
+            qtquick/views/qml/Group.qml
+            qtquick/views/qml/FloatingWindow.qml
+            qtquick/views/qml/TabBarBase.qml
+            qtquick/views/qml/TabBar.qml
+            qtquick/views/qml/Separator.qml
+            qtquick/views/qml/MainWindowMDI.qml
+            qtquick/views/qml/MDIResizeHandlerHelper.qml
+            qtquick/views/qml/RubberBand.qml
+            qtquick/views/qml/TitleBarButton.qml
+            qtquick/views/qml/ClassicIndicatorsOverlay.qml
+            qtquick/views/qml/ClassicIndicator.qml
+        )
+
+        fix_resource_paths(${KDDW_QML_FILES})
+
+        target_compile_definitions(kddockwidgets PUBLIC KDDW_QML_MODULE)
+
+        qt_add_qml_module(
+            kddockwidgets
+            URI
+            com.kdab.dockwidgets
+            VERSION
+            2.0
+            QML_FILES
+            ${KDDW_QML_FILES}
+            NO_CACHEGEN
+            SOURCES
+            KDDockWidgets.h
+            qtquick/MainWindowInstantiator.cpp
+            qtquick/MainWindowInstantiator.h
+            qtquick/LayoutSaverInstantiator.cpp
+            qtquick/LayoutSaverInstantiator.h
+            qtquick/DockWidgetInstantiator.cpp
+            qtquick/DockWidgetInstantiator.h
+            qtquick/MainWindowMDIInstantiator.cpp
+            qtquick/MainWindowMDIInstantiator.h
+            OUTPUT_DIRECTORY
+            ${CMAKE_BINARY_DIR}/com/kdab/dockwidgets
+            # NO_PLUGIN # For now. Feel free to enable plugin but add CI test coverage
+        )
+    endif()
+
     install(FILES ${KDDW_QTQUICK_HEADERS} DESTINATION ${DOCKS_INCLUDES_INSTALL_PATH}/kddockwidgets/qtquick)
     install(FILES ${KDDW_QTQUICK_VIEW_HEADERS} DESTINATION ${DOCKS_INCLUDES_INSTALL_PATH}/kddockwidgets/qtquick)
     install(FILES ${KDDW_FRONTEND_QTQUICK_VIEW_HEADERS}

diff --git a/src/KDDockWidgets.cpp b/src/KDDockWidgets.cpp
@@ -48,7 +48,7 @@ void KDDockWidgets::initFrontend(FrontendType type)
 
 const char *KDDockWidgets::spdlogLoggerName()
 {
-    return "com.kdab.kddockwidgets";
+    return "com.kdab.dockwidgets";
 }
 
 NeighbourSqueezeStrategy InitialOption::s_defaultNeighbourSqueezeStrategy = NeighbourSqueezeStrategy::AllNeighbours;

diff --git a/src/KDDockWidgets.h b/src/KDDockWidgets.h
@@ -36,6 +36,11 @@
 
 #endif
 
+#ifdef KDDW_FRONTEND_QTQUICK
+#include <QQmlEngine>
+#endif
+
+
 namespace KDDockWidgets::QtQuick {
 }
 namespace KDDockWidgets::QtWidgets {
@@ -48,6 +53,7 @@ namespace KDDockWidgets::Flutter {
 namespace KDDockWidgets {
 QT_DOCKS_EXPORT
 Q_NAMESPACE
+QML_ELEMENT
 
 namespace QtWidgets {
 class DockWidget;

diff --git a/src/qtquick/DockWidgetInstantiator.h b/src/qtquick/DockWidgetInstantiator.h
@@ -17,6 +17,7 @@
 #include <QQmlParserStatus>
 #include <QQuickItem>
 #include <QString>
+#include <QQmlEngine>
 
 namespace KDDockWidgets {
 
@@ -32,6 +33,7 @@ namespace KDDockWidgets {
 class DockWidgetInstantiator : public QQuickItem
 {
     Q_OBJECT
+    QML_NAMED_ELEMENT(DockWidget)
     Q_PROPERTY(QString uniqueName READ uniqueName WRITE setUniqueName NOTIFY uniqueNameChanged)
     Q_PROPERTY(QString source READ source WRITE setSource NOTIFY sourceChanged)
     Q_PROPERTY(KDDockWidgets::QtQuick::DockWidget *dockWidget READ dockWidget NOTIFY

diff --git a/src/qtquick/LayoutSaverInstantiator.h b/src/qtquick/LayoutSaverInstantiator.h
@@ -16,7 +16,7 @@
 #include "LayoutSaver.h"
 
 #include <QObject>
-
+#include <QQmlEngine>
 
 QT_BEGIN_NAMESPACE
 class QQuickItem;
@@ -33,6 +33,7 @@ namespace KDDockWidgets {
 class DOCKS_EXPORT LayoutSaverInstantiator : public QObject, public LayoutSaver
 {
     Q_OBJECT
+    QML_NAMED_ELEMENT(LayoutSaver)
     Q_PROPERTY(QVector<QString> affinities READ affinities WRITE setAffinities NOTIFY affinitiesChanged)
 public:
     explicit LayoutSaverInstantiator(QObject *parent = nullptr);

diff --git a/src/qtquick/MainWindowInstantiator.h b/src/qtquick/MainWindowInstantiator.h
@@ -17,6 +17,7 @@
 #include "kddockwidgets/KDDockWidgets.h"
 
 #include <QQuickItem>
+#include <QQmlEngine>
 
 namespace KDDockWidgets {
 
@@ -30,6 +31,7 @@ class SideBar;
 class DOCKS_EXPORT MainWindowInstantiator : public QQuickItem
 {
     Q_OBJECT
+    QML_NAMED_ELEMENT(DockingArea)
     Q_PROPERTY(QString uniqueName READ uniqueName WRITE setUniqueName NOTIFY uniqueNameChanged)
     Q_PROPERTY(QString persistentCentralItemFileName READ persistentCentralItemFileName WRITE setPersistentCentralItemFileName NOTIFY uniqueNameChanged)
     Q_PROPERTY(KDDockWidgets::MainWindowOptions options READ options WRITE setOptions NOTIFY

diff --git a/src/qtquick/MainWindowMDIInstantiator.h b/src/qtquick/MainWindowMDIInstantiator.h
@@ -17,6 +17,7 @@
 #include "kddockwidgets/KDDockWidgets.h"
 
 #include <QQuickItem>
+#include <QQmlEngine>
 
 namespace KDDockWidgets {
 
@@ -30,6 +31,7 @@ class SideBar;
 class DOCKS_EXPORT MainWindowMDIInstantiator : public QQuickItem
 {
     Q_OBJECT
+    QML_NAMED_ELEMENT(MDIDockingArea)
     Q_PROPERTY(QString uniqueName READ uniqueName WRITE setUniqueName NOTIFY uniqueNameChanged)
     Q_PROPERTY(QVector<QString> affinities READ affinities CONSTANT)
 public:

diff --git a/src/qtquick/Platform.cpp b/src/qtquick/Platform.cpp
@@ -83,7 +83,10 @@ void Platform::init()
     initResources();
 #endif
 
+#ifndef KDDW_QML_MODULE
     KDDockWidgets::registerQmlTypes();
+#endif
+
     QQuickWindow::setDefaultAlphaBuffer(true);
 
     qGuiApp->connect(qApp, &QGuiApplication::focusObjectChanged, qApp, [this](QObject *obj) {