#include <qgsstylev2.h>

Collaboration diagram for QgsStyleV2:

Public Types
enum	StyleEntity { SymbolEntity, GroupEntity, TagEntity, ColorrampEntity, SmartgroupEntity }
	Enum for Entities involved in a style. More...

Public Member Functions
	QgsStyleV2 ()
	~QgsStyleV2 ()
bool	addColorRamp (QString name, QgsVectorColorRampV2 *colorRamp, bool update=false)
	add color ramp to style. takes ramp's ownership
int	addGroup (QString groupName, int parent=0)
	adds a new group and returns the group's id
int	addSmartgroup (QString name, QString op, QgsSmartConditionMap conditions)
	adds new smartgroup to the database and returns the id
bool	addSymbol (QString name, QgsSymbolV2 *symbol, bool update=false)
	add symbol to style. takes symbol's ownership
int	addTag (QString tagName)
	adds a new tag and returns the tag's id
QgsSymbolGroupMap	childGroupNames (QString parent="")
	return a map of groupid and names for the given parent group
void	clear ()
	remove all contents of the style
QgsVectorColorRampV2 *	colorRamp (QString name)
	return a NEW copy of color ramp
int	colorRampCount ()
	return count of color ramps
QStringList	colorRampNames ()
	return a list of names of color ramps
