KArchiveFile Class Reference

#include <karchive.h>

Inheritance diagram for KArchiveFile:

Public Member Functions
	KArchiveFile (KArchive *archive, const QString &name, int access, int date, const QString &user, const QString &group, const QString &symlink, qint64 pos, qint64 size)
virtual	~KArchiveFile ()
void	copyTo (const QString &dest) const
virtual QIODevice *	createDevice () const
virtual QByteArray	data () const
virtual bool	isFile () const
qint64	position () const
void	setSize (qint64 s)
qint64	size () const
Public Member Functions inherited from KArchiveEntry
	KArchiveEntry (KArchive *archive, const QString &name, int access, int date, const QString &user, const QString &group, const QString &symlink)
virtual	~KArchiveEntry ()
int	date () const
QDateTime	datetime () const
QString	group () const
virtual bool	isDirectory () const
QString	name () const
mode_t	permissions () const
QString	symLinkTarget () const
QString	user () const

Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from KArchiveEntry
KArchive *	archive () const

Detailed Description

Represents a file entry in a KArchive.

A file in an archive.

See also

KArchive

KArchiveDirectory

Definition at line 457 of file karchive.h.

Constructor & Destructor Documentation

KArchiveFile::KArchiveFile	(	KArchive *	archive,
		const QString &	name,
		int	access,
		int	date,
		const QString &	user,
		const QString &	group,
		const QString &	symlink,
		qint64	pos,
		qint64	size
	)

Creates a new file entry.

Do not call this, KArchive takes care of it.

Parameters

archive	the entries archive
name	the name of the entry
access	the permissions in unix format
date	the date (in seconds since 1970)
user	the user that owns the entry
group	the group that owns the entry
symlink	the symlink, or QString()
pos	the position of the file in the directory
size	the size of the file

Definition at line 606 of file karchive.cpp.

KArchiveFile::~KArchiveFile ( )

virtual

Destructor.

Do not call this, KArchive takes care of it.

Definition at line 615 of file karchive.cpp.

Member Function Documentation

void KArchiveFile::copyTo

(

const QString &

dest

)

const

Extracts the file to the directory dest.

Parameters

dest	the directory to extract to

Definition at line 662 of file karchive.cpp.

QIODevice * KArchiveFile::createDevice ( ) const

virtual

This method returns QIODevice (internal class: KLimitedIODevice) on top of the underlying QIODevice.

This is obviously for reading only.

WARNING: Note that the ownership of the device is being transferred to the caller, who will have to delete it.

The returned device auto-opens (in readonly mode), no need to open it.

Returns

the QIODevice of the file

Reimplemented in KZipFileEntry.

Definition at line 652 of file karchive.cpp.

QByteArray KArchiveFile::data ( ) const

virtual

Returns the data of the file.

Call data() with care (only once per file), this data isn't cached.

Returns

the content of this file.

Reimplemented in KZipFileEntry.

Definition at line 635 of file karchive.cpp.

bool KArchiveFile::isFile ( ) const

virtual

Checks whether this entry is a file.

Returns

true, since this entry is a file

Reimplemented from KArchiveEntry.

Definition at line 657 of file karchive.cpp.

qint64 KArchiveFile::position

(

)

const

Position of the data in the [uncompressed] archive.

Returns

the position of the file

Definition at line 620 of file karchive.cpp.

void KArchiveFile::setSize

(

qint64

s

)

Set size of data, usually after writing the file.

Parameters

s	the new size of the file

Definition at line 630 of file karchive.cpp.

qint64 KArchiveFile::size

(

)

const

Size of the data.

Returns

the size of the file

Definition at line 625 of file karchive.cpp.

void KArchiveFile::virtual_hook ( int  id, void *  data  )

protectedvirtual

Reimplemented from KArchiveEntry.

Definition at line 866 of file karchive.cpp.

---

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

• karchive.h
• karchive.cpp