.TH "KIO::CopyJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::CopyJob \- \fBCopyJob\fP is used to move, copy or symlink files and directories.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <jobclasses.h>\fP
.PP
Inherits \fBKIO::Job\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBCopyMode\fP { \fBCopy\fP, \fBMove\fP, \fBLink\fP }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBtotalFiles\fP (\fBKIO::Job\fP *job, unsigned long files)"
.br
.ti -1c
.RI "void \fBtotalDirs\fP (\fBKIO::Job\fP *job, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBaboutToCreate\fP (\fBKIO::Job\fP *job, const \fBQValueList\fP< KIO::CopyInfo > &files)"
.br
.ti -1c
.RI "void \fBprocessedFiles\fP (\fBKIO::Job\fP *job, unsigned long files)"
.br
.ti -1c
.RI "void \fBprocessedDirs\fP (\fBKIO::Job\fP *job, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBcopying\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &from, const \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBlinking\fP (\fBKIO::Job\fP *job, const \fBQString\fP &target, const \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBmoving\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &from, const \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBcreatingDir\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &dir)"
.br
.ti -1c
.RI "void \fBrenamed\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &from, const \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBcopyingDone\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &from, const \fBKURL\fP &to, bool directory, bool renamed)"
.br
.ti -1c
.RI "void \fBcopyingLinkDone\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &from, const \fBQString\fP &target, const \fBKURL\fP &to)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCopyJob\fP (const \fBKURL::List\fP &src, const \fBKURL\fP &dest, \fBCopyMode\fP mode, bool asMethod, bool showProgressInfo)"
.br
.ti -1c
.RI "\fBKURL::List\fP \fBsrcURLs\fP () const "
.br
.ti -1c
.RI "\fBKURL\fP \fBdestURL\fP () const "
.br
.ti -1c
.RI "void \fBsetDefaultPermissions\fP (bool b)"
.br
.ti -1c
.RI "void \fBsetInteractive\fP (bool b)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotStart\fP ()"
.br
.ti -1c
.RI "void \fBslotEntries\fP (\fBKIO::Job\fP *, const \fBKIO::UDSEntryList\fP &list)"
.br
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotProcessedSize\fP (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP data_size)"
.br
.ti -1c
.RI "void \fBslotTotalSize\fP (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBslotReport\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBstatCurrentSrc\fP ()"
.br
.ti -1c
.RI "void \fBstatNextSrc\fP ()"
.br
.ti -1c
.RI "void \fBslotResultStating\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBstartListing\fP (const \fBKURL\fP &src)"
.br
.ti -1c
.RI "void \fBslotResultCreatingDirs\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotResultConflictCreatingDirs\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBcreateNextDir\fP ()"
.br
.ti -1c
.RI "void \fBslotResultCopyingFiles\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotResultConflictCopyingFiles\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBcopyNextFile\fP ()"
.br
.ti -1c
.RI "void \fBslotResultDeletingDirs\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBdeleteNextDir\fP ()"
.br
.ti -1c
.RI "void \fBskip\fP (const \fBKURL\fP &sourceURL)"
.br
.ti -1c
.RI "void \fBslotResultRenaming\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBCopyJobPrivate\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBCopyJob\fP is used to move, copy or symlink files and directories. 

Don't create the job directly, but use \fBKIO::copy()\fP, \fBKIO::move()\fP, \fBKIO::link()\fP and friends.
.PP
\fBSee also:\fP
.RS 4
\fBKIO::copy()\fP 
.PP
\fBKIO::copyAs()\fP 
.PP
\fBKIO::move()\fP 
.PP
\fBKIO::moveAs()\fP 
.PP
\fBKIO::link()\fP 
.PP
\fBKIO::linkAs()\fP 
.RE
.PP

.PP
Definition at line 1445 of file jobclasses.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKIO::CopyJob::CopyMode\fP"
.PP
Defines the mode of the operation. 
.PP
Definition at line 1452 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KIO::CopyJob::CopyJob (const \fBKURL::List\fP & src, const \fBKURL\fP & dest, \fBCopyMode\fP mode, bool asMethod, bool showProgressInfo)"
.PP
Do not create a \fBCopyJob\fP directly. 
.PP
Use \fBKIO::copy()\fP, \fBKIO::move()\fP, \fBKIO::link()\fP and friends instead.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the list of source URLs 
.br
\fIdest\fP the destination URL 
.br
\fImode\fP specifies whether the job should copy, move or link 
.br
\fIasMethod\fP if true, behaves like \fBKIO::copyAs()\fP, \fBKIO::moveAs()\fP or \fBKIO::linkAs()\fP 
.br
\fIshowProgressInfo\fP true to show progress information to the user 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKIO::copy()\fP 
.PP
\fBKIO::copyAs()\fP 
.PP
\fBKIO::move()\fP 
.PP
\fBKIO::moveAs()\fP 
.PP
\fBKIO::link()\fP 
.PP
\fBKIO::linkAs()\fP
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBKURL::List\fP KIO::CopyJob::srcURLs () const\fC [inline]\fP"
.PP
Returns the list of source URLs. 
.PP
\fBReturns:\fP
.RS 4
the list of source URLs.
.RE
.PP

.PP
Definition at line 1479 of file jobclasses.h.
.SS "\fBKURL\fP KIO::CopyJob::destURL () const\fC [inline]\fP"
.PP
Returns the destination URL. 
.PP
\fBReturns:\fP
.RS 4
the destination URL
.RE
.PP

.PP
Definition at line 1485 of file jobclasses.h.
.SS "void KIO::CopyJob::setDefaultPermissions (bool b)"
.PP
By default the permissions of the copied files will be those of the source files. 
.PP
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)
.PP
TODO KDE4: consider adding this as bool to copy/copyAs? 
.PP
\fBSince:\fP
.RS 4
3.2.3 
.RE
.PP

