src/gui/text/qzipreader_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 QtGui 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 QZIPREADER_H
  43 #define QZIPREADER_H
  44
  45 #ifndef QT_NO_TEXTODFWRITER
  46
  47 //
  48 //  W A R N I N G
  49 //  -------------
  50 //
  51 // This file is not part of the Qt API.  It exists for the convenience
  52 // of the QZipReader class.  This header file may change from
  53 // version to version without notice, or even be removed.
  54 //
  55 // We mean it.
  56 //
  57
  58 #include <QtCore/qdatetime.h>
  59 #include <QtCore/qfile.h>
  60 #include <QtCore/qstring.h>
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 class QZipReaderPrivate;
  65
  66 class Q_GUI_EXPORT QZipReader
  67 {
  68 public:
  69     QZipReader(const QString &fileName, QIODevice::OpenMode mode = QIODevice::ReadOnly );
  70
  71     explicit QZipReader(QIODevice *device);
  72     ~QZipReader();
  73
  74     QIODevice* device() const;
  75
  76     bool isReadable() const;
  77     bool exists() const;
  78
  79     struct Q_GUI_EXPORT FileInfo
  80     {
  81         FileInfo();
  82         FileInfo(const FileInfo &other);
  83         ~FileInfo();
  84         FileInfo &operator=(const FileInfo &other);
  85         bool isValid() const;
  86         QString filePath;
  87         uint isDir : 1;
  88         uint isFile : 1;
  89         uint isSymLink : 1;
  90         QFile::Permissions permissions;
  91         uint crc32;
  92         qint64 size;
  93         QDateTime lastModified;
  94         void *d;
  95     };
  96
  97     QList<FileInfo> fileInfoList() const;
  98     int count() const;
  99
 100     FileInfo entryInfoAt(int index) const;
 101     QByteArray fileData(const QString &fileName) const;
 102     bool extractAll(const QString &destinationDir) const;
 103
 104     enum Status {
 105         NoError,
 106         FileReadError,
 107         FileOpenError,
 108         FilePermissionsError,
 109         FileError
 110     };
 111
 112     Status status() const;
 113
 114     void close();
 115
 116 private:
 117     QZipReaderPrivate *d;
 118     Q_DISABLE_COPY(QZipReader)
 119 };
 120
 121 QT_END_NAMESPACE
 122
 123 #endif // QT_NO_TEXTODFWRITER
 124 #endif // QZIPREADER_H