class KTar

# class KTar | A class for reading/writing (optionnally compressed) tar archives. More...
Definition | `#include <ktar.h>`
Inherits | KArchive [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KTar ( const QString& filename, const QString & mimetype = QString::null )
- KTar ( QIODevice * dev )
- virtual ~KTar ()
- QString fileName ()
- void setOrigFileName ( const QCString & fileName )
- virtual bool writeDir ( const QString& name, const QString& user, const QString& group )
- virtual bool prepareWriting ( const QString& name, const QString& user, const QString& group, uint size )
- virtual bool doneWriting ( uint size )

#### Protected Methods

- virtual bool openArchive ( int mode )
- virtual bool closeArchive ()
- virtual void virtual_hook ( int id, void* data )

## Detailed Description

KTar ( const QString& filename, const QString & mimetype = QString::null ) | ### KTar

Creates an instance that operates on the given filename. using the compression filter associated to given mimetype.

Parameters:

filename | is a local path (e.g. "/home/weis/myfile.tgz")
mimetype | "application/x-gzip" or "application/x-bzip2" Do not use application/x-tgz or so. Only the compression layer ! If the mimetype is ommitted, it will be determined from the filename.

KTar ( QIODevice * dev ) | ### KTar

Creates an instance that operates on the given device. The device can be compressed (KFilterDev) or not (QFile, etc.). WARNING: don't assume that giving a QFile here will decompress the file, in case it's compressed!

~KTar () | ### ~KTar

[virtual]

If the tar ball is still opened, then it will be closed automatically by the destructor.

QString fileName () | ### fileName

The name of the tar file, as passed to the constructor Null if you used the QIODevice constructor.

void setOrigFileName ( const QCString & fileName ) | ### setOrigFileName

Special function for setting the "original file name" in the gzip header, when writing a tar.gz file. It appears when using in the "file" command, for instance. Should only be called if the underlying device is a KFilterDev!

bool writeDir ( const QString& name, const QString& user, const QString& group ) | ### writeDir

[virtual]

Reimplemented from KArchive.

bool prepareWriting ( const QString& name, const QString& user, const QString& group, uint size ) | ### prepareWriting

[virtual]

Reimplemented from KArchive.

bool doneWriting ( uint size ) | ### doneWriting

[virtual]

Reimplemented from KArchive.

bool openArchive ( int mode ) | ### openArchive

[protected virtual]

Opens the archive for reading. Parses the directory listing of the archive and creates the KArchiveDirectory/KArchiveFile entries.

Reimplemented from KArchive.

bool closeArchive () | ### closeArchive

[protected virtual]

Reimplemented from KArchive.

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KArchive.

- Author: Torben Weis , David Faure
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:57 2003, using kdoc 2.0a54.