Add method to retrieve most recently used color

qgis · Sep 14, 2016 · b4d9f64 · b4d9f64
1 parent 2c3548d
commit b4d9f64
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 1 deletion.
diff --git a/python/core/qgscolorscheme.sip b/python/core/qgscolorscheme.sip
@@ -204,8 +204,15 @@ class QgsRecentColorScheme : QgsColorScheme
     /** Adds a color to the list of recent colors.
      * @param color color to add
      * @note added in QGIS 2.14
+     * @see lastUsedColor()
      */
     static void addRecentColor( const QColor& color );
+
+    /** Returns the most recently used color.
+     * @note added in QGIS 3.0
+     * @see addRecentColor()
+     */
+    static QColor lastUsedColor();
 };
 
 /** \ingroup core

diff --git a/src/core/qgscolorscheme.cpp b/src/core/qgscolorscheme.cpp
@@ -117,6 +117,18 @@ void QgsRecentColorScheme::addRecentColor( const QColor& color )
   settings.setValue( QString( "/colors/recent" ), recentColorVariants );
 }
 
+QColor QgsRecentColorScheme::lastUsedColor()
+{
+  //fetch recent colors
+  QSettings settings;
+  QList< QVariant > recentColorVariants = settings.value( QString( "/colors/recent" ) ).toList();
+
+  if ( recentColorVariants.isEmpty() )
+    return QColor();
+
+  return recentColorVariants.at( 0 ).value<QColor>();
+}
+
 
 QgsCustomColorScheme::QgsCustomColorScheme() : QgsColorScheme()
 {

diff --git a/src/core/qgscolorscheme.h b/src/core/qgscolorscheme.h
@@ -205,8 +205,15 @@ class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme
     /** Adds a color to the list of recent colors.
      * @param color color to add
      * @note added in QGIS 2.14
+     * @see lastUsedColor()
      */
     static void addRecentColor( const QColor& color );
+
+    /** Returns the most recently used color.
+     * @note added in QGIS 3.0
+     * @see addRecentColor()
+     */
+    static QColor lastUsedColor();
 };
 
 /** \ingroup core

diff --git a/tests/src/python/test_qgscolorscheme.py b/tests/src/python/test_qgscolorscheme.py
@@ -15,7 +15,7 @@
 import qgis  # NOQA
 
 from qgis.testing import unittest, start_app
-from qgis.core import QgsColorScheme, QgsUserColorScheme
+from qgis.core import QgsColorScheme, QgsUserColorScheme, QgsRecentColorScheme
 from qgis.PyQt.QtCore import QCoreApplication, QSettings
 from qgis.PyQt.QtGui import QColor
 
@@ -113,6 +113,18 @@ def testUserScheme(self):
 
         scheme.erase()
 
+    def testRecentColors(self):
+        """ test retrieving recent colors """
+
+        # no colors
+        self.assertFalse(QgsRecentColorScheme().lastUsedColor().isValid())
+
+        # add a recent color
+        QgsRecentColorScheme().addRecentColor(QColor(255, 0, 0))
+        self.assertEqual(QgsRecentColorScheme().lastUsedColor(), QColor(255, 0, 0))
+        QgsRecentColorScheme().addRecentColor(QColor(0, 255, 0))
+        self.assertEqual(QgsRecentColorScheme().lastUsedColor(), QColor(0, 255, 0))
+
 
 if __name__ == "__main__":
     unittest.main()