qgsstyle.h

Go to the documentation of this file.

/***************************************************************************
    qgsstyle.h
    ---------------------
    begin                : November 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk 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 QGSSTYLE_H
#define QGSSTYLE_H
 
#include <sqlite3.h>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgslegendpatchshape.h"
#include "qgspallabeling.h"
#include "qgssqliteutils.h"
#include "qgssymbollayerutils.h"
#include "qgstextformat.h"
 
#include <QMap>
#include <QMultiMap>
#include <QString>
 
class QgsSymbol;
class QgsSymbolLayer;
class QgsColorRamp;
class QgsStyleEntityInterface;
class QgsAbstract3DSymbol;
class QDomDocument;
class QDomElement;
 
typedef QMap<QString, QgsColorRamp * > QgsVectorColorRampMap;
typedef QMap<int, QString> QgsSymbolGroupMap;

typedef QMap<QString, QgsTextFormat > QgsTextFormatMap;

typedef QMap<QString, QgsPalLayerSettings > QgsLabelSettingsMap;
 
/*
 * Constants used to describe copy-paste MIME types
 */
#define QGSCLIPBOARD_STYLE_MIME "application/qgis.style"
#define QGSCLIPBOARD_STYLES_MIME "application/qgis.styles"

typedef QMultiMap<QString, QString> QgsSmartConditionMap;
 

class CORE_EXPORT QgsStyle : public QObject
{
    Q_OBJECT
 
  public:

    enum class SymbolTableColumn : int
    {
      Id, 
      Name, 
      XML, 
      FavoriteId, 
    };
    Q_ENUM( SymbolTableColumn )
 
    
    enum class TagTableColumn : int
    {
      Id, 
      Name, 
    };
    Q_ENUM( TagTableColumn )
 
    
    enum class TagmapTableColumn : int
    {
      TagId, 
      SymbolId, 
    };
    Q_ENUM( TagmapTableColumn )
 
    
    enum class ColorRampTableColumn : int
    {
      Id, 
      Name, 
      XML, 
      FavoriteId, 
    };
    Q_ENUM( ColorRampTableColumn )
 
    
    enum class TextFormatTableColumn : int
    {
      Id, 
      Name, 
      XML, 
      FavoriteId, 
    };
    Q_ENUM( TextFormatTableColumn )
 
    
    enum class LabelSettingsTableColumn : int
    {
      Id, 
      Name, 
      XML, 
      FavoriteId, 
    };
    Q_ENUM( LabelSettingsTableColumn )
 
    
    enum class SmartGroupTableColumn : int
    {
      Id, 
      Name, 
      XML, 
    };
    Q_ENUM( SmartGroupTableColumn )
 
    
    QgsStyle( QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsStyle() override;

    enum StyleEntity
    {
      SymbolEntity, 
      TagEntity, 
      ColorrampEntity, 
      SmartgroupEntity, 
      TextFormatEntity, 
      LabelSettingsEntity, 
      LegendPatchShapeEntity, 
      Symbol3DEntity, 
    };

    QString name() const;

    void setName( const QString &name );

    bool isInitialized() const { return mInitialized; }

    bool isReadOnly() const;

    void setReadOnly( bool readOnly );

    bool addEntity( const QString &name, const QgsStyleEntityInterface *entity, bool update = false );

    bool addSymbol( const QString &name, QgsSymbol *symbol SIP_TRANSFER, bool update = false );

    bool addColorRamp( const QString &name, QgsColorRamp *colorRamp SIP_TRANSFER, bool update = false );

    bool addTextFormat( const QString &name, const QgsTextFormat &format, bool update = false );

    bool addLabelSettings( const QString &name, const QgsPalLayerSettings &settings, bool update = false );

    bool addLegendPatchShape( const QString &name, const QgsLegendPatchShape &shape, bool update = false );

    bool addSymbol3D( const QString &name, QgsAbstract3DSymbol *symbol SIP_TRANSFER, bool update = false );

    int addTag( const QString &tagName );

    int addSmartgroup( const QString &name, const QString &op, const QgsSmartConditionMap &conditions ) SIP_SKIP;

    int addSmartgroup( const QString &name, const QString &op, const QStringList &matchTag, const QStringList &noMatchTag,
                       const QStringList &matchName, const QStringList &noMatchName );

    QStringList tags() const;

    void clear();

    QgsColorRamp *colorRamp( const QString &name ) const SIP_FACTORY;

    int colorRampCount();

    QStringList colorRampNames() const;

    const QgsColorRamp *colorRampRef( const QString &name ) const;

    int colorrampId( const QString &name );

    QgsTextFormat textFormat( const QString &name ) const;

    int textFormatCount() const;

    QStringList textFormatNames() const;

    int textFormatId( const QString &name );

    QgsPalLayerSettings labelSettings( const QString &name ) const;

    QgsLegendPatchShape legendPatchShape( const QString &name ) const;

    int legendPatchShapesCount() const;

    Qgis::SymbolType legendPatchShapeSymbolType( const QString &name ) const;

    QgsAbstract3DSymbol *symbol3D( const QString &name ) const SIP_FACTORY;

    int symbol3DCount() const;

    QList< Qgis::GeometryType > symbol3DCompatibleGeometryTypes( const QString &name ) const;

    Qgis::GeometryType labelSettingsLayerType( const QString &name ) const;

    int labelSettingsCount() const;

    QStringList labelSettingsNames() const;

    int labelSettingsId( const QString &name );

    static QgsStyle *defaultStyle( bool initialize = true );

    static void cleanDefaultStyle() SIP_SKIP;

    bool tagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags );

    bool detagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags );

    bool detagSymbol( StyleEntity type, const QString &symbol );

    bool removeSymbol( const QString &name );

    bool renameEntity( StyleEntity type, const QString &oldName, const QString &newName );

    bool renameSymbol( const QString &oldName, const QString &newName );

    QgsSymbol *symbol( const QString &name ) SIP_FACTORY;

    const QgsSymbol *symbolRef( const QString &name ) const;

    int symbolCount();

    QStringList symbolNames() const;

    int symbolId( const QString &name );

    int entityId( StyleEntity type, const QString &name );

    int tagId( const QString &tag );
    int smartgroupId( const QString &smartgroup );

    QStringList allNames( StyleEntity type ) const;

    QStringList symbolsOfFavorite( StyleEntity type ) const;

    QStringList symbolsWithTag( StyleEntity type, int tagid ) const;

    bool addFavorite( StyleEntity type, const QString &name );

    bool removeFavorite( StyleEntity type, const QString &name );

    bool rename( StyleEntity type, int id, const QString &newName );

    bool remove( StyleEntity type, int id );

    bool removeEntityByName( StyleEntity type, const QString &name );

    bool saveSymbol( const QString &name, const QgsSymbol *symbol, bool favorite, const QStringList &tags );

    bool saveColorRamp( const QString &name, const QgsColorRamp *ramp, bool favorite, const QStringList &tags );

    bool removeColorRamp( const QString &name );

    bool renameColorRamp( const QString &oldName, const QString &newName );

    bool saveTextFormat( const QString &name, const QgsTextFormat &format, bool favorite, const QStringList &tags );

    bool removeTextFormat( const QString &name );

    bool renameTextFormat( const QString &oldName, const QString &newName );

    bool saveLabelSettings( const QString &name, const QgsPalLayerSettings &settings, bool favorite, const QStringList &tags );

    bool removeLabelSettings( const QString &name );

    bool renameLabelSettings( const QString &oldName, const QString &newName );

    bool saveLegendPatchShape( const QString &name, const QgsLegendPatchShape &shape, bool favorite, const QStringList &tags );

    bool renameLegendPatchShape( const QString &oldName, const QString &newName );

    QStringList legendPatchShapeNames() const;

    const QgsSymbol *previewSymbolForPatchShape( const QgsLegendPatchShape &shape ) const;

    QgsLegendPatchShape defaultPatch( Qgis::SymbolType type, QSizeF size ) const;

    QList< QList< QPolygonF > > defaultPatchAsQPolygonF( Qgis::SymbolType type, QSizeF size ) const;

    enum class TextFormatContext : int
    {
      Labeling, 
    };

    QgsTextFormat defaultTextFormat( QgsStyle::TextFormatContext context = QgsStyle::TextFormatContext::Labeling ) const;

    static QgsTextFormat defaultTextFormatForProject( QgsProject *project,  QgsStyle::TextFormatContext context = QgsStyle::TextFormatContext::Labeling );

    bool saveSymbol3D( const QString &name, QgsAbstract3DSymbol *symbol SIP_TRANSFER, bool favorite, const QStringList &tags );

    bool renameSymbol3D( const QString &oldName, const QString &newName );

    QStringList symbol3DNames() const;

    bool createDatabase( const QString &filename );

    bool createMemoryDatabase();

    void createTables();

    bool load( const QString &filename );

    Q_DECL_DEPRECATED bool save( const QString &filename = QString() ) SIP_DEPRECATED;

    QString errorString() const { return mErrorString; }

    QString fileName() const { return mFileName; }

    void setFileName( const QString &filename );

    QStringList findSymbols( StyleEntity type, const QString &qword );

    QStringList tagsOfSymbol( StyleEntity type, const QString &symbol );

    bool isFavorite( StyleEntity type, const QString &name );

    bool symbolHasTag( StyleEntity type, const QString &symbol, const QString &tag );

    QString tag( int id ) const;

    QgsSymbolGroupMap smartgroupsListMap();

    QStringList smartgroupNames() const;

    QgsSmartConditionMap smartgroup( int id );

    QString smartgroupOperator( int id );

    QStringList symbolsOfSmartgroup( StyleEntity type, int id );

    bool exportXml( const QString &filename );

    bool importXml( const QString &filename );

    static bool isXmlStyleFile( const QString &path );
 
  public slots:
