src/declarative/util/qdeclarativepixmapcache_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 QtDeclarative 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 #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
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 QT_MODULE(Declarative)
  55
  56 class QDeclarativeEngine;
  57 class QDeclarativePixmapData;
  58 class Q_DECLARATIVE_EXPORT QDeclarativePixmap
  59 {
  60     Q_DECLARE_TR_FUNCTIONS(QDeclarativePixmap)
  61 public:
  62     QDeclarativePixmap();
  63     QDeclarativePixmap(QDeclarativeEngine *, const QUrl &);
  64     QDeclarativePixmap(QDeclarativeEngine *, const QUrl &, const QSize &);
  65     ~QDeclarativePixmap();
  66
  67     enum Status { Null, Ready, Error, Loading };
  68
  69     enum Option {
  70         Asynchronous = 0x00000001,
  71         Cache        = 0x00000002
  72     };
  73     Q_DECLARE_FLAGS(Options, Option)
  74
  75     bool isNull() const;
  76     bool isReady() const;
  77     bool isError() const;
  78     bool isLoading() const;
  79
  80     Status status() const;
  81     QString error() const;
  82     const QUrl &url() const;
  83     const QSize &implicitSize() const;
  84     const QSize &requestSize() const;
  85     const QPixmap &pixmap() const;
  86     void setPixmap(const QPixmap &);
  87
  88     QRect rect() const;
  89     int width() const;
  90     int height() const;
  91     inline operator const QPixmap &() const;
  92
  93     void load(QDeclarativeEngine *, const QUrl &);
  94     void load(QDeclarativeEngine *, const QUrl &, QDeclarativePixmap::Options options);
  95     void load(QDeclarativeEngine *, const QUrl &, const QSize &);
  96     void load(QDeclarativeEngine *, const QUrl &, const QSize &, QDeclarativePixmap::Options options);
  97
  98     void clear();
  99     void clear(QObject *);
 100
 101     bool connectFinished(QObject *, const char *);
 102     bool connectFinished(QObject *, int);
 103     bool connectDownloadProgress(QObject *, const char *);
 104     bool connectDownloadProgress(QObject *, int);
 105
 106 private:
 107     Q_DISABLE_COPY(QDeclarativePixmap)
 108     QDeclarativePixmapData *d;
 109 };
 110
 111 inline QDeclarativePixmap::operator const QPixmap &() const
 112 {
 113     return pixmap();
 114 }
 115
 116 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativePixmap::Options)
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif // QDECLARATIVEPIXMAPCACHE_H