Added QIcon::name()

This only works with icons loaded with QIcon::fromTheme() for now.

Merge-request: 2367
Reviewed-by: Olivier Goffart <olivier.goffart@nokia.com>
Reviewed-by: jbache

6 files changed, 74 insertions, 1 deletions

diff --git a/src/gui/image/qicon.cpp b/src/gui/image/qicon.cpp
index fad51f4..bc52e99 100644
--- a/src/gui/image/qicon.cpp
+++ b/src/gui/image/qicon.cpp
@@ -879,6 +879,25 @@ QList<QSize> QIcon::availableSizes(Mode mode, State state) const
 }
 
 /*!
+    \since 4.7
+
+    Returns the name used to create the icon, if available.
+
+    Depending on the way the icon was created, it may have an associated
+    name. This is the case for icons created with fromTheme() or icons
+    using a QIconEngine which supports the QIconEngineV2::IconNameHook.
+
+    \sa fromTheme(), QIconEngine
+*/
+QString QIcon::name() const
+{
+    if (!d || !d->engine || d->engine_version < 2)
+        return QString();
+    QIconEngineV2 *engine = static_cast<QIconEngineV2*>(d->engine);
+    return engine->iconName();
+}
+
+/*!
     \since 4.6
 
     Sets the search paths for icon themes to \a paths.
diff --git a/src/gui/image/qicon.h b/src/gui/image/qicon.h
index 2812703..faef07b 100644
--- a/src/gui/image/qicon.h
+++ b/src/gui/image/qicon.h
@@ -81,6 +81,8 @@ public:
 
     QSize actualSize(const QSize &size, Mode mode = Normal, State state = Off) const;
 
+    QString name() const;
+
     void paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment = Qt::AlignCenter, Mode mode = Normal, State state = Off) const;
     inline void paint(QPainter *painter, int x, int y, int w, int h, Qt::Alignment alignment = Qt::AlignCenter, Mode mode = Normal, State state = Off) const
         { paint(painter, QRect(x, y, w, h), alignment, mode, state); }
diff --git a/src/gui/image/qiconengine.cpp b/src/gui/image/qiconengine.cpp
index 4c7c728..050d48d 100644
--- a/src/gui/image/qiconengine.cpp
+++ b/src/gui/image/qiconengine.cpp
@@ -183,6 +183,10 @@ void QIconEngine::addFile(const QString &/*fileName*/, const QSize &/*size*/, QI
     that should be filled with icon sizes. Engines that work in terms
     of a scalable, vectorial format normally return an empty list.
 
+    \value IconNameHook Allows to query the name used to create the
+    icon, for example when instantiating an icon using
+    QIcon::fromTheme().
+
     \sa virtual_hook()
  */
 
@@ -301,4 +305,20 @@ QList<QSize> QIconEngineV2::availableSizes(QIcon::Mode mode, QIcon::State state)
     return arg.sizes;
 }
 
+/*!
+    \since 4.7
+
+    Returns the name used to create the engine, if available.
+
+    \note This is a helper method and the actual work is done by
+    virtual_hook() method, hence this method depends on icon engine support
+    and may not work with all icon engines.
+ */
+QString QIconEngineV2::iconName()
+{
+    QString name;
+    virtual_hook(QIconEngineV2::IconNameHook, reinterpret_cast<void*>(&name));
+    return name;
+}
+
 QT_END_NAMESPACE
diff --git a/src/gui/image/qiconengine.h b/src/gui/image/qiconengine.h
index 1f9266b..6d8b6ad 100644
--- a/src/gui/image/qiconengine.h
+++ b/src/gui/image/qiconengine.h
@@ -80,7 +80,7 @@ public:
     virtual void virtual_hook(int id, void *data);
 
 public:
-    enum IconEngineHook { AvailableSizesHook = 1 };
+    enum IconEngineHook { AvailableSizesHook = 1, IconNameHook };
 
     struct AvailableSizesArgument
     {
@@ -92,6 +92,9 @@ public:
     // ### Qt 5: make this function const and virtual.
     QList<QSize> availableSizes(QIcon::Mode mode = QIcon::Normal,
                                 QIcon::State state = QIcon::Off);
+
+    // ### Qt 5: make this function const and virtual.
+    QString iconName();
 };
 
 QT_END_NAMESPACE
diff --git a/src/gui/image/qiconloader.cpp b/src/gui/image/qiconloader.cpp
index 72ec2e8..a515ef8 100644
--- a/src/gui/image/qiconloader.cpp
+++ b/src/gui/image/qiconloader.cpp
@@ -554,6 +554,12 @@ void QIconLoaderEngine::virtual_hook(int id, void *data)
             }
         }
         break;
+    case QIconEngineV2::IconNameHook:
+        {
+            QString &name = *reinterpret_cast<QString*>(data);
+            name = m_iconName;
+        }
+        break;
     default:
         QIconEngineV2::virtual_hook(id, data);
     }
diff --git a/tests/auto/qicon/tst_qicon.cpp b/tests/auto/qicon/tst_qicon.cpp
index fae9cc0..e68664c 100644
--- a/tests/auto/qicon/tst_qicon.cpp
+++ b/tests/auto/qicon/tst_qicon.cpp
@@ -76,6 +76,7 @@ private slots:
     void svg();
     void addFile();
     void availableSizes();
+    void name();
     void streamAvailableSizes_data();
     void streamAvailableSizes();
     void fromTheme();
@@ -550,6 +551,28 @@ void tst_QIcon::availableSizes()
     }
 }
 
+void tst_QIcon::name()
+{
+    {
+        // No name if icon does not come from a theme
+        QIcon icon(":/image.png");
+        QString name = icon.name();
+        QVERIFY(name.isEmpty());
+    }
+
+    {
+        // Getting the name of an icon coming from a theme should work
+        QString searchPath = QLatin1String(":/icons");
+        QIcon::setThemeSearchPaths(QStringList() << searchPath);
+        QString themeName("testtheme");
+        QIcon::setThemeName(themeName);
+
+        QIcon icon = QIcon::fromTheme("appointment-new");
+        QString name = icon.name();
+        QCOMPARE(name, QLatin1String("appointment-new"));
+    }
+}
+
 void tst_QIcon::streamAvailableSizes_data()
 {
     QTest::addColumn<QIcon>("icon");