const QgsVectorColorRampV2 *	colorRampRef (QString name) const
	return a const pointer to a symbol (doesn't create new instance)
int	colorrampId (QString name)
	return the id in the style database for the given colorramp name returns 0 if not found
bool	tagSymbol (StyleEntity type, QString symbol, QStringList tags)
	tags the symbol with the tags in the list
bool	detagSymbol (StyleEntity type, QString symbol, QStringList tags)
	detags the symbol with the given list
bool	removeSymbol (QString name)
	remove symbol from style (and delete it)
bool	renameSymbol (QString oldName, QString newName)
	change symbol's name
QgsSymbolV2 *	symbol (QString name)
	return a NEW copy of symbol
const QgsSymbolV2 *	symbolRef (QString name) const
	return a const pointer to a symbol (doesn't create new instance)
int	symbolCount ()
	return count of symbols in style
QStringList	symbolNames ()
	return a list of names of symbols
int	symbolId (QString name)
	return the id in the style database for the given symbol name returns 0 if not found
int	groupId (QString group)
	return the DB id for the given group name
int	tagId (QString tag)
	return the DB id for the given tag name
int	smartgroupId (QString smartgroup)
	return the DB id for the given smartgroup name
QStringList	groupNames ()
	return the all the groups in the style
QStringList	symbolsOfGroup (StyleEntity type, int groupid)
	returns the symbolnames of a given groupid
QStringList	symbolsWithTag (StyleEntity type, int tagid)
	returns the symbol names with which have the given tag
bool	group (StyleEntity type, QString name, int groupid)
	applies the specified group to the symbol or colorramp specified by StyleEntity
void	rename (StyleEntity type, int id, QString newName)
	rename the given entity with the specified id
void	remove (StyleEntity type, int id)
	remove the specified entity from the db
bool	saveSymbol (QString name, QgsSymbolV2 *symbol, int groupid, QStringList tags)
	add the symbol to the DB with the tags
bool	saveColorRamp (QString name, QgsVectorColorRampV2 *ramp, int groupid, QStringList tags)
	add the colorramp to the DB
bool	removeColorRamp (QString name)
	remove color ramp from style (and delete it)
bool	renameColorRamp (QString oldName, QString newName)
	change ramp's name
bool	load (QString filename)
	load a file into the style
bool	save (QString filename=QString())
	save style into a file (will use current filename if empty string is passed)
QString	errorString ()
	return last error from load/save operation
QString	fileName ()
	return current file name of the style
QStringList	findSymbols (StyleEntity type, QString qword)
	return the names of the symbols which have a matching 'substring' in its defintion
QStringList	tagsOfSymbol (StyleEntity type, QString symbol)
	return the tags associated with the symbol
QgsSymbolGroupMap	smartgroupsListMap ()
	returns the smart groups map with id as key and name as value
QStringList	smartgroupNames ()
	returns the smart groups list
QgsSmartConditionMap	smartgroup (int id)
	returns the QgsSmartConditionMap for the given id
QString	smartgroupOperator (int id)
	returns the operator for the smartgroup
QStringList	symbolsOfSmartgroup (StyleEntity type, int id)
	returns the symbols for the smartgroup
bool	exportXML (QString filename)
	Exports the style as a XML file.
bool	importXML (QString filename)
	Imports the symbols and colorramps into the default style database from the given XML file.

Static Public Member Functions
static QgsStyleV2 *	defaultStyle ()
	return default application-wide style

Protected Member Functions
bool	openDB (QString filename)
	convenience function to open the DB and return a sqlite3 object
bool	runEmptyQuery (char *query, bool freeQuery=true)
	convenience function that would run queries which don't generate return values
char *	getGroupRemoveQuery (int id)
	prepares the complex query for removing a group, so that the children are not abandoned
int	getId (QString table, QString name)
	gets the id from the table for the given name from the database, 0 if not found
bool	updateSymbol (StyleEntity type, QString name)
	updates the properties of an existing symbol/colorramp

Protected Attributes
QgsSymbolV2Map	mSymbols
QgsVectorColorRampV2Map	mColorRamps
QString	mErrorString
QString	mFileName
sqlite3 *	mCurrentDB

Static Protected Attributes
static QgsStyleV2 *	mDefaultStyle = 0

Detailed Description

Definition at line 66 of file qgsstylev2.h.

Member Enumeration Documentation

enum QgsStyleV2::StyleEntity

Enum for Entities involved in a style.

The enumerator is used for identifying the entity being operated on when generic database functions are being run.

See Also: group(), rename(), remove(), symbolsOfGroup(), symbolsWithTag(), symbolsOfSmartgroup()

Enumerator:

SymbolEntity
GroupEntity
TagEntity
ColorrampEntity
SmartgroupEntity

Definition at line 78 of file qgsstylev2.h.

Constructor & Destructor Documentation

QgsStyleV2::QgsStyleV2 ( )

Definition at line 41 of file qgsstylev2.cpp.

References mCurrentDB.

Referenced by defaultStyle().

QgsStyleV2::~QgsStyleV2 ( )

Definition at line 46 of file qgsstylev2.cpp.

References clear().

Member Function Documentation

bool QgsStyleV2::addColorRamp	(	QString	name,
		QgsVectorColorRampV2 *	colorRamp,
		bool	update = `false`
	)

add color ramp to style. takes ramp's ownership

Note: Adding a color ramp with the name of existing one replaces it.

Parameters

name	is the name of the color ramp being added or updated
colorRamp	is the Vector color ramp
update	set to true when the style DB has to be updated, by default it is false

Returns: success status of the operation

Definition at line 186 of file qgsstylev2.cpp.

References ColorrampEntity, mColorRamps, saveColorRamp(), and updateSymbol().

Referenced by importXML().

int QgsStyleV2::addGroup	(	QString	groupName,
		int	parent = `0`
	)

adds a new group and returns the group's id

Parameters

groupName	the name of the new group as QString
parent	is the id of the parent group when a subgrouo is to be created. By default it is 0 indicating it is not a sub-group

Returns: returns an int, which is the DB id of the new group created, 0 if the group couldn't be created

Definition at line 599 of file qgsstylev2.cpp.

References mCurrentDB.

int QgsStyleV2::addSmartgroup	(	QString	name,
		QString	op,
		QgsSmartConditionMap	conditions
	)

adds new smartgroup to the database and returns the id

Parameters

name	is the name of the new Smart Group to be added
op	is the operator between the conditions; AND/OR as QString
conditions	are the smart group conditions

Definition at line 1011 of file qgsstylev2.cpp.

References mCurrentDB, QgsDebugMsg, and runEmptyQuery().

bool QgsStyleV2::addSymbol	(	QString	name,
		QgsSymbolV2 *	symbol,
		bool	update = `false`
	)

add symbol to style. takes symbol's ownership

Note: Adding a symbol with the name of existing one replaces it.

Parameters

name	is the name of the symbol being added or updated
symbol	is the Vector symbol
update	set to true when the style DB has to be updated, by default it is false

Returns: success status of the operation

Definition at line 83 of file qgsstylev2.cpp.

References mSymbols, saveSymbol(), SymbolEntity, and updateSymbol().

Referenced by importXML().

int QgsStyleV2::addTag ( QString tagName )

adds a new tag and returns the tag's id

Parameters

tagName the name of the new tag to be created

Returns: returns an int, which is the DB id of the new tag created, 0 if the tag couldn't be created

Definition at line 616 of file qgsstylev2.cpp.

References mCurrentDB.

Referenced by tagSymbol().

QgsSymbolGroupMap QgsStyleV2::childGroupNames ( QString parent = "" )

return a map of groupid and names for the given parent group

Definition at line 466 of file qgsstylev2.cpp.

References group(), groupNames(), mCurrentDB, QgsDebugMsg, SymgroupId, and SymgroupName.

void QgsStyleV2::clear ( )

remove all contents of the style

Definition at line 70 of file qgsstylev2.cpp.

References mColorRamps, mCurrentDB, and mSymbols.

Referenced by ~QgsStyleV2().

QgsVectorColorRampV2 * QgsStyleV2::colorRamp ( QString name )

return a NEW copy of color ramp

Definition at line 258 of file qgsstylev2.cpp.

References QgsVectorColorRampV2::clone(), and colorRampRef().

Referenced by updateSymbol().

int QgsStyleV2::colorRampCount ( )

return count of color ramps

Definition at line 269 of file qgsstylev2.cpp.

References mColorRamps.

int QgsStyleV2::colorrampId ( QString name )

return the id in the style database for the given colorramp name returns 0 if not found

Definition at line 991 of file qgsstylev2.cpp.

References getId().

Referenced by tagsOfSymbol(), and tagSymbol().

QStringList QgsStyleV2::colorRampNames ( )

return a list of names of color ramps

Definition at line 274 of file qgsstylev2.cpp.

References mColorRamps.

Referenced by symbolsOfSmartgroup(), and updateSymbol().

const QgsVectorColorRampV2 * QgsStyleV2::colorRampRef ( QString name ) const

return a const pointer to a symbol (doesn't create new instance)

Definition at line 264 of file qgsstylev2.cpp.

References mColorRamps.

Referenced by colorRamp(), and fcnRampColor().

QgsStyleV2 * QgsStyleV2::defaultStyle ( )

static

return default application-wide style

Definition at line 51 of file qgsstylev2.cpp.

References QgsApplication::defaultStyleV2Path(), load(), mDefaultStyle, QgsStyleV2(), and QgsApplication::userStyleV2Path().

Referenced by QgsSymbolV2::defaultSymbol(), fcnRampColor(), and QgsSingleBandPseudoColorRendererWidget::QgsSingleBandPseudoColorRendererWidget().

bool QgsStyleV2::detagSymbol	(	StyleEntity	type,
		QString	symbol,
		QStringList	tags
	)

detags the symbol with the given list

Removes the given tags for the specified symbol or colorramp

Parameters

type	is either SymbolEntity or ColorrampEntity
symbol	is the name of the symbol or colorramp
tags	is the list of tags that are to be removed as QStringList

Returns: returns the success state of the operation

Definition at line 876 of file qgsstylev2.cpp.

References mCurrentDB, QgsDebugMsg, runEmptyQuery(), and SymbolEntity.

QString QgsStyleV2::errorString ( )

inline

return last error from load/save operation

Definition at line 275 of file qgsstylev2.h.

bool QgsStyleV2::exportXML ( QString filename )

Exports the style as a XML file.

Definition at line 1289 of file qgsstylev2.cpp.

References mColorRamps, mErrorString, mFileName, mSymbols, QgsDebugMsg, saveColorRamp(), QgsSymbolLayerV2Utils::saveSymbols(), and STYLE_CURRENT_VERSION.

QString QgsStyleV2::fileName ( )

inline

return current file name of the style

Definition at line 278 of file qgsstylev2.h.

QStringList QgsStyleV2::findSymbols	(	StyleEntity	type,
		QString	qword
	)

return the names of the symbols which have a matching 'substring' in its defintion

Parameters

type	is either SymbolEntity or ColorrampEntity
qword	is the query string to search the symbols or colorramps.

Returns: A QStringList of the matched symbols or colorramps

Definition at line 750 of file qgsstylev2.cpp.

References mCurrentDB, QgsDebugMsg, and SymbolEntity.

char * QgsStyleV2::getGroupRemoveQuery ( int id )

protected

prepares the complex query for removing a group, so that the children are not abandoned

Definition at line 659 of file qgsstylev2.cpp.

References mCurrentDB.

Referenced by remove().

int QgsStyleV2::getId	(	QString	table,
		QString	name
	)

protected

gets the id from the table for the given name from the database, 0 if not found

Definition at line 968 of file qgsstylev2.cpp.

References mCurrentDB.

Referenced by colorrampId(), groupId(), smartgroupId(), symbolId(), and tagId().

bool QgsStyleV2::group	(	StyleEntity	type,
		QString	name,
		int	groupid
	)

applies the specified group to the symbol or colorramp specified by StyleEntity

Parameters

type	is either SymbolEntity of ColorrampEntity
name	is the name of the symbol or coloramp whose group is to be set
groupid	is the id of the group to which the entity is assigned

Returns: returns the success state as bool

Definition at line 729 of file qgsstylev2.cpp.

References ColorrampEntity, QgsDebugMsg, runEmptyQuery(), and SymbolEntity.

Referenced by childGroupNames(), and smartgroupsListMap().

int QgsStyleV2::groupId ( QString group )

return the DB id for the given group name

Definition at line 996 of file qgsstylev2.cpp.

References getId().

Referenced by symbolsOfSmartgroup().

QStringList QgsStyleV2::groupNames ( )

return the all the groups in the style

Definition at line 452 of file qgsstylev2.cpp.

References mCurrentDB, and SymgroupName.

Referenced by childGroupNames(), and smartgroupsListMap().

bool QgsStyleV2::importXML ( QString filename )

Imports the symbols and colorramps into the default style database from the given XML file.

Definition at line 1333 of file qgsstylev2.cpp.

References addColorRamp(), addSymbol(), QgsSymbolLayerV2Utils::loadColorRamp(), QgsSymbolLayerV2Utils::loadSymbol(), QgsSymbolLayerV2Utils::loadSymbols(), mErrorString, mFileName, QgsDebugMsg, STYLE_CURRENT_VERSION, and symbol().

bool QgsStyleV2::load ( QString filename )

load a file into the style

Definition at line 292 of file qgsstylev2.cpp.

References ColorrampName, ColorrampXML, QgsSymbolLayerV2Utils::loadColorRamp(), QgsSymbolLayerV2Utils::loadSymbol(), mColorRamps, mCurrentDB, mErrorString, mFileName, mSymbols, openDB(), QgsDebugMsg, runEmptyQuery(), symbol(), SymbolName, and SymbolXML.

Referenced by defaultStyle().

bool QgsStyleV2::openDB ( QString filename )

protected

convenience function to open the DB and return a sqlite3 object

Definition at line 279 of file qgsstylev2.cpp.

References mCurrentDB, and mErrorString.

Referenced by load().

void QgsStyleV2::remove	(	StyleEntity	type,
		int	id
	)

remove the specified entity from the db

Parameters

type	is any of the style entites. Refer enum StyleEntity.
id	is the DB id of the entity to be removed

Definition at line 677 of file qgsstylev2.cpp.

References ColorrampEntity, getGroupRemoveQuery(), GroupEntity, QgsDebugMsg, runEmptyQuery(), SmartgroupEntity, SymbolEntity, and TagEntity.

bool QgsStyleV2::removeColorRamp ( QString name )

remove color ramp from style (and delete it)

Definition at line 240 of file qgsstylev2.cpp.

References mColorRamps, QgsDebugMsg, and runEmptyQuery().

bool QgsStyleV2::removeSymbol ( QString name )

remove symbol from style (and delete it)

Definition at line 136 of file qgsstylev2.cpp.

References mCurrentDB, mSymbols, QgsDebugMsg, symbol(), SymbolEntity, and symbolId().

void QgsStyleV2::rename	(	StyleEntity	type,
		int	id,
		QString	newName
	)

rename the given entity with the specified id

Parameters

type	is any of the style entites. Refer enum StyleEntity.
id	is the DB id of the entity which is to be renamed
newName	is the new name of the entity

Definition at line 631 of file qgsstylev2.cpp.

References ColorrampEntity, GroupEntity, mErrorString, QgsDebugMsg, runEmptyQuery(), SmartgroupEntity, SymbolEntity, and TagEntity.

Referenced by renameColorRamp(), and renameSymbol().

bool QgsStyleV2::renameColorRamp	(	QString	oldName,
		QString	newName
	)

change ramp's name

Note: added in v1.7

Definition at line 430 of file qgsstylev2.cpp.

References ColorrampEntity, mColorRamps, mCurrentDB, and rename().

bool QgsStyleV2::renameSymbol	(	QString	oldName,
		QString	newName
	)

change symbol's name

Note: added in v1.7

Definition at line 404 of file qgsstylev2.cpp.

References mCurrentDB, mSymbols, QgsDebugMsg, rename(), symbol(), SymbolEntity, and symbolId().

bool QgsStyleV2::runEmptyQuery	(	char *	query,
		bool	freeQuery = `true`
	)

protected

convenience function that would run queries which don't generate return values

Parameters

query	query to run
freeQuery	release query memory

Returns: success true on success

Definition at line 708 of file qgsstylev2.cpp.

References mCurrentDB, and QgsDebugMsg.

Referenced by addSmartgroup(), detagSymbol(), group(), load(), remove(), removeColorRamp(), rename(), saveColorRamp(), saveSymbol(), and updateSymbol().

bool QgsStyleV2::save ( QString filename = QString() )

save style into a file (will use current filename if empty string is passed)

Definition at line 358 of file qgsstylev2.cpp.

References mColorRamps, mErrorString, mFileName, mSymbols, saveColorRamp(), QgsSymbolLayerV2Utils::saveSymbols(), and STYLE_CURRENT_VERSION.

bool QgsStyleV2::saveColorRamp	(	QString	name,
		QgsVectorColorRampV2 *	ramp,
		int	groupid,
		QStringList	tags
	)

add the colorramp to the DB

Parameters

name	is the name of the colorramp as QString
ramp	is the pointer to the new QgsVectorColorRampV2 being saved
groupid	is the id of the group to which the Color Ramp belongs. Pass 0 if it doesn't belong to any group or not known.
tags	is a list of tags that are associated with the color ramp as a QStringList.

Returns: returns the success state of the save operation

Definition at line 210 of file qgsstylev2.cpp.

References QgsDebugMsg, and runEmptyQuery().

Referenced by addColorRamp(), exportXML(), save(), and updateSymbol().

bool QgsStyleV2::saveSymbol	(	QString	name,
		QgsSymbolV2 *	symbol,
		int	groupid,
		QStringList	tags
	)

add the symbol to the DB with the tags

Parameters

name	is the name of the symbol as QString
symbol	is the pointer to the new QgsSymbolV2 being saved
groupid	is the id of the group to which the symbol belongs. Pass 0 if it doesn't belong to any group or not known.
tags	is a list of tags that are associated with the symbol as a QStringList.

Returns: returns the success state of the save operation

Definition at line 107 of file qgsstylev2.cpp.

References QgsDebugMsg, and runEmptyQuery().

Referenced by addSymbol(), and updateSymbol().

QgsSmartConditionMap QgsStyleV2::smartgroup ( int id )

returns the QgsSmartConditionMap for the given id

Definition at line 1216 of file qgsstylev2.cpp.

References mCurrentDB, and QgsDebugMsg.

int QgsStyleV2::smartgroupId ( QString smartgroup )

return the DB id for the given smartgroup name

Definition at line 1006 of file qgsstylev2.cpp.

References getId().

QStringList QgsStyleV2::smartgroupNames ( )

returns the smart groups list

Definition at line 1077 of file qgsstylev2.cpp.

References mCurrentDB, and QgsDebugMsg.

QString QgsStyleV2::smartgroupOperator ( int id )

returns the operator for the smartgroup

Definition at line 1258 of file qgsstylev2.cpp.

References mCurrentDB, and QgsDebugMsg.

QgsSymbolGroupMap QgsStyleV2::smartgroupsListMap ( )

returns the smart groups map with id as key and name as value

Definition at line 1051 of file qgsstylev2.cpp.

References group(), groupNames(), mCurrentDB, QgsDebugMsg, SmartgroupId, and SmartgroupName.

QgsSymbolV2 * QgsStyleV2::symbol ( QString name )

return a NEW copy of symbol

Definition at line 164 of file qgsstylev2.cpp.

References QgsSymbolV2::clone(), and symbolRef().

Referenced by QgsSymbolV2::defaultSymbol(), importXML(), load(), removeSymbol(), renameSymbol(), and updateSymbol().

int QgsStyleV2::symbolCount ( )

return count of symbols in style

Definition at line 175 of file qgsstylev2.cpp.

References mSymbols.

int QgsStyleV2::symbolId ( QString name )

return the id in the style database for the given symbol name returns 0 if not found

Definition at line 986 of file qgsstylev2.cpp.

References getId().

Referenced by removeSymbol(), renameSymbol(), symbolsWithTag(), tagsOfSymbol(), and tagSymbol().

QStringList QgsStyleV2::symbolNames ( )

return a list of names of symbols

Definition at line 180 of file qgsstylev2.cpp.

References mSymbols.

Referenced by symbolsOfSmartgroup(), and updateSymbol().

const QgsSymbolV2 * QgsStyleV2::symbolRef ( QString name ) const

return a const pointer to a symbol (doesn't create new instance)

Definition at line 170 of file qgsstylev2.cpp.

References mSymbols.

Referenced by symbol().

QStringList QgsStyleV2::symbolsOfGroup	(	StyleEntity	type,
		int	groupid
	)

returns the symbolnames of a given groupid

Parameters

type	is either SymbolEntity or ColorampEntity
groupid	is id of the group to which the symbols belong to, as int

Returns: A QStringList of the symbol or colorramp names for the given group id

Definition at line 513 of file qgsstylev2.cpp.

References ColorrampEntity, mCurrentDB, QgsDebugMsg, and SymbolEntity.

Referenced by symbolsOfSmartgroup().

QStringList QgsStyleV2::symbolsOfSmartgroup	(	StyleEntity	type,
		int	id
	)

returns the symbols for the smartgroup

Definition at line 1102 of file qgsstylev2.cpp.

References colorRampNames(), groupId(), mCurrentDB, QgsDebugMsg, SymbolEntity, symbolNames(), symbolsOfGroup(), symbolsWithTag(), and tagId().

QStringList QgsStyleV2::symbolsWithTag	(	StyleEntity	type,
		int	tagid
	)

returns the symbol names with which have the given tag

Parameters

type	is either SymbolEntity or ColorampEntity
tagid	is id of the tag which has been applied over the symbol as int

Returns: A QStringList of the symbol or colorramp names for the given tag id

Definition at line 550 of file qgsstylev2.cpp.

References ColorrampEntity, mCurrentDB, QgsDebugMsg, SymbolEntity, and symbolId().

Referenced by symbolsOfSmartgroup().

int QgsStyleV2::tagId ( QString tag )

return the DB id for the given tag name

Definition at line 1001 of file qgsstylev2.cpp.

References getId().

Referenced by symbolsOfSmartgroup().

QStringList QgsStyleV2::tagsOfSymbol	(	StyleEntity	type,
		QString	symbol
	)

return the tags associated with the symbol

Parameters

type	is either SymbolEntity or ColorrampEntity
symbol	is the name of the symbol or color ramp

Returns: A QStringList of the tags that have been applied to that symbol/colorramp

Definition at line 929 of file qgsstylev2.cpp.

References colorrampId(), mCurrentDB, QgsDebugMsg, SymbolEntity, and symbolId().

bool QgsStyleV2::tagSymbol	(	StyleEntity	type,
		QString	symbol,
		QStringList	tags
	)

tags the symbol with the tags in the list

Applies the given tags to the given symbol or colorramp

Parameters

type	is either SymbolEntity or ColorrampEntity
symbol	is the name of the symbol or colorramp as QString
tags	is the list of the tags that are to be applied as QStringList