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

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.

timerEvent

writeXml

Returns a DOM element representing the settings.

Signals

bearingFormatChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

bearingFormat(self) QgsBearingNumericFormat

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

Return type:

QgsBearingNumericFormat

bearingFormatChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
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()

Parameters:

format (QgsBearingNumericFormat) –

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

Returns a DOM element representing the settings.

See also

readXml()

Parameters:
Return type:

QDomElement