kio Library API Documentation

KFilterBase Class Reference

This is the base class for compression filters such as gzip and bzip2. More...

#include <kfilterbase.h>

Inheritance diagram for KFilterBase:

QObject List of all members.

Public Types

enum  Result { OK, END, ERROR }

Public Member Functions

void setDevice (QIODevice *dev, bool autodelete=false)
QIODevicedevice ()
virtual void init (int mode)=0
virtual int mode () const =0
virtual void terminate ()
virtual void reset ()
virtual bool readHeader ()=0
virtual bool writeHeader (const QCString &filename)=0
virtual void setOutBuffer (char *data, uint maxlen)=0
virtual void setInBuffer (const char *data, uint size)=0
virtual bool inBufferEmpty () const
virtual int inBufferAvailable () const =0
virtual bool outBufferFull () const
virtual int outBufferAvailable () const =0
virtual Result uncompress ()=0
virtual Result compress (bool finish)=0

Static Public Member Functions

KFilterBasefindFilterByFileName (const QString &fileName)
KFilterBasefindFilterByMimeType (const QString &mimeType)

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Protected Attributes

QIODevicem_dev
bool m_bAutoDel

Detailed Description

This is the base class for compression filters such as gzip and bzip2.

It's pretty much internal. Don't use directly, use KFilterDev instead.

Definition at line 31 of file kfilterbase.h.


Member Function Documentation

void KFilterBase::setDevice QIODevice dev,
bool  autodelete = false
 

Sets the device on which the filter will work.

Parameters:
dev the device on which the filter will work
autodelete if true, dev is deleted when the filter is deleted

Definition at line 36 of file kfilterbase.cpp.

References setDevice().

Referenced by KFilterDev::createFilterDevice(), KFilterDev::device(), KFilterDev::deviceForFile(), and setDevice().

QIODevice* KFilterBase::device  )  [inline]
 

Returns the device on which the filter will work.

Returns:
the device on which the filter will work

Definition at line 51 of file kfilterbase.h.

Referenced by KFilterDev::at(), KFilterDev::close(), and KFilterDev::open().

KFilterBase * KFilterBase::findFilterByFileName const QString fileName  )  [static]
 

Call this to create the appropriate filter for the file named fileName.

Parameters:
fileName the name of the file to filter
Returns:
the filter for the fileName, or 0 if not found

Definition at line 42 of file kfilterbase.cpp.

References endl(), findFilterByFileName(), findFilterByMimeType(), and kdDebug().

Referenced by findFilterByFileName().

KFilterBase * KFilterBase::findFilterByMimeType const QString mimeType  )  [static]
 

Call this to create the appropriate filter for the mimetype mimeType.

For instance application/x-gzip.

Parameters:
mimeType the mime type of the file to filter
Returns:
the filter for the mimeType, or 0 if not found

Definition at line 49 of file kfilterbase.cpp.

References KLibFactory::create(), endl(), KLibLoader::factory(), findFilterByMimeType(), kdDebug(), kdWarning(), and KLibLoader::self().

Referenced by findFilterByFileName(), and findFilterByMimeType().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 10 18:55:31 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003