QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
|
Contains settings and properties relating to how a QgsProject should be displayed inside map canvas, e.g. More...
#include <qgsprojectviewsettings.h>
Signals | |
void | mapScalesChanged () |
Emitted when the list of custom project map scales changes. | |
void | presetFullExtentChanged () |
Emitted whenever the presetFullExtent() is changed. | |
Public Member Functions | |
QgsProjectViewSettings (QgsProject *project=nullptr) | |
Constructor for QgsProjectViewSettings for the specified project. | |
double | defaultRotation () const |
Returns the default map rotation (in clockwise degrees) for maps in the project. | |
QgsReferencedRectangle | defaultViewExtent () const |
Returns the default view extent, which should be used as the initial map extent when this project is opened. | |
QgsReferencedRectangle | fullExtent () const |
Returns the full extent of the project, which represents the maximal limits of the project. | |
QVector< double > | mapScales () const |
Returns the list of custom project map scales. | |
QgsReferencedRectangle | presetFullExtent () const |
Returns the project's preset full extent. | |
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) |
Reads the settings's state from a DOM element. | |
void | reset () |
Resets the settings to a default state. | |
void | setDefaultRotation (double rotation) |
Set the default rotation of maps in the project, in clockwise degrees. | |
void | setDefaultViewExtent (const QgsReferencedRectangle &extent) |
Sets the default view extent, which should be used as the initial map extent when this project is opened. | |
void | setMapScales (const QVector< double > &scales) |
Sets the list of custom project map scales. | |
void | setPresetFullExtent (const QgsReferencedRectangle &extent) |
Sets the project's preset full extent. | |
void | setUseProjectScales (bool enabled) |
Sets whether project mapScales() are enabled. | |
bool | useProjectScales () const |
Returns true if project mapScales() are enabled. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const |
Returns a DOM element representing the settings. | |
Contains settings and properties relating to how a QgsProject should be displayed inside map canvas, e.g.
map scales and default view extent for the project.
Definition at line 35 of file qgsprojectviewsettings.h.
QgsProjectViewSettings::QgsProjectViewSettings | ( | QgsProject * | project = nullptr | ) |
Constructor for QgsProjectViewSettings for the specified project.
Ownership is transferred to the project.
Definition at line 23 of file qgsprojectviewsettings.cpp.
double QgsProjectViewSettings::defaultRotation | ( | ) | const |
Returns the default map rotation (in clockwise degrees) for maps in the project.
Definition at line 134 of file qgsprojectviewsettings.cpp.
QgsReferencedRectangle QgsProjectViewSettings::defaultViewExtent | ( | ) | const |
Returns the default view extent, which should be used as the initial map extent when this project is opened.
Definition at line 49 of file qgsprojectviewsettings.cpp.
QgsReferencedRectangle QgsProjectViewSettings::fullExtent | ( | ) | const |
Returns the full extent of the project, which represents the maximal limits of the project.
The returned extent will be in the project's CRS.
If the presetFullExtent() is non null, this will be returned as the full extent. Otherwise the full extent will be calculated based on the extent of all layers in the project.
Definition at line 73 of file qgsprojectviewsettings.cpp.
QVector< double > QgsProjectViewSettings::mapScales | ( | ) | const |
Returns the list of custom project map scales.
The scales list consists of a list of scale denominator values, e.g. 1000 for a 1:1000 scale.
Definition at line 115 of file qgsprojectviewsettings.cpp.
|
signal |
Emitted when the list of custom project map scales changes.
QgsReferencedRectangle QgsProjectViewSettings::presetFullExtent | ( | ) | const |
Returns the project's preset full extent.
This extent represents the maximal limits of the project. The full extent defaults to a null rectangle, which indicates that the maximal extent should be calculated based on the layers in the project.
Definition at line 59 of file qgsprojectviewsettings.cpp.
|
signal |
Emitted whenever the presetFullExtent() is changed.
bool QgsProjectViewSettings::readXml | ( | const QDomElement & | element, |
const QgsReadWriteContext & | context | ||
) |
Reads the settings's state from a DOM element.
Definition at line 144 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::reset | ( | ) |
Resets the settings to a default state.
Definition at line 30 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::setDefaultRotation | ( | double | rotation | ) |
Set the default rotation of maps in the project, in clockwise degrees.
Definition at line 139 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::setDefaultViewExtent | ( | const QgsReferencedRectangle & | extent | ) |
Sets the default view extent, which should be used as the initial map extent when this project is opened.
Definition at line 54 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::setMapScales | ( | const QVector< double > & | scales | ) |
Sets the list of custom project map scales.
The scales list consists of a list of scale denominator values, e.g. 1000 for a 1:1000 scale.
Definition at line 101 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::setPresetFullExtent | ( | const QgsReferencedRectangle & | extent | ) |
Sets the project's preset full extent.
This extent represents the maximal limits of the project. Setting the full extent to a null rectangle indicates that the maximal extent should be calculated based on the layers in the project.
Definition at line 64 of file qgsprojectviewsettings.cpp.
void QgsProjectViewSettings::setUseProjectScales | ( | bool | enabled | ) |
Sets whether project mapScales() are enabled.
When project map scales are enabled these scales will replace the default QGIS map scales list while working with this project.
Definition at line 120 of file qgsprojectviewsettings.cpp.
bool QgsProjectViewSettings::useProjectScales | ( | ) | const |
Returns true
if project mapScales() are enabled.
When project map scales are enabled these scales will replace the default QGIS map scales list while working with this project.
Definition at line 129 of file qgsprojectviewsettings.cpp.
QDomElement QgsProjectViewSettings::writeXml | ( | QDomDocument & | doc, |
const QgsReadWriteContext & | context | ||
) | const |
Returns a DOM element representing the settings.
Definition at line 204 of file qgsprojectviewsettings.cpp.