• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.4 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • StatJob
Public Types | Signals | Public Member Functions | Protected Slots | Protected Member Functions
KIO::StatJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::StatJob:
KIO::SimpleJob KIO::Job KCompositeJob KJob QObject

List of all members.

Public Types

enum  StatSide { SourceSide, DestinationSide }

Signals

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

Public Member Functions

 ~StatJob ()
KUrl mostLocalUrl () const
void setDetails (short int details)
void setSide (StatSide side)
void setSide (bool source)
const UDSEntry & statResult () const
- Public Member Functions inherited from KIO::SimpleJob
 ~SimpleJob ()
bool isRedirectionHandlingEnabled () const
virtual void putOnHold ()
void setRedirectionHandlingEnabled (bool handle)
const KUrl & url () const
- Public Member Functions inherited from KIO::Job
virtual ~Job ()
void addMetaData (const QString &key, const QString &value)
void addMetaData (const QMap< QString, QString > &values)
QStringList detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
QString errorString () const
bool isInteractive () const
void mergeMetaData (const QMap< QString, QString > &values)
MetaData metaData () const
MetaData outgoingMetaData () const
Job * parentJob () const
QString queryMetaData (const QString &key)
void setMetaData (const KIO::MetaData &metaData)
void setParentJob (Job *parentJob)
void showErrorDialog (QWidget *parent=0)
void start ()
JobUiDelegate * ui () const
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=0)
virtual ~KCompositeJob ()
virtual ~KJob ()
Capabilities capabilities () const
int error () const
QString errorText () const
bool exec ()
bool isAutoDelete () const
bool isSuspended () const
 KJob (QObject *parent=0)
unsigned long percent () const
qulonglong processedAmount (Unit unit) const
void setAutoDelete (bool autodelete)
void setUiDelegate (KJobUiDelegate *delegate)
qulonglong totalAmount (Unit unit) const
KJobUiDelegate * uiDelegate () const
- Public Member Functions inherited from KJob
qulonglong processedAmount (Unit unit) const
qulonglong totalAmount (Unit unit) const

Protected Slots

virtual void slotFinished ()
virtual void slotMetaData (const KIO::MetaData &_metaData)
- Protected Slots inherited from KIO::SimpleJob
virtual void slotWarning (const QString &)

Protected Member Functions

 StatJob (StatJobPrivate &dd)
- Protected Member Functions inherited from KIO::SimpleJob
 SimpleJob (SimpleJobPrivate &dd)
virtual bool doKill ()
virtual bool doResume ()
virtual bool doSuspend ()
void storeSSLSessionFromJob (const KUrl &m_redirectionURL)
- Protected Member Functions inherited from KIO::Job
 Job ()
 Job (JobPrivate &dd)
virtual bool addSubjob (KJob *job)
virtual bool removeSubjob (KJob *job)
- Protected Member Functions inherited from KCompositeJob
 KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
void clearSubjobs ()
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void emitResult ()
void emitSpeed (unsigned long speed)
bool hasSubjobs ()
 KJob (KJobPrivate &dd, QObject *parent)
void setCapabilities (Capabilities capabilities)
void setError (int errorCode)
void setErrorText (const QString &errorText)
void setPercent (unsigned long percentage)
void setProcessedAmount (Unit unit, qulonglong amount)
void setTotalAmount (Unit unit, qulonglong amount)
const QList< KJob * > & subjobs () const
- Protected Member Functions inherited from KJob
void setProcessedAmount (Unit unit, qulonglong amount)
void setTotalAmount (Unit unit, qulonglong amount)

Additional Inherited Members

- Public Slots inherited from KIO::SimpleJob
void slotError (int, const QString &)
- Static Public Member Functions inherited from KIO::SimpleJob
static void removeOnHold ()

Detailed Description

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

See also:
KIO::stat()

Definition at line 440 of file jobclasses.h.


Member Enumeration Documentation

enum KIO::StatJob::StatSide
Enumerator:
SourceSide 
DestinationSide 

Definition at line 445 of file jobclasses.h.


Constructor & Destructor Documentation

StatJob::~StatJob ( )

Definition at line 800 of file job.cpp.

StatJob::StatJob ( StatJobPrivate &  dd)
protected

Definition at line 795 of file job.cpp.


Member Function Documentation

KUrl StatJob::mostLocalUrl ( ) const

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

Returns:
the most local URL for the URL we were stat'ing.

Sample usage: KIO::StatJob* job = KIO::mostLocalUrl("desktop:/foo"); job->ui()->setWindow(this); connect(job, SIGNAL(result(KJob*)), this, SLOT(slotMostLocalUrlResult(KJob*))); [...] // and in the slot if (job->error()) { [...] // doesn't exist } else { const KUrl localUrl = job->mostLocalUrl(); // localUrl = file:///$HOME/Desktop/foo [...] }

Since:
4.4

Definition at line 826 of file job.cpp.

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:
jobthe job that is redirected
fromUrlthe original URL
toUrlthe new URL
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:
jobthe job that is redirected
urlthe new url
void StatJob::setDetails ( short int  details)

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:
details2 for all details, 1 for simple, 0 for very simple

Definition at line 816 of file job.cpp.

void StatJob::setSide ( StatSide  side)

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:
sideSourceSide or DestinationSide

Definition at line 811 of file job.cpp.

void StatJob::setSide ( bool  source)

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:
sourcetrue for "source" mode, false for "dest" mode

Definition at line 805 of file job.cpp.

void StatJob::slotFinished ( )
protectedvirtualslot

Called when the slave marks the job as finished.

Reimplemented from KIO::SimpleJob.

Definition at line 874 of file job.cpp.

void StatJob::slotMetaData ( const KIO::MetaData &  _metaData)
protectedvirtualslot

MetaData from the slave is received.

Parameters:
_metaDatathe meta data
See also:
metaData()

Reimplemented from KIO::SimpleJob.

Definition at line 899 of file job.cpp.

const UDSEntry & StatJob::statResult ( ) const

Result of the stat operation.

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 821 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jun 1 2013 12:08:39 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.4 API Reference

Skip menu "kdelibs-4.10.4 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal