1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsziputils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
%ModuleHeaderCode
#include "qgsziputils.h"
%End
namespace QgsZipUtils
{
bool isZipFile( const QString &filename );
%Docstring
Returns ``True`` if the file name is a zipped file ( i.e with a '.qgz'
extension, ``False`` otherwise.
:param filename: The name of the file
:return: ``True`` if the file is zipped, ``False`` otherwise
%End
bool unzip( const QString &zip, const QString &dir, QStringList &files /Out/, bool checkConsistency = true );
%Docstring
Unzip a zip file in an output directory.
:param zip: The zip filename
:param dir: The output directory
:param checkConsistency: Perform additional stricter consistency checks
on the archive, and error if they fail (since
QGIS 3.30)
:return: - ``False`` if the zip filename does not exist, the output
directory does not exist or is not writable.
- files: The absolute path of unzipped files
%End
bool zip( const QString &zip, const QStringList &files, bool overwrite = false );
%Docstring
Zip the list of files in the zip file. If the zip file already exists or
is empty, an error is returned. If an input file does not exist, an
error is also returned.
:param zip: The zip filename
:param files: The absolute path to files to embed within the zip
:param overwrite: Set to ``True`` to allow overwriting existing files
(since QGIS 3.44)
%End
const QStringList files( const QString &zip );
%Docstring
Returns the list of files within a ``zip`` file
.. versionadded:: 3.30
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsziputils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
