QgsLayoutMultiFrameAbstractMetadata Class Reference

Stores metadata about one layout multiframe class. More...

#include <qgslayoutitemregistry.h>

Inheritance diagram for QgsLayoutMultiFrameAbstractMetadata:

Public Member Functions
	QgsLayoutMultiFrameAbstractMetadata (int type, const QString &visibleName)
	Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName. More...
virtual	~QgsLayoutMultiFrameAbstractMetadata ()=default
virtual QgsLayoutMultiFrame *	createMultiFrame (QgsLayout *layout)=0
	Creates a layout multiframe of this class for a specified layout. More...
virtual QIcon	icon () const
	Returns an icon representing the layout multiframe type. More...
virtual void	resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving)
	Resolve paths in the item's properties (if there are any paths). More...
int	type () const
	Returns the unique item type code for the layout multiframe class. More...
QString	visibleName () const
	Returns a translated, user visible name for the layout multiframe class. More...

Detailed Description

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.

Since

QGIS 3.0

Definition at line 189 of file qgslayoutitemregistry.h.

Constructor & Destructor Documentation

QgsLayoutMultiFrameAbstractMetadata()

QgsLayoutMultiFrameAbstractMetadata::QgsLayoutMultiFrameAbstractMetadata ( int  type, const QString &  visibleName  )

inline

Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName.

Definition at line 197 of file qgslayoutitemregistry.h.

~QgsLayoutMultiFrameAbstractMetadata()

virtual QgsLayoutMultiFrameAbstractMetadata::~QgsLayoutMultiFrameAbstractMetadata ( )

virtualdefault

Member Function Documentation

createMultiFrame()

virtual QgsLayoutMultiFrame * QgsLayoutMultiFrameAbstractMetadata::createMultiFrame ( QgsLayout *  layout )

pure virtual

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

Implemented in QgsLayoutMultiFrameMetadata.

icon()

virtual QIcon QgsLayoutMultiFrameAbstractMetadata::icon ( ) const

inlinevirtual

Returns an icon representing the layout multiframe type.

Definition at line 212 of file qgslayoutitemregistry.h.

resolvePaths()

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

inlinevirtual

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.

Reimplemented in QgsLayoutMultiFrameMetadata.

Definition at line 246 of file qgslayoutitemregistry.h.

type()

int QgsLayoutMultiFrameAbstractMetadata::type ( ) const

inline

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

Definition at line 207 of file qgslayoutitemregistry.h.

visibleName()

QString QgsLayoutMultiFrameAbstractMetadata::visibleName ( ) const

inline

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

Definition at line 217 of file qgslayoutitemregistry.h.

---

The documentation for this class was generated from the following file:

• /build/qgis-3.28.0+99sid/src/core/layout/qgslayoutitemregistry.h