.TH "KIO::FileCopyJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::FileCopyJob \- The \fBFileCopyJob\fP copies data from one place to another.  

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

.in +1c
.ti -1c
.RI "void \fBslotStart\fP ()"
.br
.ti -1c
.RI "void \fBslotData\fP (\fBKIO::Job\fP *, const \fBQByteArray\fP &data)"
.br
.ti -1c
.RI "void \fBslotDataReq\fP (\fBKIO::Job\fP *, \fBQByteArray\fP &data)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBFileCopyJob\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, int permissions, bool move, bool overwrite, bool resume, bool showProgressInfo)"
.br
.ti -1c
.RI "void \fBsetSourceSize64\fP (\fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBsetSourceSize\fP (off_t size) KDE_DEPRECATED"
.br
.ti -1c
.RI "\fBKURL\fP \fBsrcURL\fP () const "
.br
.ti -1c
.RI "\fBKURL\fP \fBdestURL\fP () const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBslotResult\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBslotProcessedSize\fP (\fBKIO::Job\fP *job, \fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBslotTotalSize\fP (\fBKIO::Job\fP *job, \fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "void \fBslotPercent\fP (\fBKIO::Job\fP *job, unsigned long pct)"
.br
.ti -1c
.RI "void \fBslotCanResume\fP (\fBKIO::Job\fP *job, \fBKIO::filesize_t\fP offset)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBstartCopyJob\fP ()"
.br
.ti -1c
.RI "void \fBstartCopyJob\fP (const \fBKURL\fP &slave_url)"
.br
.ti -1c
.RI "void \fBstartRenameJob\fP (const \fBKURL\fP &slave_url)"
.br
.ti -1c
.RI "void \fBstartDataPump\fP ()"
.br
.ti -1c
.RI "void \fBconnectSubjob\fP (\fBSimpleJob\fP *job)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKURL\fP \fBm_src\fP"
.br
.ti -1c
.RI "\fBKURL\fP \fBm_dest\fP"
.br
.ti -1c
.RI "int \fBm_permissions\fP"
.br
.ti -1c
.RI "bool \fBm_move\fP:1"
.br
.ti -1c
.RI "bool \fBm_overwrite\fP:1"
.br
.ti -1c
.RI "bool \fBm_resume\fP:1"
.br
.ti -1c
.RI "bool \fBm_canResume\fP:1"
.br
.ti -1c
.RI "bool \fBm_resumeAnswerSent\fP:1"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBm_buffer\fP"
.br
.ti -1c
.RI "\fBSimpleJob\fP * \fBm_moveJob\fP"
.br
.ti -1c
.RI "\fBSimpleJob\fP * \fBm_copyJob\fP"
.br
.ti -1c
.RI "\fBTransferJob\fP * \fBm_getJob\fP"
.br
.ti -1c
.RI "\fBTransferJob\fP * \fBm_putJob\fP"
.br
.ti -1c
.RI "\fBKIO::filesize_t\fP \fBm_totalSize\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBFileCopyJob\fP copies data from one place to another. 

\fBSee also:\fP
.RS 4
\fBKIO::file_copy()\fP 
.PP
\fBKIO::file_move()\fP 
.RE
.PP

.PP
Definition at line 1209 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KIO::FileCopyJob::FileCopyJob (const \fBKURL\fP & src, const \fBKURL\fP & dest, int permissions, bool move, bool overwrite, bool resume, bool showProgressInfo)"
.PP
Do not create a \fBFileCopyJob\fP directly. 
.PP
Use \fBKIO::file_move()\fP or \fBKIO::file_copy()\fP instead. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the source URL 
.br
\fIdest\fP the destination URL 
.br
\fIpermissions\fP the permissions of the resulting resource 
.br
\fImove\fP true to move, false to copy 
.br
\fIoverwrite\fP true to allow overwriting, false otherwise 
.br
\fIresume\fP true to resume an operation, false otherwise 
.br
\fIshowProgressInfo\fP true to show progress information to the user
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void KIO::FileCopyJob::setSourceSize64 (\fBKIO::filesize_t\fP size)"
.PP
If you know the size of the source file, call this method to inform this job. 
.PP
It will be displayed in the 'resume' dialog. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the size of the source file 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.SS "void KIO::FileCopyJob::setSourceSize (off_t size)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "\fBKURL\fP KIO::FileCopyJob::srcURL () const\fC [inline]\fP"
.PP
Returns the source URL. 
.PP
\fBReturns:\fP
.RS 4
the source URL
.RE
.PP

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

.PP
Definition at line 1251 of file jobclasses.h.
.SS "virtual void KIO::FileCopyJob::slotResult (\fBKIO::Job\fP * job)\fC [protected, virtual, slot]\fP"
.PP
Called whenever a subjob finishes. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.RE
.PP

.PP
Reimplemented from \fBKIO::Job\fP.
.SS "void KIO::FileCopyJob::slotProcessedSize (\fBKIO::Job\fP * job, \fBKIO::filesize_t\fP size)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIsize\fP the processed size in bytes 
.RE
.PP

.SS "void KIO::FileCopyJob::slotTotalSize (\fBKIO::Job\fP * job, \fBKIO::filesize_t\fP size)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIsize\fP the total size 
.RE
.PP

.SS "void KIO::FileCopyJob::slotPercent (\fBKIO::Job\fP * job, unsigned long pct)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIpct\fP the percentage 
.RE
.PP

.SS "void KIO::FileCopyJob::slotCanResume (\fBKIO::Job\fP * job, \fBKIO::filesize_t\fP offset)\fC [protected, slot]\fP"
.PP
Forward signal from subjob. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that emitted this signal 
.br
\fIoffset\fP the offset to resume from 
.RE
.PP


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