src/gui/text/qzipwriter_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QZIPWRITER_H
  42 #define QZIPWRITER_H
  43 #ifndef QT_NO_TEXTODFWRITER
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists for the convenience
  50 // of the QZipWriter class.  This header file may change from
  51 // version to version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qstring.h>
  57 #include <QtCore/qfile.h>
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 class QZipWriterPrivate;
  62
  63
  64 class Q_GUI_EXPORT QZipWriter
  65 {
  66 public:
  67     QZipWriter(const QString &fileName, QIODevice::OpenMode mode = (QIODevice::WriteOnly | QIODevice::Truncate) );
  68
  69     explicit QZipWriter(QIODevice *device);
  70     ~QZipWriter();
  71
  72     QIODevice* device() const;
  73
  74     bool isWritable() const;
  75     bool exists() const;
  76
  77     enum Status {
  78         NoError,
  79         FileWriteError,
  80         FileOpenError,
  81         FilePermissionsError,
  82         FileError
  83     };
  84
  85     Status status() const;
  86
  87     enum CompressionPolicy {
  88         AlwaysCompress,
  89         NeverCompress,
  90         AutoCompress
  91     };
  92
  93     void setCompressionPolicy(CompressionPolicy policy);
  94     CompressionPolicy compressionPolicy() const;
  95
  96     void setCreationPermissions(QFile::Permissions permissions);
  97     QFile::Permissions creationPermissions() const;
  98
  99     void addFile(const QString &fileName, const QByteArray &data);
 100
 101     void addFile(const QString &fileName, QIODevice *device);
 102
 103     void addDirectory(const QString &dirName);
 104
 105     void addSymLink(const QString &fileName, const QString &destination);
 106
 107     void close();
 108 private:
 109     QZipWriterPrivate *d;
 110     Q_DISABLE_COPY(QZipWriter)
 111 };
 112
 113 QT_END_NAMESPACE
 114
 115 #endif // QT_NO_TEXTODFWRITER
 116 #endif // QZIPWRITER_H