Doc: Document new property change notifiers for QSortFilterProxyModel

Change-Id: I02789fa2281d33c7344a5d5e730a27fe6fa50e56
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

1 files changed, 45 insertions, 3 deletions

diff --git a/src/corelib/itemmodels/qsortfilterproxymodel.cpp b/src/corelib/itemmodels/qsortfilterproxymodel.cpp
index 122b95ed57..35c97da532 100644
--- a/src/corelib/itemmodels/qsortfilterproxymodel.cpp
+++ b/src/corelib/itemmodels/qsortfilterproxymodel.cpp
@@ -2663,12 +2663,19 @@ void QSortFilterProxyModel::setFilterKeyColumn(int column)
     \property QSortFilterProxyModel::filterCaseSensitivity
 
     \brief the case sensitivity of the QRegExp pattern used to filter the
-    contents of the source model
+    contents of the source model.
 
     By default, the filter is case sensitive.
 
     \sa filterRegExp, sortCaseSensitivity
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::filterCaseSensitivityChanged(Qt::CaseSensitivity filterCaseSensitivity)
+    \brief This signal is emitted when the case sensitivity of the filter
+           changes to \a filterCaseSensitivity.
+ */
 Qt::CaseSensitivity QSortFilterProxyModel::filterCaseSensitivity() const
 {
     Q_D(const QSortFilterProxyModel);
@@ -2695,6 +2702,13 @@ void QSortFilterProxyModel::setFilterCaseSensitivity(Qt::CaseSensitivity cs)
 
     \sa filterCaseSensitivity, lessThan()
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::sortCaseSensitivityChanged(Qt::CaseSensitivity sortCaseSensitivity)
+    \brief This signal is emitted when the case sensitivity for sorting
+           changes to \a sortCaseSensitivity.
+*/
 Qt::CaseSensitivity QSortFilterProxyModel::sortCaseSensitivity() const
 {
     Q_D(const QSortFilterProxyModel);
@@ -2721,6 +2735,13 @@ void QSortFilterProxyModel::setSortCaseSensitivity(Qt::CaseSensitivity cs)
 
     \sa sortCaseSensitivity, lessThan()
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::sortLocaleAwareChanged(bool sortLocaleAware)
+    \brief This signal is emitted when the locale aware setting
+           changes to \a sortLocaleAware.
+*/
 bool QSortFilterProxyModel::isSortLocaleAware() const
 {
     Q_D(const QSortFilterProxyModel);
@@ -2841,12 +2862,19 @@ void QSortFilterProxyModel::setDynamicSortFilter(bool enable)
 /*!
     \since 4.2
     \property QSortFilterProxyModel::sortRole
-    \brief the item role that is used to query the source model's data when sorting items
+    \brief the item role that is used to query the source model's data when
+           sorting items.
 
     The default value is Qt::DisplayRole.
 
     \sa lessThan()
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::sortRoleChanged(int sortRole)
+    \brief This signal is emitted when the sort role changes to \a sortRole.
+*/
 int QSortFilterProxyModel::sortRole() const
 {
     Q_D(const QSortFilterProxyModel);
@@ -2866,12 +2894,19 @@ void QSortFilterProxyModel::setSortRole(int role)
 /*!
     \since 4.2
     \property QSortFilterProxyModel::filterRole
-    \brief the item role that is used to query the source model's data when filtering items
+    \brief the item role that is used to query the source model's data when
+           filtering items.
 
     The default value is Qt::DisplayRole.
 
     \sa filterAcceptsRow()
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::filterRoleChanged(int filterRole)
+    \brief This signal is emitted when the filter role changes to \a filterRole.
+*/
 int QSortFilterProxyModel::filterRole() const
 {
     Q_D(const QSortFilterProxyModel);
@@ -2899,6 +2934,13 @@ void QSortFilterProxyModel::setFilterRole(int role)
 
     \sa filterAcceptsRow()
 */
+
+/*!
+    \since 5.15
+    \fn void QSortFilterProxyModel::recursiveFilteringEnabledChanged(int recursiveFilteringEnabled)
+    \brief This signal is emitted when the recursive filter setting is changed
+           to \a recursiveFilteringEnabled.
+*/
 bool QSortFilterProxyModel::isRecursiveFilteringEnabled() const
 {
     Q_D(const QSortFilterProxyModel);