Kerfuffle::ReadOnlyArchiveInterface Class Reference

#include <archiveinterface.h>

Inheritance diagram for Kerfuffle::ReadOnlyArchiveInterface:

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

Public Member Functions
	ReadOnlyArchiveInterface (QObject *parent, const QVariantList &args)
virtual	~ReadOnlyArchiveInterface ()
virtual bool	copyFiles (const QList< QVariant > &files, const QString &destinationDirectory, ExtractionOptions options)=0
virtual bool	doKill ()
virtual bool	doResume ()
virtual bool	doSuspend ()
QString	filename () const
virtual bool	isReadOnly () const
virtual bool	list ()=0
virtual bool	open ()
void	setPassword (const QString &password)
bool	waitForFinishedSignal ()

Protected Member Functions
QString	password () const
void	setWaitForFinishedSignal (bool value)

Detailed Description

Definition at line 43 of file archiveinterface.h.

Constructor & Destructor Documentation

Kerfuffle::ReadOnlyArchiveInterface::ReadOnlyArchiveInterface ( QObject *  parent, const QVariantList &  args  )

explicit

Definition at line 37 of file archiveinterface.cpp.

Kerfuffle::ReadOnlyArchiveInterface::~ReadOnlyArchiveInterface ( )

virtual

Definition at line 44 of file archiveinterface.cpp.

Member Function Documentation

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

pure 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.

Implemented in Kerfuffle::CliInterface, LibSingleFileInterface, and KArchiveInterface.

bool Kerfuffle::ReadOnlyArchiveInterface::doKill ( )

virtual

Reimplemented in Kerfuffle::CliInterface.

Definition at line 73 of file archiveinterface.cpp.

bool Kerfuffle::ReadOnlyArchiveInterface::doResume ( )

virtual

Reimplemented in Kerfuffle::CliInterface.

Definition at line 85 of file archiveinterface.cpp.

bool Kerfuffle::ReadOnlyArchiveInterface::doSuspend ( )

virtual

Reimplemented in Kerfuffle::CliInterface.

Definition at line 79 of file archiveinterface.cpp.

void Kerfuffle::ReadOnlyArchiveInterface::entry ( const ArchiveEntry &  archiveEntry )

signal

void Kerfuffle::ReadOnlyArchiveInterface::entryRemoved ( const QString &  path )

signal

void Kerfuffle::ReadOnlyArchiveInterface::error ( const QString &  message, const QString &  details = QString()  )

signal

QString Kerfuffle::ReadOnlyArchiveInterface::filename

(

)

const

Returns the filename of the archive currently being handled.

Definition at line 48 of file archiveinterface.cpp.

void Kerfuffle::ReadOnlyArchiveInterface::finished ( bool  result )

signal

void Kerfuffle::ReadOnlyArchiveInterface::info ( const QString &  info )

signal

bool Kerfuffle::ReadOnlyArchiveInterface::isReadOnly ( ) const

virtual

Returns whether the file can only be read.

Returns

true The file cannot be written.

false The file can be read and written.

Reimplemented in Kerfuffle::ReadWriteArchiveInterface.

Definition at line 53 of file archiveinterface.cpp.

virtual bool Kerfuffle::ReadOnlyArchiveInterface::list ( )

pure 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.

Implemented in Kerfuffle::CliInterface, LibArchiveInterface, LibSingleFileInterface, and KArchiveInterface.

bool Kerfuffle::ReadOnlyArchiveInterface::open ( )

virtual

Definition at line 58 of file archiveinterface.cpp.

QString Kerfuffle::ReadOnlyArchiveInterface::password ( ) const

protected

Definition at line 68 of file archiveinterface.cpp.

void Kerfuffle::ReadOnlyArchiveInterface::progress ( double  progress )

signal

void Kerfuffle::ReadOnlyArchiveInterface::setPassword

(

const QString &

password

)

Definition at line 63 of file archiveinterface.cpp.

void Kerfuffle::ReadOnlyArchiveInterface::setWaitForFinishedSignal ( bool  value )

protected

Setting this option to true will not exit the thread with the exit of the various functions, but rather when finished(bool) is called.

Doing this one can use the event loop easily while doing the operation.

Definition at line 105 of file archiveinterface.cpp.

void Kerfuffle::ReadOnlyArchiveInterface::userQuery ( Query *  query )

signal

bool Kerfuffle::ReadOnlyArchiveInterface::waitForFinishedSignal

(

)

Definition at line 100 of file archiveinterface.cpp.

---

The documentation for this class was generated from the following files:

• archiveinterface.h
• archiveinterface.cpp