KDECore
#include <kfilterbase.h>
Public Types | |
enum | FilterFlags { NoHeaders = 0, WithHeaders = 1 } |
enum | Result { Ok, End, Error } |
Public Member Functions | |
KFilterBase () | |
virtual | ~KFilterBase () |
virtual Result | compress (bool finish)=0 |
QIODevice * | device () |
FilterFlags | filterFlags () const |
virtual int | inBufferAvailable () const =0 |
virtual bool | inBufferEmpty () const |
virtual void | init (int mode)=0 |
virtual int | mode () const =0 |
virtual int | outBufferAvailable () const =0 |
virtual bool | outBufferFull () const |
virtual bool | readHeader ()=0 |
virtual void | reset () |
void | setDevice (QIODevice *dev, bool autodelete=false) |
void | setFilterFlags (FilterFlags flags) |
virtual void | setInBuffer (const char *data, uint size)=0 |
virtual void | setOutBuffer (char *data, uint maxlen)=0 |
virtual void | terminate () |
virtual Result | uncompress ()=0 |
virtual bool | writeHeader (const QByteArray &filename)=0 |
Static Public Member Functions | |
static KFilterBase * | findFilterByFileName (const QString &fileName) |
static KFilterBase * | findFilterByMimeType (const QString &mimeType) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
bool | m_bAutoDel |
QIODevice * | m_dev |
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 36 of file kfilterbase.h.
Member Enumeration Documentation
enum KFilterBase::Result |
Enumerator | |
---|---|
Ok | |
End | |
Error |
Definition at line 82 of file kfilterbase.h.
Constructor & Destructor Documentation
KFilterBase::KFilterBase | ( | ) |
Definition at line 42 of file kfilterbase.cpp.
|
virtual |
Definition at line 47 of file kfilterbase.cpp.
Member Function Documentation
Implemented in KGzipFilter.
QIODevice * KFilterBase::device | ( | ) |
Returns the device on which the filter will work.
- Returns
- the device on which the filter will work
Definition at line 60 of file kfilterbase.cpp.
KFilterBase::FilterFlags KFilterBase::filterFlags | ( | ) | const |
Definition at line 162 of file kfilterbase.cpp.
|
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 75 of file kfilterbase.cpp.
|
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 103 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
|
virtual |
Definition at line 65 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
|
pure virtual |
Implemented in KGzipFilter.
|
pure virtual |
Implemented in KGzipFilter.
|
virtual |
Definition at line 70 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
|
virtual |
Reimplemented in KGzipFilter.
Definition at line 153 of file kfilterbase.cpp.
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 54 of file kfilterbase.cpp.
void KFilterBase::setFilterFlags | ( | FilterFlags | flags | ) |
- Since
- 4.3
Definition at line 157 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
|
pure virtual |
Implemented in KGzipFilter.
|
virtual |
Reimplemented in KGzipFilter.
Definition at line 149 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
|
protectedvirtual |
Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.
Unused in this class.
Definition at line 167 of file kfilterbase.cpp.
|
pure virtual |
Implemented in KGzipFilter.
Member Data Documentation
|
protected |
Definition at line 121 of file kfilterbase.h.
|
protected |
Definition at line 120 of file kfilterbase.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:10 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.