QGIS API Documentation
3.0.2-Girona (307d082)
|
Stores metadata about one layout item class. More...
#include <qgslayoutitemregistry.h>
Public Member Functions | |
QgsLayoutItemAbstractMetadata (int type, const QString &visibleName) | |
Constructor for QgsLayoutItemAbstractMetadata with the specified class type and visibleName. More... | |
virtual | ~QgsLayoutItemAbstractMetadata ()=default |
virtual QgsLayoutItem * | createItem (QgsLayout *layout)=0 |
Creates a layout item of this class for a specified layout. More... | |
virtual void | resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Resolve paths in the item's properties (if there are any paths). More... | |
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... | |
Stores metadata about one layout item class.
A companion class, QgsLayoutItemAbstractGuiMetadata, handles the GUI behavior of QgsLayoutItems.
Definition at line 45 of file qgslayoutitemregistry.h.
|
inline |
Constructor for QgsLayoutItemAbstractMetadata with the specified class type and visibleName.
Definition at line 53 of file qgslayoutitemregistry.h.
|
virtualdefault |
|
pure virtual |
Creates a layout item of this class for a specified layout.
Implemented in QgsLayoutItemMetadata.
|
inlinevirtual |
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 in QgsLayoutItemMetadata.
Definition at line 82 of file qgslayoutitemregistry.h.
|
inline |
Returns the unique item type code for the layout item class.
Definition at line 63 of file qgslayoutitemregistry.h.
|
inline |
Returns a translated, user visible name for the layout item class.
Definition at line 68 of file qgslayoutitemregistry.h.