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 "qgis_core.h"
#include "qgis.h"
#include <QMap>
#include <QMultiMap>
#include <QString>

#include <sqlite3.h>

#include "qgssqliteutils.h"
#include "qgssymbollayerutils.h" // QgsStringMap
#include "qgstextrenderer.h"
#include "qgspallabeling.h"

class QgsSymbol;
class QgsSymbolLayer;
class QgsColorRamp;
class QgsStyleEntityInterface;

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"

typedef QMultiMap<QString, QString> QgsSmartConditionMap;

// enumerators representing sqlite DB columns

enum SymbolTable
{
  SymbolId, 
  SymbolName, 
  SymbolXML, 
  SymbolFavoriteId, 
};

enum TagTable
{
  TagId, 
  TagName, 
};

enum TagmapTable
{
  TagmapTagId, 
  TagmapSymbolId, 
};

enum ColorrampTable
{
  ColorrampId, 
  ColorrampName, 
  ColorrampXML, 
  ColorrampFavoriteId, 
};

enum TextFormatTable
{
  TextFormatId, 
  TextFormatName, 
  TextFormatXML, 
  TextFormatFavoriteId, 
};

enum LabelSettingsTable
{
  LabelSettingsId, 
  LabelSettingsName, 
  LabelSettingsXML, 
  LabelSettingsFavoriteId, 
};

enum SmartgroupTable
{
  SmartgroupId, 
  SmartgroupName, 
  SmartgroupXML, 
};

class CORE_EXPORT QgsStyle : public QObject
{
    Q_OBJECT

  public:

    QgsStyle() = default;
    ~QgsStyle() override;

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

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

    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;

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

    int labelSettingsCount() const;

    QStringList labelSettingsNames() const;

    int labelSettingsId( const QString &name );

    static QgsStyle *defaultStyle();

    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 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 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 saveSymbol( const QString &name, QgsSymbol *symbol, bool favorite, const QStringList &tags );

    bool saveColorRamp( const QString &name, 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 createDatabase( const QString &filename );

    bool createMemoryDatabase();

    void createTables();

    bool load( const QString &filename );

    bool save( QString filename = QString() );

    QString errorString() { return mErrorString; }

    QString fileName() { return mFileName; }

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

  signals:

    void symbolSaved( const QString &name, 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 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 );

  private:

    QgsSymbolMap mSymbols;
    QgsVectorColorRampMap mColorRamps;
    QgsTextFormatMap mTextFormats;
    QgsLabelSettingsMap mLabelSettings;

    QHash< QString, QStringList > mCachedSymbolTags;
    QHash< QString, QStringList > mCachedColorRampTags;
    QHash< QString, QStringList > mCachedTextFormatTags;
    QHash< QString, QStringList > mCachedLabelSettingsTags;

    QHash< QString, bool > mCachedSymbolFavorites;
    QHash< QString, bool > mCachedColorRampFavorites;
    QHash< QString, bool > mCachedTextFormatFavorites;
    QHash< QString, bool > mCachedLabelSettingsFavorites;

    QString mErrorString;
    QString mFileName;

    sqlite3_database_unique_ptr mCurrentDB;

    static QgsStyle *sDefaultStyle;

    bool openDatabase( const QString &filename );

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

    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( const QgsSymbol *symbol )
      : mSymbol( symbol )
    {}

    QgsStyle::StyleEntity type() const override;

    const QgsSymbol *symbol() const { return mSymbol; }

  private:

    const QgsSymbol *mSymbol = nullptr;

};

class CORE_EXPORT QgsStyleColorRampEntity : public QgsStyleEntityInterface
{
  public:

    QgsStyleColorRampEntity( const QgsColorRamp *ramp )
      : mRamp( ramp )
    {}

    QgsStyle::StyleEntity type() const override;

    const QgsColorRamp *ramp() const { return mRamp; }

  private:

    const 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;
};

#endif