KArchive - KFilterDev Class Reference

View on LXR

#include <KFilterDev>

Inheritance diagram for KFilterDev:

Public Member Functions
	KFilterDev (const QString &fileName)

Public Member Functions inherited from KCompressionDevice
	KCompressionDevice (QIODevice *inputDevice, bool autoDeleteInputDevice, CompressionType type)

	KCompressionDevice (const QString &fileName, CompressionType type)

virtual	~KCompressionDevice ()

bool	atEnd () const override

void	close () override

CompressionType	compressionType () const

QFileDevice::FileError	error () const

bool	open (QIODevice::OpenMode mode) override

bool	seek (qint64) override

void	setOrigFileName (const QByteArray &fileName)

void	setSkipHeaders ()

Public Member Functions inherited from QIODevice
	QIODevice (QObject *parent)

void	aboutToClose ()

virtual qint64	bytesAvailable () const

virtual qint64	bytesToWrite () const

void	bytesWritten (qint64 bytes)

virtual bool	canReadLine () const

QString	errorString () const

bool	getChar (char *c)

bool	isOpen () const

bool	isReadable () const

virtual bool	isSequential () const

bool	isTextModeEnabled () const

bool	isWritable () const

virtual bool	open (QFlags< QIODevice::OpenModeFlag > mode)

OpenMode	openMode () const

qint64	peek (char *data, qint64 maxSize)

QByteArray	peek (qint64 maxSize)

virtual qint64	pos () const

bool	putChar (char c)

qint64	read (char *data, qint64 maxSize)

QByteArray	read (qint64 maxSize)

QByteArray	readAll ()

void	readChannelFinished ()

qint64	readLine (char *data, qint64 maxSize)

QByteArray	readLine (qint64 maxSize)

void	readyRead ()

virtual bool	reset ()

void	setTextModeEnabled (bool enabled)

virtual qint64	size () const

void	ungetChar (char c)

virtual bool	waitForBytesWritten (int msecs)

virtual bool	waitForReadyRead (int msecs)

qint64	write (const char *data, qint64 maxSize)

qint64	write (const QByteArray &byteArray)

qint64	write (const char *data)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Static Public Member Functions
static CompressionType	compressionTypeForMimeType (const QString &mimetype)

static KCompressionDevice *	device (QIODevice *inDevice, const QString &mimetype, bool autoDeleteInDevice=true)

static KCompressionDevice *	deviceForFile (const QString &fileName, const QString &mimetype=QString(), bool forceFilter=false)

Static Public Member Functions inherited from KCompressionDevice
static KFilterBase *	filterForCompressionType (CompressionType type)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Types inherited from KCompressionDevice
enum	CompressionType { GZip, BZip2, Xz, None }

Properties inherited from QObject
	objectName

Public Attributes inherited from QIODevice
typedef	OpenMode

Protected Member Functions inherited from KCompressionDevice
KFilterBase *	filterBase ()

qint64	readData (char *data, qint64 maxlen) override

qint64	writeData (const char *data, qint64 len) override

Protected Member Functions inherited from QIODevice
virtual qint64	readData (char *data, qint64 maxSize)=0

virtual qint64	readLineData (char *data, qint64 maxSize)

void	setErrorString (const QString &str)

void	setOpenMode (QFlags< QIODevice::OpenModeFlag > openMode)

virtual qint64	writeData (const char *data, qint64 maxSize)=0

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A class for reading and writing compressed data onto a device (e.g.

file, but other usages are possible, like a buffer or a socket).

To simply read/write compressed files, see deviceForFile.

KFilterDev adds MIME type support to KCompressionDevice, and also provides compatibility methods for KDE 4 code.

Author: David Faure faure[email protected]@kde[email protected].org

Definition at line 29 of file kfilterdev.h.

Constructor & Destructor Documentation

KFilterDev::KFilterDev ( const QString & fileName )

Since: 5.0 Constructs a KFilterDev for a given FileName.

Parameters

fileName the name of the file to filter.

Definition at line 38 of file kfilterdev.cpp.

Member Function Documentation

KCompressionDevice::CompressionType KFilterDev::compressionTypeForMimeType ( const QString & mimetype )

static

Returns the compression type for the given mimetype, if possible.

Otherwise returns None. This handles simple cases like application/x-gzip, but also application/x-compressed-tar, and inheritance.

Definition at line 43 of file kfilterdev.cpp.

static KCompressionDevice* KFilterDev::device	(	QIODevice *	inDevice,
		const QString &	mimetype,
		bool	autoDeleteInDevice = `true`
	)

inlinestatic

Deprecated:: Since 5.0, use KCompressionDevice

Use: KCompressionDevice::CompressionType type = KFilterDev::compressionTypeForMimeType(mimeType); KCompressionDevice flt(&file, false, type); instead of: QIODevice *flt = KFilterDev::device(&file, mimeType, false);

Creates an i/o device that is able to read from the QIODevice inDevice, whether the data is compressed or not. Available compression filters (gzip/bzip2 etc.) will automatically be used.

The compression filter to be used is determined mimetype . Pass "application/x-gzip" or "application/x-bzip" to use the corresponding decompression filter.

Warning: application/x-bzip may not be available. In that case 0 will be returned !

The returned QIODevice has to be deleted after using.

Parameters

inDevice	input device. Won't be deleted if `autoDeleteInDevice` = false
mimetype	the mime type for the filter
autoDeleteInDevice	if true, `inDevice` will be deleted automatically

Returns: a KCompressionDevice that filters the original stream. Must be deleted after using

Definition at line 134 of file kfilterdev.h.

static KCompressionDevice* KFilterDev::deviceForFile	(	const QString &	fileName,
		const QString &	mimetype = `QString()`,
		bool	forceFilter = `false`
	)

inlinestatic

Deprecated:: Since 5.0, use the constructor instead (if mimetype is empty), or KCompressionDevice (if the mimetype is known).

Use: KFilterDev dev(fileName) instead of: QIODevice * dev = KFilterDev::deviceForFile(fileName);

If the mimetype was specified explicitly, use: KCompressionDevice dev(fileName, KCompressionDevice::GZip); instead of: QIODevice * dev = KFilterDev::deviceForFile(fileName, "application/gzip");

Creates an i/o device that is able to read from fileName, whether it's compressed or not. Available compression filters (gzip/bzip2 etc.) will automatically be used.

The compression filter to be used is determined from the fileName if mimetype is empty. Pass "application/x-gzip" or "application/x-bzip" to force the corresponding decompression filter, if available.

Warning: application/x-bzip may not be available. In that case a QFile opened on the compressed data will be returned ! Use KFilterBase::findFilterByMimeType and code similar to what deviceForFile is doing, to better control what's happening.

The returned QIODevice has to be deleted after using.

Parameters

fileName	the name of the file to filter
mimetype	the mime type of the file to filter, or QString() if unknown
forceFilter	if true, the function will either find a compression filter, or return 0. If false, it will always return a QIODevice. If no filter is available it will return a simple QFile. This can be useful if the file is usable without a filter.

Returns: if a filter has been found, the KCompressionDevice for the filter. If the filter does not exist, the return value depends on forceFilter. The returned KCompressionDevice has to be deleted after using.

Definition at line 87 of file kfilterdev.h.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

KFilterDev

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation