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

KIO

  • KIO
  • SpecialJob
Public Member Functions
KIO::SpecialJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::SpecialJob:
KIO::TransferJob KIO::SimpleJob KIO::Job KCompositeJob KJob QObject

List of all members.

Public Member Functions

 SpecialJob (const KUrl &url, const QByteArray &data=QByteArray())
 ~SpecialJob ()
QByteArray arguments () const
void setArguments (const QByteArray &data)
- Public Member Functions inherited from KIO::TransferJob
 ~TransferJob ()
bool isErrorPage () const
QString mimetype () const
bool reportDataSent () const
void sendAsyncData (const QByteArray &data)
void setAsyncDataEnabled (bool enabled)
void setModificationTime (const QDateTime &mtime)
void setReportDataSent (bool enabled)
void setTotalSize (KIO::filesize_t bytes)
- 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

Additional Inherited Members

- Signals inherited from KIO::TransferJob
void canResume (KIO::Job *job, KIO::filesize_t offset)
void data (KIO::Job *job, const QByteArray &data)
void dataReq (KIO::Job *job, QByteArray &data)
void mimetype (KIO::Job *job, const QString &type)
void permanentRedirection (KIO::Job *job, const KUrl &fromUrl, const KUrl &toUrl)
void redirection (KIO::Job *job, const KUrl &url)
- Protected Slots inherited from KIO::TransferJob
virtual void slotData (const QByteArray &data)
virtual void slotDataReq ()
virtual void slotFinished ()
virtual void slotMetaData (const KIO::MetaData &_metaData)
virtual void slotMimetype (const QString &mimetype)
virtual void slotRedirection (const KUrl &url)
- Protected Slots inherited from KIO::SimpleJob
virtual void slotWarning (const QString &)
- Protected Member Functions inherited from KIO::TransferJob
 TransferJob (TransferJobPrivate &dd)
virtual bool doResume ()
virtual void slotResult (KJob *job)
- Protected Member Functions inherited from KIO::SimpleJob
 SimpleJob (SimpleJobPrivate &dd)
virtual bool doKill ()
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)

Detailed Description

A class that sends a special command to an ioslave.

This allows you to send a binary blob to an ioslave and handle its responses. The ioslave will receive the binary data as an argument to the "special" function (inherited from SlaveBase::special()).

Use this only on ioslaves that belong to your application. Sending special commands to other ioslaves may cause unexpected behaviour.

See also:
KIO::special

Definition at line 1021 of file jobclasses.h.


Constructor & Destructor Documentation

SpecialJob::SpecialJob ( const KUrl &  url,
const QByteArray &  data = QByteArray() 
)
explicit

Creates a KIO::SpecialJob.

Parameters:
urlthe URL to be passed to the ioslave
datathe data to be sent to the SlaveBase::special() function.

Definition at line 2990 of file job.cpp.

SpecialJob::~SpecialJob ( )

Definition at line 2995 of file job.cpp.


Member Function Documentation

QByteArray SpecialJob::arguments ( ) const

Returns the QByteArray data that will be sent (or has been sent) to the ioslave.

Definition at line 3005 of file job.cpp.

void SpecialJob::setArguments ( const QByteArray &  data)

Sets the QByteArray that is passed to SlaveBase::special() on the ioslave.

Definition at line 2999 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 Tue Jul 23 2013 22:01:07 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.5 API Reference

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