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 fromQgsLayoutItemBaseWidget
(rather then directly working withQgsLayoutConfigObject
).QgsLayoutConfigObject(parent: QWidget, layoutObject:
QgsLayoutObject
) Constructor forQgsLayoutConfigObject
, linked with the specifiedlayoutObject
.Methods
Returns the current layout context coverage layer (if set).
Registers a data defined
button
, setting up its initial value, connections and description.Returns the atlas for the layout, if available
Updates a data defined button to reflect the item's current properties.
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- coverageLayer(self) QgsVectorLayer ¶
Returns the current layout context coverage layer (if set).
- Return type:
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- initializeDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsLayoutObject.DataDefinedProperty)¶
Registers a data defined
button
, setting up its initial value, connections and description. The corresponding propertykey
must be specified.- Parameters:
button (QgsPropertyOverrideButton) –
- isSignalConnected(self, QMetaMethod) bool ¶
- layoutAtlas(self) QgsLayoutAtlas ¶
Returns the atlas for the layout, if available
- Return type:
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, QTimerEvent)¶
- updateDataDefinedButton(self, button: QgsPropertyOverrideButton)¶
Updates a data defined button to reflect the item’s current properties.
- Parameters:
button (QgsPropertyOverrideButton) –