QGIS API Documentation 3.41.0-Master (57ec4277f5e)
|
Class allowing to manage the zip/unzip actions. More...
#include <qgsarchive.h>
Public Member Functions | |
QgsArchive () | |
QgsArchive (const QgsArchive &other) | |
virtual | ~QgsArchive ()=default |
void | addFile (const QString &filename) |
Add a new file to this archive. | |
void | clear () |
Clear the current content of this archive and create a new temporary directory. | |
QString | dir () const |
Returns the current temporary directory. | |
bool | exists () const |
Returns true if the archive exists on the filesystem, false otherwise. | |
QStringList | files () const |
Returns the list of files within this archive. | |
QgsArchive & | operator= (const QgsArchive &other) |
bool | removeFile (const QString &filename) |
Remove a file from this archive and from the filesystem. | |
virtual bool | unzip (const QString &zipFilename) |
Clear the current content of this archive and unzip. | |
bool | zip (const QString &zipFilename) |
Zip the content of this archive. | |
Class allowing to manage the zip/unzip actions.
Definition at line 34 of file qgsarchive.h.
QgsArchive::QgsArchive | ( | ) |
Definition at line 32 of file qgsarchive.cpp.
QgsArchive::QgsArchive | ( | const QgsArchive & | other | ) |
Definition at line 37 of file qgsarchive.cpp.
|
virtualdefault |
void QgsArchive::addFile | ( | const QString & | filename | ) |
Add a new file to this archive.
During a zip action, this file will be part of the resulting zipped file.
filename | A file to add when zipping this archive |
Definition at line 113 of file qgsarchive.cpp.
void QgsArchive::clear | ( | ) |
Clear the current content of this archive and create a new temporary directory.
Definition at line 59 of file qgsarchive.cpp.
QString QgsArchive::dir | ( | ) | const |
Returns the current temporary directory.
Definition at line 54 of file qgsarchive.cpp.
bool QgsArchive::exists | ( | ) | const |
Returns true
if the archive exists on the filesystem, false
otherwise.
Definition at line 135 of file qgsarchive.cpp.
QStringList QgsArchive::files | ( | ) | const |
Returns the list of files within this archive.
Definition at line 130 of file qgsarchive.cpp.
QgsArchive & QgsArchive::operator= | ( | const QgsArchive & | other | ) |
Definition at line 43 of file qgsarchive.cpp.
bool QgsArchive::removeFile | ( | const QString & | filename | ) |
Remove a file from this archive and from the filesystem.
filename | The path of the file to remove |
true
if the file has been removed from the filesystem, false
otherwise Definition at line 118 of file qgsarchive.cpp.
|
virtual |
Clear the current content of this archive and unzip.
Files are unzipped in the temporary directory.
zipFilename | The zip file to unzip |
true
if unzip action is a success, false
otherwise Reimplemented in QgsProjectArchive.
Definition at line 107 of file qgsarchive.cpp.
bool QgsArchive::zip | ( | const QString & | zipFilename | ) |
Zip the content of this archive.
zipFilename | The name of the zip to generate |
false
if something goes wrong, true
otherwise Definition at line 65 of file qgsarchive.cpp.