File indexing completed on 2024-04-21 08:28:58

 /*
     SPDX-FileCopyrightText: 2010 Peter Penz <peter.penz@gmx.at>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef _BALOO_FILEMETADATAPROVIDER_H
 #define _BALOO_FILEMETADATAPROVIDER_H
 
 #include <QObject>
 #include <QString>
 #include <QVariant>
 
 #include <KFileItem>
 
 namespace Baloo
 {
 class FileMetaDataProviderPrivate;
 
 /**
  * @brief 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 FileMetaDataWidget
  */
 class FileMetaDataProvider : public QObject
 {
     Q_OBJECT
 
 public:
     explicit FileMetaDataProvider(QObject *parent = nullptr);
     ~FileMetaDataProvider() override;
 
     /**
      * 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;
 
     /**
      * 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.
      */
     void setReadOnly(bool readOnly);
     bool isReadOnly() 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 QString &metaDataLabel) 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 label belongs to. Per default an empty string
      *         is returned.
      */
     virtual QString group(const QString &label) 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).
      */
     QVariantMap data() const;
 
 Q_SIGNALS:
     /**
      * Emitted once per KFileMetaDataProvider::setItems()
      * after data loading is finished.
      */
     void loadingFinished();
 
 private:
     FileMetaDataProviderPrivate *d;
 };
 
 }
 #endif