37#include "moc_qgslayoutview.cpp"
44#define MIN_VIEW_SCALE 0.05
45#define MAX_VIEW_SCALE 1000.0
48 : QGraphicsView( parent )
50 setResizeAnchor( QGraphicsView::AnchorViewCenter );
51 setMouseTracking(
true );
52 viewport()->setMouseTracking(
true );
58 viewport()->setStyleSheet( QStringLiteral(
"background-color:#d7d7d7;" ) );
65 viewport()->setGraphicsEffect( mPreviewEffect );
79 return qobject_cast<QgsLayout *>( scene() );
84 return qobject_cast<const QgsLayout *>( scene() );
98 mSnapMarker =
new QgsLayoutViewSnapMarker();
100 layout->addItem( mSnapMarker );
101 mHorizontalSnapLine = createSnapLine();
102 mHorizontalSnapLine->hide();
103 layout->addItem( mHorizontalSnapLine );
104 mVerticalSnapLine = createSnapLine();
105 mVerticalSnapLine->hide();
106 layout->addItem( mVerticalSnapLine );
107 mSectionLabel =
nullptr;
109 if ( mHorizontalRuler )
111 connect( &layout->
guides(), &QAbstractItemModel::dataChanged, mHorizontalRuler, [ = ] { mHorizontalRuler->update(); } );
112 connect( &layout->
guides(), &QAbstractItemModel::rowsInserted, mHorizontalRuler, [ = ] { mHorizontalRuler->update(); } );
113 connect( &layout->
guides(), &QAbstractItemModel::rowsRemoved, mHorizontalRuler, [ = ] { mHorizontalRuler->update(); } );
114 connect( &layout->
guides(), &QAbstractItemModel::modelReset, mHorizontalRuler, [ = ] { mHorizontalRuler->update(); } );
116 if ( mVerticalRuler )
118 connect( &layout->
guides(), &QAbstractItemModel::dataChanged, mVerticalRuler, [ = ] { mVerticalRuler->update(); } );
119 connect( &layout->
guides(), &QAbstractItemModel::rowsInserted, mVerticalRuler, [ = ] { mVerticalRuler->update(); } );
120 connect( &layout->
guides(), &QAbstractItemModel::rowsRemoved, mVerticalRuler, [ = ] { mVerticalRuler->update(); } );
121 connect( &layout->
guides(), &QAbstractItemModel::modelReset, mVerticalRuler, [ = ] { mVerticalRuler->update(); } );
146 if ( mHorizontalSnapLine )
147 mHorizontalSnapLine->hide();
148 if ( mVerticalSnapLine )
149 mVerticalSnapLine->hide();
161 if ( mTool && mTool ==
tool )
165 setCursor( Qt::ArrowCursor );
171 mPreviewEffect->setEnabled( enabled );
176 return mPreviewEffect->isEnabled();
181 mPreviewEffect->
setMode( mode );
186 return mPreviewEffect->
mode();
191 double currentScale = transform().m11();
192 scale *= currentScale;
194 setTransform( QTransform::fromScale( scale, scale ) );
206 setTransform( QTransform::fromScale( level, level ) );
210 const double dpi = mScreenHelper->
screenDpi();
215 setTransform( QTransform::fromScale( mmLevel, mmLevel ) );
223 mHorizontalRuler = ruler;
227 connect( &layout->guides(), &QAbstractItemModel::dataChanged, ruler, [ = ] { mHorizontalRuler->update(); } );
228 connect( &layout->guides(), &QAbstractItemModel::rowsInserted, ruler, [ = ] { mHorizontalRuler->update(); } );
229 connect( &layout->guides(), &QAbstractItemModel::rowsRemoved, ruler, [ = ] { mHorizontalRuler->update(); } );
230 connect( &layout->guides(), &QAbstractItemModel::modelReset, ruler, [ = ] { mHorizontalRuler->update(); } );
237 mVerticalRuler = ruler;
241 connect( &layout->guides(), &QAbstractItemModel::dataChanged, ruler, [ = ] { mVerticalRuler->update(); } );
242 connect( &layout->guides(), &QAbstractItemModel::rowsInserted, ruler, [ = ] { mVerticalRuler->update(); } );
243 connect( &layout->guides(), &QAbstractItemModel::rowsRemoved, ruler, [ = ] { mVerticalRuler->update(); } );
244 connect( &layout->guides(), &QAbstractItemModel::modelReset, ruler, [ = ] { mVerticalRuler->update(); } );
251 mMenuProvider.reset( provider );
256 return mMenuProvider.get();
262 return QList< QgsLayoutItemPage *>();
265 QRect viewportRect( 0, 0, viewport()->width(), viewport()->height() );
266 QRectF visibleRect = mapToScene( viewportRect ).boundingRect();
273 return QList< int >();
276 QRect viewportRect( 0, 0, viewport()->width(), viewport()->height() );
277 QRectF visibleRect = mapToScene( viewportRect ).boundingRect();
320 QDomElement documentElement = doc.createElement( QStringLiteral(
"LayoutItemClipboard" ) );
324 QSet< QgsLayoutMultiFrame * > copiedMultiFrames;
331 const QList<QgsLayoutItem *> groupedItems = itemGroup->items();
334 groupedItem->writeXml( documentElement, doc, context );
337 else if (
QgsLayoutFrame *frame = qobject_cast<QgsLayoutFrame *>( item ) )
340 if ( frame->multiFrame() && !copiedMultiFrames.contains( frame->multiFrame() ) )
342 frame->multiFrame()->writeXml( documentElement, doc, context );
343 copiedMultiFrames.insert( frame->multiFrame() );
346 item->writeXml( documentElement, doc, context );
350 doc.appendChild( documentElement );
358 QDomNodeList itemsNodes = doc.elementsByTagName( QStringLiteral(
"LayoutItem" ) );
359 for (
int i = 0; i < itemsNodes.count(); ++i )
361 QDomNode itemNode = itemsNodes.at( i );
362 if ( itemNode.isElement() )
364 itemNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
365 itemNode.toElement().removeAttribute( QStringLiteral(
"groupUuid" ) );
368 QDomNodeList multiFrameNodes = doc.elementsByTagName( QStringLiteral(
"LayoutMultiFrame" ) );
369 for (
int i = 0; i < multiFrameNodes.count(); ++i )
371 QDomNode multiFrameNode = multiFrameNodes.at( i );
372 if ( multiFrameNode.isElement() )
374 multiFrameNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
375 QDomNodeList frameNodes = multiFrameNode.toElement().elementsByTagName( QStringLiteral(
"childFrame" ) );
376 for (
int j = 0; j < frameNodes.count(); ++j )
378 QDomNode itemNode = frameNodes.at( j );
379 if ( itemNode.isElement() )
381 itemNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
387 QMimeData *mimeData =
new QMimeData;
388 mimeData->setData( QStringLiteral(
"text/xml" ), doc.toByteArray() );
389 QClipboard *clipboard = QApplication::clipboard();
390 clipboard->setMimeData( mimeData );
396 return QList< QgsLayoutItem * >();
398 QList< QgsLayoutItem * > pastedItems;
400 QClipboard *clipboard = QApplication::clipboard();
401 if ( doc.setContent( clipboard->mimeData()->data( QStringLiteral(
"text/xml" ) ) ) )
403 QDomElement docElem = doc.documentElement();
404 if ( docElem.tagName() == QLatin1String(
"LayoutItemClipboard" ) )
413 pt = mapToScene( mapFromGlobal( QCursor::pos() ) );
419 pt = mapToScene( viewport()->rect().center() );
437 return QList<QgsLayoutItem *>();
439 QList< QgsLayoutItem * > pastedItems;
441 QClipboard *clipboard = QApplication::clipboard();
442 if ( doc.setContent( clipboard->mimeData()->data( QStringLiteral(
"text/xml" ) ) ) )
444 QDomElement docElem = doc.documentElement();
445 if ( docElem.tagName() == QLatin1String(
"LayoutItemClipboard" ) )
460 QClipboard *clipboard = QApplication::clipboard();
461 if ( doc.setContent( clipboard->mimeData()->data( QStringLiteral(
"text/xml" ) ) ) )
463 QDomElement docElem = doc.documentElement();
464 if ( docElem.tagName() == QLatin1String(
"LayoutItemClipboard" ) )
473 double increment = 1.0;
474 if ( event->modifiers() & Qt::ShiftModifier )
479 else if ( event->modifiers() & Qt::AltModifier )
482 double viewScale = transform().m11();
485 increment = 1 / viewScale;
491 switch ( event->key() )
509 return QPointF( deltaX, deltaY );
514 mPaintingEnabled = enabled;
524 if ( !mSectionLabel )
526 mSectionLabel =
new QgsLayoutReportSectionLabel(
currentLayout(),
this );
528 mSectionLabel->setRect( 0, -200, 1000, 200 );
529 mSectionLabel->setZValue( -1 );
531 mSectionLabel->setLabel( label );
539 fitInView( scene()->sceneRect(), Qt::KeepAspectRatio );
550 QRect viewportRect( 0, 0, viewport()->width(), viewport()->height() );
551 QRectF visibleRect = mapToScene( viewportRect ).boundingRect();
553 double verticalCenter = ( visibleRect.top() + visibleRect.bottom() ) / 2.0;
558 const double tinyHeight = 0.01;
559 QRectF targetRect( scene()->sceneRect().left(),
560 verticalCenter - tinyHeight,
561 scene()->sceneRect().width(),
564 fitInView( targetRect, Qt::KeepAspectRatio );
598 const QList<QGraphicsItem *> itemList =
currentLayout()->items();
599 for ( QGraphicsItem *graphicsItem : itemList )
603 if ( item && !paperItem )
640 const QList<QGraphicsItem *> itemList =
currentLayout()->items();
641 for ( QGraphicsItem *graphicsItem : itemList )
645 if ( item && !paperItem )
648 if ( item->isSelected() || item->
isLocked() )
672 if ( !selectedItems.isEmpty() )
674 previousSelectedItem = selectedItems.at( 0 );
677 if ( !previousSelectedItem )
685 selectedItem = layout->
itemsModel()->findItemBelow( previousSelectedItem );
687 selectedItem = layout->
itemsModel()->findItemAbove( previousSelectedItem );
714 bool itemsRaised =
false;
737 bool itemsLowered =
false;
760 bool itemsRaised =
false;
783 bool itemsLowered =
false;
809 item->setLocked(
true );
829 const QList<QGraphicsItem *> itemList =
currentLayout()->items();
830 for ( QGraphicsItem *graphicItem : itemList )
904 QList< QgsLayoutItem * > ungroupedItems;
916 if ( !ungroupedItems.empty() )
918 for (
QgsLayoutItem *item : std::as_const( ungroupedItems ) )
932 mSnapMarker->setVisible(
false );
937 mTool->layoutPressEvent( me.get() );
938 event->setAccepted( me->isAccepted() );
941 if ( !mTool || !event->isAccepted() )
943 if ( event->button() == Qt::MiddleButton )
946 setTool( mMidMouseButtonPanTool );
949 else if ( event->button() == Qt::RightButton && mMenuProvider )
951 QMenu *menu = mMenuProvider->createContextMenu(
this,
currentLayout(), mapToScene( event->pos() ) );
954 menu->exec( event->globalPos() );
960 QGraphicsView::mousePressEvent( event );
973 mTool->layoutReleaseEvent( me.get() );
974 event->setAccepted( me->isAccepted() );
977 if ( !mTool || !event->isAccepted() )
978 QGraphicsView::mouseReleaseEvent( event );
986 mMouseCurrentXY =
event->pos();
988 QPointF cursorPos = mapToScene( mMouseCurrentXY );
994 me->snapPoint( mHorizontalSnapLine, mVerticalSnapLine, mTool->ignoredSnapItems() );
999 if ( me->isSnapped() )
1001 cursorPos = me->snappedPoint();
1004 mSnapMarker->setPos( me->snappedPoint() );
1005 mSnapMarker->setVisible(
true );
1008 else if ( mSnapMarker )
1010 mSnapMarker->setVisible(
false );
1013 mTool->layoutMoveEvent( me.get() );
1014 event->setAccepted( me->isAccepted() );
1020 if ( !mTool || !event->isAccepted() )
1021 QGraphicsView::mouseMoveEvent( event );
1032 mTool->layoutDoubleClickEvent( me.get() );
1033 event->setAccepted( me->isAccepted() );
1036 if ( !mTool || !event->isAccepted() )
1037 QGraphicsView::mouseDoubleClickEvent( event );
1047 mTool->wheelEvent( event );
1050 if ( !mTool || !event->isAccepted() )
1064 mTool->keyPressEvent( event );
1067 if ( mTool && event->isAccepted() )
1070 if ( event->key() == Qt::Key_Space && ! event->isAutoRepeat() )
1072 if ( !( event->modifiers() & Qt::ControlModifier ) )
1084 else if ( event->key() == Qt::Key_Left
1085 || event->key() == Qt::Key_Right
1086 || event->key() == Qt::Key_Up
1087 || event->key() == Qt::Key_Down )
1098 item->attemptMoveBy( delta.x(), delta.y() );
1113 mTool->keyReleaseEvent( event );
1116 if ( !mTool || !event->isAccepted() )
1117 QGraphicsView::keyReleaseEvent( event );
1122 QGraphicsView::resizeEvent( event );
1129 QGraphicsView::scrollContentsBy( dx, dy );
1143 if ( mPaintingEnabled )
1145 QGraphicsView::paintEvent( event );
1154void QgsLayoutView::invalidateCachedRenders()
1160 QList< QgsLayoutItem *> items;
1165 item->invalidateCache();
1171 if ( mHorizontalRuler )
1175 if ( mVerticalRuler )
1181 QRect viewportRect( 0, 0, viewport()->width(), viewport()->height() );
1182 QRectF visibleRect = mapToScene( viewportRect ).boundingRect();
1183 QPointF centerVisible = visibleRect.center();
1188 if ( newPage != mCurrentPage )
1190 mCurrentPage = newPage;
1201void QgsLayoutView::wheelZoom( QWheelEvent *event )
1205 double zoomFactor = settings.
value( QStringLiteral(
"qgis/zoom_factor" ), 2 ).toDouble();
1206 bool reverseZoom = settings.
value( QStringLiteral(
"qgis/reverse_wheel_zoom" ),
false ).toBool();
1207 bool zoomIn = reverseZoom ?
event->angleDelta().y() < 0 :
event->angleDelta().y() > 0;
1210 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 120.0 * std::fabs( event->angleDelta().y() );
1212 if ( event->modifiers() & Qt::ControlModifier )
1215 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 20.0;
1219 double scaleFactor = (
zoomIn ? 1 / zoomFactor : zoomFactor );
1222 QRect viewportRect( 0, 0, viewport()->width(), viewport()->height() );
1226#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
1227 QPointF scenePoint = mapToScene( event->pos() );
1229 QPointF scenePoint = mapToScene( event->position().x(), event->position().y() );
1234 QgsPointXY newCenter( scenePoint.x() + ( ( oldCenter.x() - scenePoint.x() ) * scaleFactor ),
1235 scenePoint.y() + ( ( oldCenter.y() - scenePoint.y() ) * scaleFactor ) );
1236 centerOn( newCenter.x(), newCenter.y() );
1249QGraphicsLineItem *QgsLayoutView::createSnapLine()
const
1251 std::unique_ptr< QGraphicsLineItem> item(
new QGraphicsLineItem(
nullptr ) );
1252 QPen pen = QPen( QColor( Qt::blue ) );
1253 pen.setStyle( Qt::DotLine );
1254 pen.setWidthF( 0.0 );
1255 item->setPen( pen );
1257 return item.release();
1265QgsLayoutViewSnapMarker::QgsLayoutViewSnapMarker()
1266 : QGraphicsRectItem( QRectF( 0, 0, 0, 0 ) )
1269 QFontMetrics fm( f );
1270 mSize = fm.horizontalAdvance(
'X' );
1271 setPen( QPen( Qt::transparent, mSize ) );
1273 setFlags( flags() | QGraphicsItem::ItemIgnoresTransformations );
1277void QgsLayoutViewSnapMarker::paint( QPainter *p,
const QStyleOptionGraphicsItem *, QWidget * )
1279 QPen pen( QColor( 255, 0, 0 ) );
1282 p->setBrush( Qt::NoBrush );
1284 double halfSize = mSize / 2.0;
1285 p->drawLine( QLineF( -halfSize, -halfSize, halfSize, halfSize ) );
1286 p->drawLine( QLineF( -halfSize, halfSize, halfSize, -halfSize ) );
@ Millimeters
Millimeters.
Alignment
Alignment options.
static void alignItems(QgsLayout *layout, const QList< QgsLayoutItem * > &items, Alignment alignment)
Aligns a set of items from a layout in place.
static void distributeItems(QgsLayout *layout, const QList< QgsLayoutItem * > &items, Distribution distribution)
Distributes a set of items from a layout in place.
static void resizeItems(QgsLayout *layout, const QList< QgsLayoutItem * > &items, Resize resize)
Resizes a set of items from a layout in place.
Distribution
Distribution options.
Base class for frame items, which form a layout multiframe item.
A container for grouping several QgsLayoutItems.
Item representing the paper in a layout.
@ LayoutGroup
Grouped item.
Base class for graphical items within a QgsLayout.
@ UndoIncrementalMove
Layout item incremental movement, e.g. as a result of a keypress.
virtual void setSelected(bool selected)
Sets whether the item should be selected.
bool isLocked() const
Returns true if the item is locked, and cannot be interacted with using the mouse.
void setLocked(bool locked)
Sets whether the item is locked, preventing mouse interactions with the item.
double length() const
Returns the length of the measurement.
QList< int > visiblePageNumbers(const QRectF ®ion) const
Returns a list of the page numbers which are visible within the specified region (in layout coordinat...
void changed()
Emitted when pages are added or removed from the collection.
int pageNumberForPoint(QPointF point) const
Returns the page number corresponding to a point in the layout (in layout units).
QList< QgsLayoutItemPage * > visiblePages(const QRectF ®ion) const
Returns a list of the pages which are visible within the specified region (in layout coordinates).
A custom ruler widget for use with QgsLayoutView, displaying the current zoom and position of the vis...
void setSceneTransform(const QTransform &transform)
Sets the current scene transform.
void setLayoutView(QgsLayoutView *view)
Sets the current layout view to synchronize the ruler with.
void endCommand()
Saves final state of an object and pushes the active command to the undo history.
void beginMacro(const QString &commandText)
Starts a macro command, with the given descriptive commandText.
void beginCommand(QgsLayoutUndoObjectInterface *object, const QString &commandText, int id=0)
Begins a new undo command for the specified object.
void endMacro()
Ends a macro command.
A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView.
void alignSelectedItems(QgsLayoutAligner::Alignment alignment)
Aligns all selected items using the specified alignment.
void zoomFull()
Zooms the view to the full extent of the layout.
void selectNextItemBelow()
Selects the next item below the existing selection, by item z order.
QgsLayoutView(QWidget *parent=nullptr)
Constructor for QgsLayoutView.
void moveSelectedItemsToBottom()
Lowers the selected items to the bottom of the z-order.
void pushStatusMessage(const QString &message)
Pushes a new status bar message to the view.
void viewChanged()
Updates associated rulers and other widgets after view extent or zoom has changed.
void cursorPosChanged(QPointF layoutPoint)
Emitted when the mouse cursor coordinates change within the view.
@ PasteModeCenter
Paste items in center of view.
@ PasteModeInPlace
Paste items in place.
@ PasteModeCursor
Paste items at cursor position.
void unlockAllItems()
Unlocks all locked items in the layout.
void deleteSelectedItems()
Deletes all selected items.
void mouseMoveEvent(QMouseEvent *event) override
QgsLayout * currentLayout
void setMenuProvider(QgsLayoutViewMenuProvider *provider)
Sets a provider for context menus.
void dragEnterEvent(QDragEnterEvent *e) override
void resizeEvent(QResizeEvent *event) override
void lowerSelectedItems()
Lowers the selected items down the z-order.
void setPaintingEnabled(bool enabled)
Sets whether widget repainting should be allowed for the view.
void mouseReleaseEvent(QMouseEvent *event) override
QgsPreviewEffect::PreviewMode previewMode() const
Returns the preview mode which may be used to modify the view's appearance.
void lockSelectedItems()
Locks any selected items, preventing them from being interacted with by mouse interactions.
void setSectionLabel(const QString &label)
Sets a section label, to display above the first page shown in the view.
void resizeSelectedItems(QgsLayoutAligner::Resize resize)
Resizes all selected items using the specified resize mode.
void setTool(QgsLayoutViewTool *tool)
Sets the tool currently being used in the view.
void zoomLevelChanged()
Emitted whenever the zoom level of the view is changed.
void deleteItems(const QList< QgsLayoutItem * > &items)
Delete the specified items.
void selectAll()
Selects all items in the view.
QList< QgsLayoutItem * > pasteItems(PasteMode mode)
Pastes items from clipboard, using the specified mode.
void willBeDeleted()
Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid sta...
QPointF deltaForKeyEvent(QKeyEvent *event)
Returns the delta (in layout coordinates) by which to move items for the given key event.
void setHorizontalRuler(QgsLayoutRuler *ruler)
Sets a horizontal ruler to synchronize with the view state.
~QgsLayoutView() override
void setPreviewMode(QgsPreviewEffect::PreviewMode mode)
Sets the preview mode which should be used to modify the view's appearance.
void deselectAll()
Deselects all items in the view.
void keyPressEvent(QKeyEvent *event) override
void zoomWidth()
Zooms the view to the full width of the layout.
void raiseSelectedItems()
Raises the selected items up the z-order.
void statusMessage(const QString &message)
Emitted when the view has a message for display in a parent window's status bar.
void itemFocused(QgsLayoutItem *item)
Emitted when an item is "focused" in the view, i.e.
void selectNextItemAbove()
Selects the next item above the existing selection, by item z order.
void moveSelectedItemsToTop()
Raises the selected items to the top of the z-order.
bool hasItemsInClipboard() const
Returns true if the current clipboard contains layout items.
void zoomActual()
Zooms to the actual size of the layout.
void setPreviewModeEnabled(bool enabled)
Sets whether a preview effect should be used to alter the view's appearance.
void layoutSet(QgsLayout *layout)
Emitted when a layout is set for the view.
void setCurrentLayout(QgsLayout *layout)
Sets the current layout to edit in the view.
void wheelEvent(QWheelEvent *event) override
ClipboardOperation
Clipboard operations.
void ungroupSelectedItems()
Ungroups all selected items.
void emitZoomLevelChanged()
Emits the zoomLevelChanged() signal.
bool previewModeEnabled() const
Returns true if a preview effect is being used to alter the view's appearance.
void zoomOut()
Zooms out of the view by a preset amount.
void setVerticalRuler(QgsLayoutRuler *ruler)
Sets a vertical ruler to synchronize with the view state.
QList< QgsLayoutItemPage * > visiblePages() const
Returns a list of page items which are currently visible in the view.
void copyItems(const QList< QgsLayoutItem * > &items, ClipboardOperation operation)
Cuts or copies the a list of items, respecting the specified operation.
void setZoomLevel(double level)
Sets the zoom level for the view, where a zoom level of 1.0 corresponds to 100%.
void distributeSelectedItems(QgsLayoutAligner::Distribution distribution)
Distributes all selected items using the specified distribution.
void unsetTool(QgsLayoutViewTool *tool)
Unsets the current view tool, if it matches the specified tool.
void invertSelection()
Inverts the current selection, selecting deselected items and deselecting and selected items.
void toolSet(QgsLayoutViewTool *tool)
Emitted when the current tool is changed.
void mouseDoubleClickEvent(QMouseEvent *event) override
void scaleSafe(double scale)
Scales the view in a safe way, by limiting the acceptable range of the scale applied.
void pageChanged(int page)
Emitted when the page visible in the view is changed.
void scrollContentsBy(int dx, int dy) override
void copySelectedItems(ClipboardOperation operation)
Cuts or copies the selected items, respecting the specified operation.
void zoomIn()
Zooms in to the view by a preset amount.
void paintEvent(QPaintEvent *event) override
void keyReleaseEvent(QKeyEvent *event) override
QgsLayoutViewMenuProvider * menuProvider() const
Returns the provider for context menus.
QList< int > visiblePageNumbers() const
Returns a list of page numbers for pages which are currently visible in the view.
void groupSelectedItems()
Groups all selected items.
void mousePressEvent(QMouseEvent *event) override
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QgsLayoutModel * itemsModel()
Returns the items model attached to the layout.
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
QgsLayoutGuideCollection & guides()
Returns a reference to the layout's guide collection, which manages page snap guides.
QList< QgsLayoutItem * > ungroupItems(QgsLayoutItemGroup *group)
Ungroups items by removing them from an item group and removing the group from the layout.
bool moveItemToTop(QgsLayoutItem *item, bool deferUpdate=false)
Raises an item up to the top of the z-order.
bool moveItemToBottom(QgsLayoutItem *item, bool deferUpdate=false)
Lowers an item down to the bottom of the z-order.
QgsLayoutItemGroup * groupItems(const QList< QgsLayoutItem * > &items)
Creates a new group from a list of layout items and adds the group to the layout.
QList< QgsLayoutItem * > addItemsFromXml(const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context, QPointF *position=nullptr, bool pasteInPlace=false)
Add items from an XML representation to the layout.
bool lowerItem(QgsLayoutItem *item, bool deferUpdate=false)
Lowers an item down the z-order.
QgsLayoutMeasurement convertFromLayoutUnits(double length, Qgis::LayoutUnit unit) const
Converts a length measurement from the layout's native units to a specified target unit.
bool raiseItem(QgsLayoutItem *item, bool deferUpdate=false)
Raises an item up the z-order.
QList< QgsLayoutItem * > selectedLayoutItems(bool includeLockedItems=true)
Returns list of selected layout items.
void selectedItemChanged(QgsLayoutItem *selected)
Emitted whenever the selected item changes.
void deselectAll()
Clears any selected items in the layout.
void setSelectedItem(QgsLayoutItem *item)
Clears any selected items and sets item as the current selection.
void removeLayoutItem(QgsLayoutItem *item)
Removes an item from the layout.
void updateZValues(bool addUndoCommands=true)
Resets the z-values of items based on their position in the internal z order list.
@ ZSmartGuide
Z-value for smart (item bounds based) guides.
@ ZSnapIndicator
Z-value for snapping indicator.
QgsProject * project() const
The project associated with the layout.
QgsLayoutUndoStack * undoStack()
Returns a pointer to the layout's undo stack, which manages undo/redo states for the layout and it's ...
A class to represent a 2D point.
A graphics effect which can be applied to a widget to simulate various printing and color blindness m...
void setMode(PreviewMode mode)
Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance.
PreviewMode mode() const
Returns the mode used for the preview effect.
void setDirty(bool b=true)
Flag the project as dirty (modified).
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
QgsPointXY center() const
Returns the center point of the rectangle.
A utility class for dynamic handling of changes to screen properties.
double screenDpi() const
Returns the current screen DPI for the screen that the parent widget appears on.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void selectNextByZOrder(QgsLayout *layout, bool above)