src/quick/util/qdeclarativepixmapcache_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEPIXMAPCACHE_H
  43 #define QDECLARATIVEPIXMAPCACHE_H
  44
  45 #include <QtCore/qcoreapplication.h>
  46 #include <QtCore/qstring.h>
  47 #include <QtGui/qpixmap.h>
  48 #include <QtCore/qurl.h>
  49 #include <QtQuick/qtquickglobal.h>
  50
  51 #include <private/qintrusivelist_p.h>
  52 #include <qdeclarativeimageprovider.h>
  53
  54 QT_BEGIN_HEADER
  55
  56 QT_BEGIN_NAMESPACE
  57
  58 class QDeclarativeEngine;
  59 class QDeclarativePixmapData;
  60 class QDeclarativeTextureFactory;
  61
  62 class QDeclarativeDefaultTextureFactory : public QDeclarativeTextureFactory
  63 {
  64     Q_OBJECT
  65 public:
  66     QDeclarativeDefaultTextureFactory(const QImage &i)
  67         : im(i)
  68     {
  69     }
  70
  71     QSGTexture *createTexture() const;
  72     QSize textureSize() const { return im.size(); }
  73     int textureByteCount() const { return im.byteCount(); }
  74     QImage image() const { return im; }
  75
  76 private:
  77     QImage im;
  78 };
  79
  80 class Q_QUICK_EXPORT QDeclarativePixmap
  81 {
  82     Q_DECLARE_TR_FUNCTIONS(QDeclarativePixmap)
  83 public:
  84     QDeclarativePixmap();
  85     QDeclarativePixmap(QDeclarativeEngine *, const QUrl &);
  86     QDeclarativePixmap(QDeclarativeEngine *, const QUrl &, const QSize &);
  87     ~QDeclarativePixmap();
  88
  89     enum Status { Null, Ready, Error, Loading };
  90
  91     enum Option {
  92         Asynchronous = 0x00000001,
  93         Cache        = 0x00000002
  94     };
  95     Q_DECLARE_FLAGS(Options, Option)
  96
  97     bool isNull() const;
  98     bool isReady() const;
  99     bool isError() const;
 100     bool isLoading() const;
 101
 102     Status status() const;
 103     QString error() const;
 104     const QUrl &url() const;
 105     const QSize &implicitSize() const;
 106     const QSize &requestSize() const;
 107     const QImage &image() const;
 108     void setImage(const QImage &);
 109
 110     QDeclarativeTextureFactory *textureFactory() const;
 111
 112     QRect rect() const;
 113     int width() const;
 114     int height() const;
 115
 116     void load(QDeclarativeEngine *, const QUrl &);
 117     void load(QDeclarativeEngine *, const QUrl &, QDeclarativePixmap::Options options);
 118     void load(QDeclarativeEngine *, const QUrl &, const QSize &);
 119     void load(QDeclarativeEngine *, const QUrl &, const QSize &, QDeclarativePixmap::Options options);
 120
 121     void clear();
 122     void clear(QObject *);
 123
 124     bool connectFinished(QObject *, const char *);
 125     bool connectFinished(QObject *, int);
 126     bool connectDownloadProgress(QObject *, const char *);
 127     bool connectDownloadProgress(QObject *, int);
 128
 129 private:
 130     Q_DISABLE_COPY(QDeclarativePixmap)
 131     QDeclarativePixmapData *d;
 132     QIntrusiveListNode dataListNode;
 133     friend class QDeclarativePixmapData;
 134 };
 135
 136 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativePixmap::Options)
 137
 138 QT_END_NAMESPACE
 139
 140 QT_END_HEADER
 141
 142 #endif // QDECLARATIVEPIXMAPCACHE_H