KFileMetaDataProvider Class Reference

Provides the data for the KMetaDataWidget. More...

#include <kfilemetadataprovider_p.h>

Inheritance diagram for KFileMetaDataProvider:

List of all members.

Signals
void	dataChangeFinished ()
void	dataChangeStarted ()
void	loadingFinished ()
void	urlActivated (const KUrl &url)
Public Member Functions
	KFileMetaDataProvider (QObject *parent=0)
virtual	~KFileMetaDataProvider ()
virtual QWidget *	createValueWidget (const KUrl &metaDataUri, const Nepomuk::Variant &value, QWidget *parent) const
virtual QHash< KUrl, Nepomuk::Variant >	data () const
virtual QString	group (const KUrl &metaDataUri) const
bool	isReadOnly () const
KFileItemList	items () const
virtual QString	label (const KUrl &metaDataUri) const
void	setItems (const KFileItemList &items)
void	setReadOnly (bool readOnly)

---

Detailed Description

Provides the data for the KMetaDataWidget.

The default implementation provides all meta data that are available due to Strigi and Nepomuk. If custom meta data should be added, the method KFileMetaDataProvider::loadData() must be overwritten.

See also:

KFileMetaDataWidget

Definition at line 49 of file kfilemetadataprovider_p.h.

---

Constructor & Destructor Documentation

KFileMetaDataProvider::KFileMetaDataProvider

(

QObject *

parent = 0

)

[explicit]

Definition at line 360 of file kfilemetadataprovider.cpp.

KFileMetaDataProvider::~KFileMetaDataProvider

(

)

[virtual]

Definition at line 366 of file kfilemetadataprovider.cpp.

---

Member Function Documentation

QWidget * KFileMetaDataProvider::createValueWidget	(	const KUrl &	metaDataUri,
		const Nepomuk::Variant &	value,
		QWidget *	parent
	)		const [virtual]

Returns:

Factory method that returns a widget that should be used to show the meta data represented by metaDataUri. If no custom value widget is used for the given URI, the base implementation must be invoked. Per default an instance of QLabel will be returned.

Definition at line 481 of file kfilemetadataprovider.cpp.

QHash< KUrl, Nepomuk::Variant > KFileMetaDataProvider::data

(

)

const [virtual]

Returns:

Meta data for the items that have been set by KFileMetaDataProvider::setItems(). The method should be invoked after the signal loadingFinished() has been received (otherwise no data will be returned).

Definition at line 476 of file kfilemetadataprovider.cpp.

void KFileMetaDataProvider::dataChangeFinished

(

)

[signal]

void KFileMetaDataProvider::dataChangeStarted

(

)

[signal]

QString KFileMetaDataProvider::group

(

const KUrl &

metaDataUri

)

const [virtual]

Meta data items are sorted alphabetically by their translated label per default.

However it is possible to provide an internal prefix to the label, so that specific items are grouped together. For example it makes sense that the meta data for 'width' and 'height' of an image are shown below each other. By adding a common prefix, a grouping is done.

Returns:

Returns the name of the group the meta data indicated by metaDataUri belongs to. Per default an empty string is returned.

Definition at line 442 of file kfilemetadataprovider.cpp.

bool KFileMetaDataProvider::isReadOnly

(

)

const

Definition at line 470 of file kfilemetadataprovider.cpp.

KFileItemList KFileMetaDataProvider::items

(

)

const

Definition at line 460 of file kfilemetadataprovider.cpp.

QString KFileMetaDataProvider::label

(

const KUrl &

metaDataUri

)

const [virtual]

Returns:

Translated string for the label of the meta data represented by metaDataUri. If no custom translation is provided, the base implementation must be invoked.

Definition at line 404 of file kfilemetadataprovider.cpp.

void KFileMetaDataProvider::loadingFinished

(

)

[signal]

Is emitted after the loading triggered by KFileMetaDataProvider::setItems() has been finished.

void KFileMetaDataProvider::setItems

(

const KFileItemList &

items

)

Sets the items, where the meta data should be requested.

The loading of the meta data is done asynchronously. The signal loadingFinished() is emitted, as soon as the loading has been finished. The meta data can be retrieved by KFileMetaDataProvider::data() afterwards. The label for each item can be retrieved by KFileMetaDataProvider::label().

Definition at line 371 of file kfilemetadataprovider.cpp.

void KFileMetaDataProvider::setReadOnly

(

bool

readOnly

)

If set to true, data such as the comment, tag or rating cannot be changed by the user.

Per default read-only is disabled. The method readOnlyChanged() can be overwritten to react on the change.

Definition at line 465 of file kfilemetadataprovider.cpp.

void KFileMetaDataProvider::urlActivated

(

const KUrl &

url

)

[signal]

---

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

• kfilemetadataprovider_p.h
• kfilemetadataprovider.cpp