Class: QgsLayoutConfigObject

class qgis.gui.QgsLayoutConfigObject

Bases: PyQt5.QtCore.QObject

An object for property widgets for layout items. All layout config type widgets should contain this object.

If you are creating a new QgsLayoutItem configuration widget, you should instead inherit from QgsLayoutItemBaseWidget (rather then directly working with QgsLayoutConfigObject).

QgsLayoutConfigObject(parent: Optional[QWidget], layoutObject: Optional[QgsLayoutObject]) Constructor for QgsLayoutConfigObject, linked with the specified layoutObject.

Methods

childEvent

connectNotify

coverageLayer

Returns the current layout context coverage layer (if set).

customEvent

disconnectNotify

initializeDataDefinedButton

Registers a data defined button, setting up its initial value, connections and description.

isSignalConnected

layoutAtlas

Returns the atlas for the layout, if available

receivers

sender

senderSignalIndex

timerEvent

updateDataDefinedButton

Updates a data defined button to reflect the item's current properties.
childEvent(self, a0: QChildEvent | None)
connectNotify(self, signal: QMetaMethod)
coverageLayer(self) → QgsVectorLayer | None

Returns the current layout context coverage layer (if set).

Return type:

Optional[QgsVectorLayer]

customEvent(self, a0: QEvent | None)
disconnectNotify(self, signal: QMetaMethod)
initializeDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsLayoutObject.DataDefinedProperty)

Registers a data defined button, setting up its initial value, connections and description. The corresponding property key must be specified.

Parameters:
isSignalConnected(self, signal: QMetaMethod) → bool
layoutAtlas(self) → QgsLayoutAtlas | None

Returns the atlas for the layout, if available

Return type:

Optional[QgsLayoutAtlas]

receivers(self, signal: PYQT_SIGNAL) → int
sender(self) → QObject | None
senderSignalIndex(self) → int
timerEvent(self, a0: QTimerEvent | None)
updateDataDefinedButton(self, button: QgsPropertyOverrideButton | None)

Updates a data defined button to reflect the item’s current properties.

Parameters:

button (Optional[QgsPropertyOverrideButton])