QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | Static Public Member Functions | List of all members
QgsBookmark Class Reference

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. More...
 
QgsReferencedRectangle extent () const
 Returns the bookmark's spatial extent. More...
 
QString group () const
 Returns the bookmark's group, which is a user-visible string identifying the bookmark's category. More...
 
QString id () const
 Returns the bookmark's unique ID. More...
 
QString name () const
 Returns the bookmark's name, which is a user-visible string identifying the bookmark. More...
 
bool operator!= (const QgsBookmark &other)
 
bool operator== (const QgsBookmark &other)
 
void setExtent (const QgsReferencedRectangle &extent)
 Sets the bookmark's spatial extent. More...
 
void setGroup (const QString &group)
 Sets the bookmark's group, which is a user-visible string identifying the bookmark's category. More...
 
void setId (const QString &id)
 Sets the bookmark's unique id. More...
 
void setName (const QString &name)
 Sets the bookmark's name, which is a user-visible string identifying the bookmark. More...
 
QDomElement writeXml (QDomDocument &doc) const
 Returns a DOM element representing the bookmark's properties. More...
 

Static Public Member Functions

static QgsBookmark fromXml (const QDomElement &element, const QDomDocument &doc)
 Creates a bookmark using the properties from a DOM element. More...
 

Detailed Description

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.

Since
QGIS 3.10

Definition at line 37 of file qgsbookmarkmanager.h.

Constructor & Destructor Documentation

◆ QgsBookmark()

QgsBookmark::QgsBookmark ( )
default

Default constructor, creates an empty bookmark.

Member Function Documentation

◆ extent()

QgsReferencedRectangle QgsBookmark::extent ( ) const

Returns the bookmark's spatial extent.

See also
setExtent()

Definition at line 92 of file qgsbookmarkmanager.cpp.

◆ fromXml()

QgsBookmark QgsBookmark::fromXml ( const QDomElement &  element,
const QDomDocument &  doc 
)
static

Creates a bookmark using the properties from a DOM element.

See also
writeXml()

Definition at line 38 of file qgsbookmarkmanager.cpp.

◆ group()

QString QgsBookmark::group ( ) const

Returns the bookmark's group, which is a user-visible string identifying the bookmark's category.

See also
setGroup()

Definition at line 82 of file qgsbookmarkmanager.cpp.

◆ id()

QString QgsBookmark::id ( ) const

Returns the bookmark's unique ID.

See also
setId()

Definition at line 28 of file qgsbookmarkmanager.cpp.

◆ name()

QString QgsBookmark::name ( ) const

Returns the bookmark's name, which is a user-visible string identifying the bookmark.

See also
setName()

Definition at line 72 of file qgsbookmarkmanager.cpp.

◆ operator!=()

bool QgsBookmark::operator!= ( const QgsBookmark other)

Definition at line 67 of file qgsbookmarkmanager.cpp.

◆ operator==()

bool QgsBookmark::operator== ( const QgsBookmark other)

Definition at line 62 of file qgsbookmarkmanager.cpp.

◆ setExtent()

void QgsBookmark::setExtent ( const QgsReferencedRectangle extent)

Sets the bookmark's spatial extent.

See also
extent()

Definition at line 97 of file qgsbookmarkmanager.cpp.

◆ setGroup()

void QgsBookmark::setGroup ( const QString &  group)

Sets the bookmark's group, which is a user-visible string identifying the bookmark's category.

See also
group()

Definition at line 87 of file qgsbookmarkmanager.cpp.

◆ setId()

void QgsBookmark::setId ( const QString &  id)

Sets the bookmark's unique id.

See also
id()

Definition at line 33 of file qgsbookmarkmanager.cpp.

◆ setName()

void QgsBookmark::setName ( const QString &  name)

Sets the bookmark's name, which is a user-visible string identifying the bookmark.

See also
name()

Definition at line 77 of file qgsbookmarkmanager.cpp.

◆ writeXml()

QDomElement QgsBookmark::writeXml ( QDomDocument &  doc) const

Returns a DOM element representing the bookmark's properties.

See also
fromXml()

Definition at line 51 of file qgsbookmarkmanager.cpp.


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