Class: QgsProjectDisplaySettings

class qgis.core.QgsProjectDisplaySettings

Bases: PyQt5.QtCore.QObject

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

New in version 3.12.

QgsProjectDisplaySettings(parent: QObject = None) Constructor for QgsProjectDisplaySettings with the specified parent object.

Methods

bearingFormat

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

childEvent

connectNotify

customEvent

disconnectNotify

geographicCoordinateFormat

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

isSignalConnected

readXml

Reads the settings's state from a DOM element.

receivers

reset

Resets the settings to a default state.

sender

senderSignalIndex

setBearingFormat

Sets the project bearing format, which controls how bearings associated with the project are displayed.

setGeographicCoordinateFormat

Sets the project geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.

timerEvent

writeXml

Returns a DOM element representing the settings.

Signals

bearingFormatChanged

Emitted when the bearing format changes.

geographicCoordinateFormatChanged

Emitted when the geographic coordinate format changes.
bearingFormat(self) → QgsBearingNumericFormat

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

See also

setBearingFormat()

See also

bearingFormatChanged()

Return type

QgsBearingNumericFormat

bearingFormatChanged

Emitted when the bearing format changes.

See also

setBearingFormat()

See also

bearingFormat() [signal]

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
geographicCoordinateFormat(self) → QgsGeographicCoordinateNumericFormat

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

See also

setGeographicCoordinateFormat()

See also

geographicCoordinateFormatChanged()

Return type

QgsGeographicCoordinateNumericFormat

geographicCoordinateFormatChanged

Emitted when the geographic coordinate format changes.

See also

setGeographicCoordinateFormat()

See also

geographicCoordinateFormat() [signal]

isSignalConnected(self, QMetaMethod) → bool
readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool

Reads the settings’s state from a DOM element.

See also

writeXml()

Parameters
Return type

bool

receivers(self, PYQT_SIGNAL) → int
reset(self)

Resets the settings to a default state.

sender(self) → QObject
senderSignalIndex(self) → int
setBearingFormat(self, format: QgsBearingNumericFormat)

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()

See also

bearingFormatChanged()

Parameters

format (QgsBearingNumericFormat) –

setGeographicCoordinateFormat(self, format: QgsGeographicCoordinateNumericFormat)

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()

See also

geographicCoordinateFormatChanged()

New in version 3.26.

Parameters

format (QgsGeographicCoordinateNumericFormat) –

timerEvent(self, QTimerEvent)
writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Returns a DOM element representing the settings.

See also

readXml()

Parameters
Return type

QDomElement