Contains settings and properties relating to how a QgsProject should display values such as map coordinates and bearings. More...

#include <qgsprojectdisplaysettings.h>

Inheritance diagram for QgsProjectDisplaySettings:

[legend]

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

Detailed Description

Contains settings and properties relating to how a QgsProject should display values such as map coordinates and bearings.

Since: QGIS 3.12

Definition at line 40 of file qgsprojectdisplaysettings.h.

Constructor & Destructor Documentation

◆ QgsProjectDisplaySettings()

QgsProjectDisplaySettings::QgsProjectDisplaySettings ( QObject * parent = nullptr )

Constructor for QgsProjectDisplaySettings with the specified parent object.

Definition at line 27 of file qgsprojectdisplaysettings.cpp.

◆ ~QgsProjectDisplaySettings()

QgsProjectDisplaySettings::~QgsProjectDisplaySettings ( )

overridedefault

Member Function Documentation

◆ bearingFormat()

const QgsBearingNumericFormat * QgsProjectDisplaySettings::bearingFormat ( ) const

Returns the project bearing's format, which controls how bearings associated with the project are displayed.

See also: setBearingFormat(); bearingFormatChanged()

Definition at line 67 of file qgsprojectdisplaysettings.cpp.

◆ bearingFormatChanged

void QgsProjectDisplaySettings::bearingFormatChanged ( )

signal

Emitted when the bearing format changes.

See also: setBearingFormat(); bearingFormat()

◆ coordinateAxisOrder()

Qgis::CoordinateOrder QgsProjectDisplaySettings::coordinateAxisOrder ( ) const

inline

Returns default coordinate axis order to use when displaying coordinates for the project.

See also: setCoordinateAxisOrder(); coordinateAxisOrderChanged()

Since: QGIS 3.28

Definition at line 121 of file qgsprojectdisplaysettings.h.

◆ coordinateAxisOrderChanged

void QgsProjectDisplaySettings::coordinateAxisOrderChanged ( )

signal

Emitted when the default coordinate axis order changes.

See also: setCoordinateAxisOrder(); coordinateAxisOrder()

Since: QGIS 3.28

◆ coordinateCrs()

QgsCoordinateReferenceSystem QgsProjectDisplaySettings::coordinateCrs ( ) const

inline

Returns the coordinate display CRS used derived from the coordinate type.

See also: coordinateType()

Note: if not parented to a project object, an invalid CRS will be returned.

Since: QGIS 3.28

Definition at line 151 of file qgsprojectdisplaysettings.h.

◆ coordinateCrsChanged

void QgsProjectDisplaySettings::coordinateCrsChanged ( )

signal

Emitted when the coordinate CRS changes.

See also: coordinateCrs(); coordinateType()

Since: QGIS 3.28

◆ coordinateCustomCrs()

QgsCoordinateReferenceSystem QgsProjectDisplaySettings::coordinateCustomCrs ( ) const

inline

Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.

See also: setCoordinateCustomCrs()

Since: QGIS 3.28

Definition at line 136 of file qgsprojectdisplaysettings.h.

◆ coordinateCustomCrsChanged

void QgsProjectDisplaySettings::coordinateCustomCrsChanged ( )

signal

Emitted when the coordinate custom CRS changes.

See also: setCoordinateCustomCrs(); coordinateCustomCrs()

Since: QGIS 3.28

◆ coordinateType()

Qgis::CoordinateDisplayType QgsProjectDisplaySettings::coordinateType ( ) const

inline

Returns default coordinate type for the project.

See also: setCoordinateType()

Since: QGIS 3.28

Definition at line 106 of file qgsprojectdisplaysettings.h.

◆ coordinateTypeChanged

void QgsProjectDisplaySettings::coordinateTypeChanged ( )

signal

Emitted when the default coordinate format changes.

See also: setCoordinateType(); coordinateType()

Since: QGIS 3.28

◆ geographicCoordinateFormat()

const QgsGeographicCoordinateNumericFormat * QgsProjectDisplaySettings::geographicCoordinateFormat ( ) const

Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.

See also: setGeographicCoordinateFormat(); geographicCoordinateFormatChanged()

Definition at line 78 of file qgsprojectdisplaysettings.cpp.

◆ geographicCoordinateFormatChanged

