Introduction and implementation of the Bookmark tool (#533)

Author: mfeigl

CHANGELOG.md

@@ -9,6 +9,7 @@
 * Added a `CONTRIBUTING.md`.
 * Added a `.clang-format` file.
 * Added vscode/spellchecking for documentation purposes.
+* (BookmarksView) Introduction of new Bookmark tool (C++/Quick, QML/Quick, Widget) 
 
 ## 100.14
 * `toolkitwidgets.pri`, `toolkitqml.pri`, and `toolkitcpp.pri` now include `QT += ...` lines to account for needed dependencies.

uitools/README.md

@@ -11,6 +11,7 @@ In the [API Documentation](https://developers.arcgis.com/qt/toolkit/api-referenc
 |:--:|:--:|:--:|:--:|
 |Authentication view|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-authenticationview.html) | [✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-authenticationview.html) | [✔](https://developers.arcgis.com/qt/toolkit/api-reference/esri-arcgisruntime-toolkit-authenticationview.html) |
 |Basemap gallery|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-basemapgallery.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-basemapgallery.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/esri-arcgisruntime-toolkit-basemapgallery.html)|
+| Bookmarks view |✔|✔ |✔ |
 |Callout|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-callout.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-callout.html)||
 |Coordinate conversion|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-coordinateconversion.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-coordinateconversion.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/esri-arcgisruntime-toolkit-coordinateconversion.html)|
 |Floor Filter|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-floorfilter.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/qml-floorfilter.html)|[✔](https://developers.arcgis.com/qt/toolkit/api-reference/esri-arcgisruntime-toolkit-floorfilter.html)|

uitools/common.pri

@@ -19,6 +19,8 @@ INCLUDEPATH += $$PWD/cpp $$CPPPATH
 HEADERS += $$CPPPATH/AuthenticationController.h \
            $$CPPPATH/BasemapGalleryController.h \
            $$CPPPATH/BasemapGalleryItem.h \
+           $$CPPPATH/BookmarksViewController.h \
+           $$CPPPATH/BookmarkListItem.h \
            $$CPPPATH/CoordinateConversionConstants.h \
            $$CPPPATH/CoordinateConversionController.h \
            $$CPPPATH/CoordinateConversionOption.h \
@@ -51,6 +53,8 @@ HEADERS += $$CPPPATH/AuthenticationController.h \
 SOURCES += $$CPPPATH/AuthenticationController.cpp \
            $$CPPPATH/BasemapGalleryController.cpp \
            $$CPPPATH/BasemapGalleryItem.cpp \
+           $$CPPPATH/BookmarksViewController.cpp \
+           $$CPPPATH/BookmarkListItem.cpp \
            $$CPPPATH/CoordinateConversionConstants.cpp \
            $$CPPPATH/CoordinateConversionController.cpp \
            $$CPPPATH/CoordinateConversionOption.cpp \

uitools/cpp/Esri/ArcGISRuntime/Toolkit/BookmarkListItem.cpp

@@ -0,0 +1,111 @@
+/*******************************************************************************
+ *  Copyright 2012-2022 Esri
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ******************************************************************************/
+#include "BookmarkListItem.h"
+
+// ArcGISRuntime headers
+#include <Bookmark.h>
+
+namespace Esri {
+  namespace ArcGISRuntime {
+    namespace Toolkit {
+
+    /*!
+    \inmodule EsriArcGISRuntimeToolkit
+    \class Esri::ArcGISRuntime::Toolkit::BookmarkListItem
+    \brief An item contained within \l BookmarksViewController::bookmarks. This class wraps
+    a \c Bookmark for easy manipulation/inspection within an AbstractItemModel.
+   */
+
+    /*!
+    \brief Constructs a new empty BookmarkListItem object with a given \a parent.
+   */
+    BookmarkListItem::BookmarkListItem(QObject* parent) :
+      BookmarkListItem(nullptr, parent)
+    {
+    }
+
+    /*!
+    \brief Constructs a new BookmarkListItem object with a given \a bookmark and
+    \a parent.
+   */
+      BookmarkListItem::BookmarkListItem(Bookmark* bookmark, QObject* parent) :
+        QObject(parent),
+        m_bookmark(bookmark)
+      {
+        connect(this, &BookmarkListItem::bookmarkChanged, this, &BookmarkListItem::nameChanged);
+      }
+
+    /*!
+    \brief Destructor.
+   */
+    BookmarkListItem::~BookmarkListItem() = default;
+
+    /*!
+    \brief Change the underlying item to \a bookmark.
+   */
+    void BookmarkListItem::setBookmark(Bookmark* bookmark)
+    {
+      if (m_bookmark == bookmark)
+      {
+        return;
+      }
+
+      m_bookmark = bookmark;
+      emit bookmarkChanged();
+    }
+
+    /*!
+    \brief Returns the current \c bookmark.
+   */
+    Bookmark* BookmarkListItem::bookmark() const
+    {
+      return m_bookmark;
+    }
+
+    /*!
+    \property Esri::ArcGISRuntime::Toolkit::BookmarkListItem::name
+    \brief Returns the name of the item.
+   */
+    QString BookmarkListItem::name() const
+    {
+      return m_bookmark ? m_bookmark->name() : QString{};
+    }
+
+    /*!
+    \brief Sets the underlying item to \a name.
+   */
+    void BookmarkListItem::setName(const QString& name)
+    {
+      if (m_bookmark && m_bookmark->name() != name)
+      {
+        m_bookmark->setName(name);
+        emit nameChanged();
+      }
+    }
+
+    /*!
+    \fn void Esri::ArcGISRuntime::Toolkit::BookmarkListItem::bookmarkChanged()
+    \brief Signal emitted when the \l bookmark changes.
+   */
+
+    /*!
+    \fn void Esri::ArcGISRuntime::Toolkit::BookmarkListItem::nameChanged()
+    \brief Signal emitted when the \l bookmark name changes.
+   */
+
+    } // Toolkit
+  } // ArcGISRuntime
+} // Esri

uitools/cpp/Esri/ArcGISRuntime/Toolkit/BookmarkListItem.h

@@ -0,0 +1,56 @@
+/*******************************************************************************
+ *  Copyright 2012-2022 Esri
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ******************************************************************************/
+#ifndef ESRI_ARCGISRUNTIME_TOOLKIT_BOOKMARKLISTITEM_H
+#define ESRI_ARCGISRUNTIME_TOOLKIT_BOOKMARKLISTITEM_H
+
+// Qt headers
+#include <QObject>
+#include <QPointer>
+
+namespace Esri {
+  namespace ArcGISRuntime {
+    class Bookmark;
+
+    namespace Toolkit {
+      class BookmarkListItem : public QObject
+      {
+        Q_OBJECT
+        Q_PROPERTY(QString name READ name NOTIFY nameChanged)
+
+      public:
+        Q_INVOKABLE explicit BookmarkListItem(QObject* parent = nullptr);
+        Q_INVOKABLE explicit BookmarkListItem(Bookmark* bookmark, QObject* parent = nullptr);
+        ~BookmarkListItem() override;
+
+        void setBookmark(Bookmark* bookmark);
+        Bookmark* bookmark() const;
+
+        QString name() const;
+        void setName(const QString& name);
+
+      signals:
+        void bookmarkChanged();
+        void nameChanged();
+
+      private:
+        QPointer<Bookmark> m_bookmark;
+      };
+
+    } // Toolkit
+  } // ArcGISRuntime
+} // Esri
+
+#endif // ESRI_ARCGISRUNTIME_TOOLKIT_BOOKMARKLISTITEM_H