KArchiveFile

#include <KArchiveFile>

Inheritance diagram for KArchiveFile:

Public Member Functions

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

Protected Member Functions

void virtual_hook (int id, void *data) override
 
- Protected Member Functions inherited from KArchiveEntry
KArchivearchive () const
 

Detailed Description

Represents a file entry in a KArchive.

A file in an archive.

See also
KArchive
KArchiveDirectory

Definition at line 24 of file karchivefile.h.

Constructor & Destructor Documentation

KArchiveFile::KArchiveFile ( KArchive archive,
const QString name,
int  access,
const QDateTime 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
archivethe entries archive
namethe name of the entry
accessthe permissions in unix format
datethe date (in seconds since 1970)
userthe user that owns the entry
groupthe group that owns the entry
symlinkthe symlink, or QString()
posthe position of the file in the directory
sizethe size of the file

Definition at line 738 of file karchive.cpp.

KArchiveFile::~KArchiveFile ( )
virtual

Destructor.

Do not call this, KArchive takes care of it.

Definition at line 747 of file karchive.cpp.

Member Function Documentation

bool KArchiveFile::copyTo ( const QString dest) const

Extracts the file to the directory dest.

Parameters
destthe directory to extract to
Returns
true on success, false if the file (dest + '/' + name()) couldn't be created

Definition at line 809 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 783 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 767 of file karchive.cpp.

bool KArchiveFile::isFile ( ) const
overridevirtual

Checks whether this entry is a file.

Returns
true, since this entry is a file

Reimplemented from KArchiveEntry.

Definition at line 788 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 752 of file karchive.cpp.

void KArchiveFile::setSize ( qint64  s)

Set size of data, usually after writing the file.

Parameters
sthe new size of the file

Definition at line 762 of file karchive.cpp.

qint64 KArchiveFile::size ( ) const

Size of the data.

Returns
the size of the file

Definition at line 757 of file karchive.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Nov 27 2020 23:04:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.