Class QfBookmarkModel

ClassList > QfBookmarkModel

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
	QfBookmarkModel (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 (int idx) Returns the center point of the bookmark at row idx transformed to the map canvas CRS, or an empty point on failure.
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 QfBookmarkModel::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 QfBookmarkModel::hideProjectBookmarks;

---

property mapSettings [1/2]

QgsQuickMapSettings * QfBookmarkModel::mapSettings;

---

property selectedCount [1/2]

Number of currently selected bookmarks.

qsizetype QfBookmarkModel::selectedCount;

---

Public Signals Documentation

signal hideProjectBookmarksChanged

void QfBookmarkModel::hideProjectBookmarksChanged;

---

signal mapSettingsChanged

void QfBookmarkModel::mapSettingsChanged;

---

signal requestJumpToPoint

void QfBookmarkModel::requestJumpToPoint;

---

signal selectedCountChanged

void QfBookmarkModel::selectedCountChanged;

---

Public Functions Documentation

function QfBookmarkModel

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

---

function addBookmarkAtPoint

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

---

function clearSelection

Clears the current selection.

Q_INVOKABLE void QfBookmarkModel::clearSelection () 

---

function data

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

---

function deleteSelected

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

Q_INVOKABLE int QfBookmarkModel::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 QfBookmarkModel::exportBookmarks (
    bool selectedOnly
) 

---

function getBookmarkCrs

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

---

function getBookmarkPoint [1/2]

Returns the center point of the bookmark at row idx transformed to the map canvas CRS, or an empty point on failure.

Q_INVOKABLE QgsPoint QfBookmarkModel::getBookmarkPoint (
    int idx
) 

---

function getBookmarkPoint [2/2]

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

---

function hideProjectBookmarks [2/2]

inline bool QfBookmarkModel::hideProjectBookmarks () const

---

function mapSettings [2/2]

inline QgsQuickMapSettings * QfBookmarkModel::mapSettings () const

---

function removeBookmark

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

---

function roleNames

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

---

function selectedCount [2/2]

inline qsizetype QfBookmarkModel::selectedCount () const

---

function setExtentFromBookmark

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

---

function setHideProjectBookmarks

void QfBookmarkModel::setHideProjectBookmarks (
    bool hideProjectBookmarks
) 

---

function setMapSettings

void QfBookmarkModel::setMapSettings (
    QgsQuickMapSettings * mapSettings
) 

---

function store

Q_INVOKABLE void QfBookmarkModel::store () 

---

function toggleSelected

Toggles the selection state of the bookmark identified by id .

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

---

function updateBookmarkDetails

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

---

Protected Functions Documentation

function filterAcceptsRow

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

---

function lessThan

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

---

---

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