Invalidate current locator results when locator options are changed

nyalldawson · nyalldawson · commit df9d9f674875 · 2017-05-17T21:33:48.000+10:00
diff --git a/python/gui/locator/qgslocatorwidget.sip b/python/gui/locator/qgslocatorwidget.sip
@@ -49,6 +49,12 @@ class QgsLocatorWidget : QWidget
  Triggers the locator widget to focus, open and start searching for a specified ``string``.
 %End
 
+    void invalidateResults();
+%Docstring
+ Invalidates the current search results, e.g. as a result of changes to the locator
+ filter settings.
+%End
+
   signals:
 
     void configTriggered();
diff --git a/src/app/locator/qgslocatoroptionswidget.cpp b/src/app/locator/qgslocatoroptionswidget.cpp
@@ -16,11 +16,13 @@
  ***************************************************************************/
 
 #include "qgslocatoroptionswidget.h"
+#include "qgslocatorwidget.h"
 #include "qgssettings.h"
 
-QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocator *locator, QWidget *parent )
+QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocatorWidget *locator, QWidget *parent )
   : QWidget( parent )
-  , mLocator( locator )
+  , mLocatorWidget( locator )
+  , mLocator( locator->locator() )
 {
   setupUi( this );
 
@@ -34,6 +36,7 @@ QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocator *locator, QWidget *
 void QgsLocatorOptionsWidget::commitChanges()
 {
   mModel->commitChanges();
+  mLocatorWidget->invalidateResults();
 }
 
 
diff --git a/src/app/locator/qgslocatoroptionswidget.h b/src/app/locator/qgslocatoroptionswidget.h
@@ -23,21 +23,23 @@
 #include "ui_qgslocatoroptionswidgetbase.h"
 
 class QgsLocatorFiltersModel;
+class QgsLocatorWidget;
 
 class QgsLocatorOptionsWidget : public QWidget, private Ui::QgsLocatorOptionsWidgetBase
 {
     Q_OBJECT
 
   public:
 
-    QgsLocatorOptionsWidget( QgsLocator *locator, QWidget *parent = nullptr );
+    QgsLocatorOptionsWidget( QgsLocatorWidget *locator, QWidget *parent = nullptr );
 
   public slots:
 
     void commitChanges();
 
   private:
 
+    QgsLocatorWidget *mLocatorWidget = nullptr;
     QgsLocator *mLocator = nullptr;
     QgsLocatorFiltersModel *mModel = nullptr;
 };
diff --git a/src/app/qgsoptions.cpp b/src/app/qgsoptions.cpp
@@ -943,7 +943,7 @@ QgsOptions::QgsOptions( QWidget *parent, Qt::WindowFlags fl, const QList<QgsOpti
   mVariableEditor->setEditableScopeIndex( 0 );
 
   // locator
-  mLocatorOptionsWidget = new QgsLocatorOptionsWidget( QgisApp::instance()->locatorWidget()->locator(), this );
+  mLocatorOptionsWidget = new QgsLocatorOptionsWidget( QgisApp::instance()->locatorWidget(), this );
   QVBoxLayout *locatorLayout = new QVBoxLayout();
   locatorLayout->addWidget( mLocatorOptionsWidget );
   mOptionsLocatorGroupBox->setLayout( locatorLayout );
diff --git a/src/gui/locator/qgslocatorwidget.cpp b/src/gui/locator/qgslocatorwidget.cpp
@@ -122,6 +122,13 @@ void QgsLocatorWidget::search( const QString &string )
   performSearch();
 }
 
+void QgsLocatorWidget::invalidateResults()
+{
+  mLocator->cancelWithoutBlocking();
+  mLocatorModel->clear();
+  mResultsContainer->hide();
+}
+
 void QgsLocatorWidget::scheduleDelayedPopup()
 {
   mPopupTimer.start();
diff --git a/src/gui/locator/qgslocatorwidget.h b/src/gui/locator/qgslocatorwidget.h
@@ -74,6 +74,12 @@ class GUI_EXPORT QgsLocatorWidget : public QWidget
      */
     void search( const QString &string );
 
+    /**
+     * Invalidates the current search results, e.g. as a result of changes to the locator
+     * filter settings.
+     */
+    void invalidateResults();
+
   signals:
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,13 @@`
`16`	`16`	`***************************************************************************/`
`17`	`17`
`18`	`18`	`#include "qgslocatoroptionswidget.h"`
	`19`	`+#include "qgslocatorwidget.h"`
`19`	`20`	`#include "qgssettings.h"`
`20`	`21`
`21`		`-QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocator locator, QWidget parent )`
	`22`	`+QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocatorWidget locator, QWidget parent )`
`22`	`23`	`: QWidget( parent )`
`23`		`- , mLocator( locator )`
	`24`	`+ , mLocatorWidget( locator )`
	`25`	`+ , mLocator( locator->locator() )`
`24`	`26`	`{`
`25`	`27`	`setupUi( this );`
`26`	`28`
`@@ -34,6 +36,7 @@ QgsLocatorOptionsWidget::QgsLocatorOptionsWidget( QgsLocator locator, QWidget `
`34`	`36`	`void QgsLocatorOptionsWidget::commitChanges()`
`35`	`37`	`{`
`36`	`38`	`mModel->commitChanges();`
	`39`	`+ mLocatorWidget->invalidateResults();`
`37`	`40`	`}`
`38`	`41`
`39`	`42`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,13 @@ void QgsLocatorWidget::search( const QString &string )`
`122`	`122`	`performSearch();`
`123`	`123`	`}`
`124`	`124`
	`125`	`+void QgsLocatorWidget::invalidateResults()`
	`126`	`+{`
	`127`	`+ mLocator->cancelWithoutBlocking();`
	`128`	`+ mLocatorModel->clear();`
	`129`	`+ mResultsContainer->hide();`
	`130`	`+}`
	`131`	`+`
`125`	`132`	`void QgsLocatorWidget::scheduleDelayedPopup()`
`126`	`133`	`{`
`127`	`134`	`mPopupTimer.start();`