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 specifiedparent
object.Methods
Returns the project bearing's format, which controls how bearings associated with the project are displayed.
Reads the settings's state from a DOM element.
Resets the settings to a default state.
Sets the project bearing
format
, which controls how bearings associated with the project are displayed.Returns a DOM element representing the settings.
Signals
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.
See also
See also
- Return type:
- 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
- Parameters:
element (QDomElement) –
context (QgsReadWriteContext) –
- 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
See also
- Parameters:
format (QgsBearingNumericFormat) –
- timerEvent(self, QTimerEvent)¶
- writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Returns a DOM element representing the settings.
See also
- Parameters:
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
QDomElement