QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]

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...
 
QgsLayoutMultiFramecreateMultiFrame (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...
 

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 243 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 251 of file qgslayoutitemregistry.h.

Member Function Documentation

◆ createFunction()

QgsLayoutMultiFrameCreateFunc QgsLayoutMultiFrameMetadata::createFunction ( ) const
inline

Returns the classes' multiframe creation function.

Definition at line 262 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 269 of file qgslayoutitemregistry.h.

◆ pathResolverFunction()

QgsLayoutMultiFramePathResolverFunc QgsLayoutMultiFrameMetadata::pathResolverFunction ( ) const
inline

Returns the classes' path resolver function.

Definition at line 267 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 271 of file qgslayoutitemregistry.h.

Member Data Documentation

◆ mCreateFunc

QgsLayoutMultiFrameCreateFunc QgsLayoutMultiFrameMetadata::mCreateFunc = nullptr
protected

Definition at line 278 of file qgslayoutitemregistry.h.

◆ mPathResolverFunc

QgsLayoutMultiFramePathResolverFunc QgsLayoutMultiFrameMetadata::mPathResolverFunc = nullptr
protected

Definition at line 279 of file qgslayoutitemregistry.h.


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