docs

qgis · Mar 18, 2020 · 8562f78 · 8562f78
1 parent a9c81d1
commit 8562f78
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/python/gui/auto_generated/attributetable/qgsattributetablefiltermodel.sip.in b/python/gui/auto_generated/attributetable/qgsattributetablefiltermodel.sip.in
@@ -202,6 +202,8 @@ is shown.
 %Docstring
 Set the ``expression`` and the ``context`` to be stored in case of the features
 need to be filtered again (like on filter or on main model data change).
+
+.. versionadded:: 3.10.3
 %End
 
   signals:
@@ -249,7 +251,10 @@ When a change is signalled, the filter is updated and invalidated if needed.
 
     void filterFeatures();
 %Docstring
-Is called when the data changed of the main table moment to update the filter model.
+Updates the filtered features in the filter model. It is called when the data of the
+main table or the filter expression changed.
+
+.. versionadded:: 3.10.3
 %End
 
 };

diff --git a/python/gui/auto_generated/attributetable/qgsdualview.sip.in b/python/gui/auto_generated/attributetable/qgsdualview.sip.in
@@ -133,6 +133,12 @@ Set a list of currently visible features
 %End
 
     void filterFeatures( const QgsExpression &filterExpression, const QgsExpressionContext &context );
+%Docstring
+Sets the expression and Updates the filtered features in the filter model.
+It is called when the filter expression changed.
+
+.. versionadded:: 3.10.3
+%End
 
     QgsFeatureIds filteredFeatures();
 %Docstring

diff --git a/src/gui/attributetable/qgsattributetablefiltermodel.h b/src/gui/attributetable/qgsattributetablefiltermodel.h
@@ -224,6 +224,8 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub
     /**
      * Set the \a expression and the \a context to be stored in case of the features
      * need to be filtered again (like on filter or on main model data change).
+     *
+     * \since QGIS 3.10.3
      */
     void setFilterExpression( const QgsExpression &expression, const QgsExpressionContext &context );
 
@@ -268,7 +270,10 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub
     void reloadVisible();
 
     /**
-     * Is called when the data changed of the main table moment to update the filter model.
+     * Updates the filtered features in the filter model. It is called when the data of the
+     * main table or the filter expression changed.
+     *
+     * \since QGIS 3.10.3
      */
     void filterFeatures();
 

diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h
@@ -161,6 +161,12 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas
     */
     Q_DECL_DEPRECATED void setFilteredFeatures( const QgsFeatureIds &filteredFeatures );
 
+    /**
+     * Sets the expression and Updates the filtered features in the filter model.
+     * It is called when the filter expression changed.
+     *
+     * \since QGIS 3.10.3
+     */
     void filterFeatures( const QgsExpression &filterExpression, const QgsExpressionContext &context );
 
     /**