Subgroup: Layout
Class: QgsLayoutModel¶
-
class
qgis.core.
QgsLayoutModel
(layout: QgsLayout, parent: QObject = None)¶ Bases:
PyQt5.QtCore.QAbstractItemModel
Constructor for a QgsLayoutModel attached to the specified
layout
.A model for items attached to a layout. The model also maintains the z-order for the layout, and must be notified whenever item stacking changes.
Internally, QgsLayoutModel maintains two lists. One contains a complete list of all items for the layout, ordered by their position within the z-order stack.
The second list contains only items which are currently displayed in the layout’s scene. It is used as a cache of the last known stacking order, so that the model can compare the current stacking of items in the layout to the last known state, and emit the corresponding signals as required.
New in version 3.0: Methods
beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
changePersistentIndex
changePersistentIndexList
childEvent
columnCount
connectNotify
createIndex
customEvent
data
decodeData
disconnectNotify
dropMimeData
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
flags
headerData
index
indexForItem
Returns the QModelIndex corresponding to a QgsLayoutItem
item
andcolumn
, if possible.isSignalConnected
itemFromIndex
Returns the QgsLayoutItem corresponding to a QModelIndex index
, if possible.mimeData
mimeTypes
parent
persistentIndexList
receivers
removeRows
resetInternalData
rowCount
sender
senderSignalIndex
setData
supportedDropActions
timerEvent
Signals
Attributes
ItemId
LockStatus
Visibility
-
class
Columns
¶ Bases:
int
-
ItemId
= 2¶
-
LockStatus
= 1¶
-
Visibility
= 0¶
-
beginInsertColumns
()¶
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
columnCount
(self, parent: QModelIndex = QModelIndex()) → int¶
-
connectNotify
()¶
-
createIndex
()¶
-
customEvent
()¶
-
data
(self, index: QModelIndex, role: int) → Any¶
-
decodeData
()¶
-
disconnectNotify
()¶
-
dropMimeData
(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) → bool¶
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
flags
(self, index: QModelIndex) → Qt.ItemFlags¶
-
headerData
(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) → Any¶
-
index
(self, row: int, column: int, parent: QModelIndex = QModelIndex()) → QModelIndex¶
-
indexForItem
(self, item: QgsLayoutItem, column: int = 0) → QModelIndex¶ Returns the QModelIndex corresponding to a
QgsLayoutItem
item
andcolumn
, if possible.See also
-
isSignalConnected
()¶
-
itemFromIndex
(self, index: QModelIndex) → QgsLayoutItem¶ Returns the QgsLayoutItem corresponding to a QModelIndex
index
, if possible.See also
-
mimeData
(self, indexes: object) → QMimeData¶
-
mimeTypes
(self) → List[str]¶
-
parent
(self, index: QModelIndex) → QModelIndex¶
-
persistentIndexList
()¶
-
receivers
()¶
-
removeRows
(self, row: int, count: int, parent: QModelIndex = QModelIndex()) → bool¶
-
resetInternalData
()¶
-
rowCount
(self, parent: QModelIndex = QModelIndex()) → int¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setData
(self, index: QModelIndex, value: Any, role: int) → bool¶
-
supportedDropActions
(self) → Qt.DropActions¶
-
timerEvent
()¶
-
class