mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 10:52:49 +00:00
124 lines
4.7 KiB
C++
124 lines
4.7 KiB
C++
/*****************************************************************************
|
|
* Copyright (C) 2010 by Peter Penz <peter.penz@gmx.at> *
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Library General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
* Library General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Library General Public License *
|
|
* along with this library; see the file COPYING.LIB. If not, write to *
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
|
|
* Boston, MA 02110-1301, USA. *
|
|
*****************************************************************************/
|
|
|
|
#ifndef KFILEMETADATAMODEL_H
|
|
#define KFILEMETADATAMODEL_H
|
|
|
|
#include <kurl.h>
|
|
|
|
#include <QtCore/QHash>
|
|
#include <QtCore/QObject>
|
|
#include <QtCore/QString>
|
|
|
|
#include <config-kio.h>
|
|
|
|
class KFileItemList;
|
|
class KUrl;
|
|
class QWidget;
|
|
|
|
/**
|
|
* @brief Provides the data for the KMetaDataWidget.
|
|
*
|
|
* The default implementation provides all meta data that are available due to
|
|
* Strigi. If custom meta data should be added, the method
|
|
* KFileMetaDataProvider::loadData() must be overwritten.
|
|
*
|
|
* @see KFileMetaDataWidget
|
|
*/
|
|
class KFileMetaDataProvider : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit KFileMetaDataProvider(QObject* parent = 0);
|
|
virtual ~KFileMetaDataProvider();
|
|
|
|
/**
|
|
* 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().
|
|
*/
|
|
void setItems(const KFileItemList& items);
|
|
KFileItemList items() const;
|
|
|
|
/**
|
|
* @return Translated string for the label of the meta data represented
|
|
* by \p metaDataUri. If no custom translation is provided, the
|
|
* base implementation must be invoked.
|
|
*/
|
|
virtual QString label(const KUrl& metaDataUri) const;
|
|
|
|
/**
|
|
* 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.
|
|
* @return Returns the name of the group the meta data indicated
|
|
* by \p metaDataUri belongs to. Per default an empty string
|
|
* is returned.
|
|
*/
|
|
virtual QString group(const KUrl& metaDataUri) const;
|
|
|
|
/**
|
|
* @return 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).
|
|
*/
|
|
virtual QHash<KUrl, QVariant> data() const;
|
|
|
|
/**
|
|
* @return Factory method that returns a widget that should be used
|
|
* to show the meta data represented by \p 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.
|
|
*/
|
|
virtual QWidget* createValueWidget(const KUrl& metaDataUri,
|
|
const QVariant& value,
|
|
QWidget* parent) const;
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* Is emitted after the loading triggered by KFileMetaDataProvider::setItems()
|
|
* has been finished.
|
|
*/
|
|
void loadingFinished();
|
|
|
|
void urlActivated(const KUrl& url);
|
|
|
|
void dataChangeStarted();
|
|
void dataChangeFinished();
|
|
|
|
private:
|
|
class Private;
|
|
Private* const d;
|
|
|
|
Q_PRIVATE_SLOT(d, void slotLinkActivated(const QString&))
|
|
|
|
friend class KLoadMetaDataThread; // invokes KMetaDataObject::loadData()
|
|
};
|
|
|
|
#endif
|