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 Methods

void setDevice (QIODevice *dev, bool autodelete=false)
QIODevicedevice ()

Static Public Methods

KFilterBase * findFilterByFileName (const QString &fileName)
KFilterBase * findFilterByMimeType (const QString &mimeType)

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.

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

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 KMimeType::findByPath(), and findFilterByMimeType().

Referenced by KFilterDev::deviceForFile().

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 QValueList::begin(), QValueList::count(), KLibFactory::create(), QValueList::end(), KStdAccel::end(), KLibLoader::factory(), KTrader::query(), KLibLoader::self(), and KTrader::self().

Referenced by KFilterDev::device(), KFilterDev::deviceForFile(), and findFilterByFileName().


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.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:24:18 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003