improve qml cmake build

Author: ozguronsoy

CMakeLists.txt

@@ -23,7 +23,7 @@ set(SIMPLE_MAP_VIEW_QT_LIBRARIES Qt::Core Qt::Positioning Qt::Network)
 
 if(SIMPLE_MAP_VIEW_BUILD_QML)
 
-    list(APPEND SIMPLE_MAP_VIEW_DEFINITIONS SIMPLE_MAP_VIEW_USE_QML SIMPLE_MAP_VIEW_QML_URI="${SIMPLE_MAP_VIEW_QML_URI}")
+    list(APPEND SIMPLE_MAP_VIEW_DEFINITIONS SIMPLE_MAP_VIEW_USE_QML)
     list(APPEND SIMPLE_MAP_VIEW_QT_COMPONENTS Quick)
     list(APPEND SIMPLE_MAP_VIEW_QT_LIBRARIES Qt::Quick)
 
@@ -40,7 +40,7 @@ file(GLOB_RECURSE SIMPLE_MAP_VIEW_HEADERS include/*.h)
 file(GLOB_RECURSE SIMPLE_MAP_VIEW_SOURCES src/*.cpp)
 
 if(SIMPLE_MAP_VIEW_BUILD_TESTS OR SIMPLE_MAP_VIEW_BUILD_PYTHON_BINDINGS)
-    
+
     set(CMAKE_AUTOMOC ON)
     set(CMAKE_AUTORCC ON)
     set(CMAKE_AUTOUIC ON)
@@ -52,7 +52,26 @@ if(SIMPLE_MAP_VIEW_BUILD_TESTS OR SIMPLE_MAP_VIEW_BUILD_PYTHON_BINDINGS)
 
 endif()
 
-add_library(SimpleMapView STATIC ${SIMPLE_MAP_VIEW_HEADERS} ${SIMPLE_MAP_VIEW_SOURCES})
+if(SIMPLE_MAP_VIEW_BUILD_QML)
+
+    qt_add_library(SimpleMapView STATIC)
+    qt_add_qml_module(
+        SimpleMapView
+        URI ${SIMPLE_MAP_VIEW_QML_URI}
+        VERSION ${PROJECT_VERSION}
+        SOURCES ${SIMPLE_MAP_VIEW_HEADERS} ${SIMPLE_MAP_VIEW_SOURCES}
+        DEPENDENCIES
+            QtQuick
+            QtPositioning
+        OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/com/github/ozguronsoy/SimpleMapView
+    )
+
+else()
+
+    add_library(SimpleMapView STATIC ${SIMPLE_MAP_VIEW_HEADERS} ${SIMPLE_MAP_VIEW_SOURCES})
+
+endif()
+
 target_compile_definitions(SimpleMapView PUBLIC ${SIMPLE_MAP_VIEW_DEFINITIONS})
 target_include_directories(
     SimpleMapView
@@ -69,4 +88,4 @@ endif()
 if(SIMPLE_MAP_VIEW_BUILD_TESTS)
     enable_testing()
     add_subdirectory(tests)
-endif()
+endif()

README.md

@@ -34,7 +34,6 @@ CMake:
 find_package(Qt6 REQUIRED COMPONENTS Core)
 qt_standard_project_setup()
 
-set(SIMPLE_MAP_VIEW_USE_QML ON) # if QML app
 add_subdirectory(dependencies/SimpleMapView)
 
 set(CMAKE_AUTORCC ON)
@@ -51,8 +50,6 @@ target_link_libraries(mytarget PUBLIC
 
 qmake:
 ```
-SIMPLE_MAP_VIEW_ENABLE_RESOURCES = 1 # optional
-SIMPLE_MAP_VIEW_USE_QML = 1 # if QML app
 include(dependencies/SimpleMapView/SimpleMapView.pro)
 ```
 
@@ -227,38 +224,15 @@ To use the QML component, you need to enable it in your build system first.
 
 CMake:
 ```cmake
-set(SIMPLE_MAP_VIEW_USE_QML ON)
+set(SIMPLE_MAP_VIEW_BUILD_QML ON)
 ```
 
 qmake:
 ```
-SIMPLE_MAP_VIEW_USE_QML = 1
+SIMPLE_MAP_VIEW_BUILD_QML = 1
 ```
 
-Then in your ``main.cpp`` file, you need to register the QML components after creating the ``app`` instance.
-
-Sample main code:
-```c++
-#include <QGuiApplication>
-#include <QQmlApplicationEngine>
-#include "SimpleMapView.h"
-
-int main(int argc, char *argv[])
-{
-    QGuiApplication app(argc, argv);
-
-    SimpleMapView::registerQmlTypes();
-
-    QQmlApplicationEngine engine;
-    engine.load(QUrl(QStringLiteral("qrc:/qt/qml/yourapp/main.qml")));
-    if (engine.rootObjects().isEmpty())
-        return -1;
-
-    return app.exec();
-}
-```
-
-After that you can import and use the QML components in your ``.qml`` files.
+After that you can import and use the QML components in your ``QML`` files.
 
 ```qml
 import QtQuick
@@ -297,11 +271,16 @@ Window {
         }
 
         Component.onCompleted: {
-            map.addMarker(map.center)
+            var marker = map.addMarker(map.center)
+            var textItem = SimpleMapViewQmlHelpers.findChild(marker, "MapText")
+            if (textItem) {
+                textItem.setText("Marker!")
+            }
         }
     }
 }
 
+
 ```
 
 
@@ -352,4 +331,4 @@ mapView->setTileServer("path/to/offline-tiles");
 // mapView->setTileServer(":/SimpleMapView/Tiles");
 ```
 
-``downloadTiles`` method also generates a ``qrc`` file so one can use the resource system. However, this is not recommended for large maps, as it increases compile time and can significantly bloat the executable.
+``downloadTiles`` method also generates a ``qrc`` file so one can use the resource system. However, this is not recommended for large maps, as it increases compile time and can significantly bloat the executable.

SimpleMapView.pro

@@ -9,26 +9,21 @@ DEFINES += SIMPLE_MAP_VIEW_VERSION_MAJOR=$$SIMPLE_MAP_VIEW_VERSION_MAJOR
 DEFINES += SIMPLE_MAP_VIEW_VERSION_MINOR=$$SIMPLE_MAP_VIEW_VERSION_MINOR
 DEFINES += SIMPLE_MAP_VIEW_VERSION_PATCH=$$SIMPLE_MAP_VIEW_VERSION_PATCH
 
-isEmpty(SIMPLE_MAP_VIEW_USE_QML) {
+isEmpty(SIMPLE_MAP_VIEW_BUILD_QML) {
 
     QT *= gui widgets
 
 } else {
 
     QT *= quick
     DEFINES += SIMPLE_MAP_VIEW_USE_QML
-    DEFINES += SIMPLE_MAP_VIEW_QML_URI=\\\"$$SIMPLE_MAP_VIEW_QML_URI\\\"
 
+    QML_IMPORT_NAME = $$SIMPLE_MAP_VIEW_QML_URI
+    QML_DESIGNER_IMPORT_PATH = $$SIMPLE_MAP_VIEW_QML_URI
+    QML_IMPORT_MAJOR_VERSION = $$SIMPLE_MAP_VIEW_VERSION_MAJOR
 }
 
 INCLUDEPATH += $$PWD/include
 
 HEADERS += $$files($$PWD/include/*.h) $$files($$PWD/include/SimpleMapView/*.h)
 SOURCES += $$files($$PWD/src/*.cpp) $$files($$PWD/src/SimpleMapView/*.cpp)
-
-!isEmpty(SIMPLE_MAP_VIEW_ENABLE_RESOURCES) {
-
-    RESOURCES += $$PWD/Resources.qrc
-
-}
-

include/SimpleMapView.h

@@ -73,14 +73,6 @@ class SimpleMapView : public SimpleMapViewBase
 	explicit SimpleMapView(SimpleMapViewBase* parent = nullptr);
 	~SimpleMapView() = default;
 
-
-#ifdef SIMPLE_MAP_VIEW_USE_QML
-
-	/** Registers the QML types on run-time. Call this after creating the app instance. */
-	static void registerQmlTypes();
-
-#endif
-
 public slots:
 	/** Gets the minimum zoom level. */
 	int minZoomLevel() const;
@@ -301,4 +293,4 @@ public slots:
 	static constexpr unsigned int DOWNLOAD_MAX_CONCURRENT_REQUEST_COUNT = 10;
 };
 
