Class: QgsMasterLayoutInterface¶
-
class
qgis.core.
QgsMasterLayoutInterface
¶ Bases:
sip.wrapper
Interface for master layout type objects, such as print layouts and reports.
Methods
Creates a clone of the layout.
Returns an icon for the layout.
The project associated with the layout.
Returns the master layout type.
Returns the layout’s name.
Sets the layout’s state from a DOM element.
Sets the layout’s name.
Refreshes the layout when global layout related options change.
Returns the layout’s state encapsulated in a DOM element.
Attributes
-
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.
- Return type
-
icon
(self) → QIcon¶ Returns an icon for the layout.
- Return type
QIcon
-
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.
- Return type
-
layoutType
(self) → QgsMasterLayoutInterface.Type¶ Returns the master layout type.
- Return 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
- Parameters
layoutElement (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
-
updateSettings
(self)¶ Refreshes the layout when global layout related options change.
-
writeLayoutXml
(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ Returns the layout’s state encapsulated in a DOM element.
See also
- Parameters
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
-