Version control: show pixmap overlays for the version state

2 files changed, 95 insertions, 26 deletions

diff --git a/src/views/dolphinfileitemlistwidget.cpp b/src/views/dolphinfileitemlistwidget.cpp
index c3ec2b8de..a3fac7b2e 100644
--- a/src/views/dolphinfileitemlistwidget.cpp
+++ b/src/views/dolphinfileitemlistwidget.cpp
@@ -19,7 +19,8 @@
 
 #include "dolphinfileitemlistwidget.h"
 
-#include <kversioncontrolplugin.h>
+#include <KIcon>
+#include <KIconLoader>
 #include <QColor>
 
 #include <KDebug>
@@ -38,39 +39,97 @@ void DolphinFileItemListWidget::dataChanged(const QHash<QByteArray, QVariant>& c
     KFileItemListWidget::dataChanged(current, roles);
 
     QColor color;
+    QPixmap overlay;
     if (roles.contains("version")) {
         // The item is under version control. Apply the text color corresponding
         // to its version state.
         const KVersionControlPlugin::VersionState version = static_cast<KVersionControlPlugin::VersionState>(current.value("version").toInt());
-        if (version != KVersionControlPlugin::UnversionedVersion) {
-            const QColor textColor = styleOption().palette.text().color();
-            QColor tintColor = textColor;
+        const QColor textColor = styleOption().palette.text().color();
+        QColor tintColor = textColor;
 
-            // Using hardcoded colors is generally a bad idea. In this case the colors just act
-            // as tint colors and are mixed with the current set text color. The tint colors
-            // have been optimized for the base colors of the corresponding Oxygen emblems.
-            switch (version) {
-            case KVersionControlPlugin::UpdateRequiredVersion:          tintColor = Qt::yellow; break;
-            case KVersionControlPlugin::LocallyModifiedUnstagedVersion: tintColor = Qt::darkGreen; break;
-            case KVersionControlPlugin::LocallyModifiedVersion:         tintColor = Qt::green; break;
-            case KVersionControlPlugin::AddedVersion:                   tintColor = Qt::green; break;
-            case KVersionControlPlugin::RemovedVersion:                 tintColor = Qt::darkRed; break;
-            case KVersionControlPlugin::ConflictingVersion:             tintColor = Qt::red; break;
-            case KVersionControlPlugin::UnversionedVersion:
-            case KVersionControlPlugin::NormalVersion:
-            default:
-                 // use the default text color
-                 return;
-            }
-
-            color = QColor((tintColor.red()   + textColor.red())   / 2,
-                           (tintColor.green() + textColor.green()) / 2,
-                           (tintColor.blue()  + textColor.blue())  / 2,
-                           (tintColor.alpha() + textColor.alpha()) / 2);
+        // Using hardcoded colors is generally a bad idea. In this case the colors just act
+        // as tint colors and are mixed with the current set text color. The tint colors
+        // have been optimized for the base colors of the corresponding Oxygen emblems.
+        switch (version) {
+        case KVersionControlPlugin::UpdateRequiredVersion:          tintColor = Qt::yellow; break;
+        case KVersionControlPlugin::LocallyModifiedUnstagedVersion: tintColor = Qt::green; break;
+        case KVersionControlPlugin::LocallyModifiedVersion:         tintColor = Qt::green; break;
+        case KVersionControlPlugin::AddedVersion:                   tintColor = Qt::green; break;
+        case KVersionControlPlugin::RemovedVersion:                 tintColor = Qt::darkRed; break;
+        case KVersionControlPlugin::ConflictingVersion:             tintColor = Qt::red; break;
+        case KVersionControlPlugin::UnversionedVersion:             tintColor = Qt::white; break;
+        case KVersionControlPlugin::NormalVersion:
+        default:
+            break;
         }
+
+        color = QColor((tintColor.red()   + textColor.red())   / 2,
+                       (tintColor.green() + textColor.green()) / 2,
+                       (tintColor.blue()  + textColor.blue())  / 2,
+                       (tintColor.alpha() + textColor.alpha()) / 2);
+
+        overlay = overlayForState(version, styleOption().iconSize);
     }
 
     setTextColor(color);
+    setOverlay(overlay);
+}
+
+void DolphinFileItemListWidget::styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous)
+{
+    KFileItemListWidget::styleOptionChanged(current, previous);
+
+    if (!overlay().isNull() && current.iconSize != previous.iconSize) {
+        const KVersionControlPlugin::VersionState version = static_cast<KVersionControlPlugin::VersionState>(data().value("version").toInt());
+        const QPixmap newOverlay = overlayForState(version, current.iconSize);
+        setOverlay(newOverlay);
+    }
+}
+
+QPixmap DolphinFileItemListWidget::overlayForState(KVersionControlPlugin::VersionState version, int size)
+{
+    int overlayHeight = KIconLoader::SizeSmall;
+    if (size >= KIconLoader::SizeEnormous) {
+        overlayHeight = KIconLoader::SizeMedium;
+    } else if (size >= KIconLoader::SizeLarge) {
+        overlayHeight = KIconLoader::SizeSmallMedium;
+    } else if (size >= KIconLoader::SizeMedium) {
+        overlayHeight = KIconLoader::SizeSmall;
+    } else {
+        overlayHeight = KIconLoader::SizeSmall / 2;
+    }
+
+    QString iconName;
+    switch (version) {
+    case KVersionControlPlugin::NormalVersion:
+        iconName = "vcs-normal";
+        break;
+    case KVersionControlPlugin::UpdateRequiredVersion:
+        iconName = "vcs-update-required";
+        break;
+    case KVersionControlPlugin::LocallyModifiedVersion:
+        iconName = "vcs-locally-modified";
+        break;
+    case KVersionControlPlugin::LocallyModifiedUnstagedVersion:
+        iconName = "vcs-locally-modified-unstaged";
+        break;
+    case KVersionControlPlugin::AddedVersion:
+        iconName = "vcs-added";
+        break;
+    case KVersionControlPlugin::RemovedVersion:
+        iconName = "vcs-removed";
+        break;
+    case KVersionControlPlugin::ConflictingVersion:
+        iconName = "vcs-conflicting";
+        break;
+    case KVersionControlPlugin::UnversionedVersion:
+        break;
+    default:
+        Q_ASSERT(false);
+        break;
+    }
+
+    return KIcon(iconName).pixmap(QSize(overlayHeight, overlayHeight));
 }
 
 #include "dolphinfileitemlistwidget.moc"
diff --git a/src/views/dolphinfileitemlistwidget.h b/src/views/dolphinfileitemlistwidget.h
index d94a9810e..b08b96428 100644
--- a/src/views/dolphinfileitemlistwidget.h
+++ b/src/views/dolphinfileitemlistwidget.h
@@ -23,7 +23,14 @@
 #include <libdolphin_export.h>
 
 #include <kitemviews/kfileitemlistwidget.h>
+#include <kversioncontrolplugin.h>
 
+/**
+ * @brief Extends KFileItemListWidget to handle the "version" role.
+ *
+ * The "version" role is set if version-control-plugins have been enabled.
+ * @see KVersionControlPlugin
+ */
 class LIBDOLPHINPRIVATE_EXPORT DolphinFileItemListWidget : public KFileItemListWidget
 {
     Q_OBJECT
@@ -33,8 +40,11 @@ public:
     virtual ~DolphinFileItemListWidget();
 
 protected:
-    /** @reimp */
     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
+    virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
+
+private:
+    static QPixmap overlayForState(KVersionControlPlugin::VersionState state, int size);
 
 };