Class: QgsPrintLayout

class qgis.core.QgsPrintLayout(project: QgsProject)

Bases: QgsLayout, QgsMasterLayoutInterface

Constructor for QgsPrintLayout.

Print layout, a QgsLayout subclass for static or atlas-based layouts.

New in version 3.0.

Parameters

project

atlas(self)QgsLayoutAtlas

Returns the print layout’s atlas.

Return type

QgsLayoutAtlas

childEvent()
clone(self)QgsPrintLayout
Return type

QgsPrintLayout

connectNotify()
contextMenuEvent()
createExpressionContext(self)QgsExpressionContext
Return type

QgsExpressionContext

customEvent()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawBackground()
drawForeground()
dropEvent()
event()
eventFilter()
focusInEvent()
focusNextPrevChild()
focusOutEvent()
helpEvent()
icon(self) → QIcon
Return type

QIcon

inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
layoutAccept(self, visitor: QgsStyleEntityVisitorInterface) → bool
Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

layoutProject(self)QgsProject
Return type

QgsProject

layoutType(self) → QgsMasterLayoutInterface.Type
Return type

QgsMasterLayoutInterface.Type

mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
name(self) → str
Return type

str

nameChanged

Emitted when the layout’s name is changed.

See also

setName() [signal]

Parameters

name (str) –

readLayoutXml(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
  • layoutElement (QDomElement) –

  • document (QDomDocument) –

  • context (QgsReadWriteContext) –

Return type

bool

readXml(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
  • layoutElement (QDomElement) –

  • document (QDomDocument) –

  • context (QgsReadWriteContext) –

Return type

bool

receivers()
sender()
senderSignalIndex()
setName(self, name: str)
Parameters

name (str) –

timerEvent()
updateSettings(self)
wheelEvent()
writeLayoutXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters
Return type

QDomElement

writeXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters
Return type

QDomElement