QGIS API Documentation
3.6.0-Noosa (5873452)
|
Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets. More...
#include <qgslayoutitemregistry.h>
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 |
Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets.
Definition at line 230 of file qgslayoutitemregistry.h.
|
inline |
Constructor for QgsLayoutMultiFrameMetadata with the specified class type and visibleName, and function pointers for the various item creation functions.
Definition at line 238 of file qgslayoutitemregistry.h.
|
inline |
Returns the classes' multiframe creation function.
Definition at line 249 of file qgslayoutitemregistry.h.
|
inlineoverridevirtual |
Creates a layout multiframe of this class for a specified layout.
Implements QgsLayoutMultiFrameAbstractMetadata.
Definition at line 256 of file qgslayoutitemregistry.h.
|
inline |
Returns the classes' path resolver function.
Definition at line 254 of file qgslayoutitemregistry.h.
|
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 258 of file qgslayoutitemregistry.h.
|
protected |
Definition at line 265 of file qgslayoutitemregistry.h.
|
protected |
Definition at line 266 of file qgslayoutitemregistry.h.