QgsLayoutConfigObject class

An object for property widgets for layout items.

Contents

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

Constructors, destructors, conversion operators

QgsLayoutConfigObject(QWidget*parent SIP_TRANSFERTHIS, QgsLayoutObject* layoutObject)
Constructor for QgsLayoutConfigObject, linked with the specified layoutObject.

Public functions

auto coverageLayer() const -> QgsVectorLayer*
Returns the current layout context coverage layer (if set).
void initializeDataDefinedButton(QgsPropertyOverrideButton* button, QgsLayoutObject::DataDefinedProperty key)
Registers a data defined button, setting up its initial value, connections and description.
auto layoutAtlas() const -> QgsLayoutAtlas*
Returns the atlas for the layout, if available.
void setObject(QgsLayoutObject* object) SIP_SKIP
Links a new layout object to this QgsLayoutConfigObject.
void updateDataDefinedButton(QgsPropertyOverrideButton* button)
Updates a data defined button to reflect the item's current properties.

Function documentation

void QgsLayoutConfigObject::initializeDataDefinedButton(QgsPropertyOverrideButton* button, QgsLayoutObject::DataDefinedProperty key)

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

The corresponding property key must be specified.

void QgsLayoutConfigObject::setObject(QgsLayoutObject* object) SIP_SKIP

Links a new layout object to this QgsLayoutConfigObject.

The object must be the same type as the existing object.