QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Represents a spatial bookmark, with a name, CRS and extent. More...
#include <qgsbookmarkmanager.h>
Public Member Functions | |
QgsBookmark ()=default | |
Default constructor, creates an empty bookmark. | |
QgsReferencedRectangle | extent () const |
Returns the bookmark's spatial extent. | |
QString | group () const |
Returns the bookmark's group, which is a user-visible string identifying the bookmark's category. | |
QString | id () const |
Returns the bookmark's unique ID. | |
QString | name () const |
Returns the bookmark's name, which is a user-visible string identifying the bookmark. | |
bool | operator!= (const QgsBookmark &other) const |
bool | operator== (const QgsBookmark &other) const |
double | rotation () const |
Returns the bookmark's map rotation. | |
void | setExtent (const QgsReferencedRectangle &extent) |
Sets the bookmark's spatial extent. | |
void | setGroup (const QString &group) |
Sets the bookmark's group, which is a user-visible string identifying the bookmark's category. | |
void | setId (const QString &id) |
Sets the bookmark's unique id. | |
void | setName (const QString &name) |
Sets the bookmark's name, which is a user-visible string identifying the bookmark. | |
void | setRotation (double rotation) |
Sets the bookmark's spatial map rotation. | |
QDomElement | writeXml (QDomDocument &doc) const |
Returns a DOM element representing the bookmark's properties. | |
Static Public Member Functions | |
static QgsBookmark | fromXml (const QDomElement &element, const QDomDocument &doc) |
Creates a bookmark using the properties from a DOM element. | |
Represents a spatial bookmark, with a name, CRS and extent.
QgsBookmark objects are typically used alongside the QgsBookmarkManager class, which handles storage of a set of bookmarks.
Definition at line 37 of file qgsbookmarkmanager.h.
|
default |
Default constructor, creates an empty bookmark.
QgsReferencedRectangle QgsBookmark::extent | ( | ) | const |
Returns the bookmark's spatial extent.
Definition at line 100 of file qgsbookmarkmanager.cpp.
|
static |
Creates a bookmark using the properties from a DOM element.
Definition at line 40 of file qgsbookmarkmanager.cpp.
QString QgsBookmark::group | ( | ) | const |
Returns the bookmark's group, which is a user-visible string identifying the bookmark's category.
Definition at line 90 of file qgsbookmarkmanager.cpp.
QString QgsBookmark::id | ( | ) | const |
Returns the bookmark's unique ID.
Definition at line 30 of file qgsbookmarkmanager.cpp.
QString QgsBookmark::name | ( | ) | const |
Returns the bookmark's name, which is a user-visible string identifying the bookmark.
Definition at line 80 of file qgsbookmarkmanager.cpp.
bool QgsBookmark::operator!= | ( | const QgsBookmark & | other | ) | const |
Definition at line 75 of file qgsbookmarkmanager.cpp.
bool QgsBookmark::operator== | ( | const QgsBookmark & | other | ) | const |
Definition at line 66 of file qgsbookmarkmanager.cpp.
double QgsBookmark::rotation | ( | ) | const |
Returns the bookmark's map rotation.
Definition at line 110 of file qgsbookmarkmanager.cpp.
void QgsBookmark::setExtent | ( | const QgsReferencedRectangle & | extent | ) |
Sets the bookmark's spatial extent.
Definition at line 105 of file qgsbookmarkmanager.cpp.
void QgsBookmark::setGroup | ( | const QString & | group | ) |
Sets the bookmark's group, which is a user-visible string identifying the bookmark's category.
Definition at line 95 of file qgsbookmarkmanager.cpp.
void QgsBookmark::setId | ( | const QString & | id | ) |
void QgsBookmark::setName | ( | const QString & | name | ) |
Sets the bookmark's name, which is a user-visible string identifying the bookmark.
Definition at line 85 of file qgsbookmarkmanager.cpp.
void QgsBookmark::setRotation | ( | double | rotation | ) |
Sets the bookmark's spatial map rotation.
Definition at line 115 of file qgsbookmarkmanager.cpp.
QDomElement QgsBookmark::writeXml | ( | QDomDocument & | doc | ) | const |
Returns a DOM element representing the bookmark's properties.
Definition at line 54 of file qgsbookmarkmanager.cpp.