.PP
Definition at line 3699 of file job.cpp.
.SS "void KIO::CopyJob::setInteractive (bool b)"
.PP
When an error happens while copying/moving a file, the user will be presented with a dialog for skipping the file that can't be copied/moved. 
.PP
Or if the error is that the destination file already exists, the standard rename dialog is shown. If the program doesn't want \fBCopyJob\fP to show dialogs, but to simply fail on error, call setInteractive( false ).
.PP
KDE4: remove, already in \fBJob\fP 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Reimplemented from \fBKIO::Job\fP.
.PP
Definition at line 3705 of file job.cpp.
.PP
References KIO::Job::setInteractive().
.SS "void KIO::CopyJob::totalFiles (\fBKIO::Job\fP * job, unsigned long files)\fC [signal]\fP"
.PP
Emitted when the total number of files is known. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfiles\fP the total number of files
.RE
.PP

.SS "void KIO::CopyJob::totalDirs (\fBKIO::Job\fP * job, unsigned long dirs)\fC [signal]\fP"
.PP
Emitted when the toal number of direcotries is known. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIdirs\fP the total number of directories
.RE
.PP

.SS "void KIO::CopyJob::aboutToCreate (\fBKIO::Job\fP * job, const \fBQValueList\fP< KIO::CopyInfo > & files)\fC [signal]\fP"
.PP
Emitted when it is known which files / directories are going to be created. 
.PP
Note that this may still change e.g. when existing files with the same name are discovered. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfiles\fP a list of items that are about to be created.
.RE
.PP

.SS "void KIO::CopyJob::processedFiles (\fBKIO::Job\fP * job, unsigned long files)\fC [signal]\fP"
.PP
Sends the number of processed files. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfiles\fP the number of processed files
.RE
.PP

.SS "void KIO::CopyJob::processedDirs (\fBKIO::Job\fP * job, unsigned long dirs)\fC [signal]\fP"
.PP
Sends the number of processed directories. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIdirs\fP the number of processed dirs
.RE
.PP

.SS "void KIO::CopyJob::copying (\fBKIO::Job\fP * job, const \fBKURL\fP & from, const \fBKURL\fP & to)\fC [signal]\fP"
.PP
The job is copying a file or directory. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfrom\fP the URl of the file or directory that is currently being copied 
.br
\fIto\fP the destination of the current operation 
.RE
.PP

.SS "void KIO::CopyJob::linking (\fBKIO::Job\fP * job, const \fBQString\fP & target, const \fBKURL\fP & to)\fC [signal]\fP"
.PP
The job is creating a symbolic link. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fItarget\fP the URl of the file or directory that is currently being linked 
.br
\fIto\fP the destination of the current operation 
.RE
.PP

.SS "void KIO::CopyJob::moving (\fBKIO::Job\fP * job, const \fBKURL\fP & from, const \fBKURL\fP & to)\fC [signal]\fP"
.PP
The job is moving a file or directory. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfrom\fP the URl of the file or directory that is currently being moved 
.br
\fIto\fP the destination of the current operation 
.RE
.PP

.SS "void KIO::CopyJob::creatingDir (\fBKIO::Job\fP * job, const \fBKURL\fP & dir)\fC [signal]\fP"
.PP
The job is creating the directory \fCdir\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIdir\fP the directory that is currently being created 
.RE
.PP

.SS "void KIO::CopyJob::renamed (\fBKIO::Job\fP * job, const \fBKURL\fP & from, const \fBKURL\fP & to)\fC [signal]\fP"
.PP
The user chose to rename \fCfrom\fP to \fCto\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfrom\fP the original name 
.br
\fIto\fP the new name 
.RE
.PP

.SS "void KIO::CopyJob::copyingDone (\fBKIO::Job\fP * job, const \fBKURL\fP & from, const \fBKURL\fP & to, bool directory, bool renamed)\fC [signal]\fP"
.PP
The job emits this signal when copying or moving a file or directory successfully finished. 
.PP
This signal is mainly for the Undo feature.
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfrom\fP the source URL 
.br
\fIto\fP the destination URL 
.br
\fIdirectory\fP indicates whether a file or directory was successfully copied/moved. true for a directoy, false for file 
.br
\fIrenamed\fP indicates that the destination URL was created using a rename operation (i.e. fast directory moving). true if is has been renamed 
.RE
.PP

.SS "void KIO::CopyJob::copyingLinkDone (\fBKIO::Job\fP * job, const \fBKURL\fP & from, const \fBQString\fP & target, const \fBKURL\fP & to)\fC [signal]\fP"
.PP
The job is copying or moving a symbolic link, that points to target. 
.PP
The new link is created in \fCto\fP. The existing one is/was in \fCfrom\fP. This signal is mainly for the Undo feature. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIfrom\fP the source URL 
.br
\fItarget\fP the target 
.br
\fIto\fP the destination URL 
.RE
.PP

.SS "virtual void KIO::CopyJob::slotResult (\fBKIO::Job\fP * job)\fC [protected, virtual, slot]\fP"
.PP
Called whenever a subjob finishes. 
.PP
Default implementation checks for errors and propagates to parent job, then calls removeSubjob. Override if you don't want subjobs errors to be propagated. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the subjob 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBresult()\fP 
.RE
.PP

.PP
Reimplemented from \fBKIO::Job\fP.
.SS "void KIO::CopyJob::slotProcessedSize (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP data_size)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
.SS "void KIO::CopyJob::slotTotalSize (\fBKIO::Job\fP *, \fBKIO::filesize_t\fP size)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the total size 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
