QSvgGenerator

PyQt5.QtSvg.QSvgGenerator

Inherits from QPaintDevice.

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 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.

# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2017 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the examples of the Qt Toolkit.
# **
# ** $QT_BEGIN_LICENSE:BSD$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** BSD License Usage
# ** Alternatively, you may use this file under the terms of the BSD license
# ** as follows:
# **
# ** "Redistribution and use in source and binary forms, with or without
# ** modification, are permitted provided that the following conditions are
# ** met:
# **   * Redistributions of source code must retain the above copyright
# **     notice, this list of conditions and the following disclaimer.
# **   * Redistributions in binary form must reproduce the above copyright
# **     notice, this list of conditions and the following disclaimer in
# **     the documentation and/or other materials provided with the
# **     distribution.
# **   * Neither the name of The Qt Company Ltd nor the names of its
# **     contributors may be used to endorse or promote products derived
# **     from this software without specific prior written permission.
# **
# **
# ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/

# #include <QColorDialog>
# #include <QFileDialog>
# #include <QPainter>
# #include <QSvgGenerator>
# #include "window.h"
# #include "displaywidget.h"

# Window::Window(QWidget *parent)
#     : QWidget(parent)
# {
#     setupUi(this);
# }

# void Window::updateBackground(int background)
# {
#     displayWidget->setBackground(DisplayWidget::Background(background));
# }

# void Window::updateColor()
# {
#     QColor color = QColorDialog::getColor(displayWidget->color());
#     if (color.isValid())
#         displayWidget->setColor(color);
# }

# void Window::updateShape(int shape)
# {
#     displayWidget->setShape(DisplayWidget::Shape(shape));
# }

# #! [save SVG]
# void Window::saveSvg()
# {
#     QString newPath = QFileDialog::getSaveFileName(this, tr("Save SVG"),
#         path, tr("SVG files (*.svg)"));

#     if (newPath.isEmpty())
#         return;

#     path = newPath;

# //![configure SVG generator]
#     QSvgGenerator generator;
#     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."));
# //![configure SVG generator]
# //![begin painting]
#     QPainter painter;
#     painter.begin(&generator);
# //![begin painting]
#     displayWidget->paint(painter);
# //![end painting]
#     painter.end();
# //![end painting]
# }
# #! [save SVG]

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:

# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2017 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the examples of the Qt Toolkit.
# **
# ** $QT_BEGIN_LICENSE:BSD$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** BSD License Usage
# ** Alternatively, you may use this file under the terms of the BSD license
# ** as follows:
# **
# ** "Redistribution and use in source and binary forms, with or without
# ** modification, are permitted provided that the following conditions are
# ** met:
# **   * Redistributions of source code must retain the above copyright
# **     notice, this list of conditions and the following disclaimer.
# **   * Redistributions in binary form must reproduce the above copyright
# **     notice, this list of conditions and the following disclaimer in
# **     the documentation and/or other materials provided with the
# **     distribution.
# **   * Neither the name of The Qt Company Ltd nor the names of its
# **     contributors may be used to endorse or promote products derived
# **     from this software without specific prior written permission.
# **
# **
# ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/

# #include <QColorDialog>
# #include <QFileDialog>
# #include <QPainter>
# #include <QSvgGenerator>
# #include "window.h"
# #include "displaywidget.h"

# Window::Window(QWidget *parent)
#     : QWidget(parent)
# {
#     setupUi(this);
# }

# void Window::updateBackground(int background)
# {
#     displayWidget->setBackground(DisplayWidget::Background(background));
# }

# void Window::updateColor()
# {
#     QColor color = QColorDialog::getColor(displayWidget->color());
#     if (color.isValid())
#         displayWidget->setColor(color);
# }

# void Window::updateShape(int shape)
# {
#     displayWidget->setShape(DisplayWidget::Shape(shape));
# }

# #! [save SVG]
# void Window::saveSvg()
# {
#     QString newPath = QFileDialog::getSaveFileName(this, tr("Save SVG"),
#         path, tr("SVG files (*.svg)"));

#     if (newPath.isEmpty())
#         return;

#     path = newPath;

