Kerfuffle::CliInterface Class Reference

#include <cliinterface.h>

Inheritance diagram for Kerfuffle::CliInterface:

Public Types
enum	OperationMode { List, Copy, Add, Delete }

Public Member Functions
	CliInterface (QObject *parent, const QVariantList &args)
virtual	~CliInterface ()
virtual bool	addFiles (const QStringList &files, const CompressionOptions &options)
virtual bool	copyFiles (const QList< QVariant > &files, const QString &destinationDirectory, ExtractionOptions options)
virtual bool	deleteFiles (const QList< QVariant > &files)
bool	doKill ()
bool	doResume ()
bool	doSuspend ()
QString	escapedCharacters ()
virtual bool	list ()
virtual ParameterList	parameterList () const =0
virtual bool	readListLine (const QString &line)=0
void	setEscapedCharacters (const QString &characters)
void	setListEmptyLines (bool emptyLines)
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 ()
QString	filename () const
virtual bool	open ()
void	setPassword (const QString &password)
bool	waitForFinishedSignal ()

Public Attributes
OperationMode	m_operationMode

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 224 of file cliinterface.h.

Member Enumeration Documentation

enum Kerfuffle::CliInterface::OperationMode

Enumerator
List
Copy
Add
Delete

Definition at line 229 of file cliinterface.h.

Constructor & Destructor Documentation

CliInterface::CliInterface ( QObject *  parent, const QVariantList &  args  )

explicit

Definition at line 54 of file cliinterface.cpp.

CliInterface::~CliInterface ( )

virtual

Definition at line 77 of file cliinterface.cpp.

Member Function Documentation

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

virtual

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 242 of file cliinterface.cpp.

bool CliInterface::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 103 of file cliinterface.cpp.

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

virtual

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 292 of file cliinterface.cpp.

bool CliInterface::doKill ( )

virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 688 of file cliinterface.cpp.

bool CliInterface::doResume ( )

virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 707 of file cliinterface.cpp.

bool CliInterface::doSuspend ( )

virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 702 of file cliinterface.cpp.

QString Kerfuffle::CliInterface::escapedCharacters

(

)

Returns the list of characters which are preceded by a backslash when a file name in an archive is passed to a program.

See also

setEscapedCharacters().

bool CliInterface::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 87 of file cliinterface.cpp.

virtual ParameterList Kerfuffle::CliInterface::parameterList ( ) const

pure virtual

Implemented in CliPlugin, CliPlugin, CliPlugin, CliPlugin, and CliPlugin.

virtual bool Kerfuffle::CliInterface::readListLine ( const QString &  line )

pure virtual

Implemented in CliPlugin, CliPlugin, CliPlugin, CliPlugin, and CliPlugin.

void Kerfuffle::CliInterface::setEscapedCharacters

(

const QString &

characters

)

Sets which characters will be preceded by a backslash when a file name in an archive is passed to a program.

See also

escapedCharacters().

void CliInterface::setListEmptyLines

(

bool

emptyLines

)

Sets if the listing should include empty lines.

The default value is false.

Definition at line 82 of file cliinterface.cpp.

Member Data Documentation

OperationMode Kerfuffle::CliInterface::m_operationMode

Definition at line 232 of file cliinterface.h.

---

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

• cliinterface.h
• cliinterface.cpp