48#include "moc_qgslayout.cpp"
50using namespace Qt::StringLiterals;
66 , mGridSettings( this )
71 setBackgroundBrush( Qt::NoBrush );
72 mItemsModel = std::make_unique<QgsLayoutModel>(
this );
78 mUndoStack->blockCommands(
true );
80 deleteAndRemoveMultiFrames();
88 QList<QGraphicsItem *> itemList = items();
93 for ( QGraphicsItem *item : std::as_const( itemList ) )
110 QDomDocument currentDoc;
113 QDomElement elem =
writeXml( currentDoc, context );
114 currentDoc.appendChild( elem );
116 auto newLayout = std::make_unique< QgsLayout >( mProject );
118 newLayout->loadFromTemplate( currentDoc, context,
true, &ok );
124 return newLayout.release();
132 mPageCollection->addPage( page );
133 mUndoStack->stack()->clear();
138 deleteAndRemoveMultiFrames();
141 const QList<QGraphicsItem *> itemList = items();
142 for ( QGraphicsItem *item : itemList )
146 if ( cItem && !pItem )
148 removeLayoutItemPrivate( cItem );
151 mItemsModel->clear();
153 mPageCollection->clear();
154 mUndoStack->stack()->clear();
164 return mItemsModel.get();
169 QList<QgsLayoutItem *> layoutItemList;
171 const QList<QGraphicsItem *> graphicsItemList = selectedItems();
172 for ( QGraphicsItem *item : graphicsItemList )
175 if ( layoutItem && ( includeLockedItems || !layoutItem->
isLocked() ) )
177 layoutItemList.push_back( layoutItem );
181 return layoutItemList;
200 const QList<QGraphicsItem *> selectedItemList = selectedItems();
201 for ( QGraphicsItem *item : selectedItemList )
205 layoutItem->setSelected(
false );
214 bool result = mItemsModel->reorderItemUp( item );
215 if ( result && !deferUpdate )
227 bool result = mItemsModel->reorderItemDown( item );
228 if ( result && !deferUpdate )
240 bool result = mItemsModel->reorderItemToTop( item );
241 if ( result && !deferUpdate )
253 bool result = mItemsModel->reorderItemToBottom( item );
254 if ( result && !deferUpdate )
265 QList<QgsLayoutItem *> itemList;
269 if ( item->uuid() == uuid )
271 else if ( includeTemplateUuids && item->mTemplateUuid == uuid )
280 QList<QgsLayoutItem *> itemList;
284 if ( item->mTemplateUuid == uuid )
293 const QList<QGraphicsItem *> itemList = items();
294 for ( QGraphicsItem *item : itemList )
297 if ( layoutItem && layoutItem->
id() ==
id )
309 if ( mf->uuid() == uuid )
311 else if ( includeTemplateUuids && mf->mTemplateUuid == uuid )
320 return layoutItemAt( position,
nullptr, ignoreLocked, searchTolerance );
326 QList<QGraphicsItem *> itemList;
327 if ( searchTolerance == 0 )
329 itemList = items( position, Qt::IntersectsItemShape, Qt::DescendingOrder );
333 itemList = items( QRectF( position.x() - searchTolerance, position.y() - searchTolerance, 2 * searchTolerance, 2 * searchTolerance ), Qt::IntersectsItemShape, Qt::DescendingOrder );
336 bool foundBelowItem =
false;
337 for ( QGraphicsItem *graphicsItem : std::as_const( itemList ) )
341 if ( layoutItem && !paperItem )
345 if ( ( !belowItem || foundBelowItem ) && ( !ignoreLocked || !layoutItem->
isLocked() ) )
350 return layoutItemAt( position, layoutItem, ignoreLocked, searchTolerance );
357 if ( layoutItem == belowItem )
360 foundBelowItem =
true;
370 return mRenderContext->measurementConverter().convert( measurement, mUnits ).length();
375 return mRenderContext->measurementConverter().convert( size, mUnits ).toQSizeF();
380 return mRenderContext->measurementConverter().convert( point, mUnits ).toQPointF();
385 return mRenderContext->measurementConverter().convert(
QgsLayoutMeasurement( length, mUnits ), unit );
390 return mRenderContext->measurementConverter().convert(
QgsLayoutSize( size.width(), size.height(), mUnits ), unit );
395 return mRenderContext->measurementConverter().convert(
QgsLayoutPoint( point.x(), point.y(), mUnits ), unit );
400 return *mRenderContext;
405 return *mRenderContext;
410 return *mReportContext;
415 return *mReportContext;
420 mGridSettings.loadFromSettings();
421 mPageCollection->redraw();
426 return mPageCollection->
guides();
431 return mPageCollection->
guides();
439 if ( mReportContext->layer() )
448 mCustomProperties.setValue( key, value );
450 if ( key.startsWith(
"variable"_L1 ) )
456 return mCustomProperties.value( key, defaultValue );
461 mCustomProperties.remove( key );
466 return mCustomProperties.keys();
476 QList< QgsLayoutItemMap * > maps;
479 double largestMapArea = 0;
482 double area = map->rect().width() * map->rect().height();
483 if ( area > largestMapArea )
485 largestMapArea = area;
494 mWorldFileMapId = map ? map->
uuid() : QString();
495 mProject->setDirty(
true );
500 return mPageCollection.get();
505 return mPageCollection.get();
514 const auto constItems = items();
515 for (
const QGraphicsItem *item : constItems )
522 if ( !isPage || !ignorePages )
530 itemBounds = layoutItem->mapToScene( layoutItem->rect() ).boundingRect();
533 itemBounds = item->sceneBoundingRect();
535 if ( bounds.isValid() )
536 bounds = bounds.united( itemBounds );
542 if ( bounds.isValid() && margin > 0.0 )
545 double maxWidth = mPageCollection->maximumPageWidth();
546 bounds.adjust( -maxWidth * margin, -maxWidth * margin, maxWidth * margin, maxWidth * margin );
558 const QList<QGraphicsItem *> itemList = items();
559 for ( QGraphicsItem *item : itemList )
564 if ( visibleOnly && !layoutItem->isVisible() )
568 if ( bounds.isValid() )
569 bounds = bounds.united( item->sceneBoundingRect() );
571 bounds = item->sceneBoundingRect();
580 addLayoutItemPrivate( item );
584 undoText = tr(
"Create %1" ).arg( metadata->visibleName() );
588 undoText = tr(
"Create Item" );
590 if ( !mUndoStack->isBlocked() )
596 std::unique_ptr< QgsLayoutItemDeleteUndoCommand > deleteCommand;
597 if ( !mUndoStack->isBlocked() )
599 mUndoStack->beginMacro( tr(
"Delete Items" ) );
600 deleteCommand = std::make_unique<QgsLayoutItemDeleteUndoCommand>( item, tr(
"Delete Item" ) );
602 removeLayoutItemPrivate( item );
605 mUndoStack->push( deleteCommand.release() );
606 mUndoStack->endMacro();
615 if ( !mMultiFrames.contains( multiFrame ) )
616 mMultiFrames << multiFrame;
623 mMultiFrames.removeAll( multiFrame );
633 QFile templateFile( path );
634 if ( !templateFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
639 QDomDocument saveDocument;
640 QDomElement elem =
writeXml( saveDocument, context );
641 saveDocument.appendChild( elem );
643 if ( templateFile.write( saveDocument.toByteArray() ) == -1 )
654 QList< QgsLayoutItem * > result;
674 QDomNodeList itemsNodes = doc.elementsByTagName( u
"LayoutItem"_s );
675 for (
int i = 0; i < itemsNodes.count(); ++i )
677 QDomNode itemNode = itemsNodes.at( i );
678 if ( itemNode.isElement() )
680 itemNode.toElement().removeAttribute( u
"uuid"_s );
683 QDomNodeList multiFrameNodes = doc.elementsByTagName( u
"LayoutMultiFrame"_s );
684 for (
int i = 0; i < multiFrameNodes.count(); ++i )
686 QDomNode multiFrameNode = multiFrameNodes.at( i );
687 if ( multiFrameNode.isElement() )
689 multiFrameNode.toElement().removeAttribute( u
"uuid"_s );
690 QDomNodeList frameNodes = multiFrameNode.toElement().elementsByTagName( u
"childFrame"_s );
691 QDomNode itemNode = frameNodes.at( i );
692 if ( itemNode.isElement() )
694 itemNode.toElement().removeAttribute( u
"uuid"_s );
702 QDomElement layoutElem = doc.documentElement();
703 if ( layoutElem.isNull() )
708 bool loadOk =
readXml( layoutElem, doc, context );
728 return mUndoStack.get();
733 return mUndoStack.get();
746 void saveState( QDomDocument &stateDoc )
const override
749 QDomElement documentElement = stateDoc.createElement( u
"UndoState"_s );
750 mLayout->writeXmlLayoutSettings( documentElement, stateDoc, QgsReadWriteContext() );
751 stateDoc.appendChild( documentElement );
761 mLayout->readXmlLayoutSettings( stateDoc.documentElement(), stateDoc, QgsReadWriteContext() );
762 mLayout->project()->setDirty(
true );
766 QgsLayout *mLayout =
nullptr;
777 if ( items.size() < 2 )
783 mUndoStack->beginMacro( tr(
"Group Items" ) );
784 auto itemGroup = std::make_unique<QgsLayoutItemGroup>(
this );
787 itemGroup->addItem( item );
792 auto c = std::make_unique<QgsLayoutItemGroupUndoCommand>( QgsLayoutItemGroupUndoCommand::Grouped, returnGroup,
this, tr(
"Group Items" ) );
793 mUndoStack->push(
c.release() );
794 mProject->setDirty(
true );
796 mUndoStack->endMacro();
804 QList<QgsLayoutItem *> ungroupedItems;
807 return ungroupedItems;
810 mUndoStack->beginMacro( tr(
"Ungroup Items" ) );
813 auto c = std::make_unique<QgsLayoutItemGroupUndoCommand>( QgsLayoutItemGroupUndoCommand::Ungrouped, group,
this, tr(
"Ungroup Items" ) );
814 mUndoStack->push(
c.release() );
816 mProject->setDirty(
true );
818 ungroupedItems = group->
items();
822 mUndoStack->endMacro();
824 return ungroupedItems;
829 const QList< QGraphicsItem * > constItems = items();
830 for (
const QGraphicsItem *item : constItems )
836 if ( !layoutItem->
accept( visitor ) )
844 mUndoStack->blockCommands(
true );
845 mPageCollection->beginPageSizeChange();
847 mPageCollection->reflow();
848 mPageCollection->endPageSizeChange();
849 mUndoStack->blockCommands(
false );
853void QgsLayout::writeXmlLayoutSettings( QDomElement &element, QDomDocument &document,
const QgsReadWriteContext & )
const
855 mCustomProperties.
writeXml( element, document );
857 element.setAttribute( u
"worldFileMap"_s, mWorldFileMapId );
858 element.setAttribute( u
"printResolution"_s, mRenderContext->
dpi() );
863 QDomElement element = document.createElement( u
"Layout"_s );
866 save( &mGridSettings );
867 save( mPageCollection.get() );
870 const QList<QGraphicsItem *> itemList = items();
871 for (
const QGraphicsItem *graphicsItem : itemList )
878 item->writeXml( element, document, context );
885 if ( mf->frameCount() > 0 )
886 mf->writeXml( element, document, context );
889 writeXmlLayoutSettings( element, document, context );
893bool QgsLayout::readXmlLayoutSettings(
const QDomElement &layoutElement,
const QDomDocument &,
const QgsReadWriteContext & )
895 mCustomProperties.
readXml( layoutElement );
897 mWorldFileMapId = layoutElement.attribute( u
"worldFileMap"_s );
898 mRenderContext->
setDpi( layoutElement.attribute( u
"printResolution"_s, u
"300"_s ).toDouble() );
908 mItemsModel->rebuildZList();
913void QgsLayout::removeLayoutItemPrivate(
QgsLayoutItem *item )
915 mItemsModel->setItemRemoved( item );
922 emit itemRemoved( item );
928void QgsLayout::deleteAndRemoveMultiFrames()
930 qDeleteAll( mMultiFrames );
931 mMultiFrames.clear();
934QPointF QgsLayout::minPointFromXml(
const QDomElement &elem )
const
936 double minX = std::numeric_limits<double>::max();
937 double minY = std::numeric_limits<double>::max();
938 const QDomNodeList itemList = elem.elementsByTagName( u
"LayoutItem"_s );
940 for (
int i = 0; i < itemList.size(); ++i )
942 const QDomElement currentItemElem = itemList.at( i ).toElement();
947 minX = std::min( minX, layoutPoint.x() );
948 minY = std::min( minY, layoutPoint.y() );
951 return found ? QPointF( minX, minY ) : QPointF( 0, 0 );
956 int counter = mItemsModel->zOrderListSize();
957 const QList<QgsLayoutItem *> zOrderList = mItemsModel->zOrderList();
959 if ( addUndoCommands )
961 mUndoStack->beginMacro( tr(
"Change Item Stacking" ) );
967 if ( addUndoCommands )
969 mUndoStack->beginCommand( currentItem, QString() );
971 currentItem->setZValue( counter );
972 if ( addUndoCommands )
974 mUndoStack->endCommand();
979 if ( addUndoCommands )
981 mUndoStack->endMacro();
987 if ( layoutElement.nodeName() !=
"Layout"_L1 )
994 std::unique_ptr< QgsScopedRuntimeProfile > profile;
996 profile = std::make_unique< QgsScopedRuntimeProfile >( tr(
"Read layout settings" ), u
"projectload"_s );
998 blockSignals(
true );
999 readXmlLayoutSettings( layoutElement, document, context );
1000 blockSignals(
false );
1003 profile->switchTask( tr(
"Load pages" ) );
1004 restore( mPageCollection.get() );
1006 profile->switchTask( tr(
"Load snapping settings" ) );
1007 restore( &mSnapper );
1009 profile->switchTask( tr(
"Load grid settings" ) );
1010 restore( &mGridSettings );
1013 profile->switchTask( tr(
"Restore items" ) );
1023 QList< QgsLayoutItem * > newItems;
1024 QList< QgsLayoutMultiFrame * > newMultiFrames;
1029 int zOrderOffset = mItemsModel->zOrderListSize();
1031 QPointF pasteShiftPos;
1032 int pageNumber = -1;
1038 QPointF minItemPos = minPointFromXml( parentElement );
1041 pasteShiftPos = *position - minItemPos;
1044 pageNumber = mPageCollection->pageNumberForPoint( *position );
1048 std::unique_ptr< QgsScopedRuntimeProfile > profile;
1050 profile = std::make_unique< QgsScopedRuntimeProfile >( tr(
"Read items" ), u
"projectload"_s );
1055 const QDomNodeList multiFrameList = parentElement.elementsByTagName( u
"LayoutMultiFrame"_s );
1056 for (
int i = 0; i < multiFrameList.size(); ++i )
1058 const QDomElement multiFrameElem = multiFrameList.at( i ).toElement();
1059 const int itemType = multiFrameElem.attribute( u
"type"_s ).toInt();
1065 profile->switchTask( tr(
"Load %1" ).arg( metadata->visibleName() ) );
1075 mf->readXml( multiFrameElem, document, context );
1078 mf->setCreateUndoCommands(
true );
1093 newMultiFrames << m;
1096 const QDomNodeList layoutItemList = parentElement.childNodes();
1097 for (
int i = 0; i < layoutItemList.size(); ++i )
1099 const QDomElement currentItemElem = layoutItemList.at( i ).toElement();
1100 if ( currentItemElem.nodeName() !=
"LayoutItem"_L1 )
1103 const int itemType = currentItemElem.attribute( u
"type"_s ).toInt();
1109 profile->switchTask( tr(
"Load %1" ).arg( metadata->visibleName() ) );
1120 item->readXml( currentItemElem, document, context );
1126 item->attemptMove( posOnPage,
true,
false, pageNumber );
1130 item->attemptMoveBy( pasteShiftPos.x(), pasteShiftPos.y() );
1146 label->setTextFormat( textFormat );
1150 if ( item->isGroupMember() )
1154 QList<QgsLayoutItem *>
groupItems = group->items();
1156 group->removeItems();
1159 group->addItem( groupItem );
1161 group->addItem( html->
frame( 0 ) );
1164 newMultiFrames << html;
1172 layoutItem->setZValue( layoutItem->zValue() + zOrderOffset );
1173 newItems << layoutItem;
1180 std::unique_ptr< QgsScopedRuntimeProfile > itemProfile;
1183 profile->switchTask( tr(
"Finalize restore" ) );
1188 itemProfile = std::make_unique< QgsScopedRuntimeProfile >( item->
displayName(), u
"projectload"_s );
1191 itemProfile.reset();
1196 itemProfile = std::make_unique< QgsScopedRuntimeProfile >( mf->displayName(), u
"projectload"_s );
1197 mf->finalizeRestoreFromXml();
1199 itemProfile.reset();
1204 item->mTemplateUuid.clear();
1208 mf->mTemplateUuid.clear();
1216 profile->switchTask( tr(
"Update model" ) );
1217 mItemsModel->rebuildZList();
1227void QgsLayout::itemBackgroundTaskCountChanged(
int count )
1229 QgsLayoutItem *item = qobject_cast<QgsLayoutItem *>( sender() );
1234 mBackgroundTaskCount.insert( item, count );
1236 mBackgroundTaskCount.remove( item );
1240 for (
auto it = mBackgroundTaskCount.constBegin(); it != mBackgroundTaskCount.constEnd(); ++it )
1242 total += it.value();
1244 for (
auto it = mMultiFrameBackgroundTaskCount.constBegin(); it != mMultiFrameBackgroundTaskCount.constEnd(); ++it )
1246 total += it.value();
1252void QgsLayout::multiFrameBackgroundTaskCountChanged(
int count )
1259 mMultiFrameBackgroundTaskCount.insert( multiFrame, count );
1261 mMultiFrameBackgroundTaskCount.remove( multiFrame );
1265 for (
auto it = mBackgroundTaskCount.constBegin(); it != mBackgroundTaskCount.constEnd(); ++it )
1267 total += it.value();
1269 for (
auto it = mMultiFrameBackgroundTaskCount.constBegin(); it != mMultiFrameBackgroundTaskCount.constEnd(); ++it )
1271 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 std::unique_ptr< QgsExpressionContextScope > globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
static std::unique_ptr< QgsExpressionContextScope > layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static std::unique_ptr< QgsExpressionContextScope > layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout.
static std::unique_ptr< QgsExpressionContextScope > projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
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.
Stores and manages the snap guides used by a layout.
QList< QgsLayoutGuide * > guides()
Returns a list of all guides contained in the collection.
A container for grouping several QgsLayoutItems.
void removeItems()
Removes all items from the group (but does not delete them).
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.
Provides a method of storing measurements for use in QGIS layouts using a variety of different measur...
QgsLayoutFrame * frame(int index) const
Returns the child frame at a specified index from the multiframe.
void backgroundTaskCountChanged(int count)
Emitted whenever the number of background tasks the multi frame is executing changes.
A manager for a collection of pages in a layout.
Provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts.
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.
Stores information relating to the current reporting context for a layout.
An interface for layout objects which can be stored and read from DOM elements.
Provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts.
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.
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.
friend class QgsLayoutMultiFrame
static const QgsSettingsEntryString * settingsLayoutDefaultNorthArrow
Settings entry for the default north arrow SVG path.
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.
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...
static const QgsSettingsEntryString * settingsLayoutDefaultFont
Settings entry for the default font family used for new layout items.
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 writeXml(QDomNode &parentNode, QDomDocument &doc) const
Writes the store contents to an XML node.
void readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
Describes the version of a project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A container for the context for various read/write operations on objects.
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.