Class: QgsLayoutView¶

class qgis.gui.QgsLayoutView(parent: QWidget = None)¶

Bases: PyQt5.QtWidgets.QGraphicsView

Constructor for QgsLayoutView.

A graphical widget to display and interact with QgsLayouts.

QgsLayoutView manages the layout interaction tools and mouse/key events.

New in version 3.0: Enums

Methods

`actionEvent`
`alignSelectedItems`	Aligns all selected items using the specified `alignment`.
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`copyItems`	Cuts or copies the a list of `items`, respecting the specified `operation`.
`copySelectedItems`	Cuts or copies the selected items, respecting the specified `operation`.
`create`
`currentLayout`	Returns the current layout associated with the view.
`currentPage`	Returns the page visible in the view.
`customEvent`
`deleteItems`	Delete the specified `items`.
`deleteSelectedItems`	Deletes all selected items.
`deltaForKeyEvent`	Returns the delta (in layout coordinates) by which to move items for the given key `event`.
`deselectAll`	Deselects all items in the view.
`destroy`
`disconnectNotify`
`distributeSelectedItems`	Distributes all selected items using the specified `distribution`.
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`drawBackground`
`drawForeground`
`drawFrame`
`dropEvent`
`emitZoomLevelChanged`
`enterEvent`
`event`
`eventFilter`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`groupSelectedItems`	Groups all selected items.
`hasItemsInClipboard`	Returns true if the current clipboard contains layout items.
`hideEvent`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`invertSelection`	Inverts the current selection, selecting deselected items and deselecting and selected items.
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`lockSelectedItems`	Locks any selected items, preventing them from being interacted with by mouse interactions.
`lowerSelectedItems`	Lowers the selected items down the z-order.
`menuProvider`	Returns the provider for context menus.
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`moveSelectedItemsToBottom`	Lowers the selected items to the bottom of the z-order.
`moveSelectedItemsToTop`	Raises the selected items to the top of the z-order.
`nativeEvent`
`paintEvent`
`pasteItems`	Pastes items from clipboard, using the specified `mode`.
`previewMode`	Returns the preview mode which may be used to modify the view’s appearance.
`previewModeEnabled`	Returns true if a preview effect is being used to alter the view’s appearance.
`pushStatusMessage`	Pushes a new status bar `message` to the view.
`raiseSelectedItems`	Raises the selected items up the z-order.
`receivers`
`resizeEvent`
`resizeSelectedItems`	Resizes all selected items using the specified `resize` mode.
`scaleSafe`	Scales the view in a safe way, by limiting the acceptable range of the scale applied.
`scrollContentsBy`
`selectAll`	Selects all items in the view.
`selectNextItemAbove`	Selects the next item above the existing selection, by item z order.
`selectNextItemBelow`	Selects the next item below the existing selection, by item z order.
`sender`
`senderSignalIndex`
`setCurrentLayout`	Sets the current `layout` to edit in the view.
`setHorizontalRuler`	Sets a horizontal `ruler` to synchronize with the view state.
`setMenuProvider`	Sets a `provider` for context menus.
`setPreviewMode`	Sets the preview `mode` which should be used to modify the view’s appearance.
`setPreviewModeEnabled`	Sets whether a preview effect should be used to alter the view’s appearance.
`setSectionLabel`	Sets a section `label`, to display above the first page shown in the view.
`setTool`	Sets the `tool` currently being used in the view.
`setVerticalRuler`	Sets a vertical `ruler` to synchronize with the view state.
`setViewportMargins`
`setZoomLevel`	Sets the zoom `level` for the view, where a zoom level of 1.0 corresponds to 100%.
`setupViewport`
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`tool`	Returns the currently active tool for the view.
`ungroupSelectedItems`	Ungroups all selected items.
`unlockAllItems`	Unlocks all locked items in the layout.
`unsetTool`	Unsets the current view tool, if it matches the specified `tool`.
`updateMicroFocus`
`viewChanged`	Updates associated rulers and other widgets after view extent or zoom has changed.
`viewportEvent`
`viewportMargins`
`viewportSizeHint`
`visiblePageNumbers`	Returns a list of page numbers for pages which are currently visible in the view.
`visiblePages`	Returns a list of page items which are currently visible in the view.
`wheelEvent`
`zoomActual`	Zooms to the actual size of the layout.
`zoomFull`	Zooms the view to the full extent of the layout.
`zoomIn`	Zooms in to the view by a preset amount.
`zoomOut`	Zooms out of the view by a preset amount.
`zoomWidth`	Zooms the view to the full width of the layout.

