KArchiveDirectory Class

A directory in an archive. More...

Header:	`#include <KArchiveDirectory>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS Archive)` `target_link_libraries(mytarget PRIVATE KF6::Archive)`
Inherits:	KArchiveEntry

List of all members, including inherited members

Public Functions

	KArchiveDirectory(KArchive *archive, const QString &name, int access, const QDateTime &date, const QString &user, const QString &group, const QString &symlink)
bool	copyTo(const QString &dest, bool recursive = true) const
QStringList	entries() const
const KArchiveEntry *	entry(const QString &name) const
`(since 5.3)` const KArchiveFile *	file(const QString &name) const

Detailed Description

See also KArchive and KArchiveFile.

Member Function Documentation

KArchiveDirectory::KArchiveDirectory(KArchive **archive, const QString &name, int access, const QDateTime &date, const QString &user, const QString &group, const QString &symlink*)

Creates a new directory entry.

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()

bool KArchiveDirectory::copyTo(const QString &dest, bool recursive = true) const

Extracts all entries in this archive directory to the directory

dest.

dest the directory to extract to

recursive if set to true, subdirectories are extracted as well

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

QStringList KArchiveDirectory::entries() const

Returns a list of sub-entries.

Note that the list is not sorted, it's even in random order (due to using a hashtable). Use sort() on the result to sort the list by filename.

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

const KArchiveEntry KArchiveDirectory::entry(const QString &name*) const

Returns the entry in the archive with the given name.

The entry could be a file or a directory, use isFile() to find out which one it is.

name may be "test1", "mydir/test3", "mydir/mysubdir/test3", etc.

Returns a pointer to the entry in the directory, or a null pointer if there is no such entry.

`[since 5.3]` const KArchiveFile KArchiveDirectory::file(const QString &name*) const

Returns the file entry in the archive with the given name.

If the entry exists and is a file, a KArchiveFile is returned.

Otherwise, a null pointer is returned.

This is a convenience method for entry(), when we know the entry is expected to be a file.

name may be "test1", "mydir/test3", "mydir/mysubdir/test3", etc.

Returns a pointer to the file entry in the directory, or a null pointer if there is no such file entry.

This function was introduced in 5.3.

Contents