QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgslayoutitemregistry.h>
Public Member Functions | |
QgsLayoutItemMetadata (int type, const QString &visibleName, const QString &visiblePluralName, const QgsLayoutItemCreateFunc &pfCreate, const QgsLayoutItemPathResolverFunc &pfPathResolver=nullptr) | |
Constructor for QgsLayoutItemMetadata with the specified class type and visibleName, and function pointers for the various item creation functions. More... | |
QgsLayoutItemCreateFunc | createFunction () const |
Returns the classes' item creation function. More... | |
QgsLayoutItem * | createItem (QgsLayout *layout) override |
Creates a layout item of this class for a specified layout. More... | |
QgsLayoutItemPathResolverFunc | pathResolverFunction () const |
Returns the classes' path resolver function. More... | |
void | resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) override |
Resolve paths in the item's properties (if there are any paths). More... | |
![]() | |
QgsLayoutItemAbstractMetadata (int type, const QString &visibleName, const QString &visiblePluralName=QString()) | |
Constructor for QgsLayoutItemAbstractMetadata with the specified class type and visibleName. More... | |
virtual | ~QgsLayoutItemAbstractMetadata ()=default |
int | type () const |
Returns the unique item type code for the layout item class. More... | |
QString | visibleName () const |
Returns a translated, user visible name for the layout item class. More... | |
QString | visiblePluralName () const |
Returns a translated, user visible name for plurals of the layout item class (e.g. More... | |
Protected Attributes | |
QgsLayoutItemCreateFunc | mCreateFunc = nullptr |
QgsLayoutItemPathResolverFunc | mPathResolverFunc = nullptr |
Convenience metadata class that uses static functions to create layout items and their configuration widgets.
Definition at line 120 of file qgslayoutitemregistry.h.
|
inline |
Constructor for QgsLayoutItemMetadata with the specified class type and visibleName, and function pointers for the various item creation functions.
The visiblePluralName argument is used to specify a plural variant of the item type.
Definition at line 130 of file qgslayoutitemregistry.h.
|
inline |
Returns the classes' item creation function.
Definition at line 141 of file qgslayoutitemregistry.h.
|
inlineoverridevirtual |
Creates a layout item of this class for a specified layout.
Implements QgsLayoutItemAbstractMetadata.
Definition at line 148 of file qgslayoutitemregistry.h.
|
inline |
Returns the classes' path resolver function.
Definition at line 146 of file qgslayoutitemregistry.h.
|
inlineoverridevirtual |
Resolve paths in the item's properties (if there are any paths).
When saving is true
, paths are converted from absolute to relative, when saving is false
, paths are converted from relative to absolute. This ensures that paths in project files can be relative, but in item instances the paths are always absolute.
Reimplemented from QgsLayoutItemAbstractMetadata.
Definition at line 150 of file qgslayoutitemregistry.h.
|
protected |
Definition at line 157 of file qgslayoutitemregistry.h.
|
protected |
Definition at line 158 of file qgslayoutitemregistry.h.