kio Library API Documentation

KArchiveDirectory Class Reference

Represents a directory entry in a KArchive. A directory in an archive. More...

#include <karchive.h>

Inheritance diagram for KArchiveDirectory:

KArchiveEntry List of all members.

Public Member Functions

 KArchiveDirectory (KArchive *archive, const QString &name, int access, int date, const QString &user, const QString &group, const QString &symlink)
QStringList entries () const
KArchiveEntryentry (QString name)
const KArchiveEntryentry (QString name) const
void addEntry (KArchiveEntry *)
virtual bool isDirectory () const
void copyTo (const QString &dest, bool recursive=true) const

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Detailed Description

Represents a directory entry in a KArchive. A directory in an archive.

See also:
KArchive

KArchiveFile

Definition at line 560 of file karchive.h.


Constructor & Destructor Documentation

KArchiveDirectory::KArchiveDirectory KArchive archive,
const QString name,
int  access,
int  date,
const QString user,
const QString group,
const QString symlink
 

Creates a new directory entry.

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::null

Definition at line 517 of file karchive.cpp.


Member Function Documentation

QStringList KArchiveDirectory::entries  )  const
 

Returns a list of sub-entries.

Returns:
the names of all entries in this directory (filenames, no path).

Definition at line 526 of file karchive.cpp.

Referenced by copyTo().

KArchiveEntry * KArchiveDirectory::entry QString  name  ) 
 

Returns the entry with the given name.

Parameters:
name may be "test1", "mydir/test3", "mydir/mysubdir/test3", etc.
Returns:
a pointer to the entry in the directory.

Definition at line 537 of file karchive.cpp.

References KArchiveEntry::isDirectory().

Referenced by copyTo(), KArchive::findOrCreate(), and KZip::openArchive().

const KArchiveEntry * KArchiveDirectory::entry QString  name  )  const
 

Returns the entry with the given name.

Parameters:
name may be "test1", "mydir/test3", "mydir/mysubdir/test3", etc.
Returns:
a pointer to the entry in the directory.

Definition at line 574 of file karchive.cpp.

virtual bool KArchiveDirectory::isDirectory  )  const [inline, virtual]
 

Checks whether this entry is a directory.

Returns:
true, since this entry is a directory

Reimplemented from KArchiveEntry.

Definition at line 607 of file karchive.h.

void KArchiveDirectory::copyTo const QString dest,
bool  recursive = true
const
 

Extracts all entries in this archive directory to the directory dest.

If recursive is true, subdirectories are extracted as well.

Parameters:
dest the directory to extract to
Since:
3.1

Definition at line 585 of file karchive.cpp.

References KArchiveFile::copyTo(), entries(), entry(), KArchiveEntry::isDirectory(), KArchiveEntry::isFile(), KArchiveEntry::name(), and KArchiveFile::position().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Sep 23 17:12:25 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003