Allow showing Nepomuk metadata inside views

[dolphin.git] / src / kitemviews / kfileitemmodelrolesupdater.h

diff --git a/src/kitemviews/kfileitemmodelrolesupdater.h b/src/kitemviews/kfileitemmodelrolesupdater.h
index 3b173567e14105a41ba9593a44b1598b8908c6b5..47255b03fe3ef08991d58c462f760866da8d8944 100644 (file)
--- a/src/kitemviews/kfileitemmodelrolesupdater.h
+++ b/src/kitemviews/kfileitemmodelrolesupdater.h
@@ -20,6 +20,7 @@
 #ifndef KFILEITEMMODELROLESUPDATER_H
 #define KFILEITEMMODELROLESUPDATER_H
 
+#include <config-nepomuk.h>
 #include <libdolphin_export.h>
 
 #include <KFileItem>
@@ -47,7 +48,7 @@ class LIBDOLPHINPRIVATE_EXPORT KFileItemModelRolesUpdater : public QObject
     Q_OBJECT
 
 public:
-    KFileItemModelRolesUpdater(KFileItemModel* model, QObject* parent = 0);
+    explicit KFileItemModelRolesUpdater(KFileItemModel* model, QObject* parent = 0);
     virtual ~KFileItemModelRolesUpdater();
 
     void setIconSize(const QSize& size);
@@ -82,13 +83,10 @@ public:
     QSet<QByteArray> roles() const;
 
     /**
-     * Sets the list of enabled thumbnail plugins.
+     * Sets the list of enabled thumbnail plugins that are used for previews.
      * Per default all plugins enabled in the KConfigGroup "PreviewSettings"
      * are used.
      *
-     * Note that this method doesn't cause already generated previews
-     * to be regenerated.
-     *
      * For a list of available plugins, call KServiceTypeTrader::self()->query("ThumbCreator").
      *
      * @see enabledPlugins
@@ -107,24 +105,53 @@ private slots:
     void slotItemsChanged(const KItemRangeList& itemRanges,
                           const QSet<QByteArray>& roles);
 
+    /**
+     * Is invoked after a preview has been received successfully.
+     * @see startPreviewJob()
+     */
     void slotGotPreview(const KFileItem& item, const QPixmap& pixmap);
+
+    /**
+     * Is invoked after generating a preview has failed.
+     * @see startPreviewJob()
+     */
     void slotPreviewFailed(const KFileItem& item);
 
     /**
      * Is invoked when the preview job has been finished and
      * removes the job from the m_previewJobs list.
+     * @see startPreviewJob()
      */
     void slotPreviewJobFinished(KJob* job);
 
-    void resolvePendingRoles();
     void resolveNextPendingRoles();
 
+    /**
+     * Resolves items that have not been resolved yet after the change has been
+     * notified by slotItemsChanged(). Is invoked if the m_changedItemsTimer
+     * exceeds.
+     */
+    void resolveChangedItems();
+
 private:
+    /**
+     * Updates the roles for the given item ranges. The roles for the currently
+     * visible items will get updated first.
+     */
+    void startUpdating(const KItemRangeList& itemRanges);
+
+    /**
+     * Creates previews for the items starting from the first item of the
+     * given list.
+     * @see slotGotPreview()
+     * @see slotPreviewFailed()
+     * @see slotPreviewJobFinished()
+     */
     void startPreviewJob(const KFileItemList& items);
 
     bool hasPendingRoles() const;
+    void resolvePendingRoles();
     void resetPendingRoles();
-    void triggerPendingRolesResolving(int count);
     void sortAndResolveAllRoles();
     void sortAndResolvePendingRoles();
 
@@ -137,7 +164,10 @@ private:
 
     KFileItemList sortedItems(const QSet<KFileItem>& items) const;
 
-    static int subDirectoriesCount(const QString& path);
+    /**
+     * @return The number of items of the path \a path.
+     */
+    int subItemsCount(const QString& path) const;
 
 private:
     // Property for setPaused()/isPaused().
@@ -168,7 +198,20 @@ private:
     QSet<KFileItem> m_pendingInvisibleItems;
     QList<KJob*> m_previewJobs;
 
-    QTimer* m_resolvePendingRolesTimer;
+    // When downloading or copying large files, the slot slotItemsChanged()
+    // will be called periodically within a quite short delay. To prevent
+    // a high CPU-load by generating e.g. previews for each notification, the update
+    // will be postponed until no file change has been done within a longer period
+    // of time.
+    QTimer* m_changedItemsTimer;
+    QSet<KFileItem> m_changedItems;
+
+#ifdef HAVE_NEPOMUK
+    // True if roles must be resolved with the help of Nepomuk inside
+    // KFileItemModelRolesUpdater::rolesData().
+    bool m_resolveNepomukRoles;
+#endif
+
 };
 
 #endif