Class: QgsLayoutMultiFrameAbstractMetadata¶
- class qgis.core.QgsLayoutMultiFrameAbstractMetadata¶
Bases:
sip.wrapper
Stores metadata about one layout multiframe class.
A companion class,
QgsLayoutMultiFrameAbstractGuiMetadata
, handles the GUI behavior ofQgsLayoutMultiFrames
.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 classtype
andvisibleName
.QgsLayoutMultiFrameAbstractMetadata(
QgsLayoutMultiFrameAbstractMetadata
)Methods
Creates a layout multiframe of this class for a specified
layout
.Returns an icon representing the layout multiframe type.
Resolve paths in the item's
properties
(if there are any paths).Returns the unique item type code for the layout multiframe class.
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
- 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). Whensaving
isTrue
, paths are converted from absolute to relative, whensaving
isFalse
, 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