---

KAr Class Reference

A class for reading ar archives. More...

#include <kar.h>

Inheritance diagram for KAr:

List of all members.

Public Methods
	KAr (const QString &filename)
	KAr (QIODevice *dev)
virtual	~KAr ()
QString	fileName ()
virtual bool	prepareWriting (const QString &, const QString &, const QString &, uint)
virtual bool	doneWriting (uint)
virtual bool	writeDir (const QString &, const QString &, const QString &)
Protected Methods
virtual bool	openArchive (int mode)
virtual bool	closeArchive ()
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

A class for reading ar archives.

Author:

Laurence Anderson <l.d.anderson@warwick.ac.uk>

Since:

3.1

Definition at line 36 of file kar.h.

---

Constructor & Destructor Documentation

KAr::KAr (  const QString &    filename )

Creates an instance that operates on the given filename. Parameters: filename  is a local path (e.g. "/home/holger/myfile.ar")

KAr::KAr (  QIODevice *    dev )

Creates an instance that operates on the given device. The device can be compressed (KFilterDev) or not (QFile, etc.).

virtual KAr::~KAr (    )  [virtual]

If the ar file is still opened, then it will be closed automatically by the destructor.

---

Member Function Documentation

virtual bool KAr::closeArchive (    )  [protected, virtual]

Closes the archive. Called by close. Implements KArchive.

virtual bool KAr::doneWriting (  uint    )  [inline, virtual]

Call doneWriting after writing the data. See also: prepareWriting Implements KArchive. Definition at line 68 of file kar.h.

QString KAr::fileName (    )  [inline]

The name of the ar file, as passed to the constructor Null if you used the QIODevice constructor. Definition at line 62 of file kar.h.

virtual bool KAr::openArchive (  int    mode )  [protected, virtual]

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

virtual bool KAr::prepareWriting (  const QString &   , const QString &   , const QString &   , uint    )  [inline, virtual]

Here's another way of writing a file into an archive: Call prepareWriting, then call device()->writeBlock() (for tar files) or writeData (for zip files) [NEW VIRTUAL METHOD NEEDED] as many times as wanted then call doneWriting( totalSize ) For tar.gz files, you need to know the size before hand, it is needed in the header! For zip files, size isn't used. Implements KArchive. Definition at line 67 of file kar.h.

virtual bool KAr::writeDir (  const QString &   , const QString &   , const QString &    )  [inline, virtual]

If an archive is opened for writing then you can add new directories using this function. KArchive won't write one directory twice. Implements KArchive. Definition at line 69 of file kar.h.

---

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

• kar.h

---