Class: QgsLayoutModel¶
-
class
qgis.core.
QgsLayoutModel
(layout: QgsLayout, parent: QObject = None)¶ Bases:
PyQt5.QtCore.QAbstractItemModel
Constructor for a
QgsLayoutModel
attached to the specifiedlayout
.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.
- Parameters
layout (QgsLayout) –
parent –
-
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¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
connectNotify
()¶
-
createIndex
()¶
-
customEvent
()¶
-
data
(self, index: QModelIndex, role: int) → Any¶ - Parameters
index (QModelIndex) –
role (int) –
- Return type
Any
-
decodeData
()¶
-
disconnectNotify
()¶
-
dropMimeData
(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) → bool¶ - Parameters
data (QMimeData) –
action (Qt.DropAction) –
row (int) –
column (int) –
parent (QModelIndex) –
- Return type
bool
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
flags
(self, index: QModelIndex) → Qt.ItemFlags¶ - Parameters
index (QModelIndex) –
- Return type
Qt.ItemFlags
-
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
-
index
(self, row: int, column: int, parent: QModelIndex = QModelIndex()) → QModelIndex¶ - Parameters
row (int) –
column (int) –
parent (QModelIndex = QModelIndex()) –
- Return type
QModelIndex
-
indexForItem
(self, item: QgsLayoutItem, column: int = 0) → QModelIndex¶ Returns the QModelIndex corresponding to a
QgsLayoutItem
item
andcolumn
, if possible.See also
- Parameters
item (QgsLayoutItem) –
column (int = 0) –
- Return type
QModelIndex
-
isSignalConnected
()¶
-
itemFromIndex
(self, index: QModelIndex) → QgsLayoutItem¶ Returns the
QgsLayoutItem
corresponding to a QModelIndexindex
, if possible.See also
- Parameters
index (QModelIndex) –
- Return type
-
mimeData
(self, indexes: object) → QMimeData¶ - Parameters
indexes (object) –
- Return type
QMimeData
-
mimeTypes
(self) → List[str]¶ - Return type
List[str]
-
parent
(self, index: QModelIndex) → QModelIndex¶ - Parameters
index (QModelIndex) –
- Return type
QModelIndex
-
persistentIndexList
()¶
-
receivers
()¶
-
removeRows
(self, row: int, count: int, parent: QModelIndex = QModelIndex()) → bool¶ - Parameters
row (int) –
count (int) –
parent (QModelIndex = QModelIndex()) –
- Return type
bool
-
resetInternalData
()¶
-
rowCount
(self, parent: QModelIndex = QModelIndex()) → int¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
sender
()¶
-
senderSignalIndex
()¶
-
setData
(self, index: QModelIndex, value: Any, role: int) → bool¶ - Parameters
index (QModelIndex) –
value (Any) –
role (int) –
- Return type
bool
-
supportedDropActions
(self) → Qt.DropActions¶ - Return type
Qt.DropActions
-
timerEvent
()¶