qgsstylemodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsstylemodel.h
    ---------------
    begin                : September 2018
    copyright            : (C) 2018 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSTYLEMODEL_H
#define QGSSTYLEMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsstyle.h"
 
#include <QAbstractItemModel>
#include <QHash>
#include <QIcon>
#include <QSortFilterProxyModel>
 
class QgsSymbol;
class QgsCombinedStyleModel;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsAbstractStyleEntityIconGenerator : public QObject
{
    Q_OBJECT
 
  public:
    QgsAbstractStyleEntityIconGenerator( QObject *parent );

    virtual void generateIcon( QgsStyle *style, QgsStyle::StyleEntity type, const QString &name ) = 0;

    void setIconSizes( const QList< QSize > &sizes );

    QList< QSize > iconSizes() const;

    void setTargetScreenProperties( const QSet< QgsScreenProperties > &properties );

    QSet< QgsScreenProperties > targetScreenProperties() const;
 
  signals:

    void iconGenerated( QgsStyle::StyleEntity type, const QString &name, const QIcon &icon );
 
  private:
    QList< QSize > mIconSizes;
    QSet< QgsScreenProperties > mTargetScreenProperties;
};
 
#endif

class CORE_EXPORT QgsStyleModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum Column
    {
      Name = 0, 
      Tags,     
    };
 
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsStyleModel, Role ) : int
    {
      Type SIP_MONKEYPATCH_COMPAT_NAME( TypeRole ) = Qt::UserRole + 1,                    
      Tag SIP_MONKEYPATCH_COMPAT_NAME( TagRole ),                                         
      EntityName,                                                                         
      SymbolType SIP_MONKEYPATCH_COMPAT_NAME( SymbolTypeRole ),                           
      IsFavorite SIP_MONKEYPATCH_COMPAT_NAME( IsFavoriteRole ),                           
      LayerType SIP_MONKEYPATCH_COMPAT_NAME( LayerTypeRole ),                             
      CompatibleGeometryTypes SIP_MONKEYPATCH_COMPAT_NAME( CompatibleGeometryTypesRole ), 
      StyleName,                                                                          
      StyleFileName,                                                                      
      IsTitle SIP_MONKEYPATCH_COMPAT_NAME( IsTitleRole ),                                 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsStyleModel( QgsStyle *style, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsStyle *style() { return mStyle; }
 
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) 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;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;

    void addDesiredIconSize( QSize size );

    void addTargetScreenProperties( const QgsScreenProperties &properties );

    static void setIconGenerator( QgsAbstractStyleEntityIconGenerator *generator ) SIP_SKIP;
 
  private slots:
 
    void onEntityAdded( QgsStyle::StyleEntity type, const QString &name );
    void onEntityRemoved( QgsStyle::StyleEntity type, const QString &name );
    void onEntityChanged( QgsStyle::StyleEntity type, const QString &name );
    void onFavoriteChanged( QgsStyle::StyleEntity type, const QString &name, bool isFavorite );
    void onEntityRename( QgsStyle::StyleEntity type, const QString &oldName, const QString &newName );
    void onTagsChanged( int entity, const QString &name, const QStringList &tags );
    void rebuildSymbolIcons();
    void iconGenerated( QgsStyle::StyleEntity type, const QString &name, const QIcon &icon );
 
  private:
    void initStyleModel();
 
    QgsStyle *mStyle = nullptr;
 
    QHash< QgsStyle::StyleEntity, QStringList > mEntityNames;
 
    QSet< QgsScreenProperties > mTargetScreenProperties;
 
    QList< QSize > mAdditionalSizes;
    mutable std::unique_ptr< QgsExpressionContext > mExpressionContext;
 
    mutable QHash< QgsStyle::StyleEntity, QHash< QString, QIcon > > mIconCache;
 
    static QgsAbstractStyleEntityIconGenerator *sIconGenerator;
    mutable QSet< QString > mPending3dSymbolIcons;
 
    QgsStyle::StyleEntity entityTypeFromRow( int row ) const;
 
    int offsetForEntity( QgsStyle::StyleEntity entity ) const;
    static QVariant headerDataStatic( int section, Qt::Orientation orientation, int role = Qt::DisplayRole );
 
    friend class QgsCombinedStyleModel;
};

class CORE_EXPORT QgsStyleProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    explicit QgsStyleProxyModel( QgsStyle *style, QObject *parent SIP_TRANSFERTHIS = nullptr );

    explicit QgsStyleProxyModel( QgsStyleModel *model, QObject *parent SIP_TRANSFERTHIS = nullptr );

    explicit QgsStyleProxyModel( QgsCombinedStyleModel *model, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QString filterString() const { return mFilterString; }

    QgsStyle::StyleEntity entityFilter() const;

    void setEntityFilter( QgsStyle::StyleEntity filter );

    void setEntityFilters( const QList<QgsStyle::StyleEntity> &filters ) SIP_SKIP;

    bool entityFilterEnabled() const;

    void setEntityFilterEnabled( bool enabled );

    Qgis::SymbolType symbolType() const;

    void setSymbolType( Qgis::SymbolType type );

    bool symbolTypeFilterEnabled() const;

    void setSymbolTypeFilterEnabled( bool enabled );

    Qgis::GeometryType layerType() const;

    void setLayerType( Qgis::GeometryType type );

    void setTagId( int id );

    int tagId() const;

    void setTagString( const QString &tag );

    QString tagString() const;

    void setSmartGroupId( int id );

    int smartGroupId() const;
 
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;

    bool favoritesOnly() const;

    void setFavoritesOnly( bool favoritesOnly );

    void addDesiredIconSize( QSize size );

    void addTargetScreenProperties( const QgsScreenProperties &properties );
 
  public slots:

    void setFilterString( const QString &filter );
 
  private:
    void initialize();
 
    QgsStyleModel *mModel = nullptr;
    QgsCombinedStyleModel *mCombinedModel = nullptr;
    QgsStyle *mStyle = nullptr;
 
    QString mFilterString;
 
    int mTagId = -1;
    QStringList mTaggedSymbolNames;
 
    QString mTagFilter;
 
    int mSmartGroupId = -1;
    QStringList mSmartGroupSymbolNames;
 
    bool mFavoritesOnly = false;
 
    bool mEntityFilterEnabled = false;
    QList< QgsStyle::StyleEntity > mEntityFilters = QList< QgsStyle::StyleEntity >() << QgsStyle::SymbolEntity;
 
    bool mSymbolTypeFilterEnabled = false;
    Qgis::SymbolType mSymbolType = Qgis::SymbolType::Marker;
 
    Qgis::GeometryType mLayerType = Qgis::GeometryType::Unknown;
};
 
#endif //QGSSTYLEMODEL_H