• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeutils API Reference
  • KDE Home
  • Contact Us
 

ark

Public Member Functions | List of all members
KArchiveInterface Class Reference

#include <karchiveplugin.h>

Inheritance diagram for KArchiveInterface:
Inheritance graph
[legend]

Public Member Functions

 KArchiveInterface (QObject *parent=0, const QVariantList &args=QVariantList())
 
 ~KArchiveInterface ()
 
bool addFiles (const QStringList &files, const CompressionOptions &options)
 
bool copyFiles (const QList< QVariant > &files, const QString &destinationDirectory, ExtractionOptions options)
 
bool deleteFiles (const QList< QVariant > &files)
 
bool list ()
 
- Public Member Functions inherited from Kerfuffle::ReadWriteArchiveInterface
 ReadWriteArchiveInterface (QObject *parent, const QVariantList &args)
 
virtual ~ReadWriteArchiveInterface ()
 
virtual bool isReadOnly () const
 
- Public Member Functions inherited from Kerfuffle::ReadOnlyArchiveInterface
 ReadOnlyArchiveInterface (QObject *parent, const QVariantList &args)
 
virtual ~ReadOnlyArchiveInterface ()
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
QString filename () const
 
virtual bool open ()
 
void setPassword (const QString &password)
 
bool waitForFinishedSignal ()
 

Additional Inherited Members

- Signals inherited from Kerfuffle::ReadOnlyArchiveInterface
void entry (const ArchiveEntry &archiveEntry)
 
void entryRemoved (const QString &path)
 
void error (const QString &message, const QString &details=QString())
 
void finished (bool result)
 
void info (const QString &info)
 
void progress (double progress)
 
void userQuery (Query *query)
 
- Protected Member Functions inherited from Kerfuffle::ReadOnlyArchiveInterface
QString password () const
 
void setWaitForFinishedSignal (bool value)
 

Detailed Description

Definition at line 31 of file karchiveplugin.h.

Constructor & Destructor Documentation

KArchiveInterface::KArchiveInterface ( QObject *  parent = 0,
const QVariantList &  args = QVariantList() 
)
explicit

Definition at line 34 of file karchiveplugin.cpp.

KArchiveInterface::~KArchiveInterface ( )

Definition at line 40 of file karchiveplugin.cpp.

Member Function Documentation

bool KArchiveInterface::addFiles ( const QStringList &  files,
const CompressionOptions &  options 
)
virtual

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 222 of file karchiveplugin.cpp.

bool KArchiveInterface::copyFiles ( const QList< QVariant > &  files,
const QString &  destinationDirectory,
ExtractionOptions  options 
)
virtual

Extract files from archive.

Globally recognized extraction options:

  • PreservePaths - preserve file paths (extract flat if false)
  • RootNode - node in the archive which will correspond to the
  • destinationDirectory When subclassing, you can block as long as you need, the function runs in its own thread.
    Returns
    whether the listing succeeded.
    Note
    If returning false, make sure to emit the error() signal beforewards to notify the user of the error condition.

Implements Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 86 of file karchiveplugin.cpp.

bool KArchiveInterface::deleteFiles ( const QList< QVariant > &  files)
virtual

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 268 of file karchiveplugin.cpp.

bool KArchiveInterface::list ( )
virtual

List archive contents.

This runs the process of reading archive contents. When subclassing, you can block as long as you need, the function runs in its own thread.

Returns
whether the listing succeeded.
Note
If returning false, make sure to emit the error() signal beforewards to notify the user of the error condition.

Implements Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 61 of file karchiveplugin.cpp.


The documentation for this class was generated from the following files:
  • karchiveplugin.h
  • karchiveplugin.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:08:10 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

ark

Skip menu "ark"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdeutils API Reference

Skip menu "kdeutils API Reference"
  • ark
  • filelight
  • kcalc
  • kcharselect
  • kdf
  • kfloppy
  • kgpg
  • kremotecontrol
  • ktimer
  • kwallet
  • superkaramba
  • sweeper

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal