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

KIO

  • KIO
  • SimpleJob
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KIO::SimpleJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::SimpleJob:
KIO::Job KCompositeJob KJob QObject KIO::DirectCopyJob KIO::FileJob KIO::ListJob KIO::MkdirJob KIO::StatJob KIO::TransferJob KIO::DavJob KIO::MimetypeJob KIO::MultiGetJob KIO::SpecialJob KIO::StoredTransferJob

Public Slots

void slotError (int, const QString &)
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 

Public Member Functions

 ~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 QMap< QString, QString > &values)
 
void addMetaData (const QString &key, const QString &value)
 
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 ()
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=0)
 
virtual ~KJob ()
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
virtual void start ()=0
 
qulonglong totalAmount (Unit unit) const
 
KJobUiDelegate * uiDelegate () const
 

Static Public Member Functions

static void removeOnHold ()
 

Protected Slots

virtual void slotFinished ()
 
virtual void slotMetaData (const KIO::MetaData &_metaData)
 
virtual void slotWarning (const QString &)
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
virtual void slotResult (KJob *job)
 

Protected Member Functions

 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 doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
virtual bool removeSubjob (KJob *job)
 
- Protected Member Functions inherited from KCompositeJob
 KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
 
virtual bool addSubjob (KJob *job)
 
void clearSubjobs ()
 
bool hasSubjobs ()
 
virtual bool removeSubjob (KJob *job)
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
 KJob (KJobPrivate &dd, QObject *parent)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
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)
 

Additional Inherited Members

- Public Types inherited from KJob
enum  Capability
 
enum  KillVerbosity
 
enum  Unit
 
- Signals inherited from KIO::Job
void canceled (KJob *job)
 
void connected (KIO::Job *job)
 
- Signals inherited from KJob
void description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
 
void finished (KJob *job)
 
void infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedSize (KJob *job, qulonglong size)
 
void result (KJob *job)
 
void resumed (KJob *job)
 
void speed (KJob *job, unsigned long speed)
 
void suspended (KJob *job)
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 EmitResult
 
 Files
 
 Killable
 
 KilledJobError
 
 NoCapabilities
 
 NoError
 
 Quietly
 
 Suspendable
 
 UserDefinedError
 
- Protected Attributes inherited from KJob
KJobPrivate *const d_ptr
 

Detailed Description

A simple job (one url and one command).

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (CopyJob, DeleteJob, FileCopyJob...) that manage subjobs but aren't scheduled directly.

Definition at line 322 of file jobclasses.h.

Constructor & Destructor Documentation

◆ ~SimpleJob()

SimpleJob::~SimpleJob ( )

Definition at line 375 of file job.cpp.

◆ SimpleJob()

SimpleJob::SimpleJob ( SimpleJobPrivate &  dd)
protected

Creates a new simple job.

You don't need to use this constructor, unless you create a new job that inherits from SimpleJob.

Definition at line 292 of file job.cpp.

Member Function Documentation

◆ doKill()

bool SimpleJob::doKill ( )
protectedvirtual

Abort job.

This kills all subjobs and deletes the job.

Reimplemented from KIO::Job.

Definition at line 313 of file job.cpp.

◆ doResume()

bool SimpleJob::doResume ( )
protectedvirtual

Resume this job.

See also
suspend

Reimplemented from KIO::Job.

Reimplemented in KIO::TransferJob.

Definition at line 333 of file job.cpp.

◆ doSuspend()

bool SimpleJob::doSuspend ( )
protectedvirtual

Suspend this job.

See also
resume

Reimplemented from KIO::Job.

Definition at line 325 of file job.cpp.

◆ isRedirectionHandlingEnabled()

bool SimpleJob::isRedirectionHandlingEnabled ( ) const

Returns true when redirections are handled internally, the default.

Since
4.4

Definition at line 364 of file job.cpp.

◆ putOnHold()

void SimpleJob::putOnHold ( )
virtual

Abort job.

Suspends slave to be reused by another job for the same request.

Definition at line 346 of file job.cpp.

◆ removeOnHold()

void SimpleJob::removeOnHold ( )
static

Discard suspended slave.

Definition at line 359 of file job.cpp.

◆ setRedirectionHandlingEnabled()

void SimpleJob::setRedirectionHandlingEnabled ( bool  handle)

Set handle to false to prevent the internal handling of redirections.

When this flag is set, redirection requests are simply forwarded to the caller instead of being handled internally.

Since
4.4

Definition at line 369 of file job.cpp.

◆ slotError

void SimpleJob::slotError ( int  err,
const QString &  errorText 
)
slot

Called on a slave's error. Made public for the scheduler.

Definition at line 500 of file job.cpp.

◆ slotFinished

void SimpleJob::slotFinished ( )
protectedvirtualslot

Called when the slave marks the job as finished.

Definition at line 468 of file job.cpp.

◆ slotMetaData

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

MetaData from the slave is received.

Parameters
_metaDatathe meta data
See also
metaData()

Definition at line 578 of file job.cpp.

◆ slotWarning

void SimpleJob::slotWarning ( const QString &  errorText)
protectedvirtualslot

Called on a slave's warning.

Definition at line 511 of file job.cpp.

◆ storeSSLSessionFromJob()

void SimpleJob::storeSSLSessionFromJob ( const KUrl &  m_redirectionURL)
protected

Definition at line 598 of file job.cpp.

◆ url()

const KUrl & SimpleJob::url ( ) const

Returns the SimpleJob's URL.

Returns
the url

Definition at line 341 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-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 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.14.38 API Reference

Skip menu "kdelibs-4.14.38 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