Merge branch 'Applications/16.04'

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

diff --git a/src/kitemviews/kitemmodelbase.h b/src/kitemviews/kitemmodelbase.h
index edca15bd1c68331b4255ce7bedc1a2fdc0703cb4..bd5ca1d652cfb8f7b9bad39704f9d03395a08887 100644 (file)
--- a/src/kitemviews/kitemmodelbase.h
+++ b/src/kitemviews/kitemmodelbase.h
@@ -23,29 +23,21 @@
 #ifndef KITEMMODELBASE_H
 #define KITEMMODELBASE_H
 
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
+
+#include <kitemviews/kitemrange.h>
+#include <kitemviews/kitemset.h>
 
 #include <QHash>
 #include <QObject>
-#include <QSet>
 #include <QVariant>
 
 class QMimeData;
 
-struct KItemRange
-{
-    KItemRange(int index = 0, int count = 0);
-    int index;
-    int count;
-
-    bool operator == (const KItemRange& other) const;
-};
-typedef QList<KItemRange> KItemRangeList;
-
 /**
  * @brief Base class for model implementations used by KItemListView and KItemListController.
  *
- * A item-model consists of a variable number of items. The number of items
+ * An item-model consists of a variable number of items. The number of items
  * is given by KItemModelBase::count(). The data of an item is accessed by a unique index
  * with KItemModelBase::data(). The indexes are integer-values counting from 0 to the
  * KItemModelBase::count() - 1.
@@ -53,14 +45,17 @@ typedef QList<KItemRange> KItemRangeList;
  * One item consists of a variable number of role/value-pairs.
  *
  * A model can optionally provide sorting- and grouping-capabilities.
+ *
+ * Also optionally it is possible to provide a tree of items by implementing the methods
+ * setExpanded(), isExpanded(), isExpandable() and expandedParentsCount().
  */
-class LIBDOLPHINPRIVATE_EXPORT KItemModelBase : public QObject
+class DOLPHIN_EXPORT KItemModelBase : public QObject
 {
     Q_OBJECT
 
 public:
     KItemModelBase(QObject* parent = 0);
-    KItemModelBase(const QByteArray& sortRole, QObject* parent = 0);
+    explicit KItemModelBase(const QByteArray& sortRole, QObject* parent = 0);
     virtual ~KItemModelBase();
 
     /** @return The number of items. */
@@ -116,12 +111,45 @@ public:
      */
     virtual QList<QPair<int, QVariant> > groups() const;
 
+    /**
+     * Expands the item with the index \a index if \a expanded is true.
+     * If \a expanded is false the item will be collapsed.
+     *
+     * Per default no expanding of items is implemented. When implementing
+     * this method it is mandatory to overwrite KItemModelBase::isExpandable()
+     * and KItemListView::supportsExpandableItems() to return true.
+     *
+     * @return True if the operation has been successful.
+     */
+    virtual bool setExpanded(int index, bool expanded);
+
+    /**
+     * @return True if the item with the index \a index is expanded.
+     *         Per default no expanding of items is implemented. When implementing
+     *         this method it is mandatory to overwrite KItemModelBase::isExpandable()
+     *         and KItemListView::supportsExpandableItems() to return true.
+     */
+    virtual bool isExpanded(int index) const;
+
+    /**
+     * @return True if expanding and collapsing of the item with the index \a index
+     *         is supported. Per default false is returned.
+     */
+    virtual bool isExpandable(int index) const;
+
+    /**
+     * @return Number of expanded parent items for the item with the given index.
+     *         Per default 0 is returned.
+     */
+    virtual int expandedParentsCount(int index) const;
+
     /**
      * @return MIME-data for the items given by \a indexes. The default implementation
      *         returns 0. The ownership of the returned instance is in the hand of the
-     *         caller of this method.
+     *         caller of this method. The method must be implemented if dragging of
+     *         items should be possible.
      */
-    virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
+    virtual QMimeData* createMimeData(const KItemSet& indexes) const;
 
     /**
      * @return Reimplement this to return the index for the first item
@@ -182,11 +210,20 @@ signals:
      * with the items 5 and 6 then the parameters look like this:
      * - itemRange: has the index 0 and a count of 7.
      * - movedToIndexes: Contains the seven values 5, 6, 2, 3, 4, 0, 1
+     *
+     * This signal implies that the groups might have changed. Therefore,
+     * gropusChanged() is not emitted if this signal is emitted.
      */
     void itemsMoved(const KItemRange& itemRange, const QList<int>& movedToIndexes);
 
     void itemsChanged(const KItemRangeList& itemRanges, const QSet<QByteArray>& roles);
 
+    /**
+     * Is emitted if the groups have changed, even though the order of the
+     * items has not been modified.
+     */
+    void groupsChanged();
+
     void groupedSortingChanged(bool current);
     void sortRoleChanged(const QByteArray& current, const QByteArray& previous);
     void sortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);