/usr/include/kio/copyjob.h is in kdelibs5-dev 4:4.8.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | // -*- c++ -*-
/* This file is part of the KDE libraries
Copyright 2000 Stephan Kulow <coolo@kde.org>
Copyright 2000-2006 David Faure <faure@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KIO_COPYJOB_H
#define KIO_COPYJOB_H
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <sys/types.h> // time_t
#include <kurl.h>
#include "jobclasses.h"
class QTimer;
namespace KIO {
/// @internal
/// FIXME: If this is internal, why is being used in a public signal below?
/// (aboutToCreate, see also konq_operations.h/cpp
struct CopyInfo
{
KUrl uSource;
KUrl uDest;
QString linkDest; // for symlinks only
int permissions;
time_t ctime;
time_t mtime;
KIO::filesize_t size; // 0 for dirs
};
class CopyJobPrivate;
/**
* CopyJob is used to move, copy or symlink files and directories.
* Don't create the job directly, but use KIO::copy(),
* KIO::move(), KIO::link() and friends.
*
* @see KIO::copy()
* @see KIO::copyAs()
* @see KIO::move()
* @see KIO::moveAs()
* @see KIO::link()
* @see KIO::linkAs()
*/
class KIO_EXPORT CopyJob : public Job {
Q_OBJECT
public:
/**
* Defines the mode of the operation
*/
enum CopyMode { Copy, Move, Link };
virtual ~CopyJob();
/**
* Returns the mode of the operation (copy, move, or link),
* depending on whether KIO::copy(), KIO::move() or KIO::link() was called.
*/
CopyMode operationMode() const;
/**
* Returns the list of source URLs.
* @return the list of source URLs.
*/
KUrl::List srcUrls() const;
/**
* Returns the destination URL.
* @return the destination URL
*/
KUrl destUrl() const;
/**
* By default the permissions of the copied files will be those of the source files.
*
* But when copying "template" files to "new" files, people prefer the umask
* to apply, rather than the template's permissions.
* For that case, call setDefaultPermissions(true)
*/
void setDefaultPermissions( bool b );
/**
* Skip copying or moving any file when the destination already exists,
* instead of the default behavior (interactive mode: showing a dialog to the user,
* non-interactive mode: aborting with an error).
* Initially added for a unit test.
* \since 4.2
*/
void setAutoSkip(bool autoSkip);
/**
* Rename files automatically when the destination already exists,
* instead of the default behavior (interactive mode: showing a dialog to the user,
* non-interactive mode: aborting with an error).
* Initially added for a unit test.
* \since 4.7
*/
void setAutoRename(bool autoRename);
/**
* Reuse any directory that already exists, instead of the default behavior
* (interactive mode: showing a dialog to the user,
* non-interactive mode: aborting with an error).
* \since 4.2
*/
void setWriteIntoExistingDirectories(bool overwriteAllDirs);
/**
* Reimplemented for internal reasons
*/
virtual bool doSuspend();
Q_SIGNALS:
/**
* Emitted when the total number of files is known.
* @param job the job that emitted this signal
* @param files the total number of files
*/
void totalFiles( KJob *job, unsigned long files );
/**
* Emitted when the toal number of direcotries is known.
* @param job the job that emitted this signal
* @param dirs the total number of directories
*/
void totalDirs( KJob *job, unsigned long dirs );
/**
* Emitted when it is known which files / directories are going
* to be created. Note that this may still change e.g. when
* existing files with the same name are discovered.
* @param job the job that emitted this signal
* @param files a list of items that are about to be created.
*/
void aboutToCreate( KIO::Job *job, const QList<KIO::CopyInfo> &files);
/**
* Sends the number of processed files.
* @param job the job that emitted this signal
* @param files the number of processed files
*/
void processedFiles( KIO::Job *job, unsigned long files );
/**
* Sends the number of processed directories.
* @param job the job that emitted this signal
* @param dirs the number of processed dirs
*/
void processedDirs( KIO::Job *job, unsigned long dirs );
/**
* The job is copying a file or directory.
*
* Note: This signal is used for progress dialogs, it's not emitted for
* every file or directory (this would be too slow), but every 200ms.
*
* @param job the job that emitted this signal
* @param src the URL of the file or directory that is currently
* being copied
* @param dest the destination of the current operation
*/
void copying( KIO::Job *job, const KUrl& src, const KUrl& dest );
/**
* The job is creating a symbolic link.
*
* Note: This signal is used for progress dialogs, it's not emitted for
* every file or directory (this would be too slow), but every 200ms.
*
* @param job the job that emitted this signal
* @param target the URL of the file or directory that is currently
* being linked
* @param to the destination of the current operation
*/
void linking( KIO::Job *job, const QString& target, const KUrl& to );
/**
* The job is moving a file or directory.
*
* Note: This signal is used for progress dialogs, it's not emitted for
* every file or directory (this would be too slow), but every 200ms.
*
* @param job the job that emitted this signal
* @param from the URL of the file or directory that is currently
* being moved
* @param to the destination of the current operation
*/
void moving( KIO::Job *job, const KUrl& from, const KUrl& to );
/**
* The job is creating the directory @p dir.
*
* This signal is emitted for every directory being created.
*
* @param job the job that emitted this signal
* @param dir the directory that is currently being created
*/
void creatingDir( KIO::Job *job, const KUrl& dir );
/**
* The user chose to rename @p from to @p to.
*
* @param job the job that emitted this signal
* @param from the original name
* @param to the new name
*/
void renamed( KIO::Job *job, const KUrl& from, const KUrl& to );
/**
* The job emits this signal when copying or moving a file or directory successfully finished.
* This signal is mainly for the Undo feature.
* If you simply want to know when a copy job is done, use result().
*
* @param job the job that emitted this signal
* @param from the source URL
* @param to the destination URL
* @param mtime the modification time of the source file, hopefully set on the destination file
* too (when the kioslave supports it).
* @param directory indicates whether a file or directory was successfully copied/moved.
* true for a directory, false for file
* @param renamed indicates that the destination URL was created using a
* rename operation (i.e. fast directory moving). true if is has been renamed
*/
void copyingDone( KIO::Job *job, const KUrl &from, const KUrl &to, time_t mtime, bool directory, bool renamed );
/**
* The job is copying or moving a symbolic link, that points to target.
* The new link is created in @p to. The existing one is/was in @p from.
* This signal is mainly for the Undo feature.
* @param job the job that emitted this signal
* @param from the source URL
* @param target the target
* @param to the destination URL
*/
void copyingLinkDone( KIO::Job *job, const KUrl &from, const QString& target, const KUrl& to );
protected Q_SLOTS:
virtual void slotResult( KJob *job );
protected:
CopyJob(CopyJobPrivate &dd);
void emitResult();
private:
Q_PRIVATE_SLOT(d_func(), void slotStart())
Q_PRIVATE_SLOT(d_func(), void slotEntries( KIO::Job*, const KIO::UDSEntryList& list ))
Q_PRIVATE_SLOT(d_func(), void slotProcessedSize( KJob*, qulonglong data_size ))
Q_PRIVATE_SLOT(d_func(), void slotTotalSize( KJob*, qulonglong size ))
Q_PRIVATE_SLOT(d_func(), void slotReport())
Q_DECLARE_PRIVATE(CopyJob)
};
/**
* Copy a file or directory @p src into the destination @p dest,
* which can be a file (including the final filename) or a directory
* (into which @p src will be copied).
*
* This emulates the cp command completely.
*
* @param src the file or directory to copy
* @param dest the destination
* @param flags: copy() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files". However if "dest" exists, then src is copied
* into a subdir of dest, just like "cp" does. Use copyAs if you don't want that.
*
* @return the job handling the operation
* @see copyAs()
*/
KIO_EXPORT CopyJob *copy( const KUrl& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Copy a file or directory @p src into the destination @p dest,
* which is the destination name in any case, even for a directory.
*
* As opposed to copy(), this doesn't emulate cp, but is the only
* way to copy a directory, giving it a new name and getting an error
* box if a directory already exists with the same name (or writing the
* contents of @p src into @p dest, when using Overwrite).
*
* @param src the file or directory to copy
* @param dest the destination
* @param flags: copyAs() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files".
*
* * @return the job handling the operation
*/
KIO_EXPORT CopyJob *copyAs( const KUrl& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Copy a list of file/dirs @p src into a destination directory @p dest.
*
* @param src the list of files and/or directories
* @param dest the destination
* @param flags: copy() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files". However if "dest" exists, then src is copied
* into a subdir of dest, just like "cp" does.
* @return the job handling the operation
*/
KIO_EXPORT CopyJob *copy( const KUrl::List& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Moves a file or directory @p src to the given destination @p dest.
*
* @param src the file or directory to copy
* @param dest the destination
* @param flags: move() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files". However if "dest" exists, then src is copied
* into a subdir of dest, just like "cp" does.
* @return the job handling the operation
* @see copy()
* @see moveAs()
*/
KIO_EXPORT CopyJob *move( const KUrl& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Moves a file or directory @p src to the given destination @p dest. Unlike move()
* this operation will not move @p src into @p dest when @p dest exists: it will
* either fail, or move the contents of @p src into it if Overwrite is set.
*
* @param src the file or directory to copy
* @param dest the destination
* @param flags: moveAs() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files".
* @return the job handling the operation
* @see copyAs()
*/
KIO_EXPORT CopyJob *moveAs( const KUrl& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Moves a list of files or directories @p src to the given destination @p dest.
*
* @param src the list of files or directories to copy
* @param dest the destination
* @param flags: move() supports HideProgressInfo and Overwrite.
* Note: Overwrite has the meaning of both "write into existing directories" and
* "overwrite existing files". However if "dest" exists, then src is copied
* into a subdir of dest, just like "cp" does.
* @return the job handling the operation
* @see copy()
*/
KIO_EXPORT CopyJob *move( const KUrl::List& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Create a link.
* If the protocols and hosts are the same, a Unix symlink will be created.
* Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
*
* @param src The existing file or directory, 'target' of the link.
* @param destDir Destination directory where the link will be created.
* @param flags: link() supports HideProgressInfo only
* @return the job handling the operation
*/
KIO_EXPORT CopyJob *link( const KUrl& src, const KUrl& destDir, JobFlags flags = DefaultFlags );
/**
* Create several links
* If the protocols and hosts are the same, a Unix symlink will be created.
* Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
*
* @param src The existing files or directories, 'targets' of the link.
* @param destDir Destination directory where the links will be created.
* @param flags: link() supports HideProgressInfo only
* @return the job handling the operation
* @see link()
*/
KIO_EXPORT CopyJob *link( const KUrl::List& src, const KUrl& destDir, JobFlags flags = DefaultFlags );
/**
* Create a link. Unlike link() this operation will fail when the directory already
* exists.
* If the protocols and hosts are the same, a Unix symlink will be created.
* Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
*
* @param src The existing file or directory, 'target' of the link.
* @param dest Destination directory where the link will be created.
* @param flags: linkAs() supports HideProgressInfo only
* @return the job handling the operation
* @see link ()
* @see copyAs()
*/
KIO_EXPORT CopyJob *linkAs( const KUrl& src, const KUrl& dest, JobFlags flags = DefaultFlags );
/**
* Trash a file or directory.
* This is currently only supported for local files and directories.
* Use "KUrl src; src.setPath( path );" to create a URL from a path.
*
* @param src file to delete
* @param flags: trash() supports HideProgressInfo only
* @return the job handling the operation
*/
KIO_EXPORT CopyJob *trash( const KUrl& src, JobFlags flags = DefaultFlags );
/**
* Trash a list of files or directories.
* This is currently only supported for local files and directories.
*
* @param src the files to delete
* @param flags: trash() supports HideProgressInfo only
* @return the job handling the operation
*/
KIO_EXPORT CopyJob *trash( const KUrl::List& src, JobFlags flags = DefaultFlags );
}
#endif
|