An object for property widgets for layout items. More...

#include <qgslayoutitemwidget.h>

Inheritance diagram for QgsLayoutConfigObject:

Public Member Functions
	QgsLayoutConfigObject (QWidget parent SIP_TRANSFERTHIS, QgsLayoutObject layoutObject)
	Constructor for QgsLayoutConfigObject, linked with the specified layoutObject. More...

QgsVectorLayer *	coverageLayer () const
	Returns the current layout context coverage layer (if set). More...

void	initializeDataDefinedButton (QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty key)
	Registers a data defined button, setting up its initial value, connections and description. More...

QgsLayoutAtlas *	layoutAtlas () const
	Returns the atlas for the layout, if available. More...

void	setObject (QgsLayoutObject *object) SIP_SKIP
	Links a new layout object to this QgsLayoutConfigObject. More...

void	updateDataDefinedButton (QgsPropertyOverrideButton *button)
	Updates a data defined button to reflect the item's current properties. More...

Detailed Description

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

Since: QGIS 3.0

Definition at line 62 of file qgslayoutitemwidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutConfigObject()

QgsLayoutConfigObject::QgsLayoutConfigObject	(	QWidget *parent	SIP_TRANSFERTHIS,
		QgsLayoutObject *	layoutObject
	)

Constructor for QgsLayoutConfigObject, linked with the specified layoutObject.

Definition at line 36 of file qgslayoutitemwidget.cpp.

Member Function Documentation

◆ coverageLayer()

QgsVectorLayer * QgsLayoutConfigObject::coverageLayer ( ) const

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

Definition at line 171 of file qgslayoutitemwidget.cpp.

◆ initializeDataDefinedButton()

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.

Definition at line 104 of file qgslayoutitemwidget.cpp.

◆ layoutAtlas()

QgsLayoutAtlas * QgsLayoutConfigObject::layoutAtlas ( ) const

Returns the atlas for the layout, if available.

Definition at line 149 of file qgslayoutitemwidget.cpp.

◆ setObject()

void QgsLayoutConfigObject::setObject ( QgsLayoutObject * object )

Links a new layout object to this QgsLayoutConfigObject.

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

Note: Not available in Python bindings

Since: QGIS 3.4

Definition at line 166 of file qgslayoutitemwidget.cpp.

◆ updateDataDefinedButton()

void QgsLayoutConfigObject::updateDataDefinedButton ( QgsPropertyOverrideButton * button )

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

Definition at line 113 of file qgslayoutitemwidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.28.0+99sid/src/gui/layout/qgslayoutitemwidget.h
/build/qgis-3.28.0+99sid/src/gui/layout/qgslayoutitemwidget.cpp

Public Member Functions