# //![configure SVG generator]
#     QSvgGenerator generator;
#     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."));
# //![configure SVG generator]
# //![begin painting]
#     QPainter painter;
#     painter.begin(&generator);
# //![begin painting]
#     displayWidget->paint(painter);
# //![end painting]
#     painter.end();
# //![end painting]
# }
# #! [save SVG]

# This code needs porting to Python.

# /****************************************************************************
# **
# ** Copyright (C) 2017 The Qt Company Ltd.
# ** Contact: https://www.qt.io/licensing/
# **
# ** This file is part of the examples of the Qt Toolkit.
# **
# ** $QT_BEGIN_LICENSE:BSD$
# ** Commercial License Usage
# ** Licensees holding valid commercial Qt licenses may use this file in
# ** accordance with the commercial license agreement provided with the
# ** Software or, alternatively, in accordance with the terms contained in
# ** a written agreement between you and The Qt Company. For licensing terms
# ** and conditions see https://www.qt.io/terms-conditions. For further
# ** information use the contact form at https://www.qt.io/contact-us.
# **
# ** BSD License Usage
# ** Alternatively, you may use this file under the terms of the BSD license
# ** as follows:
# **
# ** "Redistribution and use in source and binary forms, with or without
# ** modification, are permitted provided that the following conditions are
# ** met:
# **   * Redistributions of source code must retain the above copyright
# **     notice, this list of conditions and the following disclaimer.
# **   * Redistributions in binary form must reproduce the above copyright
# **     notice, this list of conditions and the following disclaimer in
# **     the documentation and/or other materials provided with the
# **     distribution.
# **   * Neither the name of The Qt Company Ltd nor the names of its
# **     contributors may be used to endorse or promote products derived
# **     from this software without specific prior written permission.
# **
# **
# ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
# **
# ** $QT_END_LICENSE$
# **
# ****************************************************************************/

# #include <QColorDialog>
# #include <QFileDialog>
# #include <QPainter>
# #include <QSvgGenerator>
# #include "window.h"
# #include "displaywidget.h"

# Window::Window(QWidget *parent)
#     : QWidget(parent)
# {
#     setupUi(this);
# }

# void Window::updateBackground(int background)
# {
#     displayWidget->setBackground(DisplayWidget::Background(background));
# }

# void Window::updateColor()
# {
#     QColor color = QColorDialog::getColor(displayWidget->color());
#     if (color.isValid())
#         displayWidget->setColor(color);
# }

# void Window::updateShape(int shape)
# {
#     displayWidget->setShape(DisplayWidget::Shape(shape));
# }

# #! [save SVG]
# void Window::saveSvg()
# {
#     QString newPath = QFileDialog::getSaveFileName(this, tr("Save SVG"),
#         path, tr("SVG files (*.svg)"));

#     if (newPath.isEmpty())
#         return;

#     path = newPath;

# //![configure SVG generator]
#     QSvgGenerator generator;
#     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."));
# //![configure SVG generator]
# //![begin painting]
#     QPainter painter;
#     painter.begin(&generator);
# //![begin painting]
#     displayWidget->paint(painter);
# //![end painting]
#     painter.end();
# //![end painting]
# }
# #! [save SVG]

Painting is performed in the same way as for any other paint device. However, it is necessary to use the begin() and 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, Qt SVG C++ Classes.

Methods

__init__()

Constructs a new generator.

---

description() → str

See also

setDescription().

---

fileName() → str

See also

setFileName().

---

metric(PaintDeviceMetric) → int

TODO

---

outputDevice() → QIODevice

See also

setOutputDevice().

---

paintEngine() → QPaintEngine

TODO

---

resolution() → int

See also

setResolution().

---

setDescription(str)

See also

description().

---

setFileName(str)

See also

fileName().

---

setOutputDevice(QIODevice)

See also

outputDevice().

---

setResolution(int)

See also

resolution().

---

setSize(QSize)

See also

size().

---

setTitle(str)

See also

title().

---

setViewBox(QRect)

See also

viewBox().

---

setViewBox(QRectF)

TODO

---

size() → QSize

See also

setSize().

---

title() → str

See also

setTitle().

---

viewBox() → QRect

Returns viewBoxF().toRect().

See also

setViewBox(), viewBoxF().

---

viewBoxF() → QRectF

TODO