Commit d3f5cd14 authored by Raphael Kubo da Costa's avatar Raphael Kubo da Costa
Browse files

Start documenting BatchExtract

svn path=/trunk/KDE/kdeutils/ark/; revision=1001393
parent c15eefa1
...@@ -45,11 +45,38 @@ class KERFUFFLE_EXPORT BatchExtract : public KCompositeJob ...@@ -45,11 +45,38 @@ class KERFUFFLE_EXPORT BatchExtract : public KCompositeJob
Q_OBJECT Q_OBJECT
public: public:
/**
* Creates a new BatchExtract object.
*/
BatchExtract(); BatchExtract();
/**
* Destroys a BatchExtract object.
*/
virtual ~BatchExtract(); virtual ~BatchExtract();
void addExtraction(Archive* archive, bool preservePaths = true, QString destinationFolder = QString()); void addExtraction(Archive* archive, bool preservePaths = true, QString destinationFolder = QString());
/**
* Starts the extraction of all files.
*
* Each extraction job is started after the last one finishes.
* The jobs are executed in the order they were added via addInput.
*/
void start(); void start();
void setAutoSubfolder(bool value); void setAutoSubfolder(bool value);
/**
* Adds a file to the list of files that will be extracted.
*
* @param url The file that will be added to the list.
*
* @return @c true The file exists and a suitable plugin
* could be found for it.
* @return @c false The file does not exist or a suitable
* plugin could not be found.
*/
bool addInput(const KUrl& url); bool addInput(const KUrl& url);
bool showExtractDialog(); bool showExtractDialog();
void setDestinationFolder(QString folder); void setDestinationFolder(QString folder);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment