A cache for images / pictures derived from svg files. More...

#include <qgssvgcache.h>

Inheritance diagram for QgsSvgCache:

Signals
void	statusChanged (const QString &theStatusQString)
	Emit a signal to be caught by qgisapp and display a msg on status bar. More...

Public Member Functions
	~QgsSvgCache ()

void	containsParams (const QString &path, bool &hasFillParam, QColor &defaultFillColor, bool &hasOutlineParam, QColor &defaultOutlineColor, bool &hasOutlineWidthParam, double &defaultOutlineWidth) const
	Tests if an svg file contains parameters for fill, outline color, outline width. More...

Q_DECL_DEPRECATED void	containsParams (const QString &path, bool &hasFillParam, bool &hasDefaultFillParam, QColor &defaultFillColor, bool &hasOutlineParam, bool &hasDefaultOutlineColor, QColor &defaultOutlineColor, bool &hasOutlineWidthParam, bool &hasDefaultOutlineWidth, double &defaultOutlineWidth) const
	Tests if an svg file contains parameters for fill, outline color, outline width. More...

void	containsParams (const QString &path, bool &hasFillParam, bool &hasDefaultFillParam, QColor &defaultFillColor, bool &hasFillOpacityParam, bool &hasDefaultFillOpacity, double &defaultFillOpacity, bool &hasOutlineParam, bool &hasDefaultOutlineColor, QColor &defaultOutlineColor, bool &hasOutlineWidthParam, bool &hasDefaultOutlineWidth, double &defaultOutlineWidth, bool &hasOutlineOpacityParam, bool &hasDefaultOutlineOpacity, double &defaultOutlineOpacity) const
	Tests if an svg file contains parameters for fill, outline color, outline width. More...

QByteArray	getImageData (const QString &path) const
	Get image data. More...

const QImage &	svgAsImage (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor, bool &fitsInCache)
	Get SVG as QImage. More...

const QPicture &	svgAsPicture (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor, bool forceVectorOutput=false)
	Get SVG as QPicture&. More...

const QByteArray &	svgContent (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Get SVG content. More...

QSizeF	svgViewboxSize (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Calculates the viewbox size of a (possibly cached) SVG file. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static QgsSvgCache *	instance ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions
	QgsSvgCache (QObject *parent=nullptr)
	protected constructor More...

QgsSvgCacheEntry *	cacheEntry (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Returns entry from cache or creates a new entry if it does not exist already. More...

void	cacheImage (QgsSvgCacheEntry *entry)

void	cachePicture (QgsSvgCacheEntry *entry, bool forceVectorOutput=false)

QgsSvgCacheEntry *	insertSVG (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Creates new cache entry and returns pointer to it. More...

void	replaceParamsAndCacheSvg (QgsSvgCacheEntry *entry)

void	takeEntryFromList (QgsSvgCacheEntry *entry)

void	trimToMaximumSize ()
	Removes the least used items until the maximum size is under the limit. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

A cache for images / pictures derived from svg files.

This class supports parameter replacement in svg files according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are the parameters 'fill-color', 'pen-color', 'outline-width', 'stroke-width'. E.g. <circle fill="param(fill-color red)" stroke="param(pen-color black)" stroke-width="param(outline-width 1)"

Definition at line 95 of file qgssvgcache.h.

Constructor & Destructor Documentation

◆ ~QgsSvgCache()

QgsSvgCache::~QgsSvgCache ( )

Definition at line 112 of file qgssvgcache.cpp.

◆ QgsSvgCache()

QgsSvgCache::QgsSvgCache ( QObject * parent = nullptr )

protected

protected constructor

Definition at line 103 of file qgssvgcache.cpp.

Member Function Documentation

◆ cacheEntry()

QgsSvgCacheEntry * QgsSvgCache::cacheEntry	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

protected

Returns entry from cache or creates a new entry if it does not exist already.

Definition at line 592 of file qgssvgcache.cpp.

◆ cacheImage()

void QgsSvgCache::cacheImage ( QgsSvgCacheEntry * entry )

protected

Definition at line 510 of file qgssvgcache.cpp.

◆ cachePicture()

void QgsSvgCache::cachePicture	(	QgsSvgCacheEntry *	entry,
		bool	forceVectorOutput = `false`
	)

protected

Definition at line 559 of file qgssvgcache.cpp.

◆ containsParams() [1/3]

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		QColor &	defaultFillColor,
		bool &	hasOutlineParam,
		QColor &	defaultOutlineColor,
		bool &	hasOutlineWidthParam,
		double &	defaultOutlineWidth
	)		const

Tests if an svg file contains parameters for fill, outline color, outline width.

If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered

Definition at line 232 of file qgssvgcache.cpp.

◆ containsParams() [2/3]

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		bool &	hasDefaultFillParam,
		QColor &	defaultFillColor,
		bool &	hasOutlineParam,
		bool &	hasDefaultOutlineColor,
		QColor &	defaultOutlineColor,
		bool &	hasOutlineWidthParam,
		bool &	hasDefaultOutlineWidth,
		double &	defaultOutlineWidth
	)		const

Tests if an svg file contains parameters for fill, outline color, outline width.

If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered.

Parameters

path	path to SVG file
hasFillParam	will be true if fill param present in SVG
hasDefaultFillParam	will be true if fill param has a default value specified
defaultFillColor	will be set to default fill color specified in SVG, if present
hasOutlineParam	will be true if outline param present in SVG
hasDefaultOutlineColor	will be true if outline param has a default value specified
defaultOutlineColor	will be set to default outline color specified in SVG, if present
hasOutlineWidthParam	will be true if outline width param present in SVG
hasDefaultOutlineWidth	will be true if outline width param has a default value specified
defaultOutlineWidth	will be set to default outline width specified in SVG, if present

Note: available in python bindings as containsParamsV2; added in QGIS 2.12

Deprecated:: use variant with fill and outline opacity

Definition at line 253 of file qgssvgcache.cpp.

◆ containsParams() [3/3]

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		bool &	hasDefaultFillParam,
		QColor &	defaultFillColor,
		bool &	hasFillOpacityParam,
		bool &	hasDefaultFillOpacity,
		double &	defaultFillOpacity,
		bool &	hasOutlineParam,
		bool &	hasDefaultOutlineColor,
		QColor &	defaultOutlineColor,
		bool &	hasOutlineWidthParam,
		bool &	hasDefaultOutlineWidth,
		double &	defaultOutlineWidth,
		bool &	hasOutlineOpacityParam,
		bool &	hasDefaultOutlineOpacity,
		double &	defaultOutlineOpacity
	)		const

Tests if an svg file contains parameters for fill, outline color, outline width.

If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered.

Parameters

path	path to SVG file
hasFillParam	will be true if fill param present in SVG
hasDefaultFillParam	will be true if fill param has a default value specified
defaultFillColor	will be set to default fill color specified in SVG, if present
hasFillOpacityParam	will be true if fill opacity param present in SVG
hasDefaultFillOpacity	will be true if fill opacity param has a default value specified
defaultFillOpacity	will be set to default fill opacity specified in SVG, if present
hasOutlineParam	will be true if outline param present in SVG
hasDefaultOutlineColor	will be true if outline param has a default value specified
defaultOutlineColor	will be set to default outline color specified in SVG, if present
hasOutlineWidthParam	will be true if outline width param present in SVG
hasDefaultOutlineWidth	will be true if outline width param has a default value specified
defaultOutlineWidth	will be set to default outline width specified in SVG, if present
hasOutlineOpacityParam	will be true if outline opacity param present in SVG
hasDefaultOutlineOpacity	will be true if outline opacity param has a default value specified
defaultOutlineOpacity	will be set to default outline opacity specified in SVG, if present

Note: available in python bindings as containsParamsV3; added in QGIS 2.14

Definition at line 272 of file qgssvgcache.cpp.

◆ getImageData()

QByteArray QgsSvgCache::getImageData ( const QString & path ) const

Get image data.

Definition at line 395 of file qgssvgcache.cpp.

◆ insertSVG()

QgsSvgCacheEntry * QgsSvgCache::insertSVG	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

protected

Creates new cache entry and returns pointer to it.

Parameters

file	Absolute or relative path to SVG file. If the path is relative the file is searched by QgsSymbolLayerV2Utils::symbolNameToPath() in SVG paths. in settings svg/searchPathsForSVG
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor

Definition at line 200 of file qgssvgcache.cpp.

◆ instance()

QgsSvgCache * QgsSvgCache::instance ( )

static

Definition at line 97 of file qgssvgcache.cpp.

◆ replaceParamsAndCacheSvg()

void QgsSvgCache::replaceParamsAndCacheSvg ( QgsSvgCacheEntry * entry )

protected

Definition at line 310 of file qgssvgcache.cpp.

◆ statusChanged

void QgsSvgCache::statusChanged ( const QString & theStatusQString )

signal

Emit a signal to be caught by qgisapp and display a msg on status bar.

◆ svgAsImage()

const QImage & QgsSvgCache::svgAsImage	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor,
		bool &	fitsInCache
	)

