QSvgGenerator¶

Synopsis¶

Detailed Description¶

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

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 QSvgGenerator.fileName() or QSvgGenerator.outputDevice() properties. It is usually necessary to specify the size of the drawing by setting the QSvgGenerator.size() property, and in some cases where the drawing will be included in another, the QSvgGenerator.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(QObject.tr("SVG Generator Example Drawing"))
generator.setDescription(QObject.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 QPainter.end() to explicitly begin and end painting on the device.

The SVG Generator Example shows how the same painting commands can be used for painting a widget and writing an SVG file.

See also

QSvgRenderer QSvgWidget About SVG

class PySide.QtSvg.QSvgGenerator¶

Constructs a new generator.

QSvgGenerator.description()¶

Return type:	QString

This property holds the description of the generated SVG drawing.

See also

QSvgGenerator.title()

QSvgGenerator.fileName()¶

Return type:	QString

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

See also

QSvgGenerator.outputDevice()

QSvgGenerator.outputDevice()¶

Return type:	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

QSvgGenerator.fileName()

QSvgGenerator.resolution()¶

Return type:	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

QSvgGenerator.size() QSvgGenerator.viewBox()

QSvgGenerator.setDescription(description)¶

Parameter:	description – QString

This property holds the description of the generated SVG drawing.

See also

QSvgGenerator.title()

QSvgGenerator.setFileName(fileName)¶

Parameter:	fileName – QString

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

See also

QSvgGenerator.outputDevice()

QSvgGenerator.setOutputDevice(outputDevice)¶

Parameter:	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

QSvgGenerator.fileName()

QSvgGenerator.setResolution(dpi)¶

Parameter:	dpi – 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

QSvgGenerator.size() QSvgGenerator.viewBox()

QSvgGenerator.setSize(size)¶

Parameter:	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

QSvgGenerator.viewBox() QSvgGenerator.resolution()

QSvgGenerator.setTitle(title)¶

Parameter:	title – QString

This property holds the title of the generated SVG drawing.

See also

QSvgGenerator.description()

QSvgGenerator.setViewBox(viewBox)¶

Parameter:	viewBox – QRectF

This property holds the QSvgGenerator.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 QSvgGenerator.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

QSvgGenerator.viewBox() QSvgGenerator.size() QSvgGenerator.resolution()

QSvgGenerator.setViewBox(viewBox)

Parameter:	viewBox – QRect

See also

QSvgGenerator.viewBox()

QSvgGenerator.size()¶

Return type:	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

QSvgGenerator.viewBox() QSvgGenerator.resolution()

QSvgGenerator.title()¶

Return type:	QString

This property holds the title of the generated SVG drawing.

See also

QSvgGenerator.description()

QSvgGenerator.viewBox()¶

Return type:	QRect

Returns QSvgGenerator.viewBoxF() . toRect() .

See also

QSvgGenerator.setViewBox() QSvgGenerator.viewBoxF()

QSvgGenerator.viewBoxF()¶

Return type:	QRectF

This property holds the QSvgGenerator.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 QSvgGenerator.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

QSvgGenerator.viewBox() QSvgGenerator.size() QSvgGenerator.resolution()