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.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createMultiFrame()

Abstract Methods

createMultiFrame

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

Methods

`type`	Returns the unique item type code for the layout multiframe class.
`visibleName`	Returns a translated, user visible name for the layout multiframe class.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsLayoutMultiFrameAbstractMetadata. See the FAQ for more details.

`icon`	Returns an icon representing the layout multiframe type.
`resolvePaths`	Resolve paths in the item's properties (if there are any paths).

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)

abstract 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]

virtual icon(self) → QIcon[source]¶

Returns an icon representing the layout multiframe type.

Return type:: QIcon

virtual 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