QgsBookmarkManagerModel Class Reference

Implements a model for the contents of QgsBookmarkManager objects. More...

#include <qgsbookmarkmodel.h>

Inheritance diagram for QgsBookmarkManagerModel:

Public Types
enum	Columns {   ColumnName , ColumnGroup , ColumnXMin , ColumnYMin ,   ColumnXMax , ColumnYMax , ColumnRotation , ColumnCrs ,   ColumnStore }
	Model columns. More...
enum class	CustomRole : int {   Extent = Qt::UserRole , Name , Id , Group ,   Rotation }
	Custom model roles. More...

Public Member Functions
	QgsBookmarkManagerModel (QgsBookmarkManager *manager, QgsBookmarkManager *projectManager=nullptr, QObject *parent=nullptr)
	Constructor for QgsBookmarkManagerModel, associated with a main manager (usually the application bookmark manager, accessed via QgsApplication::bookmarkManager()) and a secondary projectManager (a project based bookmark manager). More...
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

Detailed Description

Implements a model for the contents of QgsBookmarkManager objects.

QgsBookmarkModel provides a Qt table model for displaying and manipulating the bookmarks managed by a QgsBookmarkManager object. The model requires both a main manager (usually the application bookmark manager, accessed via QgsApplication::bookmarkManager()) and a project-based manager. The resultant model data is a merge of the bookmarks stored in both managers.

Since

QGIS 3.10

Definition at line 41 of file qgsbookmarkmodel.h.

Member Enumeration Documentation

Columns

enum QgsBookmarkManagerModel::Columns

Model columns.

Enumerator
ColumnName	Name column.
ColumnGroup	Group column.
ColumnXMin	Extent x-minimum.
ColumnYMin	Extent y-minimum.
ColumnXMax	Extent x-maximum.
ColumnYMax	Extent y-maximum.
ColumnRotation	Rotation of the map.
ColumnCrs	CRS of extent.
ColumnStore	Manager storing the bookmark (true if stored in project bookmark manager)

Definition at line 67 of file qgsbookmarkmodel.h.

CustomRole

enum class QgsBookmarkManagerModel::CustomRole : int

strong

Custom model roles.

Note

Prior to QGIS 3.36 this was available as QgsBookmarkManagerModel::CustomRoles

Since

QGIS 3.36

Enumerator
Extent	Bookmark extent as a QgsReferencedRectangle.
Name	Bookmark name.
Id	Bookmark ID.
Group	Bookmark group.
Rotation	Bookmark map rotation.

Definition at line 55 of file qgsbookmarkmodel.h.

Constructor & Destructor Documentation

QgsBookmarkManagerModel()

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

Constructor for QgsBookmarkManagerModel, associated with a main manager (usually the application bookmark manager, accessed via QgsApplication::bookmarkManager()) and a secondary projectManager (a project based bookmark manager).

Definition at line 22 of file qgsbookmarkmodel.cpp.

Member Function Documentation

columnCount()

int QgsBookmarkManagerModel::columnCount ( const QModelIndex &  parent = QModelIndex() ) const

override

Definition at line 42 of file qgsbookmarkmodel.cpp.

data()

QVariant QgsBookmarkManagerModel::data ( const QModelIndex &  index, int  role = Qt::DisplayRole  ) const

override

Definition at line 47 of file qgsbookmarkmodel.cpp.

flags()

Qt::ItemFlags QgsBookmarkManagerModel::flags ( const QModelIndex &  index ) const

override

Definition at line 112 of file qgsbookmarkmodel.cpp.

headerData()

QVariant QgsBookmarkManagerModel::headerData ( int  section, Qt::Orientation  orientation, int  role = Qt::DisplayRole  ) const

override

Definition at line 254 of file qgsbookmarkmodel.cpp.

insertRows()

bool QgsBookmarkManagerModel::insertRows ( int  row, int  count, const QModelIndex &  parent = QModelIndex()  )

override

Definition at line 225 of file qgsbookmarkmodel.cpp.

removeRows()

bool QgsBookmarkManagerModel::removeRows ( int  row, int  count, const QModelIndex &  parent = QModelIndex()  )

override

Definition at line 240 of file qgsbookmarkmodel.cpp.

rowCount()

int QgsBookmarkManagerModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

override

Definition at line 37 of file qgsbookmarkmodel.cpp.

setData()

bool QgsBookmarkManagerModel::setData ( const QModelIndex &  index, const QVariant &  value, int  role = Qt::EditRole  )

override

Definition at line 131 of file qgsbookmarkmodel.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/qgsbookmarkmodel.h
• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/qgsbookmarkmodel.cpp