Class: QgsLayoutMultiFrameAbstractMetadata

class qgis.core.QgsLayoutMultiFrameAbstractMetadata

Bases: sip.wrapper

Stores metadata about one layout multiframe class.

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

Note

In C++ you can use QgsLayoutMultiFrameMetadata convenience class.

New in version 3.0.

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

QgsLayoutMultiFrameAbstractMetadata(QgsLayoutMultiFrameAbstractMetadata)

Methods

createMultiFrame

Creates a layout multiframe of this class for a specified layout.

icon

Returns an icon representing the layout multiframe type.

resolvePaths

Resolve paths in the item’s properties (if there are any paths).

type

Returns the unique item type code for the layout multiframe class.

visibleName

Returns a translated, user visible name for the layout multiframe class.

createMultiFrame(self, layout: QgsLayout)QgsLayoutMultiFrame

Creates a layout multiframe of this class for a specified layout.

Parameters

layout (QgsLayout) –

Return type

QgsLayoutMultiFrame

icon(self)QIcon

Returns an icon representing the layout multiframe type.

Return type

QIcon

resolvePaths(self, properties: Dict[str, Any], pathResolver: QgsPathResolver, saving: bool)

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.

Parameters
  • properties (Dict[str) –

  • pathResolver (QgsPathResolver) –

  • saving (bool) –

type(self)int

Returns the unique item type code for the layout multiframe class.

Return type

int

visibleName(self)str

Returns a translated, user visible name for the layout multiframe class.

Return type

str