kio Library API Documentation

kfilterbase.h

00001 /* This file is part of the KDE libraries
00002    Copyright (C) 2000 David Faure <faure@kde.org>
00003 
00004    This library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Library General Public
00006    License version 2 as published by the Free Software Foundation.
00007 
00008    This library is distributed in the hope that it will be useful,
00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011    Library General Public License for more details.
00012 
00013    You should have received a copy of the GNU Library General Public License
00014    along with this library; see the file COPYING.LIB.  If not, write to
00015    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00016    Boston, MA 02111-1307, USA.
00017 */
00018 
00019 #ifndef __kfilterbase__h
00020 #define __kfilterbase__h
00021 
00022 #include <qobject.h>
00023 #include <qstring.h>
00024 class QIODevice;
00025 
00031 class KFilterBase : public QObject // needs to inherit QObject for KLibFactory::create
00032 {
00033     Q_OBJECT
00034 public:
00035     KFilterBase();
00036     virtual ~KFilterBase();
00037 
00042     void setDevice( QIODevice * dev, bool autodelete = false );
00043     // Note that this isn't in the constructor, because of KLibFactory::create,
00044     // but it should be called before using the filterbase !
00045 
00046     QIODevice * device() { return m_dev; }
00047     virtual void init( int mode ) = 0;
00048     virtual int mode() const = 0;
00049     virtual void terminate() {}
00050     virtual void reset() {}
00051     virtual bool readHeader() = 0;
00052     virtual bool writeHeader( const QCString & filename ) = 0;
00053     virtual void setOutBuffer( char * data, uint maxlen ) = 0;
00054     virtual void setInBuffer( const char * data, uint size ) = 0;
00055     virtual bool inBufferEmpty() const { return inBufferAvailable() == 0; }
00056     virtual int  inBufferAvailable() const = 0;
00057     virtual bool outBufferFull() const { return outBufferAvailable() == 0; }
00058     virtual int  outBufferAvailable() const = 0;
00059 
00060     enum Result { OK, END, ERROR };
00061     virtual Result uncompress() = 0;
00062     virtual Result compress( bool finish ) = 0;
00063 
00068     static KFilterBase * findFilterByFileName( const QString & fileName );
00069 
00074     static KFilterBase * findFilterByMimeType( const QString & mimeType );
00075 
00076 protected:
00077     QIODevice * m_dev;
00078     bool m_bAutoDel;
00079 protected:
00080     virtual void virtual_hook( int id, void* data );
00081 private:
00082     class KFilterBasePrivate;
00083 };
00084 
00085 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:13:36 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001