Subgroup: other
Class: QgsMasterLayoutInterface¶
-
class
qgis.core.
QgsMasterLayoutInterface
¶ Bases:
sip.wrapper
Interface for master layout type objects, such as print layouts and reports.
New in version 3.0: Methods
clone
Creates a clone of the layout. icon
Returns an icon for the layout. layoutProject
The project associated with the layout. layoutType
Returns the master layout type. name
Returns the layout’s name. readLayoutXml
Sets the layout’s state from a DOM element. setName
Sets the layout’s name. writeLayoutXml
Returns the layout’s state encapsulated in a DOM element. Attributes
PrintLayout
Report
-
PrintLayout
= 0¶
-
Report
= 1¶
-
class
Type
¶ Bases:
int
-
clone
(self) → QgsMasterLayoutInterface¶ Creates a clone of the layout. Ownership of the returned layout is transferred to the caller.
-
icon
(self) → QIcon¶ Returns an icon for the layout.
-
layoutProject
(self) → QgsProject¶ The project associated with the layout. Used to get access to layers, map themes, relations and various other bits. It is never null.
-
layoutType
(self) → QgsMasterLayoutInterface.Type¶ Returns the master layout type.
-
readLayoutXml
(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets the layout’s state from a DOM element.
layoutElement
is the DOM node corresponding to the layout.See also
-
writeLayoutXml
(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ Returns the layout’s state encapsulated in a DOM element.
See also
-