QgsProjectDisplaySettings Class Reference

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:

Signals
void	bearingFormatChanged ()
	Emitted when the bearing format changes. More...

Public Member Functions
	QgsProjectDisplaySettings (QObject *parent=nullptr)
	Constructor for QgsProjectDisplaySettings with the specified parent object. More...
	~QgsProjectDisplaySettings () override
const QgsBearingNumericFormat *	bearingFormat () const
	Returns the project bearing's format, which controls how bearings associated with the project are displayed. More...
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads the settings's state from a DOM element. More...
void	reset ()
	Resets the settings to a default state. More...
void	setBearingFormat (QgsBearingNumericFormat *format)
	Sets the project bearing format, which controls how bearings associated with the project are displayed. More...
QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
	Returns a DOM element representing the settings. More...

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 36 of file qgsprojectdisplaysettings.h.

Constructor & Destructor Documentation

QgsProjectDisplaySettings()

QgsProjectDisplaySettings::QgsProjectDisplaySettings

(

QObject *

parent = nullptr

)

Constructor for QgsProjectDisplaySettings with the specified parent object.

Definition at line 25 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 48 of file qgsprojectdisplaysettings.cpp.

bearingFormatChanged

void QgsProjectDisplaySettings::bearingFormatChanged ( )

signal

Emitted when the bearing format changes.

See also

setBearingFormat()

bearingFormat()

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 53 of file qgsprojectdisplaysettings.cpp.

reset()

void QgsProjectDisplaySettings::reset

(

)

Resets the settings to a default state.

Definition at line 34 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 42 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 62 of file qgsprojectdisplaysettings.cpp.

---

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

• /build/qgis-3.18.1+99unstable/src/core/project/qgsprojectdisplaysettings.h
• /build/qgis-3.18.1+99unstable/src/core/project/qgsprojectdisplaysettings.cpp