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
-
childEvent
(self, QChildEvent)¶
-
clone
(self) → QgsPrintLayout¶ - Return type
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QGraphicsSceneContextMenuEvent)¶
-
createExpressionContext
(self) → QgsExpressionContext¶ - Return type
-
customEvent
(self, QEvent)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
dragEnterEvent
(self, QGraphicsSceneDragDropEvent)¶
-
dragLeaveEvent
(self, QGraphicsSceneDragDropEvent)¶
-
dragMoveEvent
(self, QGraphicsSceneDragDropEvent)¶
-
drawBackground
(self, QPainter, QRectF)¶
-
drawForeground
(self, QPainter, QRectF)¶
-
dropEvent
(self, QGraphicsSceneDragDropEvent)¶
-
event
(self, QEvent) → bool¶
-
eventFilter
(self, QObject, QEvent) → bool¶
-
focusInEvent
(self, QFocusEvent)¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
helpEvent
(self, QGraphicsSceneHelpEvent)¶
-
icon
(self) → QIcon¶ - Return type
QIcon
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
layoutAccept
(self, visitor: QgsStyleEntityVisitorInterface) → bool¶ - Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
-
layoutProject
(self) → QgsProject¶ - Return type
-
layoutType
(self) → QgsMasterLayoutInterface.Type¶ - Return type
-
mouseDoubleClickEvent
(self, QGraphicsSceneMouseEvent)¶
-
mouseMoveEvent
(self, QGraphicsSceneMouseEvent)¶
-
mousePressEvent
(self, QGraphicsSceneMouseEvent)¶
-
mouseReleaseEvent
(self, QGraphicsSceneMouseEvent)¶
-
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
(self, PYQT_SIGNAL) → int¶
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setName
(self, name: str)¶ - Parameters
name (str) –
-
timerEvent
(self, QTimerEvent)¶
-
updateSettings
(self)¶
-
wheelEvent
(self, QGraphicsSceneWheelEvent)¶
-
writeLayoutXml
(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ - Parameters
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
-
writeXml
(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ - Parameters
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement