Make using recent expressions API simpler and add doxygen comment

m-kuhn · m-kuhn · commit febcabb0da8d · 2016-07-07T16:39:13.000+02:00
diff --git a/python/gui/qgsexpressionbuilderwidget.sip b/python/gui/qgsexpressionbuilderwidget.sip
@@ -141,9 +141,17 @@ class QgsExpressionBuilderWidget : QWidget
 
     bool isExpressionValid();
 
-    void saveToRecent( const QString& key );
+    /**
+     * Adds the current expression to the given collection.
+     * By default it is saved to the collection "generic".
+     */
+    void saveToRecent( const QString& collection = "generic" );
 
-    void loadRecent( const QString& key );
+    /**
+     * Loads the recent expressions from the given collection.
+     * By default it is loaded from the collection "generic".
+     */
+    void loadRecent( const QString& collection = "generic" );
 
     /** Create a new file in the function editor
      */
diff --git a/src/gui/qgsexpressionbuilderwidget.cpp b/src/gui/qgsexpressionbuilderwidget.cpp
@@ -399,10 +399,10 @@ bool QgsExpressionBuilderWidget::isExpressionValid()
   return mExpressionValid;
 }
 
-void QgsExpressionBuilderWidget::saveToRecent( const QString& key )
+void QgsExpressionBuilderWidget::saveToRecent( const QString& collection )
 {
   QSettings settings;
-  QString location = QString( "/expressions/recent/%1" ).arg( key );
+  QString location = QString( "/expressions/recent/%1" ).arg( collection );
   QStringList expressions = settings.value( location ).toStringList();
   expressions.removeAll( this->expressionText() );
 
@@ -414,21 +414,21 @@ void QgsExpressionBuilderWidget::saveToRecent( const QString& key )
   }
 
   settings.setValue( location, expressions );
-  this->loadRecent( key );
+  this->loadRecent( collection );
 }
 
-void QgsExpressionBuilderWidget::loadRecent( const QString& key )
+void QgsExpressionBuilderWidget::loadRecent( const QString& collection )
 {
-  mRecentKey = key;
-  QString name = tr( "Recent (%1)" ).arg( key );
+  mRecentKey = collection;
+  QString name = tr( "Recent (%1)" ).arg( collection );
   if ( mExpressionGroups.contains( name ) )
   {
     QgsExpressionItem* node = mExpressionGroups.value( name );
     node->removeRows( 0, node->rowCount() );
   }
 
   QSettings settings;
-  QString location = QString( "/expressions/recent/%1" ).arg( key );
+  QString location = QString( "/expressions/recent/%1" ).arg( collection );
   QStringList expressions = settings.value( location ).toStringList();
   int i = 0;
   Q_FOREACH ( const QString& expression, expressions )
diff --git a/src/gui/qgsexpressionbuilderwidget.h b/src/gui/qgsexpressionbuilderwidget.h
@@ -186,9 +186,17 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp
 
     bool isExpressionValid();
 
-    void saveToRecent( const QString& key );
+    /**
+     * Adds the current expression to the given collection.
+     * By default it is saved to the collection "generic".
+     */
+    void saveToRecent( const QString& collection = "generic" );
 
-    void loadRecent( const QString& key );
+    /**
+     * Loads the recent expressions from the given collection.
+     * By default it is loaded from the collection "generic".
+     */
+    void loadRecent( const QString& collection = "generic" );
 
     /** Create a new file in the function editor
      */

Original file line number	Diff line number	Diff line change
`@@ -399,10 +399,10 @@ bool QgsExpressionBuilderWidget::isExpressionValid()`
`399`	`399`	`return mExpressionValid;`
`400`	`400`	`}`
`401`	`401`
`402`		`-void QgsExpressionBuilderWidget::saveToRecent( const QString& key )`
	`402`	`+void QgsExpressionBuilderWidget::saveToRecent( const QString& collection )`
`403`	`403`	`{`
`404`	`404`	`QSettings settings;`
`405`		`- QString location = QString( "/expressions/recent/%1" ).arg( key );`
	`405`	`+ QString location = QString( "/expressions/recent/%1" ).arg( collection );`
`406`	`406`	`QStringList expressions = settings.value( location ).toStringList();`
`407`	`407`	`expressions.removeAll( this->expressionText() );`
`408`	`408`
`@@ -414,21 +414,21 @@ void QgsExpressionBuilderWidget::saveToRecent( const QString& key )`
`414`	`414`	`}`
`415`	`415`
`416`	`416`	`settings.setValue( location, expressions );`
`417`		`- this->loadRecent( key );`
	`417`	`+ this->loadRecent( collection );`
`418`	`418`	`}`
`419`	`419`
`420`		`-void QgsExpressionBuilderWidget::loadRecent( const QString& key )`
	`420`	`+void QgsExpressionBuilderWidget::loadRecent( const QString& collection )`
`421`	`421`	`{`
`422`		`- mRecentKey = key;`
`423`		`- QString name = tr( "Recent (%1)" ).arg( key );`
	`422`	`+ mRecentKey = collection;`
	`423`	`+ QString name = tr( "Recent (%1)" ).arg( collection );`
`424`	`424`	`if ( mExpressionGroups.contains( name ) )`
`425`	`425`	`{`
`426`	`426`	`QgsExpressionItem* node = mExpressionGroups.value( name );`
`427`	`427`	`node->removeRows( 0, node->rowCount() );`
`428`	`428`	`}`
`429`	`429`
`430`	`430`	`QSettings settings;`
`431`		`- QString location = QString( "/expressions/recent/%1" ).arg( key );`
	`431`	`+ QString location = QString( "/expressions/recent/%1" ).arg( collection );`
`432`	`432`	`QStringList expressions = settings.value( location ).toStringList();`
`433`	`433`	`int i = 0;`
`434`	`434`	`Q_FOREACH ( const QString& expression, expressions )`