Class: QgsSettingsTreeModel

class qgis.gui.QgsSettingsTreeModel

Bases: PyQt5.QtCore.QAbstractItemModel

QgsSettingsTreeModel is a tree model for the settings tree.

Added in version 3.32.

QgsSettingsTreeModel(rootNode: Optional[QgsSettingsTreeNode] = None, parent: Optional[QObject] = None) Constructor

Enums

Column

Bases: enum.IntEnum

Methods

applyChanges	Apply pending changes in the model to the corresponding settings
beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
changePersistentIndex
changePersistentIndexList
childEvent
columnCount	param parent:
connectNotify
createIndex
customEvent
data	param index:
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
flags	param index:
headerData	param section:
index	param row:
isSignalConnected
parent	param child:
persistentIndexList
receivers
resetInternalData
rowCount	param parent:
sender
senderSignalIndex
setData	param index:
timerEvent

class Column(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Columns

• Name: Name

• Value: Value

• Description: Description

Description = 2

Name = 0

Value = 1

applyChanges(self)

Apply pending changes in the model to the corresponding settings

beginInsertColumns(self, parent: QModelIndex, first: int, last: int)

beginInsertRows(self, parent: QModelIndex, first: int, last: int)

beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) → bool

beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) → bool

beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)

beginRemoveRows(self, parent: QModelIndex, first: int, last: int)

beginResetModel(self)

changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)

changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])

childEvent(self, a0: QChildEvent | None)

columnCount(self, parent: QModelIndex) → int

Parameters:

parent (QModelIndex)

Return type:

int

connectNotify(self, signal: QMetaMethod)

createIndex(self, row: int, column: int, object: Any = None) → QModelIndex

customEvent(self, a0: QEvent | None)

data(self, index: QModelIndex, role: int) → Any

Parameters:

• index (QModelIndex)

• role (int)

Return type:

Any

decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) → bool

disconnectNotify(self, signal: QMetaMethod)

encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)

endInsertColumns(self)

endInsertRows(self)

endMoveColumns(self)

endMoveRows(self)

endRemoveColumns(self)

endRemoveRows(self)

endResetModel(self)

flags(self, index: QModelIndex) → Qt.ItemFlags

Parameters:

index (QModelIndex)

Return type:

Qt.ItemFlags

headerData(self, section: int, orientation: Qt.Orientation, role: int) → Any

Parameters:

• section (int)

• orientation (Qt.Orientation)

• role (int)

Return type:

Any

index(self, row: int, column: int, parent: QModelIndex) → QModelIndex

Parameters:

• row (int)

• column (int)

• parent (QModelIndex)

Return type:

QModelIndex

isSignalConnected(self, signal: QMetaMethod) → bool

parent(self, child: QModelIndex) → QModelIndex

Parameters:

child (QModelIndex)

Return type:

QModelIndex

persistentIndexList(self) → List[QModelIndex]

receivers(self, signal: PYQT_SIGNAL) → int

resetInternalData(self)

rowCount(self, parent: QModelIndex) → int

Parameters:

parent (QModelIndex)

Return type:

int

sender(self) → QObject | None

senderSignalIndex(self) → int

setData(self, index: QModelIndex, value: Any, role: int) → bool

Parameters:

• index (QModelIndex)

• value (Any)

• role (int)

Return type:

bool

timerEvent(self, a0: QTimerEvent | None)