• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KFilterBase Class Referenceabstract

#include <kfilterbase.h>

Inheritance diagram for KFilterBase:
KGzipFilter

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

◆ FilterFlags

enum KFilterBase::FilterFlags
Since
4.3
Enumerator
NoHeaders 
WithHeaders 

Definition at line 92 of file kfilterbase.h.

◆ Result

enum KFilterBase::Result
Enumerator
Ok 
End 
Error 

Definition at line 82 of file kfilterbase.h.

Constructor & Destructor Documentation

◆ KFilterBase()

KFilterBase::KFilterBase ( )

Definition at line 42 of file kfilterbase.cpp.

◆ ~KFilterBase()

KFilterBase::~KFilterBase ( )
virtual

Definition at line 47 of file kfilterbase.cpp.

Member Function Documentation

◆ compress()

virtual Result KFilterBase::compress ( bool  finish)
pure virtual

Implemented in KGzipFilter.

◆ device()

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.

◆ filterFlags()

KFilterBase::FilterFlags KFilterBase::filterFlags ( ) const

Definition at line 162 of file kfilterbase.cpp.

◆ findFilterByFileName()

KFilterBase * KFilterBase::findFilterByFileName ( const QString &  fileName)
static

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

Parameters
fileNamethe 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.

◆ findFilterByMimeType()

KFilterBase * KFilterBase::findFilterByMimeType ( const QString &  mimeType)
static

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

For instance application/x-gzip.

Parameters
mimeTypethe 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.

◆ inBufferAvailable()

virtual int KFilterBase::inBufferAvailable ( ) const
pure virtual

Implemented in KGzipFilter.

◆ inBufferEmpty()

bool KFilterBase::inBufferEmpty ( ) const
virtual

Definition at line 65 of file kfilterbase.cpp.

◆ init()

virtual void KFilterBase::init ( int  mode)
pure virtual

Implemented in KGzipFilter.

◆ mode()

virtual int KFilterBase::mode ( ) const
pure virtual

Implemented in KGzipFilter.

◆ outBufferAvailable()

virtual int KFilterBase::outBufferAvailable ( ) const
pure virtual

Implemented in KGzipFilter.

◆ outBufferFull()

bool KFilterBase::outBufferFull ( ) const
virtual

Definition at line 70 of file kfilterbase.cpp.

◆ readHeader()

virtual bool KFilterBase::readHeader ( )
pure virtual

Implemented in KGzipFilter.

◆ reset()

void KFilterBase::reset ( )
virtual

Reimplemented in KGzipFilter.

Definition at line 153 of file kfilterbase.cpp.

◆ 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

Definition at line 54 of file kfilterbase.cpp.

◆ setFilterFlags()

void KFilterBase::setFilterFlags ( FilterFlags  flags)
Since
4.3

Definition at line 157 of file kfilterbase.cpp.

◆ setInBuffer()

virtual void KFilterBase::setInBuffer ( const char *  data,
uint  size 
)
pure virtual

Implemented in KGzipFilter.

◆ setOutBuffer()

virtual void KFilterBase::setOutBuffer ( char *  data,
uint  maxlen 
)
pure virtual

Implemented in KGzipFilter.

◆ terminate()

void KFilterBase::terminate ( )
virtual

Reimplemented in KGzipFilter.

Definition at line 149 of file kfilterbase.cpp.

◆ uncompress()

virtual Result KFilterBase::uncompress ( )
pure virtual

Implemented in KGzipFilter.

◆ virtual_hook()

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.

Definition at line 167 of file kfilterbase.cpp.

◆ writeHeader()

virtual bool KFilterBase::writeHeader ( const QByteArray &  filename)
pure virtual

Implemented in KGzipFilter.

Member Data Documentation

◆ m_bAutoDel

bool KFilterBase::m_bAutoDel
protected

Definition at line 121 of file kfilterbase.h.

◆ m_dev

QIODevice* KFilterBase::m_dev
protected

Definition at line 120 of file kfilterbase.h.


The documentation for this class was generated from the following files:
  • kfilterbase.h
  • kfilterbase.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal