1// -*- c++ -*-
2/* This file is part of the KDE libraries
3 Copyright 2000 Stephan Kulow <coolo@kde.org>
4 Copyright 2000-2006 David Faure <faure@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
21
22#ifndef KIO_DELETEJOB_H
23#define KIO_DELETEJOB_H
24
25#include <QtCore/QStringList>
26
27#include <kurl.h>
28#include "global.h"
29
30#include "jobclasses.h"
31
32class QTimer;
33
34namespace KIO {
35
36 class DeleteJobPrivate;
37 /**
38 * A more complex Job to delete files and directories.
39 * Don't create the job directly, but use KIO::del() instead.
40 *
41 * @see KIO::del()
42 */
43 class KIO_EXPORT DeleteJob : public Job {
44 Q_OBJECT
45
46 public:
47 virtual ~DeleteJob();
48
49 /**
50 * Returns the list of URLs.
51 * @return the list of URLs.
52 */
53 KUrl::List urls() const;
54
55 Q_SIGNALS:
56
57 /**
58 * Emitted when the total number of files is known.
59 * @param job the job that emitted this signal
60 * @param files the total number of files
61 */
62 void totalFiles( KJob *job, unsigned long files );
63 /**
64 * Emitted when the toal number of direcotries is known.
65 * @param job the job that emitted this signal
66 * @param dirs the total number of directories
67 */
68 void totalDirs( KJob *job, unsigned long dirs );
69
70 /**
71 * Sends the number of processed files.
72 * @param job the job that emitted this signal
73 * @param files the number of processed files
74 */
75 void processedFiles( KIO::Job *job, unsigned long files );
76 /**
77 * Sends the number of processed directories.
78 * @param job the job that emitted this signal
79 * @param dirs the number of processed dirs
80 */
81 void processedDirs( KIO::Job *job, unsigned long dirs );
82
83 /**
84 * Sends the URL of the file that is currently being deleted.
85 * @param job the job that emitted this signal
86 * @param file the URL of the file or directory that is being
87 * deleted
88 */
89 void deleting( KIO::Job *job, const KUrl& file );
90
91 protected Q_SLOTS:
92 virtual void slotResult( KJob *job );
93
94 protected:
95 DeleteJob(DeleteJobPrivate &dd);
96
97 private:
98 Q_PRIVATE_SLOT(d_func(), void slotStart())
99 Q_PRIVATE_SLOT(d_func(), void slotEntries( KIO::Job*, const KIO::UDSEntryList& list ))
100 Q_PRIVATE_SLOT(d_func(), void slotReport())
101 Q_DECLARE_PRIVATE(DeleteJob)
102 };
103
104 /**
105 * Delete a file or directory.
106 *
107 * @param src file to delete
108 * @param flags: We support HideProgressInfo here
109 * @return the job handling the operation
110 */
111 KIO_EXPORT DeleteJob *del( const KUrl& src, JobFlags flags = DefaultFlags );
112
113 /**
114 * Deletes a list of files or directories.
115 *
116 * @param src the files to delete
117 * @param flags: We support HideProgressInfo here
118 * @return the job handling the operation
119 */
120 KIO_EXPORT DeleteJob *del( const KUrl::List& src, JobFlags flags = DefaultFlags );
121}
122
123#endif
124