KIO::StatJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::StatJob:

KIO::SimpleJob KIO::Job QObject List of all members.

Detailed Description

A KIO job that retrieves information about a file or directory.

See also:
KIO::stat()

Definition at line 688 of file jobclasses.h.


Signals

void redirection (KIO::Job *job, const KURL &url)
void permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl)

Public Member Functions

 StatJob (const KURL &url, int command, const QByteArray &packedArgs, bool showProgressInfo)
void setSide (bool source)
void setDetails (short int details)
const UDSEntrystatResult () const
virtual void start (Slave *slave)

Protected Slots

void slotStatEntry (const KIO::UDSEntry &entry)
void slotRedirection (const KURL &url)
virtual void slotFinished ()
virtual void slotMetaData (const KIO::MetaData &_metaData)

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Protected Attributes

UDSEntry m_statResult
KURL m_redirectionURL
bool m_bSource
short int m_details

Constructor & Destructor Documentation

StatJob::StatJob ( const KURL &  url,
int  command,
const QByteArray packedArgs,
bool  showProgressInfo 
)

Do not use this constructor to create a StatJob, use KIO::stat() instead.

Parameters:
url the url of the file or directory to check
command the command to issue
packedArgs the arguments
showProgressInfo true to show progress information to the user

Definition at line 815 of file job.cpp.


Member Function Documentation

void KIO::StatJob::setSide ( bool  source  )  [inline]

A stat() can have two meanings.

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 StatJob is for, to tune the kioslave's behavior (e.g. with FTP).

Parameters:
source true for "source" mode, false for "dest" mode

Definition at line 709 of file jobclasses.h.

void KIO::StatJob::setDetails ( short int  details  )  [inline]

Selects the level of details we want.

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 KRun.

Parameters:
details 2 for all details, 1 for simple, 0 for very simple

Definition at line 720 of file jobclasses.h.

const UDSEntry& KIO::StatJob::statResult (  )  const [inline]

Call this in the slot connected to result, and only after making sure no error happened.

Returns:
the result of the stat

Definition at line 727 of file jobclasses.h.

void KIO::StatJob::redirection ( KIO::Job job,
const KURL &  url 
) [signal]

Signals a redirection.

Use to update the URL shown to the user. The redirection itself is handled internally.

Parameters:
job the job that is redirected
url the new url

void KIO::StatJob::permanentRedirection ( KIO::Job job,
const KURL &  fromUrl,
const KURL &  toUrl 
) [signal]

Signals a permanent redirection.

The redirection itself is handled internally.

Parameters:
job the job that is redirected
fromUrl the original URL
toUrl the new URL
Since:
3.1

void StatJob::slotFinished (  )  [protected, virtual, slot]

Called when the slave marks the job as finished.

Reimplemented from KIO::SimpleJob.

Definition at line 859 of file job.cpp.

void StatJob::slotMetaData ( const KIO::MetaData _metaData  )  [protected, virtual, slot]

MetaData from the slave is received.

Parameters:
_metaData the meta data
See also:
metaData()

Reimplemented from KIO::SimpleJob.

Definition at line 881 of file job.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys