QgsLayoutMultiFrameAbstractMetadata class

Stores metadata about one layout multiframe class.

Reference

A companion class, QgsLayoutMultiFrameAbstractGuiMetadata, handles the GUI behavior of QgsLayoutMultiFrames.

Derived classes

class QgsLayoutMultiFrameMetadata: Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets.

Constructors, destructors, conversion operators

QgsLayoutMultiFrameAbstractMetadata(int type, const QString& visibleName): Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName.

Public functions

auto createMultiFrame(QgsLayout* layout) -> QgsLayoutMultiFrame* pure virtual: Creates a layout multiframe of this class for a specified layout.
auto icon() const -> QIcon virtual: Returns an icon representing the layout multiframe type.
void resolvePaths(QVariantMap& properties, const QgsPathResolver& pathResolver, bool saving) virtual: Resolve paths in the item's properties (if there are any paths).
auto type() const -> int: Returns the unique item type code for the layout multiframe class.
auto visibleName() const -> QString: Returns a translated, user visible name for the layout multiframe class.

Function documentation

void QgsLayoutMultiFrameAbstractMetadata::resolvePaths(QVariantMap& properties, const QgsPathResolver& pathResolver, bool saving) virtual

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.