Fix rating pixmap alignment on high-dpi screens

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

diff --git a/src/kitemviews/kstandarditem.h b/src/kitemviews/kstandarditem.h
index 0315f4bf6eab2fbd4d8a036d5e04cc9156c9c5b1..fb64b334d96f39e43f59b860079d02f90bde336d 100644 (file)
--- a/src/kitemviews/kstandarditem.h
+++ b/src/kitemviews/kstandarditem.h
@@ -1,69 +1,78 @@
-/***************************************************************************
- *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program 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 General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef KSTANDARDITEM_H
 #define KSTANDARDITEM_H
 
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
 
-#include <QIcon>
-#include <QList>
+#include <QByteArray>
+#include <QHash>
+#include <QObject>
+#include <QSet>
+#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
+class DOLPHIN_EXPORT KStandardItem : public QObject
 {
-
+    Q_OBJECT
 public:
-    explicit KStandardItem(KStandardItem* parent = 0);
-    explicit KStandardItem(const QString& text, KStandardItem* parent = 0);
-    KStandardItem(const QIcon& icon, const QString& text, KStandardItem* parent = 0);
-    virtual ~KStandardItem();
-
+    explicit KStandardItem(KStandardItem* parent = nullptr);
+    explicit KStandardItem(const QString& text, KStandardItem* parent = nullptr);
+    KStandardItem(const QString& icon, const QString& text, KStandardItem* parent = nullptr);
+    ~KStandardItem() override;
+
+    /**
+     * 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 setParent(KStandardItem* parent);
-    KStandardItem* parent() const;
+    void setDataValue(const QByteArray& role, const QVariant& value);
+    QVariant dataValue(const QByteArray& role) 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;
 };