QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Stores metadata about one layout multiframe class. More...
#include <qgslayoutitemregistry.h>
Public Member Functions | |
QgsLayoutMultiFrameAbstractMetadata (int type, const QString &visibleName) | |
Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName. | |
virtual | ~QgsLayoutMultiFrameAbstractMetadata ()=default |
virtual QgsLayoutMultiFrame * | createMultiFrame (QgsLayout *layout)=0 |
Creates a layout multiframe of this class for a specified layout. | |
virtual QIcon | icon () const |
Returns an icon representing the layout multiframe type. | |
virtual void | resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Resolve paths in the item's properties (if there are any paths). | |
int | type () const |
Returns the unique item type code for the layout multiframe class. | |
QString | visibleName () const |
Returns a translated, user visible name for the layout multiframe class. | |
Stores metadata about one layout multiframe class.
A companion class, QgsLayoutMultiFrameAbstractGuiMetadata, handles the GUI behavior of QgsLayoutMultiFrames.
Definition at line 186 of file qgslayoutitemregistry.h.
|
inline |
Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName.
Definition at line 194 of file qgslayoutitemregistry.h.
|
virtualdefault |
|
pure virtual |
Creates a layout multiframe of this class for a specified layout.
Implemented in QgsLayoutMultiFrameMetadata.
|
inlinevirtual |
Returns an icon representing the layout multiframe type.
Definition at line 209 of file qgslayoutitemregistry.h.
|
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 QgsLayoutMultiFrameMetadata.
Definition at line 243 of file qgslayoutitemregistry.h.
|
inline |
Returns the unique item type code for the layout multiframe class.
Definition at line 204 of file qgslayoutitemregistry.h.
|
inline |
Returns a translated, user visible name for the layout multiframe class.
Definition at line 214 of file qgslayoutitemregistry.h.