-#endif
+#endif

include/SimpleMapView/MapEllipse.h

@@ -16,6 +16,10 @@ class MapEllipse : public MapItem
 	Q_PROPERTY(MapSize size READ size WRITE setSize NOTIFY sizeChanged);
 	Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY backgroundColorChanged);
 
+#ifdef SIMPLE_MAP_VIEW_USE_QML
+    QML_ELEMENT;
+#endif
+
 public:
 	explicit MapEllipse(QObject* parent = nullptr);
 
@@ -69,4 +73,4 @@ class MapEllipse : public MapItem
 	QColor m_backgroundColor;
 };
 
-#endif
+#endif

include/SimpleMapView/MapImage.h

@@ -13,6 +13,10 @@ class MapImage : public MapRect
 	Q_PROPERTY(QString image WRITE setImage NOTIFY imageChanged);
 	Q_PROPERTY(Qt::AspectRatioMode aspectRatioMode READ aspectRatioMode WRITE setAspectRatioMode NOTIFY imageChanged);
 
+#ifdef SIMPLE_MAP_VIEW_USE_QML
+    QML_ELEMENT;
+#endif
+
 public:
 	explicit MapImage(QObject* parent = nullptr);
 
@@ -41,4 +45,4 @@ class MapImage : public MapRect
 	Qt::AspectRatioMode m_aspectRatioMode;
 };
 
