1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the QtSvg 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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qsvgwidget.h"
43
44#ifndef QT_NO_SVGWIDGET
45
46#include "qsvgrenderer.h"
47
48#include "qpainter.h"
49#include "private/qwidget_p.h"
50
51QT_BEGIN_NAMESPACE
52
53/*!
54 \class QSvgWidget
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, {QtSvg Module}, QPicture
80*/
81
82class QSvgWidgetPrivate : public QWidgetPrivate
83{
84 Q_DECLARE_PUBLIC(QSvgWidget)
85public:
86 QSvgRenderer *renderer;
87};
88
89/*!
90 Constructs a new SVG display widget with the given \a parent.
91*/
92QSvgWidget::QSvgWidget(QWidget *parent)
93 : QWidget(*new QSvgWidgetPrivate, parent, 0)
94{
95 d_func()->renderer = new QSvgRenderer(this);
96 QObject::connect(d_func()->renderer, SIGNAL(repaintNeeded()),
97 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*/
104QSvgWidget::QSvgWidget(const QString &file, QWidget *parent)
105 : QWidget(*new QSvgWidgetPrivate, parent, 0)
106{
107 d_func()->renderer = new QSvgRenderer(file, this);
108 QObject::connect(d_func()->renderer, SIGNAL(repaintNeeded()),
109 this, SLOT(update()));
110}
111
112/*!
113 Destroys the widget.
114*/
115QSvgWidget::~QSvgWidget()
116{
117
118}
119
120/*!
121 Returns the renderer used to display the contents of the widget.
122*/
123QSvgRenderer * QSvgWidget::renderer() const
124{
125 Q_D(const QSvgWidget);
126 return d->renderer;
127}
128
129
130/*!
131 \reimp
132*/
133QSize 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*/
146void QSvgWidget::paintEvent(QPaintEvent *)
147{
148 Q_D(QSvgWidget);
149 QPainter p(this);
150 d->renderer->render(&p);
151}
152
153/*!
154 Loads the contents of the specified SVG \a file and updates the widget.
155*/
156void QSvgWidget::load(const QString &file)
157{
158 Q_D(const QSvgWidget);
159 d->renderer->load(file);
160}
161
162/*!
163 Loads the specified SVG format \a contents and updates the widget.
164*/
165void QSvgWidget::load(const QByteArray &contents)
166{
167 Q_D(const QSvgWidget);
168 d->renderer->load(contents);
169}
170
171QT_END_NAMESPACE
172
173#endif // QT_NO_SVGWIDGET
174