QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | Friends | List of all members
QgsLayoutView Class Reference

A graphical widget to display and interact with QgsLayouts. More...

#include <qgslayoutview.h>

Inheritance diagram for QgsLayoutView:
Inheritance graph
[legend]

Public Types

enum  ClipboardOperation { ClipboardCut, ClipboardCopy }
 Clipboard operations. More...
 
enum  PasteMode { PasteModeCursor, PasteModeCenter, PasteModeInPlace }
 Paste modes. More...
 

Public Slots

void deleteItems (const QList< QgsLayoutItem * > &items)
 Delete the specified items. More...
 
void deleteSelectedItems ()
 Deletes all selected items. More...
 
void deselectAll ()
 Deselects all items in the view. More...
 
void emitZoomLevelChanged ()
 Emits the zoomLevelChanged() signal. More...
 
void groupSelectedItems ()
 Groups all selected items. More...
 
void invertSelection ()
 Inverts the current selection, selecting deselected items and deselecting and selected items. More...
 
void lockSelectedItems ()
 Locks any selected items, preventing them from being interacted with by mouse interactions. More...
 
void lowerSelectedItems ()
 Lowers the selected items down the z-order. More...
 
void moveSelectedItemsToBottom ()
 Lowers the selected items to the bottom of the z-order. More...
 
void moveSelectedItemsToTop ()
 Raises the selected items to the top of the z-order. More...
 
void pushStatusMessage (const QString &message)
 Pushes a new status bar message to the view. More...
 
void raiseSelectedItems ()
 Raises the selected items up the z-order. More...
 
void selectAll ()
 Selects all items in the view. More...
 
void selectNextItemAbove ()
 Selects the next item above the existing selection, by item z order. More...
 
void selectNextItemBelow ()
 Selects the next item below the existing selection, by item z order. More...
 
void ungroupSelectedItems ()
 Ungroups all selected items. More...
 
void unlockAllItems ()
 Unlocks all locked items in the layout. More...
 
void viewChanged ()
 Updates associated rulers and other widgets after view extent or zoom has changed. More...
 
void zoomActual ()
 Zooms to the actual size of the layout. More...
 
void zoomFull ()
 Zooms the view to the full extent of the layout. More...
 
void zoomIn ()
 Zooms in to the view by a preset amount. More...
 
void zoomOut ()
 Zooms out of the view by a preset amount. More...
 
void zoomWidth ()
 Zooms the view to the full width of the layout. More...
 

Signals

void cursorPosChanged (QPointF layoutPoint)
 Is emitted when the mouse cursor coordinates change within the view. More...
 
void itemFocused (QgsLayoutItem *item)
 Emitted when an item is "focused" in the view, i.e. More...
 
void layoutSet (QgsLayout *layout)
 Emitted when a layout is set for the view. More...
 
void pageChanged (int page)
 Emitted when the page visible in the view is changed. More...
 
void statusMessage (const QString &message)
 Emitted when the view has a message for display in a parent window's status bar. More...
 
void toolSet (QgsLayoutViewTool *tool)
 Emitted when the current tool is changed. More...
 
void willBeDeleted ()
 Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state. More...
 
void zoomLevelChanged ()
 Is emitted whenever the zoom level of the view is changed. More...
 

Public Member Functions

 QgsLayoutView (QWidget *parent=nullptr)
 Constructor for QgsLayoutView. More...
 
 ~QgsLayoutView () override
 
void alignSelectedItems (QgsLayoutAligner::Alignment alignment)
 Aligns all selected items using the specified alignment. More...
 
void copyItems (const QList< QgsLayoutItem * > &items, ClipboardOperation operation)
 Cuts or copies the a list of items, respecting the specified operation. More...
 
void copySelectedItems (ClipboardOperation operation)
 Cuts or copies the selected items, respecting the specified operation. More...
 
QgsLayoutcurrentLayout ()
 Returns the current layout associated with the view. More...
 
const QgsLayoutcurrentLayout () const
 Returns the current layout associated with the view. More...
 
int currentPage () const
 Returns the page visible in the view. More...
 
QPointF deltaForKeyEvent (QKeyEvent *event)
 Returns the delta (in layout coordinates) by which to move items for the given key event. More...
 
