KFileMetaDataReader Class Reference

#include <kfilemetadatareader_p.h>

Inheritance diagram for KFileMetaDataReader:

List of all members.

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 ()

---

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

---

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