• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KIO::FileJob

KIO::FileJob Class Reference

The file-job is an asynchronious version of normal file handling. More...

#include <filejob.h>

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

List of all members.

Signals

void close (KIO::Job *job)
void data (KIO::Job *job, const QByteArray &data)
void mimetype (KIO::Job *job, const QString &type)
void open (KIO::Job *job)
void position (KIO::Job *job, KIO::filesize_t offset)
void redirection (KIO::Job *job, const KUrl &url)
void written (KIO::Job *job, KIO::filesize_t written)

Public Member Functions

void close ()
void read (KIO::filesize_t size)
void seek (KIO::filesize_t offset)
KIO::filesize_t size ()
void write (const QByteArray &data)
 ~FileJob ()

Protected Member Functions

 FileJob (FileJobPrivate &dd)

Detailed Description

The file-job is an asynchronious version of normal file handling.

It allows block-wise reading and writing, and allows seeking. Results are returned through signals.

Should always be created using KIO::open(KUrl&)

Definition at line 37 of file filejob.h.


Constructor & Destructor Documentation

FileJob::~FileJob (  ) 

Definition at line 80 of file filejob.cpp.

FileJob::FileJob ( FileJobPrivate &  dd  )  [protected]

Definition at line 75 of file filejob.cpp.


Member Function Documentation

void KIO::FileJob::close ( KIO::Job *  job  )  [signal]

File is closed and will accept no more commands.

Parameters:
job the job that emitted this signal
void FileJob::close (  ) 

Close.

Closes the file-slave

Definition at line 111 of file filejob.cpp.

void KIO::FileJob::data ( KIO::Job *  job,
const QByteArray &  data 
) [signal]

Data from the slave has arrived.

Parameters:
job the job that emitted this signal
data data received from the slave.
void KIO::FileJob::mimetype ( KIO::Job *  job,
const QString &  type 
) [signal]

Mimetype determined.

Parameters:
job the job that emitted this signal
type the mime type
void KIO::FileJob::open ( KIO::Job *  job  )  [signal]

File is open, metadata has been determined and the file-slave is ready to receive commands.

Parameters:
job the job that emitted this signal
void KIO::FileJob::position ( KIO::Job *  job,
KIO::filesize_t  offset 
) [signal]

The file has reached this position.

Emitted after seek.

Parameters:
job the job that emitted this signal
offset the new position
void FileJob::read ( KIO::filesize_t  size  ) 

Read block.

The slave emits the data through data().

Parameters:
size the requested amount of data

Definition at line 84 of file filejob.cpp.

void KIO::FileJob::redirection ( KIO::Job *  job,
const KUrl &  url 
) [signal]

Signals the file is a redirection.

Follow this url manually to reach data

Parameters:
job the job that emitted this signal
url the new URL
void FileJob::seek ( KIO::filesize_t  offset  ) 

Seek.

The slave emits position()

Parameters:
offset the position from start to go to

Definition at line 102 of file filejob.cpp.

KIO::filesize_t FileJob::size (  ) 

Size.

Returns:
the file size

Definition at line 120 of file filejob.cpp.

void FileJob::write ( const QByteArray &  data  ) 

Write block.

Parameters:
data the data to write

Definition at line 94 of file filejob.cpp.

void KIO::FileJob::written ( KIO::Job *  job,
KIO::filesize_t  written 
) [signal]

Bytes written to the file.

Parameters:
job the job that emitted this signal
written bytes written.

The documentation for this class was generated from the following files:
  • filejob.h
  • filejob.cpp

KIO

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal