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

ark

  • Kerfuffle
  • CliInterface
Public Types | Public Member Functions | Public Attributes | List of all members
Kerfuffle::CliInterface Class Referenceabstract

#include <cliinterface.h>

Inheritance diagram for Kerfuffle::CliInterface:
Inheritance graph
[legend]

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 Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

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)
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from Kerfuffle::ReadOnlyArchiveInterface
QString password () const
 
void setWaitForFinishedSignal (bool value)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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 78 of file cliinterface.cpp.

Member Function Documentation

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

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 243 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 104 of file cliinterface.cpp.

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

Implements Kerfuffle::ReadWriteArchiveInterface.

Definition at line 293 of file cliinterface.cpp.

bool CliInterface::doKill ( )
virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 693 of file cliinterface.cpp.

bool CliInterface::doResume ( )
virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 714 of file cliinterface.cpp.

bool CliInterface::doSuspend ( )
virtual

Reimplemented from Kerfuffle::ReadOnlyArchiveInterface.

Definition at line 709 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 88 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 83 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:42:37 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
  • ktimer
  • kwallet
  • 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