QGIS API Documentation
3.0.2-Girona (307d082)
|
Manages storage of a set of layouts. More...
#include <qgslayoutmanager.h>
Signals | |
void | layoutAboutToBeAdded (const QString &name) |
Emitted when a layout is about to be added to the manager. More... | |
void | layoutAboutToBeRemoved (const QString &name) |
Emitted when a layout is about to be removed from the manager. More... | |
void | layoutAdded (const QString &name) |
Emitted when a layout has been added to the manager. More... | |
void | layoutRemoved (const QString &name) |
Emitted when a layout was removed from the manager. More... | |
void | layoutRenamed (QgsMasterLayoutInterface *layout, const QString &newName) |
Emitted when a layout is renamed. More... | |
Public Member Functions | |
QgsLayoutManager (QgsProject *project=nullptr) | |
Constructor for QgsLayoutManager. More... | |
~QgsLayoutManager () override | |
bool | addLayout (QgsMasterLayoutInterface *layout) |
Adds a layout to the manager. More... | |
void | clear () |
Removes and deletes all layouts from the manager. More... | |
QgsMasterLayoutInterface * | duplicateLayout (const QgsMasterLayoutInterface *layout, const QString &newName) |
Duplicates an existing layout from the manager. More... | |
QString | generateUniqueTitle (QgsMasterLayoutInterface::Type type=QgsMasterLayoutInterface::PrintLayout) const |
Generates a unique title for a new layout of the specified type, which does not clash with any already contained by the manager. More... | |
QgsMasterLayoutInterface * | layoutByName (const QString &name) const |
Returns the layout with a matching name, or nullptr if no matching layouts were found. More... | |
QList< QgsMasterLayoutInterface *> | layouts () const |
Returns a list of all layouts contained in the manager. More... | |
QList< QgsPrintLayout *> | printLayouts () const |
Returns a list of all print layouts contained in the manager. More... | |
bool | readXml (const QDomElement &element, const QDomDocument &doc) |
Reads the manager's state from a DOM element, restoring all layouts present in the XML document. More... | |
bool | removeLayout (QgsMasterLayoutInterface *layout) |
Removes a layout from the manager. More... | |
QDomElement | writeXml (QDomDocument &doc) const |
Returns a DOM element representing the state of the manager. More... | |
Manages storage of a set of layouts.
QgsLayoutManager handles the storage, serializing and deserializing of print layouts and reports. Usually this class is not constructed directly, but rather accessed through a QgsProject via QgsProject::layoutManager().
QgsLayoutManager retains ownership of all the layouts contained in the manager.
Definition at line 43 of file qgslayoutmanager.h.
|
explicit |
Constructor for QgsLayoutManager.
The project will become the parent object for this manager.
Definition at line 26 of file qgslayoutmanager.cpp.
|
override |
Definition at line 33 of file qgslayoutmanager.cpp.
bool QgsLayoutManager::addLayout | ( | QgsMasterLayoutInterface * | layout | ) |
Adds a layout to the manager.
Ownership of the layout is transferred to the manager. Returns true if the addition was successful, or false if the layout could not be added (eg as a result of a duplicate layout name).
Definition at line 38 of file qgslayoutmanager.cpp.
void QgsLayoutManager::clear | ( | ) |
Removes and deletes all layouts from the manager.
Definition at line 93 of file qgslayoutmanager.cpp.
QgsMasterLayoutInterface * QgsLayoutManager::duplicateLayout | ( | const QgsMasterLayoutInterface * | layout, |
const QString & | newName | ||
) |
Duplicates an existing layout from the manager.
The new layout will automatically be stored in the manager. Returns new the layout if duplication was successful.
Definition at line 255 of file qgslayoutmanager.cpp.
QString QgsLayoutManager::generateUniqueTitle | ( | QgsMasterLayoutInterface::Type | type = QgsMasterLayoutInterface::PrintLayout | ) | const |
Generates a unique title for a new layout of the specified type, which does not clash with any already contained by the manager.
Definition at line 278 of file qgslayoutmanager.cpp.
|
signal |
Emitted when a layout is about to be added to the manager.
|
signal |
Emitted when a layout is about to be removed from the manager.
|
signal |
Emitted when a layout has been added to the manager.
QgsMasterLayoutInterface * QgsLayoutManager::layoutByName | ( | const QString & | name | ) | const |
Returns the layout with a matching name, or nullptr if no matching layouts were found.
Definition at line 120 of file qgslayoutmanager.cpp.
|
signal |
Emitted when a layout was removed from the manager.
|
signal |
Emitted when a layout is renamed.
QList< QgsMasterLayoutInterface * > QgsLayoutManager::layouts | ( | ) | const |
Returns a list of all layouts contained in the manager.
Definition at line 102 of file qgslayoutmanager.cpp.
QList< QgsPrintLayout * > QgsLayoutManager::printLayouts | ( | ) | const |
Returns a list of all print layouts contained in the manager.
Definition at line 107 of file qgslayoutmanager.cpp.
bool QgsLayoutManager::readXml | ( | const QDomElement & | element, |
const QDomDocument & | doc | ||
) |
Reads the manager's state from a DOM element, restoring all layouts present in the XML document.
Definition at line 130 of file qgslayoutmanager.cpp.
bool QgsLayoutManager::removeLayout | ( | QgsMasterLayoutInterface * | layout | ) |
Removes a layout from the manager.
The layout is deleted. Returns true if the removal was successful, or false if the removal failed (eg as a result of removing a layout which is not contained in the manager).
Definition at line 76 of file qgslayoutmanager.cpp.
QDomElement QgsLayoutManager::writeXml | ( | QDomDocument & | doc | ) | const |
Returns a DOM element representing the state of the manager.
Definition at line 241 of file qgslayoutmanager.cpp.