QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Contains settings and properties relating to how a QgsProject should display values such as map coordinates and bearings. More...
#include <qgsprojectdisplaysettings.h>
Signals | |
void | bearingFormatChanged () |
Emitted when the bearing format changes. | |
void | coordinateAxisOrderChanged () |
Emitted when the default coordinate axis order changes. | |
void | coordinateCrsChanged () |
Emitted when the coordinate CRS changes. | |
void | coordinateCustomCrsChanged () |
Emitted when the coordinate custom CRS changes. | |
void | coordinateTypeChanged () |
Emitted when the default coordinate format changes. | |
void | geographicCoordinateFormatChanged () |
Emitted when the geographic coordinate format changes. | |
Public Member Functions | |
QgsProjectDisplaySettings (QObject *parent=nullptr) | |
Constructor for QgsProjectDisplaySettings with the specified parent object. | |
~QgsProjectDisplaySettings () override | |
const QgsBearingNumericFormat * | bearingFormat () const |
Returns the project bearing's format, which controls how bearings associated with the project are displayed. | |
Qgis::CoordinateOrder | coordinateAxisOrder () const |
Returns default coordinate axis order to use when displaying coordinates for the project. | |
QgsCoordinateReferenceSystem | coordinateCrs () const |
Returns the coordinate display CRS used derived from the coordinate type. | |
QgsCoordinateReferenceSystem | coordinateCustomCrs () const |
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs. | |
Qgis::CoordinateDisplayType | coordinateType () const |
Returns default coordinate type for the project. | |
const QgsGeographicCoordinateNumericFormat * | geographicCoordinateFormat () const |
Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed. | |
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 | setBearingFormat (QgsBearingNumericFormat *format) |
Sets the project bearing format, which controls how bearings associated with the project are displayed. | |
void | setCoordinateAxisOrder (Qgis::CoordinateOrder order) |
Sets the default coordinate axis order to use when displaying coordinates for the project. | |
void | setCoordinateCustomCrs (const QgsCoordinateReferenceSystem &crs) |
Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs. | |
void | setCoordinateType (Qgis::CoordinateDisplayType type) |
Sets the default coordinate type for the project. | |
void | setGeographicCoordinateFormat (QgsGeographicCoordinateNumericFormat *format) |
Sets the project geographic coordinate format, which controls how geographic coordinates associated with the project are displayed. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const |
Returns a DOM element representing the settings. | |
Properties | |
Qgis::CoordinateOrder | coordinateAxisOrder |
QgsCoordinateReferenceSystem | coordinateCrs |
QgsCoordinateReferenceSystem | coordinateCustomCrs |
Qgis::CoordinateDisplayType | coordinateType |
Contains settings and properties relating to how a QgsProject should display values such as map coordinates and bearings.
Definition at line 40 of file qgsprojectdisplaysettings.h.
QgsProjectDisplaySettings::QgsProjectDisplaySettings | ( | QObject * | parent = nullptr | ) |
Constructor for QgsProjectDisplaySettings with the specified parent object.
Definition at line 27 of file qgsprojectdisplaysettings.cpp.
|
overridedefault |
const QgsBearingNumericFormat * QgsProjectDisplaySettings::bearingFormat | ( | ) | const |
Returns the project bearing's format, which controls how bearings associated with the project are displayed.
Definition at line 67 of file qgsprojectdisplaysettings.cpp.
|
signal |
Emitted when the bearing format changes.
|
inline |
Returns default coordinate axis order to use when displaying coordinates for the project.
Definition at line 121 of file qgsprojectdisplaysettings.h.
|
signal |
Emitted when the default coordinate axis order changes.
|
inline |
Returns the coordinate display CRS used derived from the coordinate type.
Definition at line 151 of file qgsprojectdisplaysettings.h.
|
signal |
|
inline |
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Definition at line 136 of file qgsprojectdisplaysettings.h.
|
signal |
Emitted when the coordinate custom CRS changes.
|
inline |
Returns default coordinate type for the project.
Definition at line 106 of file qgsprojectdisplaysettings.h.
|
signal |
Emitted when the default coordinate format changes.
const QgsGeographicCoordinateNumericFormat * QgsProjectDisplaySettings::geographicCoordinateFormat | ( | ) | const |
Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.
Definition at line 78 of file qgsprojectdisplaysettings.cpp.
|
signal |
Emitted when the geographic coordinate format changes.
bool QgsProjectDisplaySettings::readXml | ( | const QDomElement & | element, |
const QgsReadWriteContext & | context | ||
) |
Reads the settings's state from a DOM element.
Definition at line 145 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::reset | ( | ) |
Resets the settings to a default state.
Definition at line 40 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::setBearingFormat | ( | QgsBearingNumericFormat * | format | ) |
Sets the project bearing format, which controls how bearings associated with the project are displayed.
Ownership of format is transferred to the settings.
Definition at line 61 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::setCoordinateAxisOrder | ( | Qgis::CoordinateOrder | order | ) |
Sets the default coordinate axis order to use when displaying coordinates for the project.
Definition at line 94 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::setCoordinateCustomCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Definition at line 103 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::setCoordinateType | ( | Qgis::CoordinateDisplayType | type | ) |
Sets the default coordinate type for the project.
Definition at line 83 of file qgsprojectdisplaysettings.cpp.
void QgsProjectDisplaySettings::setGeographicCoordinateFormat | ( | QgsGeographicCoordinateNumericFormat * | format | ) |
Sets the project geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.
Ownership of format is transferred to the settings.
Definition at line 72 of file qgsprojectdisplaysettings.cpp.
QDomElement QgsProjectDisplaySettings::writeXml | ( | QDomDocument & | doc, |
const QgsReadWriteContext & | context | ||
) | const |
Returns a DOM element representing the settings.
Definition at line 232 of file qgsprojectdisplaysettings.cpp.
|
readwrite |
Definition at line 47 of file qgsprojectdisplaysettings.h.
|
read |
Definition at line 49 of file qgsprojectdisplaysettings.h.
|
readwrite |
Definition at line 48 of file qgsprojectdisplaysettings.h.
|
readwrite |
Definition at line 46 of file qgsprojectdisplaysettings.h.