Class: QgsPrintLayout¶
- class qgis.core.QgsPrintLayout¶
Bases:
QgsLayout
,QgsMasterLayoutInterface
Print layout, a
QgsLayout
subclass for static or atlas-based layouts.QgsPrintLayout(project:
QgsProject
) Constructor for QgsPrintLayout.Methods
Returns the print layout's atlas.
- rtype:
QgsPrintLayout
- rtype:
QgsExpressionContext
- rtype:
QIcon
- param visitor:
- rtype:
QgsProject
- rtype:
QgsMasterLayoutInterface.Type
- rtype:
str
- param layoutElement:
- param layoutElement:
- param name:
- param document:
- param document:
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- 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¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- 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