QgsLayoutMultiFrameMetadata Class Reference

Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets. More...

#include <qgslayoutitemregistry.h>

Inheritance diagram for QgsLayoutMultiFrameMetadata:

Public Member Functions
	QgsLayoutMultiFrameMetadata (int type, const QString &visibleName, const QgsLayoutMultiFrameCreateFunc &pfCreate, const QgsLayoutMultiFramePathResolverFunc &pfPathResolver=nullptr)
	Constructor for QgsLayoutMultiFrameMetadata with the specified class type and visibleName, and function pointers for the various item creation functions. More...
QgsLayoutMultiFrameCreateFunc	createFunction () const
	Returns the classes' multiframe creation function. More...
QgsLayoutMultiFrame *	createMultiFrame (QgsLayout *layout) override
	Creates a layout multiframe of this class for a specified layout. More...
QgsLayoutMultiFramePathResolverFunc	pathResolverFunction () const
	Returns the classes' path resolver function. More...
void	resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) override
	Resolve paths in the item's properties (if there are any paths). More...
Public Member Functions inherited from QgsLayoutMultiFrameAbstractMetadata
	QgsLayoutMultiFrameAbstractMetadata (int type, const QString &visibleName)
	Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class type and visibleName. More...
virtual	~QgsLayoutMultiFrameAbstractMetadata ()=default
virtual QIcon	icon () const
	Returns an icon representing the layout multiframe type. 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...

Protected Attributes
QgsLayoutMultiFrameCreateFunc	mCreateFunc = nullptr
QgsLayoutMultiFramePathResolverFunc	mPathResolverFunc = nullptr

Detailed Description

Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets.

Note

not available in Python bindings

Since

QGIS 3.0

Definition at line 273 of file qgslayoutitemregistry.h.

Constructor & Destructor Documentation

QgsLayoutMultiFrameMetadata()

QgsLayoutMultiFrameMetadata::QgsLayoutMultiFrameMetadata ( int  type, const QString &  visibleName, const QgsLayoutMultiFrameCreateFunc &  pfCreate, const QgsLayoutMultiFramePathResolverFunc &  pfPathResolver = nullptr  )

inline

Constructor for QgsLayoutMultiFrameMetadata with the specified class type and visibleName, and function pointers for the various item creation functions.

Definition at line 281 of file qgslayoutitemregistry.h.

Member Function Documentation

createFunction()

QgsLayoutMultiFrameCreateFunc QgsLayoutMultiFrameMetadata::createFunction ( ) const

inline

Returns the classes' multiframe creation function.

Definition at line 292 of file qgslayoutitemregistry.h.

createMultiFrame()

QgsLayoutMultiFrame* QgsLayoutMultiFrameMetadata::createMultiFrame ( QgsLayout *  layout )

inlineoverridevirtual

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

Implements QgsLayoutMultiFrameAbstractMetadata.

Definition at line 299 of file qgslayoutitemregistry.h.

pathResolverFunction()

QgsLayoutMultiFramePathResolverFunc QgsLayoutMultiFrameMetadata::pathResolverFunction ( ) const

inline

Returns the classes' path resolver function.

Definition at line 297 of file qgslayoutitemregistry.h.

resolvePaths()

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

inlineoverridevirtual

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 from QgsLayoutMultiFrameAbstractMetadata.

Definition at line 301 of file qgslayoutitemregistry.h.

Member Data Documentation

mCreateFunc

QgsLayoutMultiFrameCreateFunc QgsLayoutMultiFrameMetadata::mCreateFunc = nullptr

protected

Definition at line 308 of file qgslayoutitemregistry.h.

mPathResolverFunc

QgsLayoutMultiFramePathResolverFunc QgsLayoutMultiFrameMetadata::mPathResolverFunc = nullptr

protected

Definition at line 309 of file qgslayoutitemregistry.h.

---

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

• /build/qgis-3.22.4+99unstable/src/core/layout/qgslayoutitemregistry.h