.TH "KArchiveDirectory" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KArchiveDirectory \- Represents a directory entry in a \fBKArchive\fP. A directory in an archive.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <karchive.h>\fP
.PP
Inherits \fBKArchiveEntry\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKArchiveDirectory\fP (\fBKArchive\fP *archive, const \fBQString\fP &name, int access, int date, const \fBQString\fP &user, const \fBQString\fP &group, const \fBQString\fP &symlink)"
.br
.ti -1c
.RI "\fBQStringList\fP \fBentries\fP () const "
.br
.ti -1c
.RI "\fBKArchiveEntry\fP * \fBentry\fP (\fBQString\fP name)"
.br
.ti -1c
.RI "const \fBKArchiveEntry\fP * \fBentry\fP (\fBQString\fP name) const "
.br
.ti -1c
.RI "void \fBaddEntry\fP (\fBKArchiveEntry\fP *)"
.br
.ti -1c
.RI "virtual bool \fBisDirectory\fP () const "
.br
.ti -1c
.RI "void \fBcopyTo\fP (const \fBQString\fP &dest, bool recursive=true) const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Represents a directory entry in a \fBKArchive\fP. A directory in an archive. 

\fBSee also:\fP
.RS 4
\fBKArchive\fP 
.PP
\fBKArchiveFile\fP 
.RE
.PP

.PP
Definition at line 562 of file karchive.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KArchiveDirectory::KArchiveDirectory (\fBKArchive\fP * archive, const \fBQString\fP & name, int access, int date, const \fBQString\fP & user, const \fBQString\fP & group, const \fBQString\fP & symlink)"
.PP
Creates a new directory entry. 
.PP
\fBParameters:\fP
.RS 4
\fIarchive\fP the entries archive 
.br
\fIname\fP the name of the entry 
.br
\fIaccess\fP the permissions in unix format 
.br
\fIdate\fP the date (in seconds since 1970) 
.br
\fIuser\fP the user that owns the entry 
.br
\fIgroup\fP the group that owns the entry 
.br
\fIsymlink\fP the symlink, or QString::null 
.RE
.PP

.PP
Definition at line 517 of file karchive.cpp.
.PP
References QDict::setAutoDelete().
.SH "Member Function Documentation"
.PP 
.SS "\fBQStringList\fP KArchiveDirectory::entries () const"
.PP
Returns a list of sub-entries. 
.PP
\fBReturns:\fP
.RS 4
the names of all entries in this directory (filenames, no path). 
.RE
.PP

.PP
Definition at line 526 of file karchive.cpp.
.PP
References QDictIterator::current(), and QDictIterator::currentKey().
.PP
Referenced by copyTo().
.SS "\fBKArchiveEntry\fP * KArchiveDirectory::entry (\fBQString\fP name)"
.PP
Returns the entry with the given name. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP may be 'test1', 'mydir/test3', 'mydir/mysubdir/test3', etc. 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to the entry in the directory. 
.RE
.PP

.PP
Definition at line 537 of file karchive.cpp.
.PP
References QString::find(), KArchiveEntry::isDirectory(), QString::left(), QString::length(), and QString::mid().
.PP
Referenced by copyTo(), KArchive::findOrCreate(), and KZip::openArchive().
.SS "const \fBKArchiveEntry\fP * KArchiveDirectory::entry (\fBQString\fP name) const"
.PP
Returns the entry with the given name. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP may be 'test1', 'mydir/test3', 'mydir/mysubdir/test3', etc. 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to the entry in the directory. 
.RE
.PP

.PP
Definition at line 574 of file karchive.cpp.
.SS "virtual bool KArchiveDirectory::isDirectory () const\fC [inline, virtual]\fP"
.PP
Checks whether this entry is a directory. 
.PP
\fBReturns:\fP
.RS 4
true, since this entry is a directory 
.RE
.PP

.PP
Reimplemented from \fBKArchiveEntry\fP.
.PP
Definition at line 609 of file karchive.h.
.SS "void KArchiveDirectory::copyTo (const \fBQString\fP & dest, bool recursive = \fCtrue\fP) const"
.PP
Extracts all entries in this archive directory to the directory \fCdest\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIdest\fP the directory to extract to 
.br
\fIrecursive\fP if set to true, subdirectories are extracted as well 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 585 of file karchive.cpp.
.PP
References KArchiveFile::copyTo(), entries(), entry(), QMap::insert(), KArchiveEntry::isDirectory(), QPtrStack::isEmpty(), KArchiveEntry::isFile(), QDir::mkdir(), KArchiveEntry::name(), QValueStack::pop(), QPtrStack::pop(), KArchiveFile::position(), QValueStack::push(), and QPtrStack::push().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
