KFileMetaDataReader Class Reference

#include <kfilemetadatareader_p.h>

Inheritance diagram for KFileMetaDataReader:

Signals
void	finished ()

Public Member Functions
	KFileMetaDataReader (const QList< KUrl > &urls, QObject *parent=0)
virtual	~KFileMetaDataReader ()
QHash< KUrl, Nepomuk::Variant >	metaData () const
bool	readContextData () const
void	setReadContextData (bool read)
void	start ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
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) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *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)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Provides metadata extracted from files.

The reading of the metadata is done asynchronously in a process. This assures that the caller won't get blocked and also prevents that the caller crashes in case if a metadata-analyzer plugin is instable.

Since

4.7

Definition at line 43 of file kfilemetadatareader_p.h.

Constructor & Destructor Documentation

KFileMetaDataReader::KFileMetaDataReader ( const QList< KUrl > &  urls, QObject *  parent = 0  )

explicit

Parameters

urls	List of files where the metadata should be extracted from.
parent	Parent object.

Definition at line 99 of file kfilemetadatareader.cpp.

KFileMetaDataReader::~KFileMetaDataReader ( )

virtual

Definition at line 116 of file kfilemetadatareader.cpp.

Member Function Documentation

void KFileMetaDataReader::finished ( )

signal

Is emitted if the reading of the metadata inside a custom process has been finished.

The method metaData() can be used afterwards to access the metadata.

QHash< KUrl, Nepomuk::Variant > KFileMetaDataReader::metaData

(

)

const

Returns

The read metadata of the given files. The method provides valid values after the signal finished() has been emitted. If it is invoked before an empty hash-table will be returned.

Definition at line 141 of file kfilemetadatareader.cpp.

bool KFileMetaDataReader::readContextData

(

)

const

Definition at line 126 of file kfilemetadatareader.cpp.

void KFileMetaDataReader::setReadContextData

(

bool

read

)

If read is set to true also metadata that is persisted outside the files itself (like e.g.

rating, comments or tags) are read. Per default the reading of context data is enabled. Pass false if only the metadata persisted inside the file should be read.

Definition at line 121 of file kfilemetadatareader.cpp.

void KFileMetaDataReader::start

(

)

Starts the reading of the metadata inside a custom process.

The signal finished() will get emitted if the reading has been finished. Use metaData() to access the read metadata.

Definition at line 131 of file kfilemetadatareader.cpp.

---

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

• kfilemetadatareader_p.h
• kfilemetadatareader.cpp