void distributeSelectedItems (QgsLayoutAligner::Distribution distribution)
 Distributes all selected items using the specified distribution. More...
 
bool hasItemsInClipboard () const
 Returns true if the current clipboard contains layout items. More...
 
QgsLayoutViewMenuProvidermenuProvider () const
 Returns the provider for context menus. More...
 
QList< QgsLayoutItem *> pasteItems (PasteMode mode)
 Pastes items from clipboard, using the specified mode. More...
 
QList< QgsLayoutItem *> pasteItems (QPointF layoutPoint)
 Pastes items from clipboard, at the specified layoutPoint, in layout units. More...
 
QgsPreviewEffect::PreviewMode previewMode () const
 Returns the preview mode which may be used to modify the view's appearance. More...
 
bool previewModeEnabled () const
 Returns true if a preview effect is being used to alter the view's appearance. More...
 
void resizeSelectedItems (QgsLayoutAligner::Resize resize)
 Resizes all selected items using the specified resize mode. More...
 
void scaleSafe (double scale)
 Scales the view in a safe way, by limiting the acceptable range of the scale applied. More...
 
void setCurrentLayout (QgsLayout *layout)
 Sets the current layout to edit in the view. More...
 
void setHorizontalRuler (QgsLayoutRuler *ruler)
 Sets a horizontal ruler to synchronize with the view state. More...
 
void setMenuProvider (QgsLayoutViewMenuProvider *provider)
 Sets a provider for context menus. More...
 
void setPaintingEnabled (bool enabled)
 Sets whether widget repainting should be allowed for the view. More...
 
void setPreviewMode (QgsPreviewEffect::PreviewMode mode)
 Sets the preview mode which should be used to modify the view's appearance. More...
 
void setPreviewModeEnabled (bool enabled)
 Sets whether a preview effect should be used to alter the view's appearance. More...
 
void setSectionLabel (const QString &label)
 Sets a section label, to display above the first page shown in the view. More...
 
void setTool (QgsLayoutViewTool *tool)
 Sets the tool currently being used in the view. More...
 
void setVerticalRuler (QgsLayoutRuler *ruler)
 Sets a vertical ruler to synchronize with the view state. More...
 
void setZoomLevel (double level)
 Sets the zoom level for the view, where a zoom level of 1.0 corresponds to 100%. More...
 
QgsLayoutViewTooltool ()
 Returns the currently active tool for the view. More...
 
void unsetTool (QgsLayoutViewTool *tool)
 Unsets the current view tool, if it matches the specified tool. More...
 
QList< int > visiblePageNumbers () const
 Returns a list of page numbers for pages which are currently visible in the view. More...
 
QList< QgsLayoutItemPage *> visiblePages () const
 Returns a list of page items which are currently visible in the view. More...
 

Protected Member Functions

void dragEnterEvent (QDragEnterEvent *e) override
 
void keyPressEvent (QKeyEvent *event) override
 
void keyReleaseEvent (QKeyEvent *event) override
 
void mouseDoubleClickEvent (QMouseEvent *event) override
 
void mouseMoveEvent (QMouseEvent *event) override
 
void mousePressEvent (QMouseEvent *event) override
 
void mouseReleaseEvent (QMouseEvent *event) override
 
void paintEvent (QPaintEvent *event) override
 
void resizeEvent (QResizeEvent *event) override
 
void scrollContentsBy (int dx, int dy) override
 
void wheelEvent (QWheelEvent *event) override
 

Properties

QgsLayout currentLayout
 
QgsLayoutViewTool tool
 

Friends

class QgsLayoutMouseHandles
 
class TestQgsLayoutView
 

Detailed Description

A graphical widget to display and interact with QgsLayouts.

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

Since
QGIS 3.0

Definition at line 49 of file qgslayoutview.h.

Member Enumeration Documentation

◆ ClipboardOperation

Clipboard operations.

Enumerator
ClipboardCut 

Cut items.

ClipboardCopy 

Copy items.

Definition at line 69 of file qgslayoutview.h.

◆ PasteMode

Paste modes.

Enumerator
PasteModeCursor 

Paste items at cursor position.

PasteModeCenter 

Paste items in center of view.

PasteModeInPlace 

Paste items in place.

Definition at line 76 of file qgslayoutview.h.

Constructor & Destructor Documentation

◆ QgsLayoutView()

QgsLayoutView::QgsLayoutView ( QWidget *  parent = nullptr)

Constructor for QgsLayoutView.

Definition at line 48 of file qgslayoutview.cpp.

◆ ~QgsLayoutView()

QgsLayoutView::~QgsLayoutView ( )
override

Definition at line 71 of file qgslayoutview.cpp.

Member Function Documentation

◆ alignSelectedItems()

void QgsLayoutView::alignSelectedItems ( QgsLayoutAligner::Alignment  alignment)

Aligns all selected items using the specified alignment.

See also
distributeSelectedItems()
resizeSelectedItems()

Definition at line 283 of file qgslayoutview.cpp.

◆ copyItems()

void QgsLayoutView::copyItems ( const QList< QgsLayoutItem * > &  items,
ClipboardOperation  operation 
)

Cuts or copies the a list of items, respecting the specified operation.

See also
copySelectedItems()
pasteItems()

Definition at line 315 of file qgslayoutview.cpp.

◆ copySelectedItems()

void QgsLayoutView::copySelectedItems ( QgsLayoutView::ClipboardOperation  operation)

Cuts or copies the selected items, respecting the specified operation.

See also
copyItems()
pasteItems()

Definition at line 310 of file qgslayoutview.cpp.

◆ currentLayout() [1/2]

QgsLayout* QgsLayoutView::currentLayout ( )

Returns the current layout associated with the view.

See also
setCurrentLayout()
layoutSet()

◆ currentLayout() [2/2]

const QgsLayout* QgsLayoutView::currentLayout ( ) const

Returns the current layout associated with the view.

See also
setCurrentLayout()
layoutSet()

◆ currentPage()

int QgsLayoutView::currentPage ( ) const
inline

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()

Definition at line 203 of file qgslayoutview.h.

◆ cursorPosChanged

void QgsLayoutView::cursorPosChanged ( QPointF  layoutPoint)
signal

Is emitted when the mouse cursor coordinates change within the view.

The layoutPoint argument indicates the cursor position within the layout coordinate system.

◆ deleteItems

void QgsLayoutView::deleteItems ( const QList< QgsLayoutItem * > &  items)
slot

Delete the specified items.

See also
deleteSelectedItems()

Definition at line 855 of file qgslayoutview.cpp.

◆ deleteSelectedItems

void QgsLayoutView::deleteSelectedItems ( )
slot

Deletes all selected items.

See also
deleteItems()

Definition at line 847 of file qgslayoutview.cpp.

◆ deltaForKeyEvent()

QPointF QgsLayoutView::deltaForKeyEvent ( QKeyEvent *  event)

Returns the delta (in layout coordinates) by which to move items for the given key event.

Definition at line 471 of file qgslayoutview.cpp.

◆ deselectAll

void QgsLayoutView::deselectAll ( )
slot

Deselects all items in the view.

See also
selectAll()
invertSelection()

Definition at line 622 of file qgslayoutview.cpp.

◆ distributeSelectedItems()

void QgsLayoutView::distributeSelectedItems ( QgsLayoutAligner::Distribution  distribution)

Distributes all selected items using the specified distribution.

See also
alignSelectedItems()
resizeSelectedItems()

Definition at line 292 of file qgslayoutview.cpp.

◆ dragEnterEvent()

void QgsLayoutView::dragEnterEvent ( QDragEnterEvent *  e)
overrideprotected

Definition at line 1134 of file qgslayoutview.cpp.

◆ emitZoomLevelChanged

void QgsLayoutView::emitZoomLevelChanged ( )
slot

Emits the zoomLevelChanged() signal.

This should be called after calling any of the QGraphicsView base class methods which alter the view's zoom level, i.e. QGraphicsView::fitInView().

Definition at line 585 of file qgslayoutview.cpp.

◆ groupSelectedItems

void QgsLayoutView::groupSelectedItems ( )
slot

Groups all selected items.

See also
ungroupSelectedItems()

Definition at line 873 of file qgslayoutview.cpp.

◆ hasItemsInClipboard()

bool QgsLayoutView::hasItemsInClipboard ( ) const

Returns true if the current clipboard contains layout items.

See also
pasteItems()

Definition at line 458 of file qgslayoutview.cpp.

◆ invertSelection

void QgsLayoutView::invertSelection ( )
slot

Inverts the current selection, selecting deselected items and deselecting and selected items.

See also
selectAll()
deselectAll()

Definition at line 632 of file qgslayoutview.cpp.

◆ itemFocused

void QgsLayoutView::itemFocused ( QgsLayoutItem item)
signal

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.

◆ keyPressEvent()

void QgsLayoutView::keyPressEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 1058 of file qgslayoutview.cpp.

◆ keyReleaseEvent()

void QgsLayoutView::keyReleaseEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 1107 of file qgslayoutview.cpp.

◆ layoutSet

void QgsLayoutView::layoutSet ( QgsLayout layout)
signal

Emitted when a layout is set for the view.

See also
currentLayout()
setCurrentLayout()

◆ lockSelectedItems

void QgsLayoutView::lockSelectedItems ( )
slot

Locks any selected items, preventing them from being interacted with by mouse interactions.

See also
unlockAllItems()

Definition at line 801 of file qgslayoutview.cpp.

◆ lowerSelectedItems

void QgsLayoutView::lowerSelectedItems ( )
slot

Lowers the selected items down the z-order.

See also
raiseSelectedItems()
moveSelectedItemsToTop()
moveSelectedItemsToBottom()

Definition at line 732 of file qgslayoutview.cpp.

◆ menuProvider()

QgsLayoutViewMenuProvider * QgsLayoutView::menuProvider ( ) const

Returns the provider for context menus.

Returned value may be nullptr if no provider is set.

See also
setMenuProvider()

Definition at line 256 of file qgslayoutview.cpp.

◆ mouseDoubleClickEvent()

void QgsLayoutView::mouseDoubleClickEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 1025 of file qgslayoutview.cpp.

◆ mouseMoveEvent()

void QgsLayoutView::mouseMoveEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 982 of file qgslayoutview.cpp.

◆ mousePressEvent()

void QgsLayoutView::mousePressEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 927 of file qgslayoutview.cpp.

◆ mouseReleaseEvent()

void QgsLayoutView::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 966 of file qgslayoutview.cpp.

◆ moveSelectedItemsToBottom

void QgsLayoutView::moveSelectedItemsToBottom ( )
slot

Lowers the selected items to the bottom of the z-order.

See also
raiseSelectedItems()
lowerSelectedItems()
moveSelectedItemsToTop()

Definition at line 778 of file qgslayoutview.cpp.

◆ moveSelectedItemsToTop

void QgsLayoutView::moveSelectedItemsToTop ( )
slot

Raises the selected items to the top of the z-order.

See also
raiseSelectedItems()
lowerSelectedItems()
moveSelectedItemsToBottom()

Definition at line 755 of file qgslayoutview.cpp.

◆ pageChanged

void QgsLayoutView::pageChanged ( int  page)
signal

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()

◆ paintEvent()

void QgsLayoutView::paintEvent ( QPaintEvent *  event)
overrideprotected

Definition at line 1142 of file qgslayoutview.cpp.

◆ pasteItems() [1/2]

QList< QgsLayoutItem *> QgsLayoutView::pasteItems ( QgsLayoutView::PasteMode  mode)

Pastes items from clipboard, using the specified mode.

A list of pasted items is returned.

See also
copySelectedItems()
hasItemsInClipboard()

Definition at line 394 of file qgslayoutview.cpp.

◆ pasteItems() [2/2]

QList< QgsLayoutItem * > QgsLayoutView::pasteItems ( QPointF  layoutPoint)

Pastes items from clipboard, at the specified layoutPoint, in layout units.

A list of pasted items is returned.

See also
copySelectedItems()
hasItemsInClipboard()

Definition at line 435 of file qgslayoutview.cpp.

◆ previewMode()

QgsPreviewEffect::PreviewMode QgsLayoutView::previewMode ( ) const

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()
previewModeEnabled()

Definition at line 183 of file qgslayoutview.cpp.

◆ previewModeEnabled()

bool QgsLayoutView::previewModeEnabled ( ) const

Returns true if a preview effect is being used to alter the view's appearance.

See also
setPreviewModeEnabled()

Definition at line 173 of file qgslayoutview.cpp.

◆ pushStatusMessage

void QgsLayoutView::pushStatusMessage ( const QString &  message)
slot

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()

Definition at line 1197 of file qgslayoutview.cpp.

◆ raiseSelectedItems

void QgsLayoutView::raiseSelectedItems ( )
slot

Raises the selected items up the z-order.

See also
lowerSelectedItems()
moveSelectedItemsToTop()
moveSelectedItemsToBottom()

Definition at line 709 of file qgslayoutview.cpp.

◆ resizeEvent()

void QgsLayoutView::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 1121 of file qgslayoutview.cpp.

◆ resizeSelectedItems()

void QgsLayoutView::resizeSelectedItems ( QgsLayoutAligner::Resize  resize)

Resizes all selected items using the specified resize mode.

See also
alignSelectedItems()
distributeSelectedItems()

Definition at line 301 of file qgslayoutview.cpp.

◆ scaleSafe()

void QgsLayoutView::scaleSafe ( double  scale)

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.

Definition at line 188 of file qgslayoutview.cpp.

◆ scrollContentsBy()

void QgsLayoutView::scrollContentsBy ( int  dx,
int  dy 
)
overrideprotected

Definition at line 1128 of file qgslayoutview.cpp.

◆ selectAll

void QgsLayoutView::selectAll ( )
slot

Selects all items in the view.

See also
deselectAll()
invertSelection()
selectNextItemAbove()
selectNextItemBelow()

Definition at line 590 of file qgslayoutview.cpp.

◆ selectNextItemAbove

void QgsLayoutView::selectNextItemAbove ( )
slot

Selects the next item above the existing selection, by item z order.

See also
selectNextItemBelow()
selectAll()
deselectAll()

Definition at line 699 of file qgslayoutview.cpp.

◆ selectNextItemBelow

void QgsLayoutView::selectNextItemBelow ( )
slot

Selects the next item below the existing selection, by item z order.

See also
selectNextItemAbove()
selectAll()
deselectAll()

Definition at line 704 of file qgslayoutview.cpp.

◆ setCurrentLayout()

void QgsLayoutView::setCurrentLayout ( QgsLayout layout)

Sets the current layout to edit in the view.

See also
currentLayout()
layoutSet()

Definition at line 86 of file qgslayoutview.cpp.

◆ setHorizontalRuler()

void QgsLayoutView::setHorizontalRuler ( QgsLayoutRuler ruler)

Sets a horizontal ruler to synchronize with the view state.

See also
setVerticalRuler()

Definition at line 223 of file qgslayoutview.cpp.

◆ setMenuProvider()

void QgsLayoutView::setMenuProvider ( QgsLayoutViewMenuProvider provider)

Sets a provider for context menus.

Ownership of the provider is transferred to the view.

See also
menuProvider()

Definition at line 251 of file qgslayoutview.cpp.

◆ setPaintingEnabled()

void QgsLayoutView::setPaintingEnabled ( bool  enabled)

Sets whether widget repainting should be allowed for the view.

This is used to temporarily halt painting while exporting layouts.

Note
Not available in Python bindings.

Definition at line 513 of file qgslayoutview.cpp.

◆ setPreviewMode()

void QgsLayoutView::setPreviewMode ( QgsPreviewEffect::PreviewMode  mode)

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()
previewMode()

Definition at line 178 of file qgslayoutview.cpp.

◆ setPreviewModeEnabled()

void QgsLayoutView::setPreviewModeEnabled ( bool  enabled)

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

Parameters
enabledSet to true to enable the preview effect on the view.
See also
setPreviewMode()

Definition at line 168 of file qgslayoutview.cpp.

◆ setSectionLabel()

void QgsLayoutView::setSectionLabel ( const QString &  label)

Sets a section label, to display above the first page shown in the view.

Definition at line 520 of file qgslayoutview.cpp.

◆ setTool()

void QgsLayoutView::setTool ( QgsLayoutViewTool tool)

Sets the tool currently being used in the view.

See also
unsetTool()
tool()

Definition at line 132 of file qgslayoutview.cpp.

◆ setVerticalRuler()

void QgsLayoutView::setVerticalRuler ( QgsLayoutRuler ruler)

Sets a vertical ruler to synchronize with the view state.

See also
setHorizontalRuler()

Definition at line 237 of file qgslayoutview.cpp.

