KArchive 5.109.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
KFilterBaseabstract

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

#include <KFilterBase>

Public Types

enum  FilterFlags { NoHeaders = 0 , WithHeaders = 1 , ZlibHeaders = 2 }
 
enum  Result { Ok , End , Error }
 

Public Member Functions

virtual Result compress (bool finish)=0
 
QIODevice * device ()
 Returns the device on which the filter will work.
 
FilterFlags filterFlags () const
 
virtual int inBufferAvailable () const =0
 
virtual bool inBufferEmpty () const
 
virtual bool 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)
 Sets the device on which the filter will work.
 
void setFilterFlags (FilterFlags flags)
 
virtual void setInBuffer (const char *data, uint size)=0
 
virtual void setOutBuffer (char *data, uint maxlen)=0
 
virtual bool terminate ()
 
virtual Result uncompress ()=0
 
virtual bool writeHeader (const QByteArray &filename)=0
 

Protected Member Functions

virtual void virtual_hook (int id, void *data)
 Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.
 

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 KCompressionDevice instead.

Member Function Documentation

◆ device()

QIODevice * KFilterBase::device ( )

Returns the device on which the filter will work.

Returns
the device on which the filter will work

◆ setDevice()

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

Sets the device on which the filter will work.

Parameters
devthe device on which the filter will work
autodeleteif true, dev is deleted when the filter is deleted

◆ virtual_hook()

virtual void KFilterBase::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.

Unused in this class.