-#endif
+#endif

include/SimpleMapView/MapItem.h

@@ -58,4 +58,4 @@ class MapItem : public QObject
 	QPen m_pen;
 };
 
-#endif
+#endif

include/SimpleMapView/MapLines.h

@@ -12,6 +12,10 @@ class MapLines : public MapItem
 	Q_OBJECT;
 	Q_PROPERTY(QVector<MapPoint> points READ points WRITE setPoints);
 
+#ifdef SIMPLE_MAP_VIEW_USE_QML
+    QML_ELEMENT;
+#endif
+
 public:
 	explicit MapLines(QObject* parent = nullptr);
 
@@ -32,4 +36,4 @@ class MapLines : public MapItem
 	QVector<MapPoint> m_points;
 };
 
-#endif
+#endif

include/SimpleMapView/MapPolygon.h

@@ -12,6 +12,10 @@ class MapPolygon : public MapLines
 	Q_OBJECT;
 	Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY backgroundColorChanged);
 
+#ifdef SIMPLE_MAP_VIEW_USE_QML
+    QML_ELEMENT;
+#endif
+
 public:
 	explicit MapPolygon(QObject* parent = nullptr);
 
@@ -29,4 +33,4 @@ class MapPolygon : public MapLines
 	QColor m_backgroundColor;
 };
 
-#endif
+#endif

include/SimpleMapView/MapRect.h

@@ -12,6 +12,10 @@ class MapRect : public MapEllipse
 {
 	Q_OBJECT;
 
+#ifdef SIMPLE_MAP_VIEW_USE_QML
+    QML_ELEMENT;
+#endif
+
 public:
 	explicit MapRect(QObject* parent = nullptr);
 
@@ -37,4 +41,4 @@ class MapRect : public MapEllipse
 	std::array<qreal, 4> m_borderRadii;  // top-left, top-right, bottom-right, bottom-left
 };
 
-#endif
+#endif