QSvgRenderer

The QSvgRenderer class is used to draw the contents of SVG files onto paint devices. More…

Inheritance diagram of PySide2.QtSvg.QSvgRenderer

Synopsis

Functions

Slots

Signals

Detailed Description

Using QSvgRenderer , Scalable Vector Graphics (SVG) can be rendered onto any QPaintDevice subclass, including QWidget , QImage , and QGLWidget .

QSvgRenderer provides an API that supports basic features of SVG rendering, such as loading and rendering of static drawings, and more interactive features like animation. Since the rendering is performed using QPainter , SVG drawings can be rendered on any subclass of QPaintDevice .

SVG drawings are either loaded when an QSvgRenderer is constructed, or loaded later using the load() functions. Data is either supplied directly as serialized XML, or indirectly using a file name. If a valid file has been loaded, either when the renderer is constructed or at some later time, isValid() returns true; otherwise it returns false. QSvgRenderer provides the render() slot to render the current document, or the current frame of an animated document, using a given painter.

The defaultSize() function provides information about the amount of space that is required to render the currently loaded SVG file. This is useful for paint devices, such as QWidget , that often need to supply a size hint to their parent layout. The default size of a drawing may differ from its visible area, found using the viewBox property.

Animated SVG drawings are supported, and can be controlled with a simple collection of functions and properties:

  • The animated() function indicates whether a drawing contains animation information.

  • The framesPerSecond property contains the rate at which the animation plays.

Finally, the QSvgRenderer class provides the repaintNeeded() signal which is emitted whenever the rendering of the document needs to be updated.

See also

QSvgWidget Qt SVG C++ Classes SVG Viewer Example QPicture

class QSvgRenderer([parent=None])

QSvgRenderer(contents[, parent=None])

QSvgRenderer(contents[, parent=None])

QSvgRenderer(filename[, parent=None])

param parent

QObject

param contents

QXmlStreamReader

param filename

unicode

Constructs a new renderer with the given parent .

Constructs a new renderer with the given parent and loads the SVG data using the stream reader specified by contents .

PySide2.QtSvg.QSvgRenderer.animated()
Return type

bool

Returns true if the current document contains animated elements; otherwise returns false.

See also

framesPerSecond()

PySide2.QtSvg.QSvgRenderer.animationDuration()
Return type

int

Returns the number of frames in the animation, or 0 if the current document is not animated.

See also

animated() framesPerSecond

PySide2.QtSvg.QSvgRenderer.boundsOnElement(id)
Parameters

id – unicode

Return type

QRectF

Returns bounding rectangle of the item with the given id . The transformation matrix of parent elements is not affecting the bounds of the element.

See also

matrixForElement()

PySide2.QtSvg.QSvgRenderer.currentFrame()
Return type

int

PySide2.QtSvg.QSvgRenderer.defaultSize()
Return type

QSize

Returns the default size of the document contents.

PySide2.QtSvg.QSvgRenderer.elementExists(id)
Parameters

id – unicode

Return type

bool

Returns true if the element with the given id exists in the currently parsed SVG file and is a renderable element.

Note: this method returns true only for elements that can be rendered. Which implies that elements that are considered part of the fill/stroke style properties, e.g. radialGradients even tough marked with “id” attributes will not be found by this method.

PySide2.QtSvg.QSvgRenderer.framesPerSecond()
Return type

int

See also

setFramesPerSecond()

PySide2.QtSvg.QSvgRenderer.isValid()
Return type

bool

Returns true if there is a valid current document; otherwise returns false.

PySide2.QtSvg.QSvgRenderer.load(contents)
Parameters

contents – QXmlStreamReader

Return type

bool

Loads the specified SVG in contents , returning true if the content was successfully parsed; otherwise returns false.

The reader will be used from where it currently is positioned. If contents is null , behavior is undefined.

PySide2.QtSvg.QSvgRenderer.load(contents)
Parameters

contents – QByteArray

Return type

bool

PySide2.QtSvg.QSvgRenderer.load(filename)
Parameters

filename – unicode

Return type

bool

PySide2.QtSvg.QSvgRenderer.matrixForElement(id)
Parameters

id – unicode

Return type

QMatrix

Returns the transformation matrix for the element with the given id . The matrix is a product of the transformation of the element’s parents. The transformation of the element itself is not included.

To find the bounding rectangle of the element in logical coordinates, you can apply the matrix on the rectangle returned from boundsOnElement() .

See also

boundsOnElement()

PySide2.QtSvg.QSvgRenderer.render(p, elementId[, bounds=QRectF()])
Parameters

  • p – QPainter

  • elementId – unicode

  • bounds – QRectF

Renders the given element with elementId using the given painter on the specified bounds . If the bounding rectangle is not specified the SVG element is mapped to the whole paint device.

PySide2.QtSvg.QSvgRenderer.render(p, bounds)
Parameters

  • p – QPainter

  • bounds – QRectF

Renders the current document, or the current frame of an animated document, using the given painter on the specified bounds within the painter. If the bounding rectangle is not specified the SVG file is mapped to the whole paint device.

PySide2.QtSvg.QSvgRenderer.render(p)
Parameters

p – QPainter

Renders the current document, or the current frame of an animated document, using the given painter .

PySide2.QtSvg.QSvgRenderer.repaintNeeded()
PySide2.QtSvg.QSvgRenderer.setCurrentFrame(arg__1)
Parameters

arg__1 – int

PySide2.QtSvg.QSvgRenderer.setFramesPerSecond(num)
Parameters

num – int

See also

framesPerSecond()

PySide2.QtSvg.QSvgRenderer.setViewBox(viewbox)
Parameters

viewbox – QRect

PySide2.QtSvg.QSvgRenderer.setViewBox(viewbox)
Parameters

viewbox – QRectF

PySide2.QtSvg.QSvgRenderer.viewBox()
Return type

QRect

Returns viewBoxF() .toRect().

See also

setViewBox() viewBoxF()

PySide2.QtSvg.QSvgRenderer.viewBoxF()
Return type

QRectF