QuaZIP  quazip-0-9
Static Public Member Functions | List of all members
JlCompress Class Reference

Utility class for typical operations. More...

#include <JlCompress.h>

Static Public Member Functions

static bool compressFile (QString fileCompressed, QString file)
 Compress a single file. More...
 
static bool compressFiles (QString fileCompressed, QStringList files)
 Compress a list of files. More...
 
static bool compressDir (QString fileCompressed, QString dir=QString(), bool recursive=true)
 Compress a whole directory. More...
 
static bool compressDir (QString fileCompressed, QString dir, bool recursive, QDir::Filters filters)
 Compress a whole directory. More...
 
static QString extractFile (QString fileCompressed, QString fileName, QString fileDest=QString())
 Extract a single file. More...
 
static QStringList extractFiles (QString fileCompressed, QStringList files, QString dir=QString())
 Extract a list of files. More...
 
static QStringList extractDir (QString fileCompressed, QString dir=QString())
 Extract a whole archive. More...
 
static QStringList extractDir (QString fileCompressed, QTextCodec *fileNameCodec, QString dir=QString())
 Extract a whole archive. More...
 
static QStringList getFileList (QString fileCompressed)
 Get the file list. More...
 
static QString extractFile (QIODevice *ioDevice, QString fileName, QString fileDest=QString())
 Extract a single file. More...
 
static QStringList extractFiles (QIODevice *ioDevice, QStringList files, QString dir=QString())
 Extract a list of files. More...
 
static QStringList extractDir (QIODevice *ioDevice, QString dir=QString())
 Extract a whole archive. More...
 
static QStringList extractDir (QIODevice *ioDevice, QTextCodec *fileNameCodec, QString dir=QString())
 Extract a whole archive. More...
 
static QStringList getFileList (QIODevice *ioDevice)
 Get the file list. More...
 

Detailed Description

Utility class for typical operations.

This class contains a number of useful static functions to perform simple operations, such as mass ZIP packing or extraction.

Member Function Documentation

◆ compressFile()

bool JlCompress::compressFile ( QString  fileCompressed,
QString  file 
)
static

Compress a single file.

Parameters
fileCompressedThe name of the archive.
fileThe file to compress.
Returns
true if success, false otherwise.

References QuaZip::close(), QuaZip::getZipError(), QuaZip::mdCreate, and QuaZip::open().

◆ compressFiles()

bool JlCompress::compressFiles ( QString  fileCompressed,
QStringList  files 
)
static

Compress a list of files.

Parameters
fileCompressedThe name of the archive.
filesThe file list to compress.
Returns
true if success, false otherwise.

References QuaZip::close(), QuaZip::getZipError(), QuaZip::mdCreate, and QuaZip::open().

◆ compressDir() [1/2]

bool JlCompress::compressDir ( QString  fileCompressed,
QString  dir = QString(),
bool  recursive = true 
)
static

Compress a whole directory.

Does not compress hidden files. See compressDir(QString, QString, bool, QDir::Filters).

Parameters
fileCompressedThe name of the archive.
dirThe directory to compress.
recursiveWhether to pack the subdirectories as well, or just regular files.
Returns
true if success, false otherwise.

◆ compressDir() [2/2]

bool JlCompress::compressDir ( QString  fileCompressed,
QString  dir,
bool  recursive,
QDir::Filters  filters 
)
static

Compress a whole directory.

Unless filters are specified explicitly, packs only regular non-hidden files (and subdirs, if recursive is true). If filters are specified, they are OR-combined with QDir::AllDirs|QDir::NoDotAndDotDot when searching for dirs and with QDir::Files when searching for files.

Parameters
fileCompressedpath to the resulting archive
dirpath to the directory being compressed
recursiveif true, then the subdirectories are packed as well
filterswhat to pack, filters are applied both when searching for subdirs (if packing recursively) and when looking for files to pack
Returns
true on success, false otherwise

References QuaZip::close(), QuaZip::getZipError(), QuaZip::mdCreate, and QuaZip::open().

◆ extractFile() [1/2]

QString JlCompress::extractFile ( QString  fileCompressed,
QString  fileName,
QString  fileDest = QString() 
)
static

Extract a single file.

Parameters
fileCompressedThe name of the archive.
fileNameThe file to extract.
fileDestThe destination file, assumed to be identical to file if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractFiles() [1/2]

QStringList JlCompress::extractFiles ( QString  fileCompressed,
QStringList  files,
QString  dir = QString() 
)
static

Extract a list of files.

Parameters
fileCompressedThe name of the archive.
filesThe file list to extract.
dirThe directory to put the files to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractDir() [1/4]

QStringList JlCompress::extractDir ( QString  fileCompressed,
QString  dir = QString() 
)
static

Extract a whole archive.

Parameters
fileCompressedThe name of the archive.
dirThe directory to extract to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractDir() [2/4]

QStringList JlCompress::extractDir ( QString  fileCompressed,
QTextCodec *  fileNameCodec,
QString  dir = QString() 
)
static

Extract a whole archive.

Parameters
fileCompressedThe name of the archive.
fileNameCodecThe codec to use for file names.
dirThe directory to extract to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

References QuaZip::setFileNameCodec().

◆ getFileList() [1/2]

QStringList JlCompress::getFileList ( QString  fileCompressed)
static

Get the file list.

Returns
The list of the files in the archive, or, more precisely, the list of the entries, including both files and directories if they are present separately.

◆ extractFile() [2/2]

QString JlCompress::extractFile ( QIODevice *  ioDevice,
QString  fileName,
QString  fileDest = QString() 
)
static

Extract a single file.

Parameters
ioDevicepointer to device with compressed data.
fileNameThe file to extract.
fileDestThe destination file, assumed to be identical to file if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractFiles() [2/2]

QStringList JlCompress::extractFiles ( QIODevice *  ioDevice,
QStringList  files,
QString  dir = QString() 
)
static

Extract a list of files.

Parameters
ioDevicepointer to device with compressed data.
filesThe file list to extract.
dirThe directory to put the files to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractDir() [3/4]

QStringList JlCompress::extractDir ( QIODevice *  ioDevice,
QString  dir = QString() 
)
static

Extract a whole archive.

Parameters
ioDevicepointer to device with compressed data.
dirThe directory to extract to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

◆ extractDir() [4/4]

QStringList JlCompress::extractDir ( QIODevice *  ioDevice,
QTextCodec *  fileNameCodec,
QString  dir = QString() 
)
static

Extract a whole archive.

Parameters
ioDevicepointer to device with compressed data.
fileNameCodecThe codec to use for file names.
dirThe directory to extract to, the current directory if left empty.
Returns
The list of the full paths of the files extracted, empty on failure.

References QuaZip::setFileNameCodec().

◆ getFileList() [2/2]

QStringList JlCompress::getFileList ( QIODevice *  ioDevice)
static

Get the file list.

Returns
The list of the files in the archive, or, more precisely, the list of the entries, including both files and directories if they are present separately.

The documentation for this class was generated from the following files: