QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgsziputils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsziputils.h
3 ---------------------
4 begin : Jul 2017
5 copyright : (C) 2017 by Paul Blottiere
6 email : [email protected]m
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSZIPUTILS_H
17#define QGSZIPUTILS_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21#include <QStringList>
22
23#ifdef SIP_RUN
24% ModuleHeaderCode
25#include "qgsziputils.h"
26% End
27#endif
28
29namespace QgsZipUtils
30{
31
38 CORE_EXPORT bool isZipFile( const QString &filename );
39
49 CORE_EXPORT bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT );
50
59 CORE_EXPORT bool zip( const QString &zip, const QStringList &files );
60
61
68 CORE_EXPORT bool decodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut ) SIP_SKIP;
69
76 CORE_EXPORT bool decodeGzip( const char *bytesIn, std::size_t size, QByteArray &bytesOut ) SIP_SKIP;
77
84 CORE_EXPORT bool encodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut ) SIP_SKIP;
85
86};
87
88#endif //QGSZIPUTILS_H
CORE_EXPORT bool isZipFile(const QString &filename)
Returns true if the file name is a zipped file ( i.e with a '.qgz' extension, false otherwise.
Definition: qgsziputils.cpp:32
CORE_EXPORT bool unzip(const QString &zip, const QString &dir, QStringList &files)
Unzip a zip file in an output directory.
Definition: qgsziputils.cpp:37
CORE_EXPORT bool zip(const QString &zip, const QStringList &files)
Zip the list of files in the zip file.
CORE_EXPORT bool decodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Decodes gzip byte stream, returns true on success.
CORE_EXPORT bool encodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Encodes gzip byte stream, returns true on success.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_OUT
Definition: qgis_sip.h:58