Subgroup: Layout

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

New in version 3.0: Methods

`blockSignals`
`childEvent`
`children`
`connectNotify`
`coverageLayer`	Returns the current layout context coverage layer (if set).
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`inherits`
`initializeDataDefinedButton`	Registers a data defined `button`, setting up its initial value, connections and description.
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`layoutAtlas`	Returns the atlas for the layout, if available
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`
`updateDataDefinedButton`	Updates a data defined button to reflect the item’s current properties.

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

childEvent()¶

connectNotify()¶

coverageLayer(self) → QgsVectorLayer¶: Returns the current layout context coverage layer (if set).

customEvent()¶

disconnectNotify()¶

initializeDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsLayoutObject.DataDefinedProperty)¶: Registers a data defined button, setting up its initial value, connections and description. The corresponding property key must be specified.

isSignalConnected()¶

layoutAtlas(self) → QgsLayoutAtlas¶: Returns the atlas for the layout, if available

receivers()¶

sender()¶

senderSignalIndex()¶

timerEvent()¶

updateDataDefinedButton(self, button: QgsPropertyOverrideButton)¶: Updates a data defined button to reflect the item’s current properties.