Class: QgsStyleModel¶
- class qgis.core.QgsStyleModel¶
Bases:
PyQt5.QtCore.QAbstractItemModel
A QAbstractItemModel subclass for showing symbol and color ramp entities contained within a
QgsStyle
database.If you are creating a style model for the default application style (see
QgsStyle.defaultStyle()
), consider using the shared style model available atQgsApplication.defaultStyleModel()
for performance instead.See also
New in version 3.4.
QgsStyleModel(style:
QgsStyle
, parent: QObject = None) Constructor forQgsStyleModel
, for the specifiedstyle
andparent
object.The
style
object must exist for the lifetime of this model.Enums
Bases:
enum.IntEnum
alias of
CustomRole
Methods
Adds an additional icon
size
to generate for Qt.DecorationRole data.Adds additional target screen
properties
to use when generating icons for Qt.DecorationRole data.- param parent:
- param index:
- param index:
- param section:
- param row:
- param index:
- param parent:
- param index:
Returns the style managed by the model.
Attributes
- class Column¶
Bases:
int
- class CustomRole(value)¶
Bases:
enum.IntEnum
Custom model roles.
Note
Prior to QGIS 3.36 this was available as QgsStyleModel.Role
New in version 3.36.
TypeRole
: Style entity type, see QgsStyle.StyleEntityTagRole
: String list of tagsEntityName
: Entity name (since QGIS 3.26)SymbolTypeRole
: Symbol type (for symbol or legend patch shape entities)IsFavoriteRole
: Whether entity is flagged as a favoriteLayerTypeRole
: Layer type (for label settings entities)CompatibleGeometryTypesRole
: Compatible layer geometry types (for 3D symbols)StyleName
: Name of associatedQgsStyle
(QgsStyle.name()) (since QGIS 3.26)StyleFileName
: File name of associatedQgsStyle
(QgsStyle.fileName()) (since QGIS 3.26)IsTitleRole
: True if the index corresponds to a title item (since QGIS 3.26)
- baseClass¶
alias of
QgsStyleModel
- Name = 0¶
- Role¶
alias of
CustomRole
- Tags = 1¶
- addDesiredIconSize(self, size: QSize)¶
Adds an additional icon
size
to generate for Qt.DecorationRole data.This allows style icons to be generated at an icon size which corresponds exactly to the view’s icon size in which this model is used.
- Parameters:
size (QSize) –
- addTargetScreenProperties(self, properties: QgsScreenProperties)¶
Adds additional target screen
properties
to use when generating icons for Qt.DecorationRole data.This allows style icons to be generated at an icon device pixel ratio and DPI which corresponds exactly to the view’s screen properties in which this model is used.
New in version 3.32.
- Parameters:
properties (QgsScreenProperties) –
- beginInsertColumns(self, QModelIndex, int, int)¶
- beginInsertRows(self, QModelIndex, int, int)¶
- beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) bool ¶
- beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) bool ¶
- beginRemoveColumns(self, QModelIndex, int, int)¶
- beginRemoveRows(self, QModelIndex, int, int)¶
- beginResetModel(self)¶
- changePersistentIndex(self, QModelIndex, QModelIndex)¶
- changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])¶
- childEvent(self, QChildEvent)¶
- columnCount(self, parent: QModelIndex = QModelIndex()) int ¶
- Parameters:
parent (QModelIndex = QModelIndex()) –
- Return type:
int
- connectNotify(self, QMetaMethod)¶
- createIndex(self, int, int, object: object = 0) QModelIndex ¶
- customEvent(self, QEvent)¶
- data(self, index: QModelIndex, role: int) Any ¶
- Parameters:
index (QModelIndex) –
role (int) –
- Return type:
Any
- decodeData(self, int, int, QModelIndex, QDataStream) bool ¶
- disconnectNotify(self, QMetaMethod)¶
- encodeData(self, Iterable[QModelIndex], 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 = 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
- isSignalConnected(self, QMetaMethod) bool ¶
- parent(self, index: QModelIndex) QModelIndex ¶
- Parameters:
index (QModelIndex) –
- Return type:
QModelIndex
- persistentIndexList(self) List[QModelIndex] ¶
- receivers(self, PYQT_SIGNAL) int ¶
- resetInternalData(self)¶
- rowCount(self, parent: QModelIndex = QModelIndex()) int ¶
- Parameters:
parent (QModelIndex = QModelIndex()) –
- Return type:
int
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) bool ¶
- Parameters:
index (QModelIndex) –
value (Any) –
role (int = Qt.EditRole) –
- Return type:
bool
- timerEvent(self, QTimerEvent)¶