Class: QgsLayoutMultiFrameAbstractMetadata¶

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.

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.

class qgis.core.QgsLayoutMultiFrameAbstractMetadata[source]¶

Bases: object

__init__(type: int, visibleName: str | None)

Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName.

Parameters:

type (int)
visibleName (Optional[str])

__init__(a0: QgsLayoutMultiFrameAbstractMetadata)

Parameters:: a0 (QgsLayoutMultiFrameAbstractMetadata)

createMultiFrame(self, layout: QgsLayout | None) → QgsLayoutMultiFrame | None[source]¶

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

Parameters:: layout (Optional[QgsLayout])
Return type:: Optional[QgsLayoutMultiFrame]

icon(self) → QIcon[source]¶

Returns an icon representing the layout multiframe type.

Return type:: QIcon

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

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, Any])
pathResolver (QgsPathResolver)
saving (bool)

type(self) → int[source]¶

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

Return type:: int

visibleName(self) → str[source]¶

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

Return type:: str