mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-08 00:05:09 -04:00
75 lines
2.5 KiB
Plaintext
75 lines
2.5 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsziputils.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsZipUtils
|
|
{
|
|
%Docstring(signature="appended")
|
|
Provides utility functions for working with zip files.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsziputils.h"
|
|
%End
|
|
public:
|
|
|
|
static 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
|
|
|
|
static 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
|
|
|
|
static bool zip( const QString &zip, const QStringList &files );
|
|
%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
|
|
%End
|
|
|
|
|
|
|
|
|
|
static 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 *
|
|
************************************************************************/
|