• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KArchiveFile Class Reference

Represents a file entry in a KArchive. More...

#include <karchive.h>

Inheritance diagram for KArchiveFile:

Inheritance graph
[legend]

List of all members.


Public Member Functions

void copyTo (const QString &dest) const
virtual QIODevice * createDevice () const
virtual QByteArray data () const
virtual bool isFile () const
 KArchiveFile (KArchive *archive, const QString &name, int access, int date, const QString &user, const QString &group, const QString &symlink, qint64 pos, qint64 size)
qint64 position () const
void setSize (qint64 s)
qint64 size () const
virtual ~KArchiveFile ()

Protected Member Functions

virtual void virtual_hook (int id, void *data)

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 597 of file karchive.cpp.

KArchiveFile::~KArchiveFile (  )  [virtual]

Destructor.

Do not call this, KArchive takes care of it.

Definition at line 606 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 651 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 641 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 626 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 646 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 611 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 621 of file karchive.cpp.

qint64 KArchiveFile::size (  )  const

Size of the data.

Returns:
the size of the file

Definition at line 616 of file karchive.cpp.

void KArchiveFile::virtual_hook ( int  id,
void *  data 
) [protected, virtual]

Reimplemented from KArchiveEntry.

Definition at line 815 of file karchive.cpp.


The documentation for this class was generated from the following files:
  • karchive.h
  • karchive.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal