QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
An object for property widgets for layout items. More...
#include <qgslayoutitemwidget.h>
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... | |
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).
Definition at line 62 of file qgslayoutitemwidget.h.
QgsLayoutConfigObject::QgsLayoutConfigObject | ( | QWidget *parent | SIP_TRANSFERTHIS, |
QgsLayoutObject * | layoutObject | ||
) |
Constructor for QgsLayoutConfigObject, linked with the specified layoutObject.
Definition at line 35 of file qgslayoutitemwidget.cpp.
QgsVectorLayer * QgsLayoutConfigObject::coverageLayer | ( | ) | const |
Returns the current layout context coverage layer (if set).
Definition at line 132 of file qgslayoutitemwidget.cpp.
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 85 of file qgslayoutitemwidget.cpp.
QgsLayoutAtlas * QgsLayoutConfigObject::layoutAtlas | ( | ) | const |
Returns the atlas for the layout, if available.
Definition at line 110 of file qgslayoutitemwidget.cpp.
void QgsLayoutConfigObject::setObject | ( | QgsLayoutObject * | object | ) |
Links a new layout object to this QgsLayoutConfigObject.
The object must be the same type as the existing object.
Definition at line 127 of file qgslayoutitemwidget.cpp.
void QgsLayoutConfigObject::updateDataDefinedButton | ( | QgsPropertyOverrideButton * | button | ) |
Updates a data defined button to reflect the item's current properties.
Definition at line 94 of file qgslayoutitemwidget.cpp.