LibSingleFileInterface Class Reference

#include <singlefileplugin.h>

Inheritance diagram for LibSingleFileInterface:

Public Member Functions
	LibSingleFileInterface (QObject *parent, const QVariantList &args)
virtual	~LibSingleFileInterface ()
virtual bool	copyFiles (const QList< QVariant > &files, const QString &destinationDirectory, Kerfuffle::ExtractionOptions options)
virtual bool	list ()
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	isReadOnly () const
virtual bool	open ()
void	setPassword (const QString &password)
bool	waitForFinishedSignal ()

Protected Member Functions
QString	overwriteFileName (QString &filename)
const QString	uncompressedFileName () const
Protected Member Functions inherited from Kerfuffle::ReadOnlyArchiveInterface
QString	password () const
void	setWaitForFinishedSignal (bool value)

Protected Attributes
QString	m_mimeType
QStringList	m_possibleExtensions

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)

Detailed Description

Definition at line 31 of file singlefileplugin.h.

Constructor & Destructor Documentation

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

Definition at line 39 of file singlefileplugin.cpp.

LibSingleFileInterface::~LibSingleFileInterface ( )

virtual

Definition at line 44 of file singlefileplugin.cpp.

Member Function Documentation

bool LibSingleFileInterface::copyFiles ( const QList< QVariant > &  files, const QString &  destinationDirectory, Kerfuffle::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 48 of file singlefileplugin.cpp.

bool LibSingleFileInterface::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 105 of file singlefileplugin.cpp.

QString LibSingleFileInterface::overwriteFileName ( QString &  filename )

protected

Definition at line 121 of file singlefileplugin.cpp.

const QString LibSingleFileInterface::uncompressedFileName ( ) const

protected

Definition at line 144 of file singlefileplugin.cpp.

Member Data Documentation

QString LibSingleFileInterface::m_mimeType

protected

Definition at line 46 of file singlefileplugin.h.

QStringList LibSingleFileInterface::m_possibleExtensions

protected

Definition at line 47 of file singlefileplugin.h.

---

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

• singlefileplugin.h
• singlefileplugin.cpp