Get SVG as QImage.

Parameters

file	Absolute or relative path to SVG file.
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor
fitsInCache

Definition at line 118 of file qgssvgcache.cpp.

◆ svgAsPicture()

const QPicture & QgsSvgCache::svgAsPicture	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor,
		bool	forceVectorOutput = `false`
	)

Get SVG as QPicture&.

Parameters

file	Absolute or relative path to SVG file.
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor
forceVectorOutput

Definition at line 163 of file qgssvgcache.cpp.

◆ svgContent()

const QByteArray & QgsSvgCache::svgContent	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

Get SVG content.

Definition at line 181 of file qgssvgcache.cpp.

◆ svgViewboxSize()

QSizeF QgsSvgCache::svgViewboxSize	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

Calculates the viewbox size of a (possibly cached) SVG file.

Parameters

file	Absolute or relative path to SVG file.
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor

Returns: viewbox size set in SVG file

Note: added in QGIS 2.14

Definition at line 191 of file qgssvgcache.cpp.

◆ takeEntryFromList()

void QgsSvgCache::takeEntryFromList ( QgsSvgCacheEntry * entry )

protected

Definition at line 949 of file qgssvgcache.cpp.

◆ trimToMaximumSize()

void QgsSvgCache::trimToMaximumSize ( )

protected

Removes the least used items until the maximum size is under the limit.

Definition at line 929 of file qgssvgcache.cpp.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-2.18.21+99unstable/src/core/symbology-ng/qgssvgcache.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/symbology-ng/qgssvgcache.cpp

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~QgsSvgCache()

◆ QgsSvgCache()

Member Function Documentation

◆ cacheEntry()

◆ cacheImage()

◆ cachePicture()

◆ containsParams() [1/3]

◆ containsParams() [2/3]

◆ containsParams() [3/3]

◆ getImageData()

◆ insertSVG()

◆ instance()

◆ replaceParamsAndCacheSvg()

◆ statusChanged

◆ svgAsImage()

◆ svgAsPicture()

◆ svgContent()

◆ svgViewboxSize()

◆ takeEntryFromList()

◆ trimToMaximumSize()