Signals

`cursorPosChanged`	Is emitted when the mouse cursor coordinates change within the view.
`itemFocused`	Emitted when an `item` is “focused” in the view, i.e.
`layoutSet`	Emitted when a `layout` is set for the view.
`pageChanged`	Emitted when the page visible in the view is changed.
`statusMessage`	Emitted when the view has a `message` for display in a parent window’s status bar.
`toolSet`	Emitted when the current `tool` is changed.
`willBeDeleted`	Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state.
`zoomLevelChanged`	Is emitted whenever the zoom level of the view is changed.

Attributes

`ClipboardCopy`
`ClipboardCut`
`PasteModeCenter`
`PasteModeCursor`
`PasteModeInPlace`

ClipboardCopy = 1¶

ClipboardCut = 0¶

class ClipboardOperation¶: Bases: int

class PasteMode¶: Bases: int

PasteModeCenter = 1¶

PasteModeCursor = 0¶

PasteModeInPlace = 2¶

actionEvent()¶

alignSelectedItems(self, alignment: QgsLayoutAligner.Alignment)¶: Aligns all selected items using the specified alignment.

See also

distributeSelectedItems()

See also

resizeSelectedItems()

changeEvent()¶

childEvent()¶

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

copyItems(self, items: Iterable[QgsLayoutItem], operation: QgsLayoutView.ClipboardOperation)¶: Cuts or copies the a list of items, respecting the specified operation.

See also

copySelectedItems()

See also

pasteItems()

copySelectedItems(self, operation: QgsLayoutView.ClipboardOperation)¶: Cuts or copies the selected items, respecting the specified operation.

See also

copyItems()

See also

pasteItems()

create()¶

currentLayout(self) → QgsLayout¶: Returns the current layout associated with the view.

See also

setCurrentLayout()

See also

layoutSet()

currentPage(self) → int¶: Returns the page visible in the view. This method considers the page at the center of the view as the current visible page.

See also

pageChanged()

cursorPosChanged¶: Is emitted when the mouse cursor coordinates change within the view. The layoutPoint argument indicates the cursor position within the layout coordinate system. [signal]

customEvent()¶

deleteItems(self, items: Iterable[QgsLayoutItem])¶: Delete the specified items.

See also

deleteSelectedItems()

deleteSelectedItems(self)¶: Deletes all selected items.

See also

deleteItems()

deltaForKeyEvent(self, event: QKeyEvent) → QPointF¶: Returns the delta (in layout coordinates) by which to move items for the given key event.

deselectAll(self)¶: Deselects all items in the view.

See also

selectAll()

See also

invertSelection()

destroy()¶

disconnectNotify()¶

distributeSelectedItems(self, distribution: QgsLayoutAligner.Distribution)¶: Distributes all selected items using the specified distribution.

See also

alignSelectedItems()

See also

resizeSelectedItems()

dragEnterEvent(self, e: QDragEnterEvent)¶

dragLeaveEvent()¶

dragMoveEvent()¶

drawBackground()¶

drawForeground()¶

drawFrame()¶

dropEvent()¶

emitZoomLevelChanged(self)¶

enterEvent()¶

event()¶

eventFilter()¶

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

groupSelectedItems(self)¶: Groups all selected items.

See also

ungroupSelectedItems()

hasItemsInClipboard(self) → bool¶: Returns true if the current clipboard contains layout items.

See also

pasteItems()

hideEvent()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

invertSelection(self)¶: Inverts the current selection, selecting deselected items and deselecting and selected items.

See also

selectAll()

See also

deselectAll()

isSignalConnected()¶

itemFocused¶: Emitted when an item is “focused” in the view, i.e. it becomes the active item and should have its properties displayed in any designer windows. [signal]

keyPressEvent(self, event: QKeyEvent)¶

keyReleaseEvent(self, event: QKeyEvent)¶

layoutSet¶: Emitted when a layout is set for the view.

See also

currentLayout()

See also

setCurrentLayout() [signal]

leaveEvent()¶

lockSelectedItems(self)¶: Locks any selected items, preventing them from being interacted with by mouse interactions.

See also

unlockAllItems()

lowerSelectedItems(self)¶: Lowers the selected items down the z-order.

See also

raiseSelectedItems()

See also

moveSelectedItemsToTop()

See also

moveSelectedItemsToBottom()

menuProvider(self) → QgsLayoutViewMenuProvider¶: Returns the provider for context menus. Returned value may be None if no provider is set.

See also

setMenuProvider()

metric()¶

mouseDoubleClickEvent(self, event: QMouseEvent)¶

mouseMoveEvent(self, event: QMouseEvent)¶

mousePressEvent(self, event: QMouseEvent)¶

mouseReleaseEvent(self, event: QMouseEvent)¶

moveEvent()¶

moveSelectedItemsToBottom(self)¶: Lowers the selected items to the bottom of the z-order.

See also

raiseSelectedItems()

See also

lowerSelectedItems()

See also

moveSelectedItemsToTop()

moveSelectedItemsToTop(self)¶: Raises the selected items to the top of the z-order.

See also

raiseSelectedItems()

See also

lowerSelectedItems()

See also

moveSelectedItemsToBottom()

nativeEvent()¶

pageChanged¶: Emitted when the page visible in the view is changed. This signal considers the page at the center of the view as the current visible page.

See also

currentPage() [signal]

paintEvent(self, event: QPaintEvent)¶

pasteItems(self, mode: QgsLayoutView.PasteMode) → List[QgsLayoutItem]¶

Pastes items from clipboard, using the specified mode.

A list of pasted items is returned.

See also

copySelectedItems()

See also

hasItemsInClipboard()

pasteItems(self, layoutPoint: Union[QPointF, QPoint]) -> List[QgsLayoutItem] Pastes items from clipboard, at the specified layoutPoint, in layout units.

A list of pasted items is returned.

See also

copySelectedItems()

See also

hasItemsInClipboard()

previewMode(self) → QgsPreviewEffect.PreviewMode¶: Returns the preview mode which may be used to modify the view’s appearance. Preview modes are only used if previewModeEnabled() is true.

See also

setPreviewMode()

See also

previewModeEnabled()

previewModeEnabled(self) → bool¶: Returns true if a preview effect is being used to alter the view’s appearance.

See also

setPreviewModeEnabled()

pushStatusMessage(self, message: str)¶: Pushes a new status bar message to the view. This causes statusMessage() to be emitted, which should cause the message to appear in the status bar for the parent window.

See also

statusMessage()

raiseSelectedItems(self)¶: Raises the selected items up the z-order.

See also

lowerSelectedItems()

See also

moveSelectedItemsToTop()

See also

moveSelectedItemsToBottom()

receivers()¶

resizeEvent(self, event: QResizeEvent)¶

resizeSelectedItems(self, resize: QgsLayoutAligner.Resize)¶: Resizes all selected items using the specified resize mode.

See also

alignSelectedItems()

See also

distributeSelectedItems()

scaleSafe(self, scale: float)¶: Scales the view in a safe way, by limiting the acceptable range of the scale applied. The scale parameter specifies the zoom factor to scale the view by.

scrollContentsBy(self, dx: int, dy: int)¶

selectAll(self)¶: Selects all items in the view.

See also

deselectAll()

See also

invertSelection()

See also

selectNextItemAbove()

See also

selectNextItemBelow()

selectNextItemAbove(self)¶: Selects the next item above the existing selection, by item z order.

See also

selectNextItemBelow()

See also

selectAll()

See also

deselectAll()

selectNextItemBelow(self)¶: Selects the next item below the existing selection, by item z order.

