Merge branch 'master' into frameworks

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

diff --git a/src/kitemviews/kstandarditem.h b/src/kitemviews/kstandarditem.h
index 0315f4bf6eab2fbd4d8a036d5e04cc9156c9c5b1..689db42519f6f8b5f3369677fc694515408b68ea 100644 (file)
--- a/src/kitemviews/kstandarditem.h
+++ b/src/kitemviews/kstandarditem.h
@@ -22,16 +22,20 @@
 
 #include <libdolphin_export.h>
 
+#include <QByteArray>
+#include <QHash>
 #include <QIcon>
 #include <QList>
+#include <QVariant>
 
 class KStandardItemModel;
 
 /**
  * @brief Represents and item of KStandardItemModel.
  *
- * Provides setter- and getter-methods for most commonly
- * used properties.
+ * Provides setter- and getter-methods for the most commonly
+ * used roles. It is possible to assign values for custom
+ * roles by using setDataValue().
  */
 class LIBDOLPHINPRIVATE_EXPORT KStandardItem
 {
@@ -39,31 +43,57 @@ class LIBDOLPHINPRIVATE_EXPORT KStandardItem
 public:
     explicit KStandardItem(KStandardItem* parent = 0);
     explicit KStandardItem(const QString& text, KStandardItem* parent = 0);
-    KStandardItem(const QIcon& icon, const QString& text, KStandardItem* parent = 0);
+    KStandardItem(const QString& icon, const QString& text, KStandardItem* parent = 0);
+    KStandardItem(const KStandardItem& item);
     virtual ~KStandardItem();
 
+    /**
+     * Sets the text for the "text"-role.
+     */
     void setText(const QString& text);
     QString text() const;
 
-    void setIcon(const QIcon& icon);
-    QIcon icon() const;
+    /**
+     * Sets the icon for the "iconName"-role.
+     */
+    void setIcon(const QString& icon);
+    QString icon() const;
 
+    void setIconOverlays(const QStringList& overlays);
+    QStringList iconOverlays() const;
+
+    /**
+     * Sets the group for the "group"-role.
+     */
     void setGroup(const QString& group);
     QString group() const;
 
+    void setDataValue(const QByteArray& role, const QVariant& value);
+    QVariant dataValue(const QByteArray& role) const;
+
     void setParent(KStandardItem* parent);
     KStandardItem* parent() const;
 
+    void setData(const QHash<QByteArray, QVariant>& values);
+    QHash<QByteArray, QVariant> data() const;
+
     QList<KStandardItem*> children() const;
 
+protected:
+    virtual void onDataValueChanged(const QByteArray& role,
+                                    const QVariant& current,
+                                    const QVariant& previous);
+
+    virtual void onDataChanged(const QHash<QByteArray, QVariant>& current,
+                               const QHash<QByteArray, QVariant>& previous);
+
 private:
-    QString m_text;
-    QIcon m_icon;
-    QString m_group;
     KStandardItem* m_parent;
     QList<KStandardItem*> m_children;
     KStandardItemModel* m_model;
 
+    QHash<QByteArray, QVariant> m_data;
+
     friend class KStandardItemModel;
 };