kio

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., 51 Franklin Street, Fifth Floor,
00016    Boston, MA 02110-1301, USA.
00017 */
00018 
00019 #ifndef __kfilterbase__h
00020 #define __kfilterbase__h
00021 
00022 #include <qobject.h>
00023 #include <qstring.h>
00024 
00025 #include <kdelibs_export.h>
00026 
00027 #ifdef Q_WS_WIN
00028 #undef ERROR //avoid conflicts
00029 #endif
00030 
00031 class QIODevice;
00032 
00038 class KIO_EXPORT KFilterBase : public QObject // needs to inherit QObject for KLibFactory::create
00039 {
00040     Q_OBJECT
00041 public:
00042     KFilterBase();
00043     virtual ~KFilterBase();
00044 
00050     void setDevice( QIODevice * dev, bool autodelete = false );
00051     // Note that this isn't in the constructor, because of KLibFactory::create,
00052     // but it should be called before using the filterbase !
00053 
00058     QIODevice * device() { return m_dev; }
00060     virtual void init( int mode ) = 0;
00062     virtual int mode() const = 0;
00064     virtual void terminate() {}
00066     virtual void reset() {}
00068     virtual bool readHeader() = 0;
00070     virtual bool writeHeader( const QCString & filename ) = 0;
00072     virtual void setOutBuffer( char * data, uint maxlen ) = 0;
00074     virtual void setInBuffer( const char * data, uint size ) = 0;
00076     virtual bool inBufferEmpty() const { return inBufferAvailable() == 0; }
00078     virtual int  inBufferAvailable() const = 0;
00080     virtual bool outBufferFull() const { return outBufferAvailable() == 0; }
00082     virtual int  outBufferAvailable() const = 0;
00083 
00085     enum Result { OK, END, ERROR };
00087     virtual Result uncompress() = 0;
00089     virtual Result compress( bool finish ) = 0;
00090 
00097     static KFilterBase * findFilterByFileName( const QString & fileName );
00098 
00105     static KFilterBase * findFilterByMimeType( const QString & mimeType );
00106 
00107 protected:
00108     QIODevice * m_dev;
00109     bool m_bAutoDel;
00110 protected:
00111     virtual void virtual_hook( int id, void* data );
00112 private:
00113     class KFilterBasePrivate;
00114 };
00115 
00116 #endif
kio

kfilterbase.h

kio

API Reference
