KZip Class
A class for reading / writing zip archives. More...
| Header: | #include <KZip> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Archive)target_link_libraries(mytarget PRIVATE KF6::Archive) |
| Inherits: | KArchive |
Public Types
| enum | Compression { NoCompression, DeflateCompression } |
| enum | ExtraField { NoExtraField, ModificationTime } |
Public Functions
| KZip(QIODevice *dev) | |
| KZip(const QString &filename) | |
| virtual | ~KZip() override |
| KZip::Compression | compression() const |
| KZip::ExtraField | extraField() const |
| void | setCompression(KZip::Compression c) |
| void | setExtraField(KZip::ExtraField ef) |
Detailed Description
You can use it in QIODevice::ReadOnly or in QIODevice::WriteOnly mode, and it behaves just as expected. It can also be used in QIODevice::ReadWrite mode, in this case one can append files to an existing zip archive. When you append new files, which are not yet in the zip, it works as expected, i.e. the files are appended at the end. When you append a file, which is already in the file, the reference to the old file is dropped and the new one is added to the zip - but the old data from the file itself is not deleted, it is still in the zipfile. So when you want to have a small and garbage-free zipfile, just read the contents of the appended zip file and write it to a new one in QIODevice::WriteOnly mode. This is especially important when you don't want to leak information of how intermediate versions of files in the zip were looking.
For more information on the zip fileformat go to http://www.pkware.com/products/enterprise/white_papers/appnote.html
Member Type Documentation
enum KZip::Compression
Describes the compression type for a given file in the Zip archive.
| Constant | Value | Description |
|---|---|---|
KZip::NoCompression | 0 | Uncompressed |
KZip::DeflateCompression | 1 | Deflate compression method |
enum KZip::ExtraField
Describes the contents of the "extra field" for a given file in the Zip archive.
| Constant | Value | Description |
|---|---|---|
KZip::NoExtraField | 0 | No extra field |
KZip::ModificationTime | 1 | Modification time ("extended timestamp" header) |
Member Function Documentation
[explicit] KZip::KZip(QIODevice *dev)
Creates an instance that operates on the given device.
The device can be compressed (KCompressionDevice) or not (QFile, etc.).
dev the device to access
Warning: Do not assume that giving a QFile here will decompress the file, in case it's compressed!
[explicit] KZip::KZip(const QString &filename)
Creates an instance that operates on the given filename. using the compression filter associated to given mimetype.
filename is a local path (e.g. "/home/holger/myfile.zip")
[override virtual noexcept] KZip::~KZip()
If the zip file is still opened, then it will be closed automatically by the destructor.
KZip::Compression KZip::compression() const
The current compression mode that will be used for new files.
Returns the current compression mode
See also setCompression().
KZip::ExtraField KZip::extraField() const
The current type of "extra field" that will be used for new files.
Returns the current type of "extra field"
See also setExtraField().
void KZip::setCompression(KZip::Compression c)
Call this before writeFile or prepareWriting, to define whether the next files to be written should be compressed or not.
c the new compression mode
See also compression().
void KZip::setExtraField(KZip::ExtraField ef)
Call this before writeFile or prepareWriting, to define what the next file to be written should have in its extra field.
ef the type of "extra field"
See also extraField().