31 createDefaultPageStyleSymbol();
38 mLayout->removeItem( page );
48 mPageStyleSymbol.reset( static_cast<QgsFillSymbol *>( symbol->
clone() ) );
59 mPreviousItemPositions.clear();
60 QList< QgsLayoutItem * > items;
68 mPreviousItemPositions.insert( item->uuid(), qMakePair( item->page(), item->pagePositionWithUnits() ) );
74 for (
auto it = mPreviousItemPositions.constBegin(); it != mPreviousItemPositions.constEnd(); ++it )
78 if ( !mBlockUndoCommands )
79 item->beginCommand( QString() );
80 item->attemptMove( it.value().second,
true,
false, it.value().first );
81 if ( !mBlockUndoCommands )
85 mPreviousItemPositions.clear();
120 double area = pageSize.width() * pageSize.height();
121 if ( area > maxArea )
136 if ( !size.isValid() )
141 || !
qgsDoubleNear( pageSize.height(), size.height(), 0.01 ) )
151 double startNextPageY = 0;
155 if ( startNextPageY > point.y() )
160 if ( pageNumber > mPages.count() - 1 )
161 pageNumber = mPages.count() - 1;
168 double startNextPageY = 0;
172 if ( startNextPageY >= point.y() )
177 if ( startNextPageY >= point.y() )
183 double lastPageHeight = mPages.last()->rect().height();
184 while ( startNextPageY < point.y() )
187 if ( startNextPageY >= point.y() )
197 const QList< QGraphicsItem * > items = mLayout->items( point );
198 for ( QGraphicsItem *item : items )
203 if ( page->mapToScene( page->rect() ).boundingRect().contains( point ) )
213 if ( page > 0 && page < mPages.count() )
215 layoutUnitsPos.ry() += mPages.at( page )->pos().y();
217 return layoutUnitsPos;
223 if ( page > 0 && page < mPages.count() )
233 double startCurrentPageY = 0;
234 double startNextPageY = 0;
238 startCurrentPageY = startNextPageY;
240 if ( startNextPageY > position.y() )
246 if ( pageNumber == mPages.size() )
255 y = position.y() - startCurrentPageY;
257 return QPointF( position.x(), y );
272 if ( !mBlockUndoCommands )
283 if ( mPages.empty() )
285 std::unique_ptr< QgsLayoutItemPage >
page = qgis::make_unique< QgsLayoutItemPage >( mLayout );
296 bounds.setWidth( bounds.width() + marginLeft + marginRight );
297 bounds.setHeight( bounds.height() + marginTop + marginBottom );
300 page->setPageSize( newPageSize );
305 double diffX = marginLeft - bounds.left();
306 double diffY = marginTop - bounds.top();
308 const QList<QGraphicsItem *> itemList = mLayout->items();
309 for ( QGraphicsItem *item : itemList )
311 if (
QgsLayoutItem *layoutItem = dynamic_cast<QgsLayoutItem *>( item ) )
317 layoutItem->attemptMoveBy( diffX, diffY );
318 layoutItem->endCommand();
325 const QList< QgsLayoutGuide * > verticalGuides = mLayout->
guides().
guides( Qt::Vertical );
328 guide->setLayoutPosition( guide->layoutPosition() + diffX );
330 const QList< QgsLayoutGuide * > horizontalGuides = mLayout->
guides().
guides( Qt::Horizontal );
333 guide->setLayoutPosition( guide->layoutPosition() + diffY );
337 if ( !mBlockUndoCommands )
343 QDomElement element = document.createElement( QStringLiteral(
"PageCollection" ) );
346 element.appendChild( pageStyleElem );
353 mGuideCollection->writeXml( element, document, context );
355 parentElement.appendChild( element );
361 QDomElement element = e;
362 if ( element.nodeName() != QStringLiteral(
"PageCollection" ) )
364 element = element.firstChildElement( QStringLiteral(
"PageCollection" ) );
367 if ( element.nodeName() != QStringLiteral(
"PageCollection" ) )
372 mBlockUndoCommands =
true;
378 mLayout->removeItem(
page );
384 QDomElement pageStyleSymbolElem = element.firstChildElement( QStringLiteral(
"symbol" ) );
385 if ( !pageStyleSymbolElem.isNull() )
387 mPageStyleSymbol.reset( QgsSymbolLayerUtils::loadSymbol<QgsFillSymbol>( pageStyleSymbolElem, context ) );
390 QDomNodeList pageList = element.elementsByTagName( QStringLiteral(
"LayoutItem" ) );
391 for (
int i = 0; i < pageList.size(); ++i )
393 QDomElement pageElement = pageList.at( i ).toElement();
395 page->readXml( pageElement, document, context );
396 page->finalizeRestoreFromXml();
397 mPages.append( page.get() );
398 mLayout->addItem( page.release() );
403 mGuideCollection->readXml( element, document, context );
405 mBlockUndoCommands =
false;
411 return *mGuideCollection;
416 return *mGuideCollection;
439 return mPages.count();
444 return mPages.value( pageNumber );
449 return mPages.value( pageNumber );
454 return mPages.indexOf( page );
459 QList<QgsLayoutItemPage *>
pages;
462 if ( page->mapToScene( page->rect() ).boundingRect().intersects( region ) )
474 if ( page->mapToScene( page->rect() ).boundingRect().intersects( region ) )
502 QList<QgsLayoutItem *> itemList;
503 const QList<QGraphicsItem *> graphicsItemList = mLayout->items();
504 for ( QGraphicsItem *graphicsItem : graphicsItemList )
509 itemList.push_back( item );
517 if ( page >= mPages.count() || page < 0 )
528 QList<QgsLayoutFrame *> frames;
532 if ( frame->hidePageIfEmpty() && frame->isEmpty() )
543 if ( !mBlockUndoCommands )
545 mPages.append( page );
546 mLayout->addItem( page );
548 if ( !mBlockUndoCommands )
554 if ( mPages.empty() )
558 std::unique_ptr< QgsLayoutItemPage > newPage = qgis::make_unique< QgsLayoutItemPage >( mLayout );
561 return mPages.at( mPages.count() - 1 );
566 if ( !mBlockUndoCommands )
572 if ( beforePage < 0 )
576 if ( beforePage >= mPages.count() )
578 mPages.append( page );
582 mPages.insert( beforePage, page );
584 mLayout->addItem( page );
588 for (
auto it = mPreviousItemPositions.begin(); it != mPreviousItemPositions.end(); ++it )
590 if ( it.value().first < beforePage )
593 it.value().first = it.value().first + 1;
597 if ( ! mBlockUndoCommands )
606 if ( pageNumber < 0 || pageNumber >= mPages.count() )
609 if ( !mBlockUndoCommands )
617 mLayout->removeItem( page );
622 for (
auto it = mPreviousItemPositions.begin(); it != mPreviousItemPositions.end(); ++it )
627 it.value().first = it.value().first - 1;
631 if ( ! mBlockUndoCommands )
640 if ( !mPages.contains( page ) )
643 if ( !mBlockUndoCommands )
648 int pageIndex = mPages.indexOf( page );
651 mPages.removeAll( page );
656 for (
auto it = mPreviousItemPositions.begin(); it != mPreviousItemPositions.end(); ++it )
658 if ( it.value().first <= pageIndex )
661 it.value().first = it.value().first - 1;
665 if ( !mBlockUndoCommands )
674 if ( !mBlockUndoCommands )
679 for (
int i = mPages.count() - 1; i >= 0; --i )
682 mPages.takeAt( i )->deleteLater();
685 if ( !mBlockUndoCommands )
694 mPages.removeAll( page );
698 void QgsLayoutPageCollection::createDefaultPageStyleSymbol()
701 properties.insert( QStringLiteral(
"color" ), QStringLiteral(
"white" ) );
702 properties.insert( QStringLiteral(
"style" ), QStringLiteral(
"solid" ) );
703 properties.insert( QStringLiteral(
"style_border" ), QStringLiteral(
"no" ) );
704 properties.insert( QStringLiteral(
"joinstyle" ), QStringLiteral(
"miter" ) );
double right() const
Returns the right margin.
The class is used as a container of context for various read/write operations on other objects...
~QgsLayoutPageCollection() override
bool writeXml(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores the collection's state in a DOM element.
void pageAboutToBeRemoved(int pageNumber)
Emitted just before a page is removed from the collection.
QList< int > visiblePageNumbers(QRectF region) const
Returns a list of the page numbers which are visible within the specified region (in layout coordinat...
void beginCommand(const QString &commandText, UndoCommand command=UndoNone)
Starts new undo command for this item.
QgsLayoutGuideCollection & guides()
Returns a reference to the layout's guide collection, which manages page snap guides.
int pageNumber(QgsLayoutItemPage *page) const
Returns the page number for the specified page, or -1 if the page is not contained in the collection...
QRectF layoutBounds(bool ignorePages=false, double margin=0.0) const
Calculates the bounds of all non-gui items in the layout.
Base class for graphical items within a QgsLayout.
QgsLayoutItemPage * extendByNewPage()
Adds a new page to the end of the collection.
int pageNumberForPoint(QPointF point) const
Returns the page number corresponding to a point in the layout (in layout units). ...
QgsLayoutUndoStack * undoStack()
Returns a pointer to the layout's undo stack, which manages undo/redo states for the layout and it's ...
bool shouldExportPage(int page) const
Returns whether the specified page number should be included in exports of the layouts.
Contains the configuration for a single snap guide used by a layout.
QgsLayoutItemPage * takePage(QgsLayoutItemPage *page)
Takes a page from the collection, returning ownership of the page to the caller.
void resizeToContents(const QgsMargins &margins, QgsUnitTypes::LayoutUnit marginUnits)
Resizes the layout to a single page which fits the current contents of the layout.
QgsUnitTypes::LayoutUnit units() const
Returns the native units for the layout.
static QgsFillSymbol * createSimple(const QgsStringMap &properties)
Create a fill symbol with one symbol layer: SimpleFill with specified properties. ...
QList< QgsLayoutItem * > itemsOnPage(int page) const
Returns a list of layout items on the specified page index.
QgsLayoutSize sizeWithUnits() const
Returns the item's current size, including units.
QgsLayoutItem * itemByUuid(const QString &uuid, bool includeTemplateUuids=false) const
Returns the layout item with matching uuid unique identifier, or a nullptr if a matching item could n...
void clear()
Removes all pages from the collection.
void setPageStyleSymbol(QgsFillSymbol *symbol)
Sets the symbol to use for drawing pages in the collection.
QgsLayoutGuideCollection & guides()
Returns a reference to the collection's guide collection, which manages page snap guides...
bool hasUniformPageSizes() const
Returns true if the layout has uniform page sizes, e.g.
QList< QgsLayoutItemPage *> pages()
Returns a list of pages in the collection.
void changed()
Emitted when pages are added or removed from the collection.
void updateBounds()
Updates the scene bounds of the layout.
double maximumPageWidth() const
Returns the maximum width of pages in the collection.
QMap< QString, QString > QgsStringMap
bool qgsDoubleNear(double a, double b, double epsilon=4 *DBL_EPSILON)
Compare two doubles (but allow some difference)
double convertToLayoutUnits(const QgsLayoutMeasurement &measurement) const
Converts a measurement into the layout's native units.
double spaceBetweenPages() const
Returns the space between pages, in layout units.
bool pageIsEmpty(int page) const
Returns whether a given page index is empty, ie, it contains no items except for the background paper...
void beginPageSizeChange()
Should be called before changing any page item sizes, and followed by a call to endPageSizeChange().
This class provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts.
void layoutItems(QList< T *> &itemList) const
Returns a list of layout items of a specific type.
bool writeXml(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
Stores the item state in a DOM element.
QgsUnitTypes::LayoutUnit units() const
Returns the units for the point.
void endCommand()
Saves final state of an object and pushes the active command to the undo history. ...
QList< QgsLayoutItemPage *> visiblePages(QRectF region) const
Returns a list of the pages which are visible within the specified region (in layout coordinates)...
QgsLayoutItemPage * page(int pageNumber)
Returns a specific page (by pageNumber) from the collection.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
QgsFillSymbol * clone() const override
Get a deep copy of this symbol.
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout...
double bottom() const
Returns the bottom margin.
double y() const
Returns y coordinate of point.
QgsLayoutItemPage * pageAtPoint(QPointF point) const
Returns the page at a specified point (in layout coordinates).
Stores and manages the snap guides used by a layout.
double top() const
Returns the top margin.
double x() const
Returns x coordinate of point.
bool readXml(const QDomElement &collectionElement, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets the collection's state from a DOM element.
int page() const
Returns the page the item is currently on, with the first page returning 0.
void redraw()
Triggers a redraw for all pages.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
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.
int pageCount() const
Returns the number of pages in the collection.
QPointF positionOnPage(QPointF point) const
Returns the position within a page of a point in the layout (in layout units).
QList< QgsLayoutGuide *> guides()
Returns a list of all guides contained in the collection.
QgsLayoutSize pageSize() const
Returns the size of the page.
QSizeF maximumPageSize() const
Returns the maximum size of any page in the collection, by area.
QPointF pagePositionToLayoutPosition(int page, const QgsLayoutPoint &position) const
Converts a position on a page to an absolute position in layout coordinates.
int predictPageNumberForPoint(QPointF point) const
Returns the theoretical page number corresponding to a point in the layout (in layout units)...
void insertPage(QgsLayoutItemPage *page, int beforePage)
Inserts a page into a specific position in the collection.
bool shouldDrawItem() const
Returns whether the item should be drawn in the current context.
virtual void attemptMove(const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
Attempts to move the item to a specified point.
void update()
Updates the position (and visibility) of all guide line items.
QgsLayoutMeasurement convertFromLayoutUnits(const double length, const QgsUnitTypes::LayoutUnit unit) const
Converts a length measurement from the layout's native units to a specified target unit...
static QDomElement saveSymbol(const QString &symbolName, QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
LayoutUnit
Layout measurement units.
void addPage(QgsLayoutItemPage *page)
Adds a page to the collection.
void deletePage(int pageNumber)
Deletes a page from the collection.
void endPageSizeChange()
Should be called after changing any page item sizes, and preceded by a call to beginPageSizeChange()...
void endMacro()
Ends a macro command.
QgsLayoutPageCollection(QgsLayout *layout)
Constructor for QgsLayoutItemPage, with the specified parent layout.
void reflow()
Forces the page collection to reflow the arrangement of pages, e.g.
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Base class for frame items, which form a layout multiframe item.
double pageShadowWidth() const
Returns the size of the page shadow, in layout units.
QgsLayoutPoint pagePositionToAbsolute(int page, const QgsLayoutPoint &position) const
Converts a position on a page to an absolute position in (maintaining the units from the input positi...
double left() const
Returns the left margin.
QgsLayout * layout() override
Returns the layout the object belongs to.
The QgsMargins class defines the four margins of a rectangle.
Item representing the paper in a layout.