Baloo::FileMetaDataProvider Class Reference

#include <filemetadataprovider.h>

Inheritance diagram for Baloo::FileMetaDataProvider:

Signals
void	loadingFinished ()

Public Member Functions
	FileMetaDataProvider (QObject *parent=nullptr)
void	cancel ()
QVariantMap	data () const
virtual QString	group (const QString &label) const
bool	isReadOnly () const
KFileItemList	items () const
virtual QString	label (const QString &metaDataLabel) const
void	refresh ()
void	setItems (const KFileItemList &items)
void	setReadOnly (bool readOnly)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
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 const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Provides the data for the MetaDataWidget.

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

See also

FileMetaDataWidget

Definition at line 30 of file filemetadataprovider.h.

Constructor & Destructor Documentation

FileMetaDataProvider()

FileMetaDataProvider::FileMetaDataProvider ( QObject * parent = nullptr )

explicit

Definition at line 341 of file filemetadataprovider.cpp.

Member Function Documentation

cancel()

void FileMetaDataProvider::cancel

(

)

Cancel data loading if it's in progress.

Definition at line 411 of file filemetadataprovider.cpp.

data()

QVariantMap FileMetaDataProvider::data

(

)

const

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 580 of file filemetadataprovider.cpp.

group()

QString FileMetaDataProvider::group ( const QString & label ) 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 label belongs to. Per default an empty string is returned.

Definition at line 500 of file filemetadataprovider.cpp.

isReadOnly()

bool FileMetaDataProvider::isReadOnly

(

)

const

Definition at line 575 of file filemetadataprovider.cpp.

items()

KFileItemList FileMetaDataProvider::items

(

)

const

Definition at line 565 of file filemetadataprovider.cpp.

label()

QString FileMetaDataProvider::label ( const QString & metaDataLabel ) 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 439 of file filemetadataprovider.cpp.

loadingFinished

void Baloo::FileMetaDataProvider::loadingFinished ( )

signal

Emitted once per KFileMetaDataProvider::setItems() after data loading is finished.

refresh()

void FileMetaDataProvider::refresh

(

)

Refresh data with latest info from storage.

Definition at line 428 of file filemetadataprovider.cpp.

setItems()

void FileMetaDataProvider::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 420 of file filemetadataprovider.cpp.

setReadOnly()

void FileMetaDataProvider::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 570 of file filemetadataprovider.cpp.

---

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

• filemetadataprovider.h
• filemetadataprovider.cpp