#ifndef SIP_RUN

    void triggerIconRebuild();
#endif
 
  signals:

    void initialized();

    void aboutToBeDestroyed();

    void symbolSaved( const QString &name, const QgsSymbol *symbol );

    void symbolChanged( const QString &name );

    void groupsModified();

    void entityTagsChanged( QgsStyle::StyleEntity entity, const QString &name, const QStringList &newTags );

    void favoritedChanged( QgsStyle::StyleEntity entity, const QString &name, bool isFavorite );

    void entityAdded( QgsStyle::StyleEntity entity, const QString &name );

    void entityRemoved( QgsStyle::StyleEntity entity, const QString &name );

    void entityRenamed( QgsStyle::StyleEntity entity, const QString &oldName, const QString &newName );

    void entityChanged( QgsStyle::StyleEntity entity, const QString &name );

    void symbolRemoved( const QString &name );

    void symbolRenamed( const QString &oldName, const QString &newName );

    void rampRenamed( const QString &oldName, const QString &newName );

    void rampAdded( const QString &name );

    void rampRemoved( const QString &name );

    void rampChanged( const QString &name );

    void textFormatRenamed( const QString &oldName, const QString &newName );

    void textFormatAdded( const QString &name );

    void textFormatRemoved( const QString &name );

    void textFormatChanged( const QString &name );

    void labelSettingsRenamed( const QString &oldName, const QString &newName );

    void labelSettingsAdded( const QString &name );

    void labelSettingsRemoved( const QString &name );

    void labelSettingsChanged( const QString &name );

    void rebuildIconPreviews();
 
  private:
 
    bool mInitialized = true;
    QString mName;
    bool mReadOnly = false;
 
    QgsSymbolMap mSymbols;
    QgsVectorColorRampMap mColorRamps;
    QgsTextFormatMap mTextFormats;
    QgsLabelSettingsMap mLabelSettings;
    QMap<QString, QgsLegendPatchShape > mLegendPatchShapes;
    QMap<QString, QgsAbstract3DSymbol * > m3dSymbols;
 
    QHash< QgsStyle::StyleEntity, QHash< QString, QStringList > > mCachedTags;
    QHash< QgsStyle::StyleEntity, QHash< QString, bool > > mCachedFavorites;
 
    QString mErrorString;
    QString mFileName;
 
    sqlite3_database_unique_ptr mCurrentDB;
 
    std::unique_ptr< QgsSymbol > mPatchMarkerSymbol;
    std::unique_ptr< QgsSymbol > mPatchLineSymbol;
    std::unique_ptr< QgsSymbol > mPatchFillSymbol;
 
    mutable QHash< int, QHash< QSizeF, QgsLegendPatchShape > > mDefaultPatchCache;
    mutable QHash< int, QHash< QSizeF, QList< QList< QPolygonF > > > > mDefaultPatchQPolygonFCache;
 
    QMap< QString, QDomElement > mDeferred3DsymbolElements;
    void handleDeferred3DSymbolCreation();
 
    static QgsStyle *sDefaultStyle;

    void initializeDefaultStyle( const QString &filename );

    bool openDatabase( const QString &filename );

    bool importXml( const QString &filename, int sinceVersion );

    bool runEmptyQuery( const QString &query );

    int getId( const QString &table, const QString &name );

    QString getName( const QString &table, int id ) const;

    bool updateSymbol( StyleEntity type, const QString &name );
 
    void clearCachedTags( StyleEntity type, const QString &name );

    bool createStyleMetadataTableIfNeeded();
    void upgradeIfRequired();

    static QString entityTableName( StyleEntity type );

    static QString tagmapTableName( StyleEntity type );

    static QString tagmapEntityIdFieldName( StyleEntity type );
 
    friend class Qgs3D;
    friend class TestStyle;
 
    Q_DISABLE_COPY( QgsStyle )
};

class CORE_EXPORT QgsStyleEntityInterface
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    switch ( sipCpp->type() )
    {
      case QgsStyle::SymbolEntity:
        sipType = sipType_QgsStyleSymbolEntity;
        break;
 
      case QgsStyle::ColorrampEntity:
        sipType = sipType_QgsStyleColorRampEntity;
        break;
 
      case QgsStyle::TextFormatEntity:
        sipType = sipType_QgsStyleTextFormatEntity;
        break;
 
      case QgsStyle::LabelSettingsEntity:
        sipType = sipType_QgsStyleLabelSettingsEntity;
        break;
 
      case QgsStyle::SmartgroupEntity:
      case QgsStyle::TagEntity:
        sipType = 0;
        break;
    }
    SIP_END
#endif
 
  public:
 
    virtual ~QgsStyleEntityInterface() = default;

    virtual QgsStyle::StyleEntity type() const = 0;
 
};

class CORE_EXPORT QgsStyleSymbolEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleSymbolEntity( QgsSymbol *symbol )
      : mSymbol( symbol )
    {}
 
    QgsStyle::StyleEntity type() const override;

    QgsSymbol *symbol() const { return mSymbol; }
 
  private:
 
    QgsSymbol *mSymbol = nullptr;
 
};

class CORE_EXPORT QgsStyleColorRampEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleColorRampEntity( QgsColorRamp *ramp )
      : mRamp( ramp )
    {}
 
    QgsStyle::StyleEntity type() const override;

    QgsColorRamp *ramp() const { return mRamp; }
 
  private:
 
    QgsColorRamp *mRamp = nullptr;
};

class CORE_EXPORT QgsStyleTextFormatEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleTextFormatEntity( const QgsTextFormat &format )
      : mFormat( format )
    {}
 
    QgsStyle::StyleEntity type() const override;

    QgsTextFormat format() const { return mFormat; }
 
  private:
 
    QgsTextFormat mFormat;
 
};

class CORE_EXPORT QgsStyleLabelSettingsEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleLabelSettingsEntity( const QgsPalLayerSettings &settings )
      : mSettings( settings )
    {}
 
    QgsStyle::StyleEntity type() const override;
 

    const QgsPalLayerSettings &settings() const { return mSettings; }
 
  private:
 
    QgsPalLayerSettings mSettings;
};

class CORE_EXPORT QgsStyleLegendPatchShapeEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleLegendPatchShapeEntity( const QgsLegendPatchShape &shape )
      : mShape( shape )
    {}
 
    QgsStyle::StyleEntity type() const override;
 

    const QgsLegendPatchShape &shape() const { return mShape; }
 
  private:
 
    QgsLegendPatchShape mShape;
};

class CORE_EXPORT QgsStyleSymbol3DEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleSymbol3DEntity( const QgsAbstract3DSymbol *symbol )
      : mSymbol( symbol )
    {}
 
    QgsStyle::StyleEntity type() const override;

    const QgsAbstract3DSymbol *symbol() const { return mSymbol; }
 
  private:
 
    const QgsAbstract3DSymbol *mSymbol = nullptr;
};
 
#endif