QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
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 : paul.blottiere@oslandia.com
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
22
#include <QStringList>
23
29
class
CORE_EXPORT
QgsZipUtils
30
{
31
public
:
38
static
bool
isZipFile
(
const
QString &filename );
39
48
static
bool
unzip
(
const
QString &
zip
,
const
QString &dir, QStringList &
files
SIP_OUT
,
bool
checkConsistency =
true
);
49
59
static
bool
zip
(
const
QString &
zip
,
const
QStringList &
files
,
bool
overwrite =
false
);
60
67
static
bool
decodeGzip
(
const
QByteArray &bytesIn, QByteArray &bytesOut )
SIP_SKIP
;
68
75
static
bool
decodeGzip
(
const
char
*bytesIn, std::size_t size, QByteArray &bytesOut )
SIP_SKIP
;
76
83
static
bool
encodeGzip
(
const
QByteArray &bytesIn, QByteArray &bytesOut )
SIP_SKIP
;
84
90
static
const
QStringList
files
(
const
QString &
zip
);
91
97
static
bool
extractFileFromZip
(
const
QString &zipFilename,
const
QString &filenameInZip, QByteArray &bytesOut
SIP_OUT
);
98
};
99
100
#endif
//QGSZIPUTILS_H
QgsZipUtils
Provides utility functions for working with zip files.
Definition
qgsziputils.h:30
QgsZipUtils::extractFileFromZip
static bool extractFileFromZip(const QString &zipFilename, const QString &filenameInZip, QByteArray &bytesOut)
Extracts a file from a zip archive, returns true on success.
Definition
qgsziputils.cpp:341
QgsZipUtils::isZipFile
static 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
QgsZipUtils::zip
static bool zip(const QString &zip, const QStringList &files, bool overwrite=false)
Zip the list of files in the zip file.
Definition
qgsziputils.cpp:146
QgsZipUtils::unzip
static bool unzip(const QString &zip, const QString &dir, QStringList &files, bool checkConsistency=true)
Unzip a zip file in an output directory.
Definition
qgsziputils.cpp:37
QgsZipUtils::decodeGzip
static bool decodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Decodes gzip byte stream, returns true on success.
Definition
qgsziputils.cpp:206
QgsZipUtils::encodeGzip
static bool encodeGzip(const QByteArray &bytesIn, QByteArray &bytesOut)
Encodes gzip byte stream, returns true on success.
Definition
qgsziputils.cpp:268
QgsZipUtils::files
static const QStringList files(const QString &zip)
Returns the list of files within a zip file.
Definition
qgsziputils.cpp:309
qgis_sip.h
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
SIP_OUT
#define SIP_OUT
Definition
qgis_sip.h:57
Generated on
for QGIS API Documentation by
1.17.0