void QgsProjectDisplaySettings::geographicCoordinateFormatChanged ( )

signal

Emitted when the geographic coordinate format changes.

See also: setGeographicCoordinateFormat(); geographicCoordinateFormat()

◆ readXml()

bool QgsProjectDisplaySettings::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context
	)

Reads the settings's state from a DOM element.

See also: writeXml()

Definition at line 145 of file qgsprojectdisplaysettings.cpp.

◆ reset()

void QgsProjectDisplaySettings::reset ( )

Resets the settings to a default state.

Definition at line 40 of file qgsprojectdisplaysettings.cpp.

◆ setBearingFormat()

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.

See also: bearingFormat(); bearingFormatChanged()

Definition at line 61 of file qgsprojectdisplaysettings.cpp.

◆ setCoordinateAxisOrder()

void QgsProjectDisplaySettings::setCoordinateAxisOrder ( Qgis::CoordinateOrder order )

Sets the default coordinate axis order to use when displaying coordinates for the project.

See also: coordinateAxisOrder(); coordinateAxisOrderChanged()

Since: QGIS 3.28

Definition at line 94 of file qgsprojectdisplaysettings.cpp.

◆ setCoordinateCustomCrs()

void QgsProjectDisplaySettings::setCoordinateCustomCrs ( const QgsCoordinateReferenceSystem & crs )

Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.

See also: setCoordinateCustomCrs()

Since: QGIS 3.28

Definition at line 103 of file qgsprojectdisplaysettings.cpp.

◆ setCoordinateType()

void QgsProjectDisplaySettings::setCoordinateType ( Qgis::CoordinateDisplayType type )

Sets the default coordinate type for the project.

See also: coordinateType()

Since: QGIS 3.28

Definition at line 83 of file qgsprojectdisplaysettings.cpp.

◆ setGeographicCoordinateFormat()

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.

See also: geographicCoordinateFormat(); geographicCoordinateFormatChanged()

Since: QGIS 3.26

Definition at line 72 of file qgsprojectdisplaysettings.cpp.

◆ writeXml()

QDomElement QgsProjectDisplaySettings::writeXml	(	QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)		const

Returns a DOM element representing the settings.

See also: readXml()

Definition at line 232 of file qgsprojectdisplaysettings.cpp.

Property Documentation

◆ coordinateAxisOrder

Qgis::CoordinateOrder QgsProjectDisplaySettings::coordinateAxisOrder

readwrite

Definition at line 47 of file qgsprojectdisplaysettings.h.

◆ coordinateCrs

QgsCoordinateReferenceSystem QgsProjectDisplaySettings::coordinateCrs

read

Definition at line 49 of file qgsprojectdisplaysettings.h.

◆ coordinateCustomCrs

QgsCoordinateReferenceSystem QgsProjectDisplaySettings::coordinateCustomCrs

readwrite

Definition at line 48 of file qgsprojectdisplaysettings.h.

◆ coordinateType

Qgis::CoordinateDisplayType QgsProjectDisplaySettings::coordinateType

readwrite

Definition at line 46 of file qgsprojectdisplaysettings.h.

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

/build/qgis-3.34.0+99sid/src/core/project/qgsprojectdisplaysettings.h
/build/qgis-3.34.0+99sid/src/core/project/qgsprojectdisplaysettings.cpp

Signals

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ QgsProjectDisplaySettings()

◆ ~QgsProjectDisplaySettings()

Member Function Documentation

◆ bearingFormat()

◆ bearingFormatChanged

◆ coordinateAxisOrder()

◆ coordinateAxisOrderChanged

◆ coordinateCrs()

◆ coordinateCrsChanged

◆ coordinateCustomCrs()

◆ coordinateCustomCrsChanged

◆ coordinateType()

◆ coordinateTypeChanged

◆ geographicCoordinateFormat()

◆ geographicCoordinateFormatChanged

◆ readXml()

◆ reset()

◆ setBearingFormat()

◆ setCoordinateAxisOrder()

◆ setCoordinateCustomCrs()

◆ setCoordinateType()

◆ setGeographicCoordinateFormat()

◆ writeXml()

Property Documentation

◆ coordinateAxisOrder

◆ coordinateCrs

◆ coordinateCustomCrs

◆ coordinateType