org.kde.koala

Class KFilterBase

public class KFilterBase extends QObject

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.

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

Field Summary
static intEND
static intERROR
static intOK
\internal @short \internal
Constructor Summary
protected KFilterBase(Class dummy)
Method Summary
StringclassName()
intcompress(boolean finish)
\internal @short \internal
QIODeviceInterfacedevice()
Returns the device on which the filter will work.
static KFilterBasefindFilterByFileName(String fileName)
Call this to create the appropriate filter for the file named fileName.
static KFilterBasefindFilterByMimeType(String mimeType)
Call this to create the appropriate filter for the mimetype mimeType. For instance application/x-gzip.
intinBufferAvailable()
\internal @short \internal
booleaninBufferEmpty()
\internal @short \internal
voidinit(int mode)
\internal @short \internal
QMetaObjectmetaObject()
intmode()
\internal @short \internal
intoutBufferAvailable()
\internal @short \internal
booleanoutBufferFull()
\internal @short \internal
booleanreadHeader()
\internal @short \internal
voidreset()
\internal @short \internal
voidsetDevice(QIODeviceInterface dev, boolean autodelete)
Sets the device on which the filter will work
voidsetDevice(QIODeviceInterface dev)
voidsetInBuffer(String data, int size)
\internal @short \internal
voidsetOutBuffer(String data, int maxlen)
\internal @short \internal
voidterminate()
\internal @short \internal
intuncompress()
\internal @short \internal
booleanwriteHeader(String filename)
\internal @short \internal

Field Detail

END

public static final int END

ERROR

public static final int ERROR

OK

public static final int OK
\internal @short \internal

Constructor Detail

KFilterBase

protected KFilterBase(Class dummy)

Method Detail

className

public String className()

compress

public int compress(boolean finish)
\internal @short \internal

device

public QIODeviceInterface device()
Returns the device on which the filter will work.

Returns: the device on which the filter will work

UNKNOWN: Returns the device on which the filter will work.

findFilterByFileName

public static KFilterBase findFilterByFileName(String fileName)
Call this to create the appropriate filter for the file named fileName.

Parameters: fileName the name of the file to filter

Returns: the filter for the fileName, or 0 if not found

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

findFilterByMimeType

public static KFilterBase findFilterByMimeType(String mimeType)
Call this to create the appropriate filter for the mimetype mimeType. For instance application/x-gzip.

Parameters: mimeType the mime type of the file to filter

Returns: the filter for the mimeType, or 0 if not found

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

inBufferAvailable

public int inBufferAvailable()
\internal @short \internal

inBufferEmpty

public boolean inBufferEmpty()
\internal @short \internal

init

public void init(int mode)
\internal @short \internal

metaObject

public QMetaObject metaObject()

mode

public int mode()
\internal @short \internal

outBufferAvailable

public int outBufferAvailable()
\internal @short \internal

outBufferFull

public boolean outBufferFull()
\internal @short \internal

readHeader

public boolean readHeader()
\internal @short \internal

reset

public void reset()
\internal @short \internal

setDevice

public void setDevice(QIODeviceInterface dev, boolean autodelete)
Sets the device on which the filter will work

Parameters: dev the device on which the filter will work autodelete if true, dev is deleted when the filter is deleted

UNKNOWN: Sets the device on which the filter will work

setDevice

public void setDevice(QIODeviceInterface dev)

setInBuffer

public void setInBuffer(String data, int size)
\internal @short \internal

setOutBuffer

public void setOutBuffer(String data, int maxlen)
\internal @short \internal

terminate

public void terminate()
\internal @short \internal

uncompress

public int uncompress()
\internal @short \internal

writeHeader

public boolean writeHeader(String filename)
\internal @short \internal