Class: QgsLayoutManager¶
-
class
qgis.core.
QgsLayoutManager
(project: QgsProject = None)¶ Bases:
PyQt5.QtCore.QObject
Constructor for QgsLayoutManager. The project will become the parent object for this manager.
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.
New in version 3.0: Enums
Methods
Adds a
layout
to the manager.Removes and deletes all layouts from the manager.
Duplicates an existing
layout
from the manager.Generates a unique title for a new layout of the specified
type
, which does not clash with any already contained by the manager.Returns the layout with a matching name, or
None
if no matching layouts were found.Returns a list of all layouts contained in the manager.
Returns a list of all print layouts contained in the manager.
Reads the manager’s state from a DOM element, restoring all layouts present in the XML document.
Removes a
layout
from the manager.Returns a DOM element representing the state of the manager.
Signals
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 [signal]
Emitted when a layout was removed from the manager [signal]
Emitted when a layout is renamed [signal]
Attributes
-
addLayout
(self, layout: QgsMasterLayoutInterface) → bool¶ Adds a
layout
to the manager. Ownership of the layout is transferred to the manager. ReturnsTrue
if the addition was successful, orFalse
if the layout could not be added (eg as a result of a duplicate layout name).See also
See also
-
childEvent
()¶
-
clear
(self)¶ Removes and deletes all layouts from the manager.
See also
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
duplicateLayout
(self, layout: QgsMasterLayoutInterface, newName: str) → QgsMasterLayoutInterface¶ 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.
-
generateUniqueTitle
(self, type: QgsMasterLayoutInterface.Type = QgsMasterLayoutInterface.PrintLayout) → str¶ Generates a unique title for a new layout of the specified
type
, which does not clash with any already contained by the manager.
-
isSignalConnected
()¶
-
layoutAboutToBeAdded
¶ Emitted when a layout is about to be added to the manager [signal]
-
layoutAboutToBeRemoved
¶ Emitted when a layout is about to be removed from the manager [signal]
-
layoutAdded
¶ Emitted when a layout has been added to the manager [signal]
-
layoutByName
(self, name: str) → QgsMasterLayoutInterface¶ Returns the layout with a matching name, or
None
if no matching layouts were found.
-
layoutRemoved
¶ Emitted when a layout was removed from the manager [signal]
-
layoutRenamed
¶ Emitted when a layout is renamed [signal]
-
layouts
(self) → List[QgsMasterLayoutInterface]¶ Returns a list of all layouts contained in the manager.
-
printLayouts
(self) → List[QgsPrintLayout]¶ Returns a list of all print layouts contained in the manager.
-
readXml
(self, element: QDomElement, doc: QDomDocument) → bool¶ Reads the manager’s state from a DOM element, restoring all layouts present in the XML document.
See also
-
receivers
()¶
-
removeLayout
(self, layout: QgsMasterLayoutInterface) → bool¶ Removes a
layout
from the manager. The layout is deleted. ReturnsTrue
if the removal was successful, orFalse
if the removal failed (eg as a result of removing a layout which is not contained in the manager).See also
See also
See also
See also
-
sender
()¶
-
senderSignalIndex
()¶
-
timerEvent
()¶
-