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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsarchive.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsArchive
{
%Docstring(signature="appended")
Class allowing to manage the zip/unzip actions
%End
%TypeHeaderCode
#include "qgsarchive.h"
%End
public:
QgsArchive();
QgsArchive( const QgsArchive &other );
virtual ~QgsArchive();
bool zip( const QString &zipFilename );
%Docstring
Zip the content of this archive
:param zipFilename: The name of the zip to generate
:return: ``False`` if something goes wrong, ``True`` otherwise
%End
virtual bool unzip( const QString &zipFilename );
%Docstring
Clear the current content of this archive and unzip. Files are unzipped
in the temporary directory.
:param zipFilename: The zip file to unzip
:return: ``True`` if unzip action is a success, ``False`` otherwise
%End
void clear();
%Docstring
Clear the current content of this archive and create a new temporary
directory.
%End
void addFile( const QString &filename );
%Docstring
Add a new file to this archive. During a zip action, this file will be
part of the resulting zipped file.
:param filename: A file to add when zipping this archive
%End
bool removeFile( const QString &filename );
%Docstring
Remove a file from this archive and from the filesystem.
:param filename: The path of the file to remove
:return: ``True`` if the file has been removed from the filesystem,
``False`` otherwise
%End
QStringList files() const;
%Docstring
Returns the list of files within this archive
%End
QString dir() const;
%Docstring
Returns the current temporary directory.
%End
bool exists() const;
%Docstring
Returns ``True`` if the archive exists on the filesystem, ``False``
otherwise.
.. versionadded:: 3.20
%End
};
class QgsProjectArchive : QgsArchive
{
%Docstring(signature="appended")
Class allowing to manage the zip/unzip actions on project file
%End
%TypeHeaderCode
#include "qgsarchive.h"
%End
public:
virtual bool unzip( const QString &zipFilename );
%Docstring
Clear the current content of this archive and unzip. If a project file
is found in the content, then this archive may be considered as a valid
one. Files are unzipped in the temporary directory.
:param zipFilename: The zip file to unzip
:return: ``True`` if a project file has been found, ``False`` otherwise
%End
QString projectFile() const;
%Docstring
Returns the current .qgs project file or an empty string if there's none
%End
bool clearProjectFile();
%Docstring
Remove the current .qgs project file from the temporary directory.
:return: ``True`` if the file is well removed, ``False`` otherwise
%End
QString auxiliaryStorageFile() const;
%Docstring
Returns the current .qgd auxiliary storage file or an empty string if
there's none
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsarchive.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
