QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
A QAbstractItemModel subclass for showing symbol and color ramp entities contained within a QgsStyle database. More...
#include <qgsstylemodel.h>
Public Types | |
enum | Column { Name = 0 , Tags } |
Model columns. More... | |
enum | Role { TypeRole = Qt::UserRole + 1 , TagRole , EntityName , SymbolTypeRole , IsFavoriteRole , LayerTypeRole , CompatibleGeometryTypesRole , StyleName , StyleFileName , IsTitleRole } |
Custom model roles. More... | |
Public Member Functions | |
QgsStyleModel (QgsStyle *style, QObject *parent=nullptr) | |
Constructor for QgsStyleModel, for the specified style and parent object. More... | |
void | addDesiredIconSize (QSize size) |
Adds an additional icon size to generate for Qt::DecorationRole data. More... | |
int | columnCount (const QModelIndex &parent=QModelIndex()) const override |
QVariant | data (const QModelIndex &index, int role) const override |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override |
QModelIndex | index (int row, int column, const QModelIndex &parent=QModelIndex()) const override |
QModelIndex | parent (const QModelIndex &index) const override |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
bool | setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override |
QgsStyle * | style () |
Returns the style managed by the model. More... | |
Static Public Member Functions | |
static void | setIconGenerator (QgsAbstractStyleEntityIconGenerator *generator) |
Sets the icon generator to use for deferred style entity icon generation. More... | |
Friends | |
class | QgsCombinedStyleModel |
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 at QgsApplication::defaultStyleModel() for performance instead.
Definition at line 107 of file qgsstylemodel.h.
Model columns.
Enumerator | |
---|---|
Name | Name column. |
Tags | Tags column. |
Definition at line 114 of file qgsstylemodel.h.
enum QgsStyleModel::Role |
Custom model roles.
Enumerator | |
---|---|
TypeRole | Style entity type, see QgsStyle::StyleEntity. |
TagRole | String list of tags. |
EntityName | Entity name (since QGIS 3.26) |
SymbolTypeRole | Symbol type (for symbol or legend patch shape entities) |
IsFavoriteRole | Whether entity is flagged as a favorite. |
LayerTypeRole | Layer type (for label settings entities) |
CompatibleGeometryTypesRole | Compatible layer geometry types (for 3D symbols) |
StyleName | Name of associated QgsStyle (QgsStyle::name()) (since QGIS 3.26) |
StyleFileName | File name of associated QgsStyle (QgsStyle::fileName()) (since QGIS 3.26) |
IsTitleRole | True if the index corresponds to a title item (since QGIS 3.26) |
Definition at line 121 of file qgsstylemodel.h.
|
explicit |
Constructor for QgsStyleModel, for the specified style and parent object.
The style object must exist for the lifetime of this model.
Definition at line 60 of file qgsstylemodel.cpp.
void QgsStyleModel::addDesiredIconSize | ( | QSize | size | ) |
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.
Definition at line 586 of file qgsstylemodel.cpp.
|
override |
Definition at line 581 of file qgsstylemodel.cpp.
|
override |
Definition at line 91 of file qgsstylemodel.cpp.
|
override |
Definition at line 503 of file qgsstylemodel.cpp.
|
override |
Definition at line 516 of file qgsstylemodel.cpp.
|
override |
Definition at line 550 of file qgsstylemodel.cpp.
|
override |
Definition at line 563 of file qgsstylemodel.cpp.
|
override |
Definition at line 569 of file qgsstylemodel.cpp.
|
override |
Definition at line 470 of file qgsstylemodel.cpp.
|
static |
Sets the icon generator to use for deferred style entity icon generation.
Currently this is used for 3D symbol icons only.
Definition at line 599 of file qgsstylemodel.cpp.
|
inline |
Returns the style managed by the model.
Definition at line 147 of file qgsstylemodel.h.
|
friend |
Definition at line 209 of file qgsstylemodel.h.