Class: QgsLayoutGuideCollection¶
-
class
qgis.core.
QgsLayoutGuideCollection
(layout: QgsLayout, pageCollection: QgsLayoutPageCollection)¶ Bases:
PyQt5.QtCore.QAbstractTableModel
,QgsLayoutSerializableObject
Constructor for
QgsLayoutGuideCollection
belonging to the specified layout, and linked to the specifiedpageCollection
.Stores and manages the snap guides used by a layout.
New in version 3.0.
- Parameters
layout (QgsLayout) –
pageCollection –
-
LayoutPositionRole
= 260¶
-
OrientationRole
= 256¶
-
PageRole
= 259¶
-
PositionRole
= 257¶
-
class
Roles
¶ Bases:
int
-
UnitsRole
= 258¶
-
addGuide
(self, guide: QgsLayoutGuide)¶ 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.- Parameters
guide (QgsLayoutGuide) –
-
applyGuidesToAllOtherPages
(self, sourcePage: int)¶ Resets all other pages’ guides to match the guides from the specified
sourcePage
.- Parameters
sourcePage (int) –
-
beginInsertColumns
()¶
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
clear
(self)¶ Removes all guides from the collection.
See also
-
columnCount
(self, QModelIndex) → int¶ - Return type
int
-
connectNotify
()¶
-
createIndex
()¶
-
customEvent
()¶
-
data
(self, index: QModelIndex, role: int) → Any¶ - Parameters
index (QModelIndex) –
role (int) –
- Return type
Any
-
decodeData
()¶
-
disconnectNotify
()¶
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
flags
(self, index: QModelIndex) → Qt.ItemFlags¶ - Parameters
index (QModelIndex) –
- Return type
Qt.ItemFlags
-
guides
(self) → object¶ Returns a list of all guides contained in the collection.
guides(self, orientation: Qt.Orientation, page: int = -1) -> List[QgsLayoutGuide] Returns the list of guides contained in the collection with the specified
orientation
and on a matchingpage
. Ifpage
is -1, guides from all pages will be returned.See also
- Return type
object
-
guidesOnPage
(self, page: int) → List[QgsLayoutGuide]¶ Returns the list of guides contained on a matching
page
.See also
- Parameters
page (int) –
- Return type
List[QgsLayoutGuide]
-
headerData
(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) → Any¶ - Parameters
section (int) –
orientation (Qt.Orientation) –
role (int = Qt.DisplayRole) –
- Return type
Any
-
isSignalConnected
()¶
-
persistentIndexList
()¶
-
readXml
(self, collectionElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets the collection’s state from a DOM element. collectionElement is the DOM node corresponding to the collection.
See also
- Parameters
collectionElement (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
-
receivers
()¶
-
removeGuide
(self, guide: QgsLayoutGuide)¶ Removes the specified
guide
, and deletes it.See also
- Parameters
guide (QgsLayoutGuide) –
-
removeRows
(self, row: int, count: int, parent: QModelIndex = QModelIndex()) → bool¶ - Parameters
row (int) –
count (int) –
parent (QModelIndex = QModelIndex()) –
- Return type
bool
-
resetInternalData
()¶
-
rowCount
(self, QModelIndex) → int¶ - Return type
int
-
sender
()¶
-
senderSignalIndex
()¶
-
setData
(self, index: QModelIndex, value: Any, role: int) → bool¶ - Parameters
index (QModelIndex) –
value (Any) –
role (int) –
- Return type
bool
-
setGuideLayoutPosition
(self, guide: QgsLayoutGuide, position: float)¶ Sets the absolute
position
(in layout coordinates) forguide
within the layout.- Parameters
guide (QgsLayoutGuide) –
position (float) –
-
setVisible
(self, visible: bool)¶ Sets whether the guide lines should be
visible
.See also
- Parameters
visible (bool) –
-
stringType
(self) → str¶ - Return type
str
-
timerEvent
()¶
-
update
(self)¶ Updates the position (and visibility) of all guide line items.
-
visible
(self) → bool¶ Returns true if the guide lines should be drawn.
See also
- Return type
bool
-
writeXml
(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Stores the collection’s state in a DOM element. The
parentElement
should refer to the parent layout’s DOM element.See also
- Parameters
parentElement (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool