17 #ifndef QGSLAYOUTPAGECOLLECTION_H 18 #define QGSLAYOUTPAGECOLLECTION_H 20 #include "qgis_core.h" 54 QString
stringType()
const override {
return QStringLiteral(
"LayoutPageCollection" ); }
62 QList< QgsLayoutItemPage * > pages();
68 int pageCount()
const;
100 QList< QgsLayoutItemPage * > visiblePages( QRectF region )
const;
107 QList< int > visiblePageNumbers( QRectF region )
const;
114 bool pageIsEmpty(
int page )
const;
119 QList< QgsLayoutItem *> itemsOnPage(
int page )
const;
125 template<
class T>
void itemsOnPage( QList<T *> &itemList,
int page )
const SIP_SKIP
128 const QList<QGraphicsItem *> graphicsItemList = mLayout->items();
129 for ( QGraphicsItem *graphicsItem : graphicsItemList )
131 T *item =
dynamic_cast<T *
>( graphicsItem );
132 if ( item && item->page() == page )
134 itemList.push_back( item );
143 bool shouldExportPage(
int page )
const;
197 void deletePage(
int pageNumber );
240 void beginPageSizeChange();
248 void endPageSizeChange();
262 double maximumPageWidth()
const;
270 QSizeF maximumPageSize()
const;
278 bool hasUniformPageSizes()
const;
294 int pageNumberForPoint( QPointF point )
const;
311 int predictPageNumberForPoint( QPointF point )
const;
329 QPointF pagePositionToLayoutPosition(
int page,
const QgsLayoutPoint &position )
const;
342 QPointF positionOnPage( QPointF point )
const;
347 double spaceBetweenPages()
const;
352 double pageShadowWidth()
const;
374 bool readXml(
const QDomElement &collectionElement,
const QDomDocument &document,
const QgsReadWriteContext &context )
override;
406 void pageAboutToBeRemoved(
int pageNumber );
412 std::unique_ptr< QgsLayoutGuideCollection > mGuideCollection;
415 std::unique_ptr< QgsFillSymbol > mPageStyleSymbol;
417 QList< QgsLayoutItemPage * > mPages;
419 bool mBlockUndoCommands =
false;
421 QMap< QString, QPair< int, QgsLayoutPoint > > mPreviousItemPositions;
423 void createDefaultPageStyleSymbol();
425 friend class QgsLayoutPageCollectionUndoCommand;
428 #endif //QGSLAYOUTPAGECOLLECTION_H The class is used as a container of context for various read/write operations on other objects...
QString stringType() const override
Return the object type as a string.
virtual bool writeXml(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const =0
Stores the objects's state in a DOM element.
const QgsFillSymbol * pageStyleSymbol() const
Returns the symbol to use for drawing pages in the collection.
This class provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts.
void itemsOnPage(QList< T *> &itemList, int page) const
Returns layout items of a specific type on a specified page.
Stores and manages the snap guides used by a layout.
virtual QgsLayout * layout()=0
Returns the layout the object belongs to.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
A manager for a collection of pages in a layout.
An interface for layout objects which can be stored and read from DOM elements.
LayoutUnit
Layout measurement units.
virtual bool readXml(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context)=0
Sets the objects's state from a DOM element.
The QgsMargins class defines the four margins of a rectangle.
Item representing the paper in a layout.