50 , mGridSettings( this )
55 setBackgroundBrush( Qt::NoBrush );
62 mUndoStack->blockCommands(
true );
64 deleteAndRemoveMultiFrames();
72 QList<QGraphicsItem *> itemList = items();
77 for ( QGraphicsItem *item : std::as_const( itemList ) )
94 QDomDocument currentDoc;
97 QDomElement elem =
writeXml( currentDoc, context );
98 currentDoc.appendChild( elem );
100 std::unique_ptr< QgsLayout > newLayout = std::make_unique< QgsLayout >( mProject );
102 newLayout->loadFromTemplate( currentDoc, context,
true, &ok );
108 return newLayout.release();
116 mPageCollection->addPage( page );
117 mUndoStack->stack()->clear();
122 deleteAndRemoveMultiFrames();
125 const QList<QGraphicsItem *> itemList = items();
126 for ( QGraphicsItem *item : itemList )
130 if ( cItem && !pItem )
132 removeLayoutItemPrivate( cItem );
135 mItemsModel->clear();
137 mPageCollection->clear();
138 mUndoStack->stack()->clear();
148 return mItemsModel.get();
153 QList<QgsLayoutItem *> layoutItemList;
155 const QList<QGraphicsItem *> graphicsItemList = selectedItems();
156 for ( QGraphicsItem *item : graphicsItemList )
159 if ( layoutItem && ( includeLockedItems || !layoutItem->
isLocked() ) )
161 layoutItemList.push_back( layoutItem );
165 return layoutItemList;
184 const QList<QGraphicsItem *> selectedItemList = selectedItems();
185 for ( QGraphicsItem *item : selectedItemList )
189 layoutItem->setSelected(
false );
198 bool result = mItemsModel->reorderItemUp( item );
199 if ( result && !deferUpdate )
211 bool result = mItemsModel->reorderItemDown( item );
212 if ( result && !deferUpdate )
224 bool result = mItemsModel->reorderItemToTop( item );
225 if ( result && !deferUpdate )
237 bool result = mItemsModel->reorderItemToBottom( item );
238 if ( result && !deferUpdate )
249 QList<QgsLayoutItem *> itemList;
253 if ( item->uuid() == uuid )
255 else if ( includeTemplateUuids && item->mTemplateUuid == uuid )
264 QList<QgsLayoutItem *> itemList;
268 if ( item->mTemplateUuid == uuid )
277 const QList<QGraphicsItem *> itemList = items();
278 for ( QGraphicsItem *item : itemList )
281 if ( layoutItem && layoutItem->
id() == id )
293 if ( mf->uuid() == uuid )
295 else if ( includeTemplateUuids && mf->mTemplateUuid == uuid )
304 return layoutItemAt( position,
nullptr, ignoreLocked, searchTolerance );
310 QList<QGraphicsItem *> itemList;
311 if ( searchTolerance == 0 )
313 itemList = items( position, Qt::IntersectsItemShape, Qt::DescendingOrder );
317 itemList = items( QRectF( position.x() - searchTolerance, position.y() - searchTolerance, 2 * searchTolerance, 2 * searchTolerance ), Qt::IntersectsItemShape, Qt::DescendingOrder );
320 bool foundBelowItem =
false;
321 for ( QGraphicsItem *graphicsItem : std::as_const( itemList ) )
325 if ( layoutItem && !paperItem )
329 if ( ( ! belowItem || foundBelowItem ) && ( !ignoreLocked || !layoutItem->
isLocked() ) )
334 return layoutItemAt( position, layoutItem, ignoreLocked, searchTolerance );
341 if ( layoutItem == belowItem )
344 foundBelowItem =
true;
384 return *mRenderContext;
389 return *mRenderContext;
394 return *mReportContext;
399 return *mReportContext;
405 mPageCollection->redraw();
410 return mPageCollection->guides();
415 return mPageCollection->guides();
423 if ( mReportContext->
layer() )
432 mCustomProperties.
setValue( key, value );
434 if ( key.startsWith( QLatin1String(
"variable" ) ) )
440 return mCustomProperties.
value( key, defaultValue );
445 mCustomProperties.
remove( key );
450 return mCustomProperties.
keys();
460 QList< QgsLayoutItemMap * > maps;
463 double largestMapArea = 0;
466 double area = map->rect().width() * map->rect().height();
467 if ( area > largestMapArea )
469 largestMapArea = area;
478 mWorldFileMapId = map ? map->
uuid() : QString();
484 return mPageCollection.get();
489 return mPageCollection.get();
498 const auto constItems = items();
499 for (
const QGraphicsItem *item : constItems )
506 if ( !isPage || !ignorePages )
514 itemBounds = layoutItem->mapToScene( layoutItem->rect() ).boundingRect();
517 itemBounds = item->sceneBoundingRect();
519 if ( bounds.isValid() )
520 bounds = bounds.united( itemBounds );
526 if ( bounds.isValid() && margin > 0.0 )
529 double maxWidth = mPageCollection->maximumPageWidth();
530 bounds.adjust( -maxWidth * margin, -maxWidth * margin, maxWidth * margin, maxWidth * margin );
543 const QList<QGraphicsItem *> itemList = items();
544 for ( QGraphicsItem *item : itemList )
549 if ( visibleOnly && !layoutItem->isVisible() )
553 if ( bounds.isValid() )
554 bounds = bounds.united( item->sceneBoundingRect() );
556 bounds = item->sceneBoundingRect();
565 addLayoutItemPrivate( item );
569 undoText = tr(
"Create %1" ).arg( metadata->visibleName() );
573 undoText = tr(
"Create Item" );
575 if ( !mUndoStack->isBlocked() )
581 std::unique_ptr< QgsLayoutItemDeleteUndoCommand > deleteCommand;
582 if ( !mUndoStack->isBlocked() )
584 mUndoStack->beginMacro( tr(
"Delete Items" ) );
587 removeLayoutItemPrivate( item );
590 mUndoStack->push( deleteCommand.release() );
591 mUndoStack->endMacro();
600 if ( !mMultiFrames.contains( multiFrame ) )
601 mMultiFrames << multiFrame;
606 mMultiFrames.removeAll( multiFrame );
616 QFile templateFile( path );
617 if ( !templateFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
622 QDomDocument saveDocument;
623 QDomElement elem =
writeXml( saveDocument, context );
624 saveDocument.appendChild( elem );
626 if ( templateFile.write( saveDocument.toByteArray() ) == -1 )
637 QList< QgsLayoutItem * > result;
657 QDomNodeList itemsNodes = doc.elementsByTagName( QStringLiteral(
"LayoutItem" ) );
658 for (
int i = 0; i < itemsNodes.count(); ++i )
660 QDomNode itemNode = itemsNodes.at( i );
661 if ( itemNode.isElement() )
663 itemNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
666 QDomNodeList multiFrameNodes = doc.elementsByTagName( QStringLiteral(
"LayoutMultiFrame" ) );
667 for (
int i = 0; i < multiFrameNodes.count(); ++i )
669 QDomNode multiFrameNode = multiFrameNodes.at( i );
670 if ( multiFrameNode.isElement() )
672 multiFrameNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
673 QDomNodeList frameNodes = multiFrameNode.toElement().elementsByTagName( QStringLiteral(
"childFrame" ) );
674 QDomNode itemNode = frameNodes.at( i );
675 if ( itemNode.isElement() )
677 itemNode.toElement().removeAttribute( QStringLiteral(
"uuid" ) );
685 QDomElement layoutElem = doc.documentElement();
686 if ( layoutElem.isNull() )
691 bool loadOk =
readXml( layoutElem, doc, context );
711 return mUndoStack.get();
716 return mUndoStack.get();
731 void saveState( QDomDocument &stateDoc )
const override
734 QDomElement documentElement = stateDoc.createElement( QStringLiteral(
"UndoState" ) );
736 stateDoc.appendChild( documentElement );
746 mLayout->readXmlLayoutSettings( stateDoc.documentElement(), stateDoc,
QgsReadWriteContext() );
747 mLayout->project()->setDirty(
true );
763 if ( items.size() < 2 )
769 mUndoStack->beginMacro( tr(
"Group Items" ) );
773 itemGroup->addItem( item );
778 std::unique_ptr< QgsLayoutItemGroupUndoCommand >
c(
new QgsLayoutItemGroupUndoCommand( QgsLayoutItemGroupUndoCommand::Grouped, returnGroup,
this, tr(
"Group Items" ) ) );
779 mUndoStack->push(
c.release() );
782 mUndoStack->endMacro();
790 QList<QgsLayoutItem *> ungroupedItems;
793 return ungroupedItems;
796 mUndoStack->beginMacro( tr(
"Ungroup Items" ) );
799 std::unique_ptr< QgsLayoutItemGroupUndoCommand >
c(
new QgsLayoutItemGroupUndoCommand( QgsLayoutItemGroupUndoCommand::Ungrouped, group,
this, tr(
"Ungroup Items" ) ) );
800 mUndoStack->push(
c.release() );
804 ungroupedItems = group->
items();
808 mUndoStack->endMacro();
810 return ungroupedItems;
815 const QList< QGraphicsItem * > constItems = items();
816 for (
const QGraphicsItem *item : constItems )
822 if ( !layoutItem->
accept( visitor ) )
830 mUndoStack->blockCommands(
true );
831 mPageCollection->beginPageSizeChange();
833 mPageCollection->reflow();
834 mPageCollection->endPageSizeChange();
835 mUndoStack->blockCommands(
false );
839void QgsLayout::writeXmlLayoutSettings( QDomElement &element, QDomDocument &document,
const QgsReadWriteContext & )
const
841 mCustomProperties.
writeXml( element, document );
843 element.setAttribute( QStringLiteral(
"worldFileMap" ), mWorldFileMapId );
844 element.setAttribute( QStringLiteral(
"printResolution" ), mRenderContext->
dpi() );
849 QDomElement element = document.createElement( QStringLiteral(
"Layout" ) );
852 return object->writeXml( element, document, context );
855 save( &mGridSettings );
856 save( mPageCollection.get() );
859 const QList<QGraphicsItem *> itemList = items();
860 for (
const QGraphicsItem *graphicsItem : itemList )
867 item->writeXml( element, document, context );
874 if ( mf->frameCount() > 0 )
875 mf->writeXml( element, document, context );
878 writeXmlLayoutSettings( element, document, context );
882bool QgsLayout::readXmlLayoutSettings(
const QDomElement &layoutElement,
const QDomDocument &,
const QgsReadWriteContext & )
884 mCustomProperties.
readXml( layoutElement );
886 mWorldFileMapId = layoutElement.attribute( QStringLiteral(
"worldFileMap" ) );
887 mRenderContext->
setDpi( layoutElement.attribute( QStringLiteral(
"printResolution" ), QStringLiteral(
"300" ) ).toDouble() );
897 mItemsModel->rebuildZList();
902void QgsLayout::removeLayoutItemPrivate(
QgsLayoutItem *item )
904 mItemsModel->setItemRemoved( item );
911 emit itemRemoved( item );
917void QgsLayout::deleteAndRemoveMultiFrames()
919 qDeleteAll( mMultiFrames );
920 mMultiFrames.clear();
923QPointF QgsLayout::minPointFromXml(
const QDomElement &elem )
const
925 double minX = std::numeric_limits<double>::max();
926 double minY = std::numeric_limits<double>::max();
927 const QDomNodeList itemList = elem.elementsByTagName( QStringLiteral(
"LayoutItem" ) );
929 for (
int i = 0; i < itemList.size(); ++i )
931 const QDomElement currentItemElem = itemList.at( i ).toElement();
936 minX = std::min( minX, layoutPoint.x() );
937 minY = std::min( minY, layoutPoint.y() );
940 return found ? QPointF( minX, minY ) : QPointF( 0, 0 );
945 int counter = mItemsModel->zOrderListSize();
946 const QList<QgsLayoutItem *> zOrderList = mItemsModel->zOrderList();
948 if ( addUndoCommands )
950 mUndoStack->beginMacro( tr(
"Change Item Stacking" ) );
956 if ( addUndoCommands )
958 mUndoStack->beginCommand( currentItem, QString() );
960 currentItem->setZValue( counter );
961 if ( addUndoCommands )
963 mUndoStack->endCommand();
968 if ( addUndoCommands )
970 mUndoStack->endMacro();
976 if ( layoutElement.nodeName() != QLatin1String(
"Layout" ) )
983 return object->readXml( layoutElement, document, context );
986 std::unique_ptr< QgsScopedRuntimeProfile > profile;
988 profile = std::make_unique< QgsScopedRuntimeProfile >( tr(
"Read layout settings" ), QStringLiteral(
"projectload" ) );
990 blockSignals(
true );
991 readXmlLayoutSettings( layoutElement, document, context );
992 blockSignals(
false );
995 profile->switchTask( tr(
"Load pages" ) );
996 restore( mPageCollection.get() );
998 profile->switchTask( tr(
"Load snapping settings" ) );
999 restore( &mSnapper );
1001 profile->switchTask( tr(
"Load grid settings" ) );
1002 restore( &mGridSettings );
1005 profile->switchTask( tr(
"Restore items" ) );
1015 QList< QgsLayoutItem * > newItems;
1016 QList< QgsLayoutMultiFrame * > newMultiFrames;
1021 int zOrderOffset = mItemsModel->zOrderListSize();
1023 QPointF pasteShiftPos;
1024 int pageNumber = -1;
1030 QPointF minItemPos = minPointFromXml( parentElement );
1033 pasteShiftPos = *position - minItemPos;
1036 pageNumber = mPageCollection->pageNumberForPoint( *position );
1040 std::unique_ptr< QgsScopedRuntimeProfile > profile;
1042 profile = std::make_unique< QgsScopedRuntimeProfile >( tr(
"Read items" ), QStringLiteral(
"projectload" ) );
1047 const QDomNodeList multiFrameList = parentElement.elementsByTagName( QStringLiteral(
"LayoutMultiFrame" ) );
1048 for (
int i = 0; i < multiFrameList.size(); ++i )
1050 const QDomElement multiFrameElem = multiFrameList.at( i ).toElement();
1051 const int itemType = multiFrameElem.attribute( QStringLiteral(
"type" ) ).toInt();
1057 profile->switchTask( tr(
"Load %1" ).arg( metadata->visibleName() ) );
1067 mf->readXml( multiFrameElem, document, context );
1070 mf->setCreateUndoCommands(
true );
1085 newMultiFrames << m;
1088 const QDomNodeList layoutItemList = parentElement.childNodes();
1089 for (
int i = 0; i < layoutItemList.size(); ++i )
1091 const QDomElement currentItemElem = layoutItemList.at( i ).toElement();
1092 if ( currentItemElem.nodeName() != QLatin1String(
"LayoutItem" ) )
1095 const int itemType = currentItemElem.attribute( QStringLiteral(
"type" ) ).toInt();
1101 profile->switchTask( tr(
"Load %1" ).arg( metadata->visibleName() ) );
1112 item->readXml( currentItemElem, document, context );
1118 item->attemptMove( posOnPage,
true,
false, pageNumber );
1122 item->attemptMoveBy( pasteShiftPos.x(), pasteShiftPos.y() );
1138 label->setTextFormat( textFormat );
1142 if ( item->isGroupMember() )
1154 newMultiFrames << html;
1162 layoutItem->setZValue( layoutItem->zValue() + zOrderOffset );
1163 newItems << layoutItem;
1170 std::unique_ptr< QgsScopedRuntimeProfile > itemProfile;
1173 profile->switchTask( tr(
"Finalize restore" ) );
1178 itemProfile = std::make_unique< QgsScopedRuntimeProfile >( item->
displayName(), QStringLiteral(
"projectload" ) );
1181 itemProfile.reset();
1186 itemProfile = std::make_unique< QgsScopedRuntimeProfile >( mf->displayName(), QStringLiteral(
"projectload" ) );
1187 mf->finalizeRestoreFromXml();
1189 itemProfile.reset();
1194 item->mTemplateUuid.clear();
1198 mf->mTemplateUuid.clear();
1206 profile->switchTask( tr(
"Update model" ) );
1207 mItemsModel->rebuildZList();
1217void QgsLayout::itemBackgroundTaskCountChanged(
int count )
1219 QgsLayoutItem *item = qobject_cast<QgsLayoutItem *>( sender() );
1224 mBackgroundTaskCount.insert( item, count );
1226 mBackgroundTaskCount.remove( item );
1230 for (
auto it = mBackgroundTaskCount.constBegin(); it != mBackgroundTaskCount.constEnd(); ++it )
1232 total += it.value();
LayoutUnit
Layout measurement units.
@ Millimeters
Millimeters.
@ Percentage
Percentage of another measurement (e.g., canvas size, feature size)
Base class for commands to undo/redo layout and layout object changes.
virtual void saveState(QDomDocument &stateDoc) const =0
Saves the state of the object to the specified stateDoc.
virtual void restoreState(QDomDocument &stateDoc)=0
Restores the state of the object from the specified stateDoc.
static QgsLayoutItemRegistry * layoutItemRegistry()
Returns the application's layout item registry, used for layout item types.
static QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
static bool isCompositionTemplate(const QDomDocument &document)
Check if the given document is a composition template.
static QDomDocument convertCompositionTemplate(const QDomDocument &document, QgsProject *project)
Convert a composition template document to a layout template.
static QgsExpressionContextScope * layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void loadFromSettings()
Loads grid settings from the application layout settings.
Stores and manages the snap guides used by a layout.
A container for grouping several QgsLayoutItems.
void removeItems()
Removes all items from the group (but does not delete them).
void addItem(QgsLayoutItem *item)
Adds an item to the group.
QList< QgsLayoutItem * > items() const
Returns a list of items contained by the group.
static QgsLayoutItemHtml * createFromLabel(QgsLayoutItemLabel *label)
Returns a new QgsLayoutItemHtml matching the content and rendering of a given label.
A layout item subclass for text labels.
@ ModeHtml
Label displays rendered HTML content.
Layout graphical items for displaying a map.
Item representing the paper in a layout.
void setPageSize(const QgsLayoutSize &size)
Sets the size of the page.
Base class for graphical items within a QgsLayout.
virtual void cleanup()
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
QgsLayoutItemGroup * parentGroup() const
Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group.
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.
int page() const
Returns the page the item is currently on, with the first page returning 0.
virtual void finalizeRestoreFromXml()
Called after all pending items have been restored from XML.
int type() const override
Returns a unique graphics item type identifier.
virtual QString displayName() const
Gets item display name.
virtual QString uuid() const
Returns the item identification string.
QString id() const
Returns the item's ID name.
void backgroundTaskCountChanged(int count)
Emitted whenever the number of background tasks an item is executing changes.
QgsLayoutMeasurement convert(QgsLayoutMeasurement measurement, Qgis::LayoutUnit targetUnits) const
Converts a measurement from one unit to another.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
double length() const
Returns the length of the measurement.
A model for items attached to a layout.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
QgsLayoutFrame * frame(int index) const
Returns the child frame at a specified index from the multiframe.
A manager for a collection of pages in a layout.
This class provides a method of storing points, consisting of an x and y coordinate,...
static QgsLayoutPoint decodePoint(const QString &string)
Decodes a point from a string.
Stores information relating to the current rendering settings for a layout.
void setDpi(double dpi)
Sets the dpi for outputting the layout.
double dpi() const
Returns the dpi for outputting the layout.
const QgsLayoutMeasurementConverter & measurementConverter() const
Returns the layout measurement converter to be used in the layout.
Stores information relating to the current reporting context for a layout.
QgsVectorLayer * layer() const
Returns the vector layer associated with the layout's context.
An interface for layout objects which can be stored and read from DOM elements.
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Manages snapping grids and preset snap lines in a layout, and handles snapping points to the nearest ...
An undo stack for QgsLayouts.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QgsLayoutItem * itemById(const QString &id) const
Returns a layout item given its id.
friend class QgsLayoutItemDeleteUndoCommand
void removeMultiFrame(QgsLayoutMultiFrame *multiFrame)
Removes a multiFrame from the layout (but does not delete it).
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the layout.
void updateBounds()
Updates the scene bounds of the layout.
bool saveAsTemplate(const QString &path, const QgsReadWriteContext &context) const
Saves the layout as a template at the given file path.
QgsAbstractLayoutUndoCommand * createCommand(const QString &text, int id=0, QUndoCommand *parent=nullptr) override
Creates a new layout undo command with the specified text and parent.
void initializeDefaults()
Initializes an empty layout, e.g.
QgsLayoutRenderContext & renderContext()
Returns a reference to the layout's render context, which stores information relating to the current ...
void removeCustomProperty(const QString &key)
Remove a custom property from the layout.
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 variablesChanged()
Emitted whenever the expression variables stored in the layout have been changed.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
QgsLayoutItem * itemByUuid(const QString &uuid, bool includeTemplateUuids=false) const
Returns the layout item with matching uuid unique identifier, or nullptr if a matching item could not...
void addMultiFrame(QgsLayoutMultiFrame *multiFrame)
Adds a multiFrame to the layout.
void setUnits(Qgis::LayoutUnit units)
Sets the native measurement units for the layout.
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.
QgsLayoutItem * layoutItemAt(QPointF position, bool ignoreLocked=false, double searchTolerance=0) const
Returns the topmost layout item at a specified position.
QgsLayoutItemMap * referenceMap() const
Returns the map item which will be used to generate corresponding world files when the layout is expo...
void changed()
Emitted when properties of the layout change.
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.
friend class QgsLayoutItemAddItemCommand
void reloadSettings()
Refreshes the layout when global layout related options change.
double convertToLayoutUnits(QgsLayoutMeasurement measurement) const
Converts a measurement into the layout's native units.
virtual bool readXml(const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context)
Sets the collection's state from a DOM element.
QStringList customProperties() const
Returns list of keys stored in custom properties for the layout.
QgsLayout * clone() const
Creates a clone of the layout.
void clear()
Clears the layout.
QgsLayoutItem * itemByTemplateUuid(const QString &uuid) const
Returns the layout item with matching template uuid unique identifier, or nullptr if a matching item ...
friend class QgsLayoutUndoCommand
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.
friend class QgsLayoutModel
QList< QgsLayoutItem * > loadFromTemplate(const QDomDocument &document, const QgsReadWriteContext &context, bool clearExisting=true, bool *ok=nullptr)
Load a layout template document.
static const QgsSettingsEntryStringList * settingsSearchPathForTemplates
Settings entry search path for templates.
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.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the layout.
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.
QRectF layoutBounds(bool ignorePages=false, double margin=0.0) const
Calculates the bounds of all non-gui items in the layout.
void refresh()
Forces the layout, and all items contained within it, to refresh.
void backgroundTaskCountChanged(int total)
Emitted whenever the total number of background tasks running in items from the layout changes.
void removeLayoutItem(QgsLayoutItem *item)
Removes an item from the layout.
void refreshed()
Emitted when the layout has been refreshed and items should also be refreshed and updated.
friend class QgsLayoutItemGroupUndoCommand
void updateZValues(bool addUndoCommands=true)
Resets the z-values of items based on their position in the internal z order list.
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the layout's current state.
QgsLayoutReportContext & reportContext()
Returns a reference to the layout's report context, which stores information relating to the current ...
virtual QDomElement writeXml(QDomDocument &document, const QgsReadWriteContext &context) const
Returns the layout's state encapsulated in a DOM element.
void setReferenceMap(QgsLayoutItemMap *map)
Sets the map item which will be used to generate corresponding world files when the layout is exporte...
QList< QgsLayoutMultiFrame * > multiFrames() const
Returns a list of multi frames contained in the layout.
void addLayoutItem(QgsLayoutItem *item)
Adds an item to the layout.
QgsLayoutMultiFrame * multiFrameByUuid(const QString &uuid, bool includeTemplateUuids=false) const
Returns the layout multiframe with matching uuid unique identifier, or nullptr if a matching multifra...
bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
QgsProject * project() const
The project associated with the layout.
void itemAdded(QgsLayoutItem *item)
Emitted when an item was added to the layout.
QRectF pageItemBounds(int page, bool visibleOnly=false) const
Returns the bounding box of the items contained on a specified page.
QgsLayout(QgsProject *project)
Construct a new layout linked to the specified project.
QgsLayoutUndoStack * undoStack()
Returns a pointer to the layout's undo stack, which manages undo/redo states for the layout and it's ...
void setValue(const QString &key, const QVariant &value)
Add an entry to the store with the specified key.
QStringList keys() const
Returns a list of all stored keys.
void writeXml(QDomNode &parentNode, QDomDocument &doc) const
Writes the store contents to an XML node.
void remove(const QString &key)
Removes a key (entry) from the store.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant()) const
Returns the value for the given key.
void readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
A class to describe the version of a project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
void setDirty(bool b=true)
Flag the project as dirty (modified).
QgsProjectVersion lastSaveVersion() const
Returns the QGIS version which the project was last saved using.
The class is used as a container of context for various read/write operations on other objects.
bool groupIsActive(const QString &group) const
Returns true if the specified group is currently being logged, i.e.
A string list settings entry.
static QgsSettingsTreeNode * sTreeLayout
An interface for classes which can visit style entity (e.g.
Container for all settings relating to text rendering.
double lineHeight() const
Returns the line height for text.
Qgis::RenderUnit lineHeightUnit() const
Returns the units for the line height for text.
void setLineHeight(double height)
Sets the line height for text.
static Q_INVOKABLE Qgis::LayoutUnit decodeLayoutUnit(const QString &string, bool *ok=nullptr)
Decodes a layout unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.