See also

selectNextItemAbove()

See also

selectAll()

See also

deselectAll()

sender()¶

senderSignalIndex()¶

setCurrentLayout(self, layout: QgsLayout)¶: Sets the current layout to edit in the view.

See also

currentLayout()

See also

layoutSet()

setHorizontalRuler(self, ruler: QgsLayoutRuler)¶: Sets a horizontal ruler to synchronize with the view state.

See also

setVerticalRuler()

setMenuProvider(self, provider: QgsLayoutViewMenuProvider)¶: Sets a provider for context menus. Ownership of the provider is transferred to the view.

See also

menuProvider()

setPreviewMode(self, mode: QgsPreviewEffect.PreviewMode)¶: Sets the preview mode which should be used to modify the view’s appearance. Preview modes are only used if previewModeEnabled() is true.

See also

setPreviewModeEnabled()

See also

previewMode()

setPreviewModeEnabled(self, enabled: bool)¶

Sets whether a preview effect should be used to alter the view’s appearance.

Parameters: enabled – Set to true to enable the preview effect on the view.

See also

setPreviewMode()

setSectionLabel(self, label: str)¶: Sets a section label, to display above the first page shown in the view.

setTool(self, tool: QgsLayoutViewTool)¶: Sets the tool currently being used in the view.

See also

unsetTool()

See also

tool()

setVerticalRuler(self, ruler: QgsLayoutRuler)¶: Sets a vertical ruler to synchronize with the view state.

See also

setHorizontalRuler()

setViewportMargins()¶

setZoomLevel(self, level: float)¶: Sets the zoom level for the view, where a zoom level of 1.0 corresponds to 100%.

setupViewport()¶

sharedPainter()¶

showEvent()¶

statusMessage¶: Emitted when the view has a message for display in a parent window’s status bar.

See also

pushStatusMessage() [signal]

tabletEvent()¶

timerEvent()¶

tool(self) → QgsLayoutViewTool¶: Returns the currently active tool for the view.

See also

setTool()

toolSet¶: Emitted when the current tool is changed.

See also

setTool() [signal]

ungroupSelectedItems(self)¶: Ungroups all selected items.

See also

groupSelectedItems()

unlockAllItems(self)¶: Unlocks all locked items in the layout.

See also

lockSelectedItems()

unsetTool(self, tool: QgsLayoutViewTool)¶

Unsets the current view tool, if it matches the specified tool.

This is called from destructor of view tools to make sure that the tool won’t be used any more. You don’t have to call it manually, QgsLayoutViewTool takes care of it.

updateMicroFocus()¶

viewChanged(self)¶: Updates associated rulers and other widgets after view extent or zoom has changed. This should be called after calling any of the QGraphicsView base class methods which alter the view’s zoom level or extent, i.e. QGraphicsView.fitInView().

viewportEvent()¶

viewportMargins()¶

viewportSizeHint()¶

visiblePageNumbers(self) → List[int]¶: Returns a list of page numbers for pages which are currently visible in the view.

See also

visiblePages()

visiblePages(self) → List[QgsLayoutItemPage]¶: Returns a list of page items which are currently visible in the view.

See also

visiblePageNumbers()

wheelEvent(self, event: QWheelEvent)¶

willBeDeleted¶: Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state. [signal]

zoomActual(self)¶: Zooms to the actual size of the layout.

See also

zoomFull()

See also

zoomIn()

See also

zoomOut()

zoomFull(self)¶: Zooms the view to the full extent of the layout.

See also

zoomIn()

See also

zoomOut()

See also

zoomActual()

zoomIn(self)¶: Zooms in to the view by a preset amount.

See also

zoomFull()

See also

zoomOut()

See also

zoomActual()

zoomLevelChanged¶: Is emitted whenever the zoom level of the view is changed. [signal]

zoomOut(self)¶: Zooms out of the view by a preset amount.

See also

zoomFull()

See also

zoomIn()

See also

zoomActual()

zoomWidth(self)¶: Zooms the view to the full width of the layout.

See also

zoomIn()

See also

zoomOut()

See also

zoomActual()