src/qml/qml/qqmlfile.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml 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 #ifndef QQMLFILE_H
  43 #define QQMLFILE_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 class QUrl;
  52 class QString;
  53 class QObject;
  54 class QQmlEngine;
  55 class QQmlFilePrivate;
  56
  57 class Q_QML_EXPORT QQmlFile
  58 {
  59 public:
  60     QQmlFile();
  61     QQmlFile(QQmlEngine *, const QUrl &);
  62     QQmlFile(QQmlEngine *, const QString &);
  63     ~QQmlFile();
  64
  65     enum Status { Null, Ready, Error, Loading };
  66
  67     bool isNull() const;
  68     bool isReady() const;
  69     bool isError() const;
  70     bool isLoading() const;
  71
  72     QUrl url() const;
  73
  74     Status status() const;
  75     QString error() const;
  76
  77     qint64 size() const;
  78     const char *data() const;
  79     QByteArray dataByteArray() const;
  80
  81     QByteArray metaData(const QString &) const;
  82
  83     void load(QQmlEngine *, const QUrl &);
  84     void load(QQmlEngine *, const QString &);
  85
  86     void clear();
  87     void clear(QObject *);
  88
  89     bool connectFinished(QObject *, const char *);
  90     bool connectFinished(QObject *, int);
  91     bool connectDownloadProgress(QObject *, const char *);
  92     bool connectDownloadProgress(QObject *, int);
  93
  94     static bool isSynchronous(const QString &url);
  95     static bool isSynchronous(const QUrl &url);
  96
  97     static bool isBundle(const QString &url);
  98     static bool isBundle(const QUrl &url);
  99
 100     static bool isLocalFile(const QString &url);
 101     static bool isLocalFile(const QUrl &url);
 102
 103     static QString urlToLocalFileOrQrc(const QString &);
 104     static QString urlToLocalFileOrQrc(const QUrl &);
 105
 106     static bool bundleDirectoryExists(const QString &, QQmlEngine *);
 107     static bool bundleDirectoryExists(const QUrl &, QQmlEngine *);
 108
 109     static bool bundleFileExists(const QString &, QQmlEngine *);
 110     static bool bundleFileExists(const QUrl &, QQmlEngine *);
 111
 112     static QString bundleFileName(const QString &, QQmlEngine *);
 113     static QString bundleFileName(const QUrl &, QQmlEngine *);
 114
 115 private:
 116     Q_DISABLE_COPY(QQmlFile)
 117     QQmlFilePrivate *d;
 118 };
 119
 120 QT_END_NAMESPACE
 121
 122 QT_END_HEADER
 123
 124 #endif // QQMLFILE_H