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 "qgssymbol.h"
#include <QAbstractItemModel>
#include <QSortFilterProxyModel>
#include <QIcon>
#include <QHash>

class QgsSymbol;

class CORE_EXPORT QgsStyleModel: public QAbstractItemModel
{
    Q_OBJECT

  public:

    enum Column
    {
      Name = 0, 
      Tags, 
    };

    enum Role
    {
      TypeRole = Qt::UserRole + 1, 
      TagRole, 
      SymbolTypeRole, 
    };

    explicit QgsStyleModel( QgsStyle *style, QObject *parent SIP_TRANSFERTHIS = nullptr );

    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 );

  private slots:

    void onSymbolAdded( const QString &name, QgsSymbol *symbol );
    void onSymbolRemoved( const QString &name );
    void onSymbolChanged( const QString &name );
    void onSymbolRename( const QString &oldName, const QString &newName );
    void onRampAdded( const QString &name );
    void onRampRemoved( const QString &name );
    void onRampChanged( const QString &name );
    void onRampRename( const QString &oldName, const QString &newName );
    void onTagsChanged( int entity, const QString &name, const QStringList &tags );
    void rebuildSymbolIcons();

  private:

    QgsStyle *mStyle = nullptr;
    QStringList mSymbolNames;
    QStringList mRampNames;
    QList< QSize > mAdditionalSizes;

    mutable QHash< QString, QIcon > mSymbolIconCache;
    mutable QHash< QString, QIcon > mColorRampIconCache;

};

class CORE_EXPORT QgsStyleProxyModel: public QSortFilterProxyModel
{
    Q_OBJECT

  public:

    explicit QgsStyleProxyModel( QgsStyle *style, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QString filterString() const { return mFilterString; }

    QgsStyle::StyleEntity entityFilter() const;

    void setEntityFilter( QgsStyle::StyleEntity filter );

    bool entityFilterEnabled() const;

    void setEntityFilterEnabled( bool enabled );

    QgsSymbol::SymbolType symbolType() const;

    void setSymbolType( QgsSymbol::SymbolType type );

    bool symbolTypeFilterEnabled() const;

    void setSymbolTypeFilterEnabled( bool enabled );

    void setTagId( int id );

    int tagId() const;

    void setSmartGroupId( int id );

    int smartGroupId() const;

    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;

    bool favoritesOnly() const;

    void setFavoritesOnly( bool favoritesOnly );

    void addDesiredIconSize( QSize size );

  public slots:

    void setFilterString( const QString &filter );

  private:

    QgsStyleModel *mModel = nullptr;
    QgsStyle *mStyle = nullptr;

    QString mFilterString;

    int mTagId = -1;
    QStringList mTaggedSymbolNames;

    int mSmartGroupId = -1;
    QStringList mSmartGroupSymbolNames;

    bool mFavoritesOnly = false;
    QStringList mFavoritedSymbolNames;

    bool mEntityFilterEnabled = false;
    QgsStyle::StyleEntity mEntityFilter = QgsStyle::SymbolEntity;

    bool mSymbolTypeFilterEnabled = false;
    QgsSymbol::SymbolType mSymbolType = QgsSymbol::Marker;

};

#endif //QGSSTYLEMODEL_H