• 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 | List of all members
KGzipFilter Class Reference

#include <kgzipfilter.h>

Inheritance diagram for KGzipFilter:
KFilterBase

Public Types

enum  Flag { RawDeflate = 0 , ZlibHeader = 1 , GZipHeader = 2 }
 
- Public Types inherited from KFilterBase
enum  FilterFlags { NoHeaders = 0 , WithHeaders = 1 }
 
enum  Result { Ok , End , Error }
 

Public Member Functions

 KGzipFilter ()
 
virtual ~KGzipFilter ()
 
virtual Result compress (bool finish)
 
virtual int inBufferAvailable () const
 
virtual void init (int mode)
 
void init (int mode, Flag flag)
 
virtual int mode () const
 
virtual int outBufferAvailable () const
 
virtual bool readHeader ()
 
virtual void reset ()
 
virtual void setInBuffer (const char *data, uint size)
 
virtual void setOutBuffer (char *data, uint maxlen)
 
virtual void terminate ()
 
virtual Result uncompress ()
 
void writeFooter ()
 
virtual bool writeHeader (const QByteArray &fileName)
 
- Public Member Functions inherited from KFilterBase
 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
 

Additional Inherited Members

- Static Public Member Functions inherited from KFilterBase
static KFilterBase * findFilterByFileName (const QString &fileName)
 
static KFilterBase * findFilterByMimeType (const QString &mimeType)
 
- Protected Member Functions inherited from KFilterBase
virtual void virtual_hook (int id, void *data)
 
- Protected Attributes inherited from KFilterBase
bool m_bAutoDel
 
QIODevice * m_dev
 

Detailed Description

Internal class used by KFilterDev.

This header is not installed.

Definition at line 32 of file kgzipfilter.h.

Member Enumeration Documentation

◆ Flag

enum KGzipFilter::Flag
Enumerator
RawDeflate 
ZlibHeader 
GZipHeader 

Definition at line 48 of file kgzipfilter.h.

Constructor & Destructor Documentation

◆ KGzipFilter()

KGzipFilter::KGzipFilter ( )

Definition at line 58 of file kgzipfilter.cpp.

◆ ~KGzipFilter()

KGzipFilter::~KGzipFilter ( )
virtual

Definition at line 64 of file kgzipfilter.cpp.

Member Function Documentation

◆ compress()

KGzipFilter::Result KGzipFilter::compress ( bool  finish)
virtual

Implements KFilterBase.

Definition at line 353 of file kgzipfilter.cpp.

◆ inBufferAvailable()

int KGzipFilter::inBufferAvailable ( ) const
virtual

Implements KFilterBase.

Definition at line 294 of file kgzipfilter.cpp.

◆ init() [1/2]

void KGzipFilter::init ( int  mode)
virtual

Implements KFilterBase.

Definition at line 69 of file kgzipfilter.cpp.

◆ init() [2/2]

void KGzipFilter::init ( int  mode,
Flag  flag 
)

Definition at line 74 of file kgzipfilter.cpp.

◆ mode()

int KGzipFilter::mode ( ) const
virtual

Implements KFilterBase.

Definition at line 110 of file kgzipfilter.cpp.

◆ outBufferAvailable()

int KGzipFilter::outBufferAvailable ( ) const
virtual

Implements KFilterBase.

Definition at line 298 of file kgzipfilter.cpp.

◆ readHeader()

bool KGzipFilter::readHeader ( )
virtual

Implements KFilterBase.

Definition at line 156 of file kgzipfilter.cpp.

◆ reset()

void KGzipFilter::reset ( )
virtual

Reimplemented from KFilterBase.

Definition at line 136 of file kgzipfilter.cpp.

◆ setInBuffer()

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

Implements KFilterBase.

Definition at line 286 of file kgzipfilter.cpp.

◆ setOutBuffer()

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

Implements KFilterBase.

Definition at line 281 of file kgzipfilter.cpp.

◆ terminate()

void KGzipFilter::terminate ( )
virtual

Reimplemented from KFilterBase.

Definition at line 115 of file kgzipfilter.cpp.

◆ uncompress()

KGzipFilter::Result KGzipFilter::uncompress ( )
virtual

Implements KFilterBase.

Definition at line 320 of file kgzipfilter.cpp.

◆ writeFooter()

void KGzipFilter::writeFooter ( )

Definition at line 265 of file kgzipfilter.cpp.

◆ writeHeader()

bool KGzipFilter::writeHeader ( const QByteArray &  filename)
virtual

Implements KFilterBase.

Definition at line 239 of file kgzipfilter.cpp.


The documentation for this class was generated from the following files:
  • kgzipfilter.h
  • kgzipfilter.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