QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
qgsstylev2.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsstylev2.h
3  ---------------------
4  begin : November 2009
5  copyright : (C) 2009 by Martin Dobias
6  email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSSTYLEV2_H
17 #define QGSSTYLEV2_H
18 
19 #include <QMap>
20 #include <QMultiMap>
21 #include <QString>
22 
23 #include <sqlite3.h>
24 
25 #include "qgssymbollayerv2utils.h" // QgsStringMap
26 
27 class QgsSymbolV2;
28 class QgsSymbolLayerV2;
30 
31 class QDomDocument;
32 class QDomElement;
33 
34 typedef QMap<QString, QgsVectorColorRampV2* > QgsVectorColorRampV2Map;
35 typedef QMap<int, QString> QgsSymbolGroupMap;
36 
56 typedef QMultiMap<QString, QString> QgsSmartConditionMap;
57 
58 // enumerators representing sqlite DB columns
65 
66 class CORE_EXPORT QgsStyleV2 : public QObject
67 {
68  Q_OBJECT
69 
70  public:
71  QgsStyleV2();
72  ~QgsStyleV2();
73 
75 
80  enum StyleEntity { SymbolEntity, GroupEntity, TagEntity, ColorrampEntity, SmartgroupEntity };
81 
83 
90  bool addColorRamp( QString name, QgsVectorColorRampV2* colorRamp, bool update = false );
91 
93 
98  int addGroup( QString groupName, int parent = 0 );
99 
101 
106  int addSmartgroup( QString name, QString op, QgsSmartConditionMap conditions );
107 
109 
116  bool addSymbol( QString name, QgsSymbolV2* symbol, bool update = false );
117 
119 
123  int addTag( QString tagName );
124 
126  QgsSymbolGroupMap childGroupNames( QString parent = "" );
127 
129  void clear();
130 
132  QgsVectorColorRampV2* colorRamp( QString name );
133 
135  int colorRampCount();
136 
138  QStringList colorRampNames();
139 
141  const QgsVectorColorRampV2* colorRampRef( QString name ) const;
142 
145  int colorrampId( QString name );
146 
148  static QgsStyleV2* defaultStyle();
149 
151 
158  bool tagSymbol( StyleEntity type, QString symbol, QStringList tags );
159 
161 
168  bool detagSymbol( StyleEntity type, QString symbol, QStringList tags );
169 
171  bool removeSymbol( QString name );
172 
174  bool renameSymbol( QString oldName, QString newName );
175 
177  QgsSymbolV2* symbol( QString name );
178 
180  const QgsSymbolV2* symbolRef( QString name ) const;
181 
183  int symbolCount();
184 
186  QStringList symbolNames();
187 
190  int symbolId( QString name );
192  int groupId( QString group );
194  int tagId( QString tag );
196  int smartgroupId( QString smartgroup );
197 
199  QStringList groupNames();
200 
202 
207  QStringList symbolsOfGroup( StyleEntity type, int groupid );
208 
210 
215  QStringList symbolsWithTag( StyleEntity type, int tagid );
216 
218 
224  bool group( StyleEntity type, QString name, int groupid );
225 
227 
232  void rename( StyleEntity type, int id, QString newName );
233 
235 
239  void remove( StyleEntity type, int id );
240 
242 
249  bool saveSymbol( QString name, QgsSymbolV2* symbol, int groupid, QStringList tags );
250 
252 
259  bool saveColorRamp( QString name, QgsVectorColorRampV2* ramp, int groupid, QStringList tags );
260 
262  bool removeColorRamp( QString name );
263 
265  bool renameColorRamp( QString oldName, QString newName );
266 
268  bool load( QString filename );
269 
271  bool save( QString filename = QString() );
272 
274  QString errorString() { return mErrorString; }
275 
277  QString fileName() { return mFileName; }
278 
280 
285  QStringList findSymbols( StyleEntity type, QString qword );
286 
288 
293  QStringList tagsOfSymbol( StyleEntity type, QString symbol );
294 
296  QgsSymbolGroupMap smartgroupsListMap();
297 
299  QStringList smartgroupNames();
300 
302  QgsSmartConditionMap smartgroup( int id );
303 
305  //clumsy implementation TODO create a class for smartgroups
306  QString smartgroupOperator( int id );
307 
309  QStringList symbolsOfSmartgroup( StyleEntity type, int id );
310 
312  bool exportXML( QString filename );
313 
315  bool importXML( QString filename );
316 
317  signals:
318  void symbolSaved( QString name, QgsSymbolV2* symbol );
319 
320  protected:
321 
324 
325  QString mErrorString;
326  QString mFileName;
327 
329 
331 
333  bool openDB( QString filename );
334 
339  bool runEmptyQuery( char* query, bool freeQuery = true );
340 
342  char* getGroupRemoveQuery( int id );
343 
345  int getId( QString table, QString name );
346 
348 
354  bool updateSymbol( StyleEntity type, QString name );
355 
356  private:
357  Q_DISABLE_COPY( QgsStyleV2 )
358 };
359 
360 
361 #endif
QString mErrorString
Definition: qgsstylev2.h:325
QMap< QString, QgsSymbolV2 * > QgsSymbolV2Map
Definition: qgsrendererv2.h:39
QString mFileName
Definition: qgsstylev2.h:326
QMultiMap< QString, QString > QgsSmartConditionMap
Definition: qgsstylev2.h:56
ColorrampTable
Definition: qgsstylev2.h:63
QString fileName()
return current file name of the style
Definition: qgsstylev2.h:277
static QgsStyleV2 * mDefaultStyle
Definition: qgsstylev2.h:330
sqlite3 * mCurrentDB
Definition: qgsstylev2.h:328
QMap< int, QString > QgsSymbolGroupMap
Definition: qgsstylev2.h:35
SymbolTable
Definition: qgsstylev2.h:59
struct sqlite3 sqlite3
QgsSymbolV2Map mSymbols
Definition: qgsstylev2.h:322
QMap< QString, QgsVectorColorRampV2 * > QgsVectorColorRampV2Map
Definition: qgsstylev2.h:32
QgsVectorColorRampV2Map mColorRamps
Definition: qgsstylev2.h:323
TagTable
Definition: qgsstylev2.h:61
TagmapTable
Definition: qgsstylev2.h:62
StyleEntity
Enum for Entities involved in a style.
Definition: qgsstylev2.h:80
SmartgroupTable
Definition: qgsstylev2.h:64
QString errorString()
return last error from load/save operation
Definition: qgsstylev2.h:274
SymgroupTable
Definition: qgsstylev2.h:60