File indexing completed on 2024-05-05 16:08:25

 /*****************************************************************************
  * 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 <QHash>
 #include <QObject>
 #include <QString>
 
 #include <config-kdelibs4support.h>
 #if ! KIO_NO_NEPOMUK
 #define DISABLE_NEPOMUK_LEGACY
 #include <variant.h>
 #endif
 
 class KFileItemList;
 class QUrl;
 class QWidget;
 
 /**
  * @brief 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 KFileMetaDataWidget
  */
 class KFileMetaDataProvider : public QObject
 {
     Q_OBJECT
 
 public:
     KDELIBS4SUPPORT_DEPRECATED 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;
 
     /**
      * 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 QUrl &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 QUrl &metaDataUri) const;
 
 #if ! KIO_NO_NEPOMUK
     /**
      * @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<QUrl, Nepomuk::Variant> 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 QUrl &metaDataUri,
                                        const Nepomuk::Variant &value,
                                        QWidget *parent) const;
 #endif
 
 Q_SIGNALS:
     /**
      * Is emitted after the loading triggered by KFileMetaDataProvider::setItems()
      * has been finished.
      */
     void loadingFinished();
 
     void urlActivated(const QUrl &url);
 
     void dataChangeStarted();
     void dataChangeFinished();
 
 private:
     class Private;
     Private *const d;
 
     Q_PRIVATE_SLOT(d, void slotLoadingFinished())
     Q_PRIVATE_SLOT(d, void slotRatingChanged(unsigned int rating))
     Q_PRIVATE_SLOT(d, void slotTagsChanged(const QList<Nepomuk::Tag> &tags))
     Q_PRIVATE_SLOT(d, void slotCommentChanged(const QString &comment))
     Q_PRIVATE_SLOT(d, void slotTagClicked(const Nepomuk::Tag &tag))
     Q_PRIVATE_SLOT(d, void slotLinkActivated(const QString &))
 
     friend class KLoadMetaDataThread; // invokes KMetaDataObject::loadData()
 };
 
 #endif