1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the Qt SVG module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | #include "qsvgwidget.h" |
41 | |
42 | #ifndef QT_NO_WIDGETS |
43 | |
44 | #include "qsvgrenderer.h" |
45 | |
46 | #include "qstyleoption.h" |
47 | #include "qpainter.h" |
48 | #include "private/qwidget_p.h" |
49 | |
50 | QT_BEGIN_NAMESPACE |
51 | |
52 | /*! |
53 | \class QSvgWidget |
54 | \inmodule QtSvg |
55 | \ingroup painting |
56 | |
57 | \brief The QSvgWidget class provides a widget that is used to display the contents of |
58 | Scalable Vector Graphics (SVG) files. |
59 | \since 4.1 |
60 | |
61 | This class enables developers to display SVG drawings alongside standard widgets, and |
62 | is used in much the same way as QLabel is used for displaying text and bitmap images. |
63 | |
64 | Since QSvgWidget is a subclass of QWidget, SVG drawings are rendered using the properties |
65 | of the display. More control can be exercised over the rendering process with the |
66 | QSvgRenderer class, as this can be used to paint onto other paint devices, such as QImage |
67 | and QGLWidget. The renderer used by the widget can be obtained with the renderer() |
68 | function. |
69 | |
70 | Each QSvgWidget can be constructed with the file name of a SVG file, or they can be |
71 | constructed without a specific file to render and one can be supplied later. The load() |
72 | functions provide two different ways to load an SVG file: they accept either the file name |
73 | of an SVG file or a QByteArray containing the serialized XML representation of an SVG file. |
74 | |
75 | By default, the widget provides a size hint to reflect the size of the drawing that it |
76 | displays. If no data has been loaded, the widget provides the default QWidget size hint. |
77 | Subclass this class and reimplement sizeHint() if you need to customize this behavior. |
78 | |
79 | \sa QSvgRenderer, {Qt SVG C++ Classes}, QPicture |
80 | */ |
81 | |
82 | class QSvgWidgetPrivate : public QWidgetPrivate |
83 | { |
84 | Q_DECLARE_PUBLIC(QSvgWidget) |
85 | public: |
86 | QSvgRenderer *renderer; |
87 | }; |
88 | |
89 | /*! |
90 | Constructs a new SVG display widget with the given \a parent. |
91 | */ |
92 | QSvgWidget::QSvgWidget(QWidget *parent) |
93 | : QWidget(*new QSvgWidgetPrivate, parent, {}) |
94 | { |
95 | d_func()->renderer = new QSvgRenderer(this); |
96 | QObject::connect(sender: d_func()->renderer, SIGNAL(repaintNeeded()), |
97 | receiver: this, SLOT(update())); |
98 | } |
99 | |
100 | /*! |
101 | Constructs a new SVG display widget with the given \a parent and loads the contents |
102 | of the specified \a file. |
103 | */ |
104 | QSvgWidget::QSvgWidget(const QString &file, QWidget *parent) |
105 | : QWidget(*new QSvgWidgetPrivate, parent, {}) |
106 | { |
107 | d_func()->renderer = new QSvgRenderer(file, this); |
108 | QObject::connect(sender: d_func()->renderer, SIGNAL(repaintNeeded()), |
109 | receiver: this, SLOT(update())); |
110 | } |
111 | |
112 | /*! |
113 | Destroys the widget. |
114 | */ |
115 | QSvgWidget::~QSvgWidget() |
116 | { |
117 | |
118 | } |
119 | |
120 | /*! |
121 | Returns the renderer used to display the contents of the widget. |
122 | */ |
123 | QSvgRenderer * QSvgWidget::renderer() const |
124 | { |
125 | Q_D(const QSvgWidget); |
126 | return d->renderer; |
127 | } |
128 | |
129 | |
130 | /*! |
131 | \reimp |
132 | */ |
133 | QSize QSvgWidget::sizeHint() const |
134 | { |
135 | Q_D(const QSvgWidget); |
136 | if (d->renderer->isValid()) |
137 | return d->renderer->defaultSize(); |
138 | else |
139 | return QSize(128, 64); |
140 | } |
141 | |
142 | |
143 | /*! |
144 | \reimp |
145 | */ |
146 | void QSvgWidget::paintEvent(QPaintEvent *) |
147 | { |
148 | Q_D(QSvgWidget); |
149 | QStyleOption opt; |
150 | opt.init(w: this); |
151 | QPainter p(this); |
152 | style()->drawPrimitive(pe: QStyle::PE_Widget, opt: &opt, p: &p, w: this); |
153 | d->renderer->render(p: &p); |
154 | } |
155 | |
156 | /*! |
157 | Loads the contents of the specified SVG \a file and updates the widget. |
158 | */ |
159 | void QSvgWidget::load(const QString &file) |
160 | { |
161 | Q_D(const QSvgWidget); |
162 | d->renderer->load(filename: file); |
163 | } |
164 | |
165 | /*! |
166 | Loads the specified SVG format \a contents and updates the widget. |
167 | */ |
168 | void QSvgWidget::load(const QByteArray &contents) |
169 | { |
170 | Q_D(const QSvgWidget); |
171 | d->renderer->load(contents); |
172 | } |
173 | |
174 | QT_END_NAMESPACE |
175 | |
176 | #endif // QT_NO_WIDGETS |
177 | |