◆ setZoomLevel()

void QgsLayoutView::setZoomLevel ( double  level)

Sets the zoom level for the view, where a zoom level of 1.0 corresponds to 100%.

Definition at line 198 of file qgslayoutview.cpp.

◆ statusMessage

void QgsLayoutView::statusMessage ( const QString &  message)
signal

Emitted when the view has a message for display in a parent window's status bar.

See also
pushStatusMessage()

◆ tool()

QgsLayoutViewTool* QgsLayoutView::tool ( )

Returns the currently active tool for the view.

See also
setTool()

◆ toolSet

void QgsLayoutView::toolSet ( QgsLayoutViewTool tool)
signal

Emitted when the current tool is changed.

See also
setTool()

◆ ungroupSelectedItems

void QgsLayoutView::ungroupSelectedItems ( )
slot

Ungroups all selected items.

See also
groupSelectedItems()

Definition at line 898 of file qgslayoutview.cpp.

◆ unlockAllItems

void QgsLayoutView::unlockAllItems ( )
slot

Unlocks all locked items in the layout.

See also
lockSelectedItems()

Definition at line 817 of file qgslayoutview.cpp.

◆ unsetTool()

void QgsLayoutView::unsetTool ( QgsLayoutViewTool tool)

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.

Definition at line 158 of file qgslayoutview.cpp.

◆ viewChanged

void QgsLayoutView::viewChanged ( )
slot

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().

Definition at line 1170 of file qgslayoutview.cpp.

◆ visiblePageNumbers()

QList< int > QgsLayoutView::visiblePageNumbers ( ) const

Returns a list of page numbers for pages which are currently visible in the view.

See also
visiblePages()

Definition at line 272 of file qgslayoutview.cpp.

◆ visiblePages()

QList< QgsLayoutItemPage * > QgsLayoutView::visiblePages ( ) const

Returns a list of page items which are currently visible in the view.

See also
visiblePageNumbers()

Definition at line 261 of file qgslayoutview.cpp.

◆ wheelEvent()

void QgsLayoutView::wheelEvent ( QWheelEvent *  event)
overrideprotected

Definition at line 1041 of file qgslayoutview.cpp.

◆ willBeDeleted

void QgsLayoutView::willBeDeleted ( )
signal

Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state.

◆ zoomActual

void QgsLayoutView::zoomActual ( )
slot

Zooms to the actual size of the layout.

See also
zoomFull()
zoomIn()
zoomOut()

Definition at line 580 of file qgslayoutview.cpp.

◆ zoomFull

void QgsLayoutView::zoomFull ( )
slot

Zooms the view to the full extent of the layout.

See also
zoomIn()
zoomOut()
zoomActual()

Definition at line 535 of file qgslayoutview.cpp.

◆ zoomIn

void QgsLayoutView::zoomIn ( )
slot

Zooms in to the view by a preset amount.

See also
zoomFull()
zoomOut()
zoomActual()

Definition at line 570 of file qgslayoutview.cpp.

◆ zoomLevelChanged

void QgsLayoutView::zoomLevelChanged ( )
signal

Is emitted whenever the zoom level of the view is changed.

◆ zoomOut

void QgsLayoutView::zoomOut ( )
slot

Zooms out of the view by a preset amount.

See also
zoomFull()
zoomIn()
zoomActual()

Definition at line 575 of file qgslayoutview.cpp.

◆ zoomWidth

void QgsLayoutView::zoomWidth ( )
slot

Zooms the view to the full width of the layout.

See also
zoomIn()
zoomOut()
zoomActual()

Definition at line 545 of file qgslayoutview.cpp.

Friends And Related Function Documentation

◆ QgsLayoutMouseHandles

friend class QgsLayoutMouseHandles
friend

Definition at line 582 of file qgslayoutview.h.

◆ TestQgsLayoutView

friend class TestQgsLayoutView
friend

Definition at line 581 of file qgslayoutview.h.

Property Documentation

◆ currentLayout

const QgsLayout * QgsLayoutView::currentLayout
readwrite

Definition at line 63 of file qgslayoutview.h.

◆ tool

QgsLayoutViewTool * QgsLayoutView::tool
readwrite

Definition at line 64 of file qgslayoutview.h.


The documentation for this class was generated from the following files: