kio Library API Documentation

KFilterDev Class Reference

A class for reading and writing compressed data onto a device (e.g. More...

#include <kfilterdev.h>

Inheritance diagram for KFilterDev:

QIODevice List of all members.

Public Methods

 KFilterDev (KFilterBase *filter, bool autodeleteFilterBase=false)
 Constructs a KFilterDev for a given filter (e.g.

virtual ~KFilterDev ()
 Destructs the KFilterDev.

virtual bool open (int mode)
 Open for reading or writing.

virtual void close ()
 Close after reading or writing.

virtual void flush ()
void setOrigFileName (const QCString &fileName)
 For writing gzip compressed files only: set the name of the original file, to be used in the gzip header.

void setSkipHeaders ()
 Call this let this device skip the gzip headers when reading/writing.

virtual bool at (QIODevice::Offset)
 That one can be quite slow, when going back.

virtual Q_LONG readBlock (char *data, Q_ULONG maxlen)
virtual Q_LONG writeBlock (const char *data, Q_ULONG len)
virtual int getch ()
virtual int putch (int)
virtual int ungetch (int)

Static Public Methods

QIODevicecreateFilterDevice (KFilterBase *base, QFile *file)
 Call this to create the appropriate filter device for base working on file .

QIODevicedeviceForFile (const QString &fileName, const QString &mimetype=QString::null, bool forceFilter=false)
 Creates an i/o device that is able to read from fileName, whether it's compressed or not.

QIODevicedevice (QIODevice *inDevice, const QString &mimetype)
 Creates an i/o device that is able to read from the QIODevice inDevice, whether the data is compressed or not.

QIODevicedevice (QIODevice *inDevice, const QString &mimetype, bool autoDeleteInDevice)
 Creates an i/o device that is able to read from the QIODevice inDevice, whether the data is compressed or not.


Detailed Description

A class for reading and writing compressed data onto a device (e.g.

file, but other usages are possible, like a buffer or a socket)

To simply read/write compressed files, see deviceForFile.

Author:
David Faure <faure@kde.org>

Definition at line 35 of file kfilterdev.h.


Constructor & Destructor Documentation

KFilterDev::KFilterDev KFilterBase   filter,
bool    autodeleteFilterBase = false
 

Constructs a KFilterDev for a given filter (e.g.

gzip, bzip2 etc.)

Parameters:
autoDeleteFilterbase  when true this object will become the owner of filter.

Definition at line 42 of file kfilterdev.cpp.

Referenced by createFilterDevice(), device(), and deviceForFile().

KFilterDev::~KFilterDev   [virtual]
 

Destructs the KFilterDev.

Calls close() if the filter device is still open.

Definition at line 50 of file kfilterdev.cpp.

References close(), and QIODevice::isOpen().


Member Function Documentation

bool KFilterDev::open int    mode [virtual]
 

Open for reading or writing.

If the KFilterBase's device is not opened, it will be opened.

Reimplemented from QIODevice.

Definition at line 115 of file kfilterdev.cpp.

References KFilterBase::device(), KFilterBase::init(), QIODevice::isOpen(), QIODevice::mode(), QIODevice::open(), and KFilterBase::setOutBuffer().

void KFilterDev::close   [virtual]
 

Close after reading or writing.

If the KFilterBase's device was opened by open(), it will be closed.

Reimplemented from QIODevice.

Definition at line 145 of file kfilterdev.cpp.

References QIODevice::close(), KFilterBase::device(), KFilterBase::mode(), KFilterBase::terminate(), and QIODevice::writeBlock().

Referenced by ~KFilterDev().

void KFilterDev::setOrigFileName const QCString   fileName
 

For writing gzip compressed files only: set the name of the original file, to be used in the gzip header.

Definition at line 416 of file kfilterdev.cpp.

void KFilterDev::setSkipHeaders  
 

Call this let this device skip the gzip headers when reading/writing.

This way KFilterDev (with gzip filter) can be used as a direct wrapper around zlib - this is used by KZip.

Since:
3.1

Definition at line 421 of file kfilterdev.cpp.

bool KFilterDev::at QIODevice::Offset    [virtual]
 

That one can be quite slow, when going back.

Use with care.

Definition at line 184 of file kfilterdev.cpp.

References QIODevice::at(), KFilterBase::device(), KFilterBase::mode(), QIODevice::Offset(), QIODevice::readBlock(), QIODevice::reset(), KFilterBase::reset(), and KFilterBase::setInBuffer().

QIODevice * KFilterDev::createFilterDevice KFilterBase   base,
QFile   file
[static]
 

Call this to create the appropriate filter device for base working on file .

The returned QIODevice has to be deleted after using.

Deprecated:
. Use deviceForFile instead. To be removed in KDE 3.0

Definition at line 62 of file kfilterdev.cpp.

References KFilterDev(), QFile::name(), and KFilterBase::setDevice().

QIODevice * KFilterDev::deviceForFile const QString   fileName,
const QString   mimetype = QString::null,
bool    forceFilter = false
[static]
 

Creates an i/o device that is able to read from fileName, whether it's compressed or not.

Available compression filters (gzip/bzip2 etc.) will automatically be used.

The compression filter to be used is determined from the fileName if mimetype is empty. Pass "application/x-gzip" or "application/x-bzip2" to force the corresponding decompression filter, if available.

Warning: application/x-bzip2 may not be available. In that case a QFile opened on the compressed data will be returned ! Use KFilterBase::findFilterByMimeType and code similar to what deviceForFile is doing, to better control what's happening.

The returned QIODevice has to be deleted after using.

Definition at line 77 of file kfilterdev.cpp.

References KFilterBase::findFilterByFileName(), KFilterBase::findFilterByMimeType(), QString::isEmpty(), KFilterDev(), KIO::mimetype(), and KFilterBase::setDevice().

QIODevice * KFilterDev::device QIODevice   inDevice,
const QString   mimetype
[static]
 

Creates an i/o device that is able to read from the QIODevice inDevice, whether the data is compressed or not.

Available compression filters (gzip/bzip2 etc.) will automatically be used.

The compression filter to be used is determined mimetype . Pass "application/x-gzip" or "application/x-bzip2" to use the corresponding decompression filter.

Warning: application/x-bzip2 may not be available. In that case 0 will be returned !

The returned QIODevice has to be deleted after using.

Parameters:
inDevice  input device, becomes owned by this device! Automatically deleted!

Definition at line 97 of file kfilterdev.cpp.

References KIO::mimetype().

Referenced by KZip::prepareWriting().

QIODevice * KFilterDev::device QIODevice   inDevice,
const QString   mimetype,
bool    autoDeleteInDevice
[static]
 

Creates an i/o device that is able to read from the QIODevice inDevice, whether the data is compressed or not.

Available compression filters (gzip/bzip2 etc.) will automatically be used.

The compression filter to be used is determined mimetype . Pass "application/x-gzip" or "application/x-bzip2" to use the corresponding decompression filter.

Warning: application/x-bzip2 may not be available. In that case 0 will be returned !

The returned QIODevice has to be deleted after using.

Parameters:
inDevice  input device. Won't be deleted if autoDeleteInDevice = false
Since:
3.1

Definition at line 102 of file kfilterdev.cpp.

References KFilterBase::findFilterByMimeType(), KFilterDev(), KIO::mimetype(), and KFilterBase::setDevice().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:36 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001