qgsstylev2.h

Go to the documentation of this file.

/***************************************************************************
    qgsstylev2.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 QGSSTYLEV2_H
#define QGSSTYLEV2_H

#include <QMap>
#include <QMultiMap>
#include <QString>

#include <sqlite3.h>

#include "qgssymbollayerv2utils.h" // QgsStringMap

class QgsSymbolV2;
class QgsSymbolLayerV2;
class QgsVectorColorRampV2;

class QDomDocument;
class QDomElement;

typedef QMap<QString, QgsVectorColorRampV2* > QgsVectorColorRampV2Map;
typedef QMap<int, QString> QgsSymbolGroupMap;

typedef QMultiMap<QString, QString> QgsSmartConditionMap;

// enumerators representing sqlite DB columns
enum SymbolTable { SymbolId, SymbolName, SymbolXML, SymbolGroupId };
enum SymgroupTable { SymgroupId, SymgroupName, SymgroupParent };
enum TagTable { TagId, TagName };
enum TagmapTable { TagmapTagId, TagmapSymbolId };
enum ColorrampTable { ColorrampId, ColorrampName, ColorrampXML, ColorrampGroupId };
enum SmartgroupTable { SmartgroupId, SmartgroupName, SmartgroupXML };

class CORE_EXPORT QgsStyleV2 : public QObject
{
    Q_OBJECT

  public:
    QgsStyleV2();
    ~QgsStyleV2();


    enum StyleEntity { SymbolEntity, GroupEntity, TagEntity, ColorrampEntity, SmartgroupEntity };


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


    int addGroup( const QString& groupName, int parent = 0 );


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


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


    int addTag( const QString& tagName );

    QStringList tags() const;

    QgsSymbolGroupMap childGroupNames( const QString& parent = "" );

    void clear();

    QgsVectorColorRampV2* colorRamp( const QString& name );

    int colorRampCount();

    QStringList colorRampNames();

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

    int colorrampId( const QString& name );

    static QgsStyleV2* defaultStyle();


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


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

    bool removeSymbol( const QString& name );

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

    QgsSymbolV2* symbol( const QString& name );

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

    int symbolCount();

    QStringList symbolNames();

    int symbolId( const QString& name );
    int groupId( const QString& group );
    QString groupName( int groupId ) const;
    int tagId( const QString& tag );
    int smartgroupId( const QString& smartgroup );

    QStringList groupNames();

    QList<int> groupIds() const;


    QStringList symbolsOfGroup( StyleEntity type, int groupid );


    QStringList symbolsWithTag( StyleEntity type, int tagid );


    bool group( StyleEntity type, const QString& name, int groupid );


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


    void remove( StyleEntity type, int id );


    bool saveSymbol( const QString& name, QgsSymbolV2* symbol, int groupid, const QStringList& tags );


    bool saveColorRamp( const QString& name, QgsVectorColorRampV2* ramp, int groupid, const QStringList& tags );

    bool removeColorRamp( const QString& name );

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

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

    QgsSymbolGroupMap smartgroupsListMap();

    QStringList smartgroupNames();

    QgsSmartConditionMap smartgroup( int id );

    //clumsy implementation TODO create a class for smartgroups
    QString smartgroupOperator( int id );

    QStringList symbolsOfSmartgroup( StyleEntity type, int id );

    bool exportXML( const QString& filename );

    bool importXML( const QString& filename );

  signals:
    void symbolSaved( const QString& name, QgsSymbolV2* symbol );

  protected:

    QgsSymbolV2Map mSymbols;
    QgsVectorColorRampV2Map mColorRamps;

    QString mErrorString;
    QString mFileName;

    sqlite3* mCurrentDB;

    static QgsStyleV2* mDefaultStyle;

    bool openDB( const QString& filename );

    bool runEmptyQuery( char* query, bool freeQuery = true );

    char* getGroupRemoveQuery( int id );

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

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


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

  private:
    Q_DISABLE_COPY( QgsStyleV2 )
};


#endif