.TH "KIO::StatJob" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::StatJob \- A \fBKIO\fP job that retrieves information about a file or directory.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <jobclasses.h>\fP
.PP
Inherits \fBKIO::SimpleJob\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBredirection\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBpermanentRedirection\fP (\fBKIO::Job\fP *job, const \fBKURL\fP &fromUrl, const \fBKURL\fP &toUrl)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBStatJob\fP (const \fBKURL\fP &url, int command, const \fBQByteArray\fP &packedArgs, bool showProgressInfo)"
.br
.ti -1c
.RI "void \fBsetSide\fP (bool source)"
.br
.ti -1c
.RI "void \fBsetDetails\fP (short int details)"
.br
.ti -1c
.RI "const \fBUDSEntry\fP & \fBstatResult\fP () const "
.br
.ti -1c
.RI "virtual void \fBstart\fP (Slave *slave)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotStatEntry\fP (const \fBKIO::UDSEntry\fP &entry)"
.br
.ti -1c
.RI "void \fBslotRedirection\fP (const \fBKURL\fP &url)"
.br
.ti -1c
.RI "virtual void \fBslotFinished\fP ()"
.br
.ti -1c
.RI "virtual void \fBslotMetaData\fP (const \fBKIO::MetaData\fP &_metaData)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBUDSEntry\fP \fBm_statResult\fP"
.br
.ti -1c
.RI "\fBKURL\fP \fBm_redirectionURL\fP"
.br
.ti -1c
.RI "bool \fBm_bSource\fP"
.br
.ti -1c
.RI "short int \fBm_details\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A \fBKIO\fP job that retrieves information about a file or directory. 

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

.PP
Definition at line 647 of file jobclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "StatJob::StatJob (const \fBKURL\fP & url, int command, const \fBQByteArray\fP & packedArgs, bool showProgressInfo)"
.PP
Do not use this constructor to create a \fBStatJob\fP, use \fBKIO::stat()\fP instead. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url of the file or directory to check 
.br
\fIcommand\fP the command to issue 
.br
\fIpackedArgs\fP the arguments 
.br
\fIshowProgressInfo\fP true to show progress information to the user
.RE
.PP

.PP
Definition at line 756 of file job.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KIO::StatJob::setSide (bool source)\fC [inline]\fP"
.PP
A \fBstat()\fP can have two meanings. 
.PP
Either we want to read from this URL, or to check if we can write to it. First case is 'source', second is 'dest'. It is necessary to know what the \fBStatJob\fP is for, to tune the kioslave's behavior (e.g. with FTP). 
.PP
\fBParameters:\fP
.RS 4
\fIsource\fP true for 'source' mode, false for 'dest' mode 
.RE
.PP

.PP
Definition at line 668 of file jobclasses.h.
.PP
Referenced by KIO::stat().
.SS "void KIO::StatJob::setDetails (short int details)\fC [inline]\fP"
.PP
Selects the level of \fCdetails\fP we want. 
.PP
By default this is 2 (all details wanted, including modification time, size, etc.), setDetails(1) is used when deleting: we don't need all the information if it takes too much time, no need to follow symlinks etc. setDetails(0) is used for very simple probing: we'll only get the answer 'it's a file or a directory, or it doesn't exist'. This is used by \fBKRun\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIdetails\fP 2 for all details, 1 for simple, 0 for very simple 
.RE
.PP

.PP
Definition at line 679 of file jobclasses.h.
.PP
Referenced by KIO::stat().
.SS "const \fBUDSEntry\fP& KIO::StatJob::statResult () const\fC [inline]\fP"
.PP
Call this in the slot connected to result, and only after making sure no error happened. 
.PP
\fBReturns:\fP
.RS 4
the result of the stat 
.RE
.PP

.PP
Definition at line 686 of file jobclasses.h.
.SS "void KIO::StatJob::redirection (\fBKIO::Job\fP * job, const \fBKURL\fP & url)\fC [signal]\fP"
.PP
Signals a redirection. 
.PP
Use to update the URL shown to the user. The redirection itself is handled internally. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that is redirected 
.br
\fIurl\fP the new url 
.RE
.PP

.SS "void KIO::StatJob::permanentRedirection (\fBKIO::Job\fP * job, const \fBKURL\fP & fromUrl, const \fBKURL\fP & toUrl)\fC [signal]\fP"
.PP
Signals a permanent redirection. 
.PP
The redirection itself is handled internally. 
.PP
\fBParameters:\fP
.RS 4
\fIjob\fP the job that is redirected 
.br
\fIfromUrl\fP the original URL 
.br
\fItoUrl\fP the new URL 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Referenced by slotFinished().
.SS "void StatJob::slotFinished ()\fC [protected, virtual, slot]\fP"
.PP
Called when the slave marks the job as finished. 
.PP
Reimplemented from \fBKIO::SimpleJob\fP.
.PP
Definition at line 800 of file job.cpp.
.PP
References KIO::Scheduler::doJob(), KURL::isEmpty(), KURL::isValid(), permanentRedirection(), KIO::Job::queryMetaData(), and KIO::SimpleJob::slotFinished().
.SS "void StatJob::slotMetaData (const \fBKIO::MetaData\fP & _metaData)\fC [protected, virtual, slot]\fP"
.PP
\fBMetaData\fP from the slave is received. 
.PP
\fBParameters:\fP
.RS 4
\fI_metaData\fP the meta data 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmetaData()\fP 
.RE
.PP

.PP
Reimplemented from \fBKIO::SimpleJob\fP.
.PP
Definition at line 822 of file job.cpp.
.PP
References KIO::SimpleJob::slotMetaData().

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