QGIS API Documentation 3.41.0-Master (3440c17df1d)
|
Stores and manages the snap guides used by a layout. More...
#include <qgslayoutguidecollection.h>
Public Types | |
enum class | CustomRole : int { Orientation = Qt::UserRole , Position , Units , Page , LayoutPosition } |
Model roles. More... | |
Public Member Functions | |
QgsLayoutGuideCollection (QgsLayout *layout, QgsLayoutPageCollection *pageCollection) | |
Constructor for QgsLayoutGuideCollection belonging to the specified layout, and linked to the specified pageCollection. | |
~QgsLayoutGuideCollection () override | |
void | addGuide (QgsLayoutGuide *guide) |
Adds a guide to the collection. | |
void | applyGuidesToAllOtherPages (int sourcePage) |
Resets all other pages' guides to match the guides from the specified sourcePage. | |
void | clear () |
Removes all guides from the collection. | |
int | columnCount (const QModelIndex &) const override |
QVariant | data (const QModelIndex &index, int role) const override |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
QList< QgsLayoutGuide * > | guides () |
Returns a list of all guides contained in the collection. | |
QList< QgsLayoutGuide * > | guides (Qt::Orientation orientation, int page=-1) |
Returns the list of guides contained in the collection with the specified orientation and on a matching page. | |
QList< QgsLayoutGuide * > | guidesOnPage (int page) |
Returns the list of guides contained on a matching page. | |
QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override |
QgsLayout * | layout () override |
Returns the layout the object belongs to. | |
bool | readXml (const QDomElement &collectionElement, const QDomDocument &document, const QgsReadWriteContext &context) override |
Sets the collection's state from a DOM element. | |
void | removeGuide (QgsLayoutGuide *guide) |
Removes the specified guide, and deletes it. | |
bool | removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override |
int | rowCount (const QModelIndex &) const override |
bool | setData (const QModelIndex &index, const QVariant &value, int role) override |
void | setGuideLayoutPosition (QgsLayoutGuide *guide, double position) |
Sets the absolute position (in layout coordinates) for guide within the layout. | |
void | setVisible (bool visible) |
Sets whether the guide lines should be visible. | |
QString | stringType () const override |
Returns the object type as a string. | |
void | update () |
Updates the position (and visibility) of all guide line items. | |
bool | visible () const |
Returns true if the guide lines should be drawn. | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override |
Stores the collection's state in a DOM element. | |
Public Member Functions inherited from QgsLayoutSerializableObject | |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. | |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Friends | |
class | QgsLayoutGuideCollectionUndoCommand |
Stores and manages the snap guides used by a layout.
Definition at line 166 of file qgslayoutguidecollection.h.
|
strong |
Model roles.
Custom model roles.
Enumerator | |
---|---|
Orientation | Guide orientation role. |
Position | Guide position role. |
Units | Guide position units role. |
Page | Guide page role. |
LayoutPosition | Guide position in layout coordinates. |
Definition at line 183 of file qgslayoutguidecollection.h.
QgsLayoutGuideCollection::QgsLayoutGuideCollection | ( | QgsLayout * | layout, |
QgsLayoutPageCollection * | pageCollection | ||
) |
Constructor for QgsLayoutGuideCollection belonging to the specified layout, and linked to the specified pageCollection.
Definition at line 194 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 205 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::addGuide | ( | QgsLayoutGuide * | guide | ) |
Adds a guide to the collection.
Ownership of the guide is transferred to the collection, and the guide will automatically have the correct layout set.
Definition at line 390 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::applyGuidesToAllOtherPages | ( | int | sourcePage | ) |
Resets all other pages' guides to match the guides from the specified sourcePage.
Definition at line 438 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::clear | ( | ) |
Removes all guides from the collection.
Definition at line 428 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 220 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 228 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 354 of file qgslayoutguidecollection.cpp.
QList< QgsLayoutGuide * > QgsLayoutGuideCollection::guides | ( | ) |
Returns a list of all guides contained in the collection.
Definition at line 482 of file qgslayoutguidecollection.cpp.
QList< QgsLayoutGuide * > QgsLayoutGuideCollection::guides | ( | Qt::Orientation | orientation, |
int | page = -1 |
||
) |
Returns the list of guides contained in the collection with the specified orientation and on a matching page.
If page is -1, guides from all pages will be returned.
Definition at line 487 of file qgslayoutguidecollection.cpp.
QList< QgsLayoutGuide * > QgsLayoutGuideCollection::guidesOnPage | ( | int | page | ) |
Returns the list of guides contained on a matching page.
Definition at line 500 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 361 of file qgslayoutguidecollection.cpp.
|
overridevirtual |
Returns the layout the object belongs to.
Implements QgsLayoutSerializableObject.
Definition at line 210 of file qgslayoutguidecollection.cpp.
|
overridevirtual |
Sets the collection's state from a DOM element.
collectionElement is the DOM node corresponding to the collection.
Implements QgsLayoutSerializableObject.
Definition at line 555 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::removeGuide | ( | QgsLayoutGuide * | guide | ) |
Removes the specified guide, and deletes it.
Definition at line 410 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 372 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 215 of file qgslayoutguidecollection.cpp.
|
override |
Definition at line 268 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::setGuideLayoutPosition | ( | QgsLayoutGuide * | guide, |
double | position | ||
) |
Sets the absolute position (in layout coordinates) for guide within the layout.
Definition at line 419 of file qgslayoutguidecollection.cpp.
void QgsLayoutGuideCollection::setVisible | ( | bool | visible | ) |
Sets whether the guide lines should be visible.
Definition at line 517 of file qgslayoutguidecollection.cpp.
|
inlineoverridevirtual |
Returns the object type as a string.
This string must be a unique, single word, character only representation of the item type, eg "LayoutScaleBar"
Implements QgsLayoutSerializableObject.
Definition at line 201 of file qgslayoutguidecollection.h.
void QgsLayoutGuideCollection::update | ( | ) |
Updates the position (and visibility) of all guide line items.
Definition at line 473 of file qgslayoutguidecollection.cpp.
bool QgsLayoutGuideCollection::visible | ( | ) | const |
Returns true
if the guide lines should be drawn.
Definition at line 512 of file qgslayoutguidecollection.cpp.
|
overridevirtual |
Stores the collection's state in a DOM element.
The parentElement should refer to the parent layout's DOM element.
Implements QgsLayoutSerializableObject.
Definition at line 536 of file qgslayoutguidecollection.cpp.
|
friend |
Definition at line 311 of file qgslayoutguidecollection.h.