src/svg/qsvgtinydocument_p.h

   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 ** Commercial Usage
  11 ** Licensees holding valid Qt Commercial licenses may use this file in
  12 ** accordance with the Qt Commercial License Agreement provided with the
  13 ** Software or, alternatively, in accordance with the terms contained in
  14 ** a written agreement between you and Nokia.
  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 ** GNU General Public License Usage
  29 ** Alternatively, this file may be used under the terms of the GNU
  30 ** General Public License version 3.0 as published by the Free Software
  31 ** Foundation and appearing in the file LICENSE.GPL included in the
  32 ** packaging of this file.  Please review the following information to
  33 ** ensure the GNU General Public License version 3.0 requirements will be
  34 ** met: http://www.gnu.org/copyleft/gpl.html.
  35 **
  36 ** If you have questions regarding the use of this file, please contact
  37 ** Nokia at qt-info@nokia.com.
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSVGTINYDOCUMENT_P_H
  43 #define QSVGTINYDOCUMENT_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "qsvgstructure_p.h"
  57
  58 #ifndef QT_NO_SVG
  59
  60 #include "QtCore/qrect.h"
  61 #include "QtCore/qlist.h"
  62 #include "QtCore/qhash.h"
  63 #include "QtCore/qdatetime.h"
  64 #include "QtCore/qxmlstream.h"
  65 #include "qsvgstyle_p.h"
  66 #include "qsvgfont_p.h"
  67
  68 QT_BEGIN_NAMESPACE
  69
  70 class QPainter;
  71 class QByteArray;
  72 class QSvgFont;
  73
  74 class Q_SVG_EXPORT QSvgTinyDocument : public QSvgStructureNode
  75 {
  76 public:
  77     static QSvgTinyDocument * load(const QString &file);
  78     static QSvgTinyDocument * load(const QByteArray &contents);
  79     static QSvgTinyDocument * load(QXmlStreamReader *contents);
  80 public:
  81     QSvgTinyDocument();
  82     ~QSvgTinyDocument();
  83     Type type() const;
  84
  85     QSize size() const;
  86     void setWidth(int len, bool percent);
  87     void setHeight(int len, bool percent);
  88     int width() const;
  89     int height() const;
  90     bool widthPercent() const;
  91     bool heightPercent() const;
  92
  93     bool preserveAspectRatio() const;
  94
  95     QRectF viewBox() const;
  96     void setViewBox(const QRectF &rect);
  97
  98     virtual void draw(QPainter *p, QSvgExtraStates &);//from the QSvgNode
  99
 100     void draw(QPainter *p);
 101     void draw(QPainter *p, const QRectF &bounds);
 102     void draw(QPainter *p, const QString &id,
 103               const QRectF &bounds=QRectF());
 104
 105     QMatrix matrixForElement(const QString &id) const;
 106     QRectF boundsOnElement(const QString &id) const;
 107     bool   elementExists(const QString &id) const;
 108
 109     void addSvgFont(QSvgFont *);
 110     QSvgFont *svgFont(const QString &family) const;
 111
 112     void restartAnimation();
 113     int currentElapsed() const;
 114     bool animated() const;
 115     void setAnimated(bool a);
 116     int animationDuration() const;
 117     int currentFrame() const;
 118     void setCurrentFrame(int);
 119     void setFramesPerSecond(int num);
 120 private:
 121     void mapSourceToTarget(QPainter *p, const QRectF &targetRect, const QRectF &sourceRect = QRectF());
 122 private:
 123     QSize  m_size;
 124     bool   m_widthPercent;
 125     bool   m_heightPercent;
 126
 127     mutable QRectF m_viewBox;
 128
 129     QHash<QString, QSvgRefCounter<QSvgFont> > m_fonts;
 130
 131     QTime m_time;
 132     bool  m_animated;
 133     int   m_animationDuration;
 134     int   m_fps;
 135
 136     QSvgExtraStates m_states;
 137 };
 138
 139 inline QSize QSvgTinyDocument::size() const
 140 {
 141     if (m_size.isEmpty()) {
 142         return viewBox().size().toSize();
 143     } else {
 144         return m_size;
 145     }
 146 }
 147
 148 inline int QSvgTinyDocument::width() const
 149 {
 150     return size().width();
 151 }
 152
 153 inline int QSvgTinyDocument::height() const
 154 {
 155     return size().height();
 156 }
 157
 158 inline bool QSvgTinyDocument::widthPercent() const
 159 {
 160     return m_widthPercent;
 161 }
 162
 163 inline bool QSvgTinyDocument::heightPercent() const
 164 {
 165     return m_heightPercent;
 166 }
 167
 168 inline QRectF QSvgTinyDocument::viewBox() const
 169 {
 170     if (m_viewBox.isNull()) {
 171         m_viewBox = transformedBounds(QTransform());
 172     }
 173
 174     return m_viewBox;
 175 }
 176
 177 inline bool QSvgTinyDocument::preserveAspectRatio() const
 178 {
 179     return false;
 180 }
 181
 182 inline int QSvgTinyDocument::currentElapsed() const
 183 {
 184     return m_time.elapsed();
 185 }
 186
 187 inline int QSvgTinyDocument::animationDuration() const
 188 {
 189     return m_animationDuration;
 190 }
 191
 192 QT_END_NAMESPACE
 193
 194 #endif // QT_NO_SVG
 195 #endif // QSVGTINYDOCUMENT_P_H