Class BookmarkModel

ClassList > BookmarkModel

Inherits the following classes: QSortFilterProxyModel

Public Types

Type	Name
enum	Roles

Public Properties

Type	Name
property bool	hideProjectBookmarks When TRUE, project bookmarks are hidden so only user bookmarks (those created in QField) are listed.
property QgsQuickMapSettings *	mapSettings
property qsizetype	selectedCount Number of currently selected bookmarks.

Public Signals

Type	Name
signal void	hideProjectBookmarksChanged
signal void	mapSettingsChanged
signal void	requestJumpToPoint (const QgsPoint & center, const double & scale=-1.0, bool handleMargins=false)
signal void	selectedCountChanged

Public Functions

Type	Name
	BookmarkModel (QgsBookmarkManager * manager, QgsBookmarkManager * projectManager=nullptr, QObject * parent=nullptr)
Q_INVOKABLE QString	addBookmarkAtPoint (QgsPoint point, const QString & name=QString(), const QString & group=QString())
Q_INVOKABLE void	clearSelection () Clears the current selection.
QVariant	data (const QModelIndex & index, int role) override const
Q_INVOKABLE int	deleteSelected () Deletes all currently selected bookmarks, persisting once. Returns the number deleted.
Q_INVOKABLE bool	exportBookmarks (bool selectedOnly) Exports user bookmarks to a temporary GeoPackage and sends it via the platform's native sharing. When selectedOnly is TRUE, only selected bookmarks are exported.
Q_INVOKABLE QgsCoordinateReferenceSystem	getBookmarkCrs (const QString & id)
Q_INVOKABLE QgsPoint	getBookmarkPoint (const QString & id)
bool	hideProjectBookmarks () const
QgsQuickMapSettings *	mapSettings () const
Q_INVOKABLE void	removeBookmark (const QString & id)
QHash< int, QByteArray >	roleNames () override const
qsizetype	selectedCount () const
Q_INVOKABLE void	setExtentFromBookmark (const QModelIndex & index)
void	setHideProjectBookmarks (bool hideProjectBookmarks)
void	setMapSettings (QgsQuickMapSettings * mapSettings)
Q_INVOKABLE void	store ()
Q_INVOKABLE void	toggleSelected (const QString & id) Toggles the selection state of the bookmark identified by id .
Q_INVOKABLE void	updateBookmarkDetails (const QString & id, const QString & name, const QString & group)

Protected Functions

Type	Name
bool	filterAcceptsRow (int sourceRow, const QModelIndex & sourceParent) override const
bool	lessThan (const QModelIndex & sourceLeft, const QModelIndex & sourceRight) override const

Public Types Documentation

enum Roles

enum BookmarkModel::Roles {
    BookmarkId = Qt::UserRole + 1,
    BookmarkName,
    BookmarkGroup,
    BookmarkPoint,
    BookmarkCrs,
    BookmarkUser,
    BookmarkSelected,
    BookmarkSection
};

---

Public Properties Documentation

property hideProjectBookmarks [1/2]

When TRUE, project bookmarks are hidden so only user bookmarks (those created in QField) are listed.

bool BookmarkModel::hideProjectBookmarks;

---

property mapSettings [1/2]

QgsQuickMapSettings * BookmarkModel::mapSettings;

---

property selectedCount [1/2]

Number of currently selected bookmarks.

qsizetype BookmarkModel::selectedCount;

---

Public Signals Documentation

signal hideProjectBookmarksChanged

void BookmarkModel::hideProjectBookmarksChanged;

---

signal mapSettingsChanged

void BookmarkModel::mapSettingsChanged;

---

signal requestJumpToPoint

void BookmarkModel::requestJumpToPoint;

---

signal selectedCountChanged

void BookmarkModel::selectedCountChanged;

---

Public Functions Documentation

function BookmarkModel

explicit BookmarkModel::BookmarkModel (
    QgsBookmarkManager * manager,
    QgsBookmarkManager * projectManager=nullptr,
    QObject * parent=nullptr
) 

---

function addBookmarkAtPoint

Q_INVOKABLE QString BookmarkModel::addBookmarkAtPoint (
    QgsPoint point,
    const QString & name=QString(),
    const QString & group=QString()
) 

---

function clearSelection

Clears the current selection.

Q_INVOKABLE void BookmarkModel::clearSelection () 

---

function data

QVariant BookmarkModel::data (
    const QModelIndex & index,
    int role
) override const

---

function deleteSelected

Deletes all currently selected bookmarks, persisting once. Returns the number deleted.

Q_INVOKABLE int BookmarkModel::deleteSelected () 

---

function exportBookmarks

Exports user bookmarks to a temporary GeoPackage and sends it via the platform's native sharing. When selectedOnly is TRUE, only selected bookmarks are exported.

Q_INVOKABLE bool BookmarkModel::exportBookmarks (
    bool selectedOnly
) 

---

function getBookmarkCrs

Q_INVOKABLE QgsCoordinateReferenceSystem BookmarkModel::getBookmarkCrs (
    const QString & id
) 

---

function getBookmarkPoint

Q_INVOKABLE QgsPoint BookmarkModel::getBookmarkPoint (
    const QString & id
) 

---

function hideProjectBookmarks [2/2]

inline bool BookmarkModel::hideProjectBookmarks () const

---

function mapSettings [2/2]

inline QgsQuickMapSettings * BookmarkModel::mapSettings () const

---

function removeBookmark

Q_INVOKABLE void BookmarkModel::removeBookmark (
    const QString & id
) 

---

function roleNames

QHash< int, QByteArray > BookmarkModel::roleNames () override const

---

function selectedCount [2/2]

inline qsizetype BookmarkModel::selectedCount () const

---

function setExtentFromBookmark

Q_INVOKABLE void BookmarkModel::setExtentFromBookmark (
    const QModelIndex & index
) 

---

function setHideProjectBookmarks

void BookmarkModel::setHideProjectBookmarks (
    bool hideProjectBookmarks
) 

---

function setMapSettings

void BookmarkModel::setMapSettings (
    QgsQuickMapSettings * mapSettings
) 

---

function store

Q_INVOKABLE void BookmarkModel::store () 

---

function toggleSelected

Toggles the selection state of the bookmark identified by id .

Q_INVOKABLE void BookmarkModel::toggleSelected (
    const QString & id
) 

---

function updateBookmarkDetails

Q_INVOKABLE void BookmarkModel::updateBookmarkDetails (
    const QString & id,
    const QString & name,
    const QString & group
) 

---

Protected Functions Documentation

function filterAcceptsRow

bool BookmarkModel::filterAcceptsRow (
    int sourceRow,
    const QModelIndex & sourceParent
) override const

---

function lessThan

bool BookmarkModel::lessThan (
    const QModelIndex & sourceLeft,
    const QModelIndex & sourceRight
) override const

---

---

The documentation for this class was generated from the following file src/core/bookmarkmodel.h