src/svg/qsvgwidget.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtSvg module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    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 
       
    51 QT_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 
       
    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, 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 */
       
   104 QSvgWidget::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 */
       
   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     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 */
       
   156 void 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 */
       
   165 void QSvgWidget::load(const QByteArray &contents)
       
   166 {
       
   167     Q_D(const QSvgWidget);
       
   168     d->renderer->load(contents);
       
   169 }
       
   170 
       
   171 QT_END_NAMESPACE
       
   172 
       
   173 #endif // QT_NO_SVGWIDGET