QgsSvgCache Class Reference

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

#include <qgssvgcache.h>

Inheritance diagram for QgsSvgCache:

Signals
void	remoteSvgFetched (const QString &url)
	Emitted when the cache has finished retrieving an SVG file from a remote url. More...
void	statusChanged (const QString &statusQString)
	Emit a signal to be caught by qgisapp and display a msg on status bar. More...

Public Member Functions
	QgsSvgCache (QObject *parent=nullptr)
	Constructor for QgsSvgCache. More...
	~QgsSvgCache () override
void	containsParams (const QString &path, bool &hasFillParam, QColor &defaultFillColor, bool &hasStrokeParam, QColor &defaultStrokeColor, bool &hasStrokeWidthParam, double &defaultStrokeWidth) const
	Tests if an svg file contains parameters for fill, stroke color, stroke width. More...
void	containsParams (const QString &path, bool &hasFillParam, bool &hasDefaultFillParam, QColor &defaultFillColor, bool &hasFillOpacityParam, bool &hasDefaultFillOpacity, double &defaultFillOpacity, bool &hasStrokeParam, bool &hasDefaultStrokeColor, QColor &defaultStrokeColor, bool &hasStrokeWidthParam, bool &hasDefaultStrokeWidth, double &defaultStrokeWidth, bool &hasStrokeOpacityParam, bool &hasDefaultStrokeOpacity, double &defaultStrokeOpacity) const
	Tests if an svg file contains parameters for fill, stroke color, stroke width. More...
QByteArray	getImageData (const QString &path) const
	Get image data. More...
QImage	svgAsImage (const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, bool &fitsInCache, double fixedAspectRatio=0)
	Get SVG as QImage. More...
QPicture	svgAsPicture (const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, bool forceVectorOutput=false, double fixedAspectRatio=0)
	Get SVG as QPicture&. More...
QByteArray	svgContent (const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, double fixedAspectRatio=0)
	Get SVG content. More...
QSizeF	svgViewboxSize (const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, double fixedAspectRatio=0)
	Calculates the viewbox size of a (possibly cached) SVG file. More...

Friends
class	TestQgsSvgCache

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

QgsSvgCache is not usually directly created, but rather accessed through QgsApplication::svgCache().

Definition at line 130 of file qgssvgcache.h.

Constructor & Destructor Documentation

QgsSvgCache()

QgsSvgCache::QgsSvgCache

(

QObject *

parent = nullptr

)

Constructor for QgsSvgCache.

Definition at line 82 of file qgssvgcache.cpp.

~QgsSvgCache()

QgsSvgCache::~QgsSvgCache ( )

override

Definition at line 104 of file qgssvgcache.cpp.

Member Function Documentation

containsParams() [1/2]

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		QColor &	defaultFillColor,
		bool &	hasStrokeParam,
		QColor &	defaultStrokeColor,
		bool &	hasStrokeWidthParam,
		double &	defaultStrokeWidth
	)		const

Tests if an svg file contains parameters for fill, stroke color, stroke 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 239 of file qgssvgcache.cpp.

containsParams() [2/2]

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		bool &	hasDefaultFillParam,
		QColor &	defaultFillColor,
		bool &	hasFillOpacityParam,
		bool &	hasDefaultFillOpacity,
		double &	defaultFillOpacity,
		bool &	hasStrokeParam,
		bool &	hasDefaultStrokeColor,
		QColor &	defaultStrokeColor,
		bool &	hasStrokeWidthParam,
		bool &	hasDefaultStrokeWidth,
		double &	defaultStrokeWidth,
		bool &	hasStrokeOpacityParam,
		bool &	hasDefaultStrokeOpacity,
		double &	defaultStrokeOpacity
	)		const

Tests if an svg file contains parameters for fill, stroke color, stroke 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
hasStrokeParam	will be true if stroke param present in SVG
hasDefaultStrokeColor	will be true if stroke param has a default value specified
defaultStrokeColor	will be set to default stroke color specified in SVG, if present
hasStrokeWidthParam	will be true if stroke width param present in SVG
hasDefaultStrokeWidth	will be true if stroke width param has a default value specified
defaultStrokeWidth	will be set to default stroke width specified in SVG, if present
hasStrokeOpacityParam	will be true if stroke opacity param present in SVG
hasDefaultStrokeOpacity	will be true if stroke opacity param has a default value specified
defaultStrokeOpacity	will be set to default stroke opacity specified in SVG, if present

Note

available in Python bindings as containsParamsV3

Since

QGIS 2.14

Definition at line 259 of file qgssvgcache.cpp.

getImageData()

QByteArray QgsSvgCache::getImageData

(

const QString &

path

)

const

Get image data.

Definition at line 382 of file qgssvgcache.cpp.

remoteSvgFetched

void QgsSvgCache::remoteSvgFetched ( const QString &  url )

signal

Emitted when the cache has finished retrieving an SVG file from a remote url.

Since

QGIS 3.2

statusChanged

void QgsSvgCache::statusChanged ( const QString &  statusQString )

signal

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

svgAsImage()

QImage QgsSvgCache::svgAsImage	(	const QString &	path,
		double	size,
		const QColor &	fill,
		const QColor &	stroke,
		double	strokeWidth,
		double	widthScaleFactor,
		bool &	fitsInCache,
		double	fixedAspectRatio = 0
	)

Get SVG as QImage.

Parameters

path	Absolute path to SVG file.
size	size of cached image
fill	color of fill
stroke	color of stroke
strokeWidth	width of stroke
widthScaleFactor	width scale factor
fitsInCache
fixedAspectRatio	fixed aspect ratio (optional)

Definition at line 110 of file qgssvgcache.cpp.

svgAsPicture()

QPicture QgsSvgCache::svgAsPicture	(	const QString &	path,
		double	size,
		const QColor &	fill,
		const QColor &	stroke,
		double	strokeWidth,
		double	widthScaleFactor,
		bool	forceVectorOutput = false,
		double	fixedAspectRatio = 0
	)

Get SVG as QPicture&.

Parameters

path	Absolute path to SVG file.
size	size of cached image
fill	color of fill
stroke	color of stroke
strokeWidth	width of stroke
widthScaleFactor	width scale factor
forceVectorOutput
fixedAspectRatio	fixed aspect ratio (optional)

Definition at line 170 of file qgssvgcache.cpp.

svgContent()

QByteArray QgsSvgCache::svgContent	(	const QString &	path,
		double	size,
		const QColor &	fill,
		const QColor &	stroke,
		double	strokeWidth,
		double	widthScaleFactor,
		double	fixedAspectRatio = 0
	)

Get SVG content.

Definition at line 190 of file qgssvgcache.cpp.

svgViewboxSize()

QSizeF QgsSvgCache::svgViewboxSize	(	const QString &	path,
		double	size,
		const QColor &	fill,
		const QColor &	stroke,
		double	strokeWidth,
		double	widthScaleFactor,
		double	fixedAspectRatio = 0
	)

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

Parameters

path	Absolute path to SVG file.
size	size of cached image
fill	color of fill
stroke	color of stroke
strokeWidth	width of stroke
widthScaleFactor	width scale factor
fixedAspectRatio	fixed aspect ratio (optional)

Returns

viewbox size set in SVG file

Since

QGIS 2.14

Definition at line 200 of file qgssvgcache.cpp.

Friends And Related Function Documentation

TestQgsSvgCache

friend class TestQgsSvgCache

friend

Definition at line 329 of file qgssvgcache.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/symbology/qgssvgcache.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/core/symbology/qgssvgcache.cpp