PySide6.QtSvg.QSvgGenerator¶

class QSvgGenerator¶

The QSvgGenerator class provides a paint device that is used to create SVG drawings. More…

Synopsis¶

Properties¶

descriptionᅟ - The description of the generated SVG drawing
fileNameᅟ - The target filename for the generated SVG drawing
outputDeviceᅟ - The output device for the generated SVG drawing
resolutionᅟ - The resolution of the generated output
sizeᅟ - The size of the generated SVG drawing
titleᅟ - The title of the generated SVG drawing
viewBoxᅟ - The viewBox of the generated SVG drawing

Methods¶

def __init__()
def description()
def fileName()
def outputDevice()
def resolution()
def setDescription()
def setFileName()
def setOutputDevice()
def setResolution()
def setSize()
def setTitle()
def setViewBox()
def size()
def svgVersion()
def title()
def viewBox()
def viewBoxF()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This paint device represents a Scalable Vector Graphics (SVG) drawing. Like QPrinter, it is designed as a write-only device that generates output in a specific format.

To write an SVG file, you first need to configure the output by setting the fileName or outputDevice properties. It is usually necessary to specify the size of the drawing by setting the size property, and in some cases where the drawing will be included in another, the viewBox property also needs to be set.

generator = QSvgGenerator()
generator.setFileName(path)
generator.setSize(QSize(200, 200))
generator.setViewBox(QRect(0, 0, 200, 200))
generator.setTitle(tr("SVG Generator Example Drawing"))
generator.setDescription(tr("An SVG drawing created by the SVG Generator "
                            "Example provided with Qt."))

Other meta-data can be specified by setting the title, description and resolution properties.

As with other QPaintDevice subclasses, a QPainter object is used to paint onto an instance of this class:

painter = QPainter()
painter.begin(generator)            ...

painter.end()

Painting is performed in the same way as for any other paint device. However, it is necessary to use the QPainter::begin() and end() to explicitly begin and end painting on the device.

See also

QSvgRenderer QSvgWidget Qt SVG C++ Classes

class SvgVersion¶

This enumeration describes the version of the SVG output of the generator.

Constant

Description

QSvgGenerator.SvgVersion.SvgTiny12

The generated document follows the SVG Tiny 1.2 specification.

QSvgGenerator.SvgVersion.Svg11

The generated document follows the SVG 1.1 specification.

Constant	Description
QSvgGenerator.SvgVersion.SvgTiny12	The generated document follows the SVG Tiny 1.2 specification.
QSvgGenerator.SvgVersion.Svg11	The generated document follows the SVG 1.1 specification.

Added in version 6.5.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property descriptionᅟ: str¶

This property holds the description of the generated SVG drawing.

See also

title

Access functions:

description()
setDescription()

property fileNameᅟ: str¶

This property holds the target filename for the generated SVG drawing.

See also

outputDevice

Access functions:

fileName()
setFileName()

property outputDeviceᅟ: QIODevice¶

This property holds the output device for the generated SVG drawing.

If both output device and file name are specified, the output device will have precedence.

See also

fileName

Access functions:

outputDevice()
setOutputDevice()

property resolutionᅟ: int¶

This property holds the resolution of the generated output.

The resolution is specified in dots per inch, and is used to calculate the physical size of an SVG drawing.

See also

size viewBox

Access functions:

resolution()
setResolution()

property sizeᅟ: QSize¶

This property holds the size of the generated SVG drawing.

By default this property is set to QSize(-1, -1), which indicates that the generator should not output the width and height attributes of the <svg> element.

Note

It is not possible to change this property while a QPainter is active on the generator.

See also

viewBox resolution

Access functions:

size()
setSize()

property titleᅟ: str¶

This property holds the title of the generated SVG drawing.

See also

description

Access functions:

title()
setTitle()

property viewBoxᅟ: QRectF¶

This property holds the viewBox of the generated SVG drawing.

By default this property is set to QRect(0, 0, -1, -1), which indicates that the generator should not output the viewBox attribute of the <svg> element.

Note

It is not possible to change this property while a QPainter is active on the generator.

See also

viewBox() size resolution

Access functions:

viewBoxF()
setViewBox()

__init__()¶

Constructs a new generator using the SVG Tiny 1.2 profile.

__init__(version)

Parameters:: version – SvgVersion

Constructs a new generator that uses the SVG version version.

description()¶

Return type:: str

See also

setDescription()

Getter of property descriptionᅟ .

fileName()¶

Return type:: str

See also

setFileName()

Getter of property fileNameᅟ .

outputDevice()¶

Return type:: QIODevice

See also

setOutputDevice()

Getter of property outputDeviceᅟ .

resolution()¶

Return type:: int

See also

setResolution()

Getter of property resolutionᅟ .

setDescription(description)¶

Parameters:: description – str

See also

description()

Setter of property descriptionᅟ .

setFileName(fileName)¶

Parameters:: fileName – str

See also

fileName()

Setter of property fileNameᅟ .

setOutputDevice(outputDevice)¶

Parameters:: outputDevice – QIODevice

See also

outputDevice()

Setter of property outputDeviceᅟ .

setResolution(dpi)¶

Parameters:: dpi – int

See also

resolution()

Setter of property resolutionᅟ .

setSize(size)¶

Parameters:: size – QSize

See also

size()

Setter of property sizeᅟ .

setTitle(title)¶

Parameters:: title – str

See also

title()

Setter of property titleᅟ .

setViewBox(viewBox)¶

Parameters:: viewBox – QRect

See also

viewBox()

setViewBox(viewBox)

Parameters:: viewBox – QRectF

Setter of property viewBoxᅟ .

size()¶

Return type:: QSize

See also

setSize()

Getter of property sizeᅟ .

svgVersion()¶

Return type:: SvgVersion

Returns the version of the SVG document that this generator is producing.

title()¶

Return type:: str

See also

setTitle()

Getter of property titleᅟ .

viewBox()¶

Return type:: QRect

Returns viewBoxF() .toRect().

See also

setViewBox() viewBoxF()

viewBoxF()¶

Return type:: QRectF

Getter of property viewBoxᅟ .