fw/uicomponents: Add sorter base class

Author: juli27

src/framework/uicomponents/qml/Muse/UiComponents/CMakeLists.txt

@@ -76,6 +76,8 @@ qt_add_qml_module(muse_uicomponents_qml
         selectableitemlistmodel.h
         selectmultipledirectoriesmodel.cpp
         selectmultipledirectoriesmodel.h
+        sorter.cpp
+        sorter.h
         sortervalue.cpp
         sortervalue.h
         sortfilterproxymodel.cpp

src/framework/uicomponents/qml/Muse/UiComponents/sorter.cpp

@@ -0,0 +1,60 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-CLA-applies
+ *
+ * MuseScore
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2026 MuseScore Limited and others
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "sorter.h"
+
+namespace muse::uicomponents {
+Sorter::Sorter(QObject* parent)
+    : QObject(parent)
+{
+}
+
+Qt::SortOrder Sorter::sortOrder() const
+{
+    return m_sortOrder;
+}
+
+void Sorter::setSortOrder(const Qt::SortOrder sortOrder)
+{
+    if (m_sortOrder == sortOrder) {
+        return;
+    }
+
+    m_sortOrder = sortOrder;
+    emit dataChanged();
+}
+
+bool Sorter::enabled() const
+{
+    return m_enabled;
+}
+
+void Sorter::setEnabled(const bool enabled)
+{
+    if (m_enabled == enabled) {
+        return;
+    }
+
+    m_enabled = enabled;
+    emit dataChanged();
+}
+}

src/framework/uicomponents/qml/Muse/UiComponents/sorter.h

@@ -0,0 +1,61 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-CLA-applies
+ *
+ * MuseScore
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2026 MuseScore Limited and others
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <QObject>
+
+#include <QtQmlIntegration/qqmlintegration.h>
+
+class QModelIndex;
+
+namespace muse::uicomponents {
+class SortFilterProxyModel;
+
+class Sorter : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(Qt::SortOrder sortOrder READ sortOrder WRITE setSortOrder NOTIFY dataChanged)
+    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY dataChanged)
+
+    QML_ELEMENT;
+    QML_UNCREATABLE("")
+
+public:
+    explicit Sorter(QObject* parent = nullptr);
+
+    virtual bool lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight, const SortFilterProxyModel&) = 0;
+
+    Qt::SortOrder sortOrder() const;
+    void setSortOrder(Qt::SortOrder sortOrder);
+
+    bool enabled() const;
+    void setEnabled(bool enabled);
+
+signals:
+    void dataChanged();
+
+private:
+    Qt::SortOrder m_sortOrder = Qt::AscendingOrder;
+    bool m_enabled = false;
+};
+}

src/framework/uicomponents/qml/Muse/UiComponents/sortervalue.cpp

@@ -19,28 +19,38 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+
 #include "sortervalue.h"
 
+#include "global/types/val.h"
+
+#include "sortfilterproxymodel.h"
+
 using namespace muse::uicomponents;
 
 SorterValue::SorterValue(QObject* parent)
-    : QObject(parent)
+    : Sorter(parent)
 {
 }
 
-QString SorterValue::roleName() const
+bool SorterValue::lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight,
+                           const SortFilterProxyModel& proxyModel)
 {
-    return m_roleName;
-}
+    const int role = proxyModel.roleFromRoleName(m_roleName);
+    if (role == -1) {
+        return sourceLeft < sourceRight;
+    }
 
-Qt::SortOrder SorterValue::sortOrder() const
-{
-    return m_sortOrder;
+    const QAbstractItemModel* sourceModel = proxyModel.sourceModel();
+    const Val leftData = Val::fromQVariant(sourceModel->data(sourceLeft, role));
+    const Val rightData = Val::fromQVariant(sourceModel->data(sourceRight, role));
+
+    return leftData < rightData;
 }
 
-bool SorterValue::enabled() const
+QString SorterValue::roleName() const
 {
-    return m_enabled;
+    return m_roleName;
 }
 
 void SorterValue::setRoleName(QString roleName)
@@ -52,28 +62,3 @@ void SorterValue::setRoleName(QString roleName)
     m_roleName = roleName;
     emit dataChanged();
 }
-
-void SorterValue::setSortOrder(Qt::SortOrder sortOrder)
-{
-    if (m_sortOrder == sortOrder) {
-        return;
-    }
-
-    m_sortOrder = sortOrder;
-    emit dataChanged();
-}
-
-void SorterValue::setEnabled(bool enabled)
-{
-    if (m_enabled == enabled) {
-        return;
-    }
-
-    m_enabled = enabled;
-
-    if (!enabled) {
-        m_sortOrder = Qt::AscendingOrder;
-    }
-
-    emit dataChanged();
-}

src/framework/uicomponents/qml/Muse/UiComponents/sortervalue.h

@@ -22,38 +22,31 @@
 
 #pragma once
 
-#include <qqmlintegration.h>
+#include <QString>
 
-#include <QObject>
+#include <QtQmlIntegration/qqmlintegration.h>
+
+#include "sorter.h"
 
 namespace muse::uicomponents {
-class SorterValue : public QObject
+class SorterValue : public Sorter
 {
     Q_OBJECT
-    QML_ELEMENT
-
     Q_PROPERTY(QString roleName READ roleName WRITE setRoleName NOTIFY dataChanged)
-    Q_PROPERTY(Qt::SortOrder sortOrder READ sortOrder WRITE setSortOrder NOTIFY dataChanged)
-    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY dataChanged)
+
+    QML_ELEMENT
 
 public:
     explicit SorterValue(QObject* parent = nullptr);
 
+    bool lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight, const SortFilterProxyModel&) override;
+
     QString roleName() const;
-    Qt::SortOrder sortOrder() const;
-    bool enabled() const;
 
 public slots:
     void setRoleName(QString roleName);
-    void setSortOrder(Qt::SortOrder sortOrder);
-    void setEnabled(bool enabled);
-
-signals:
-    void dataChanged();
 
 private:
     QString m_roleName;
-    Qt::SortOrder m_sortOrder = Qt::SortOrder::AscendingOrder;
-    bool m_enabled = false;
 };
 }

src/framework/uicomponents/qml/Muse/UiComponents/sortfilterproxymodel.cpp

@@ -24,8 +24,6 @@
 
 #include <QTimer>
 
-#include "global/types/val.h"
-
 #include "uicomponents/view/modelutils.h"
 
 using namespace muse::uicomponents;
@@ -70,10 +68,11 @@ SortFilterProxyModel::SortFilterProxyModel(QObject* parent)
     });
 
     auto onSortersChanged = [this] {
-        SorterValue* sorter = currentSorterValue();
+        Sorter* sorter = currentSorter();
         invalidate();
 
         if (!sorter) {
+            sort(-1, Qt::AscendingOrder);
             return;
         }
 
@@ -85,7 +84,7 @@ SortFilterProxyModel::SortFilterProxyModel(QObject* parent)
     connect(m_sorters.notifier(), &QmlListPropertyNotifier::appended, this, [this, onSortersChanged](int index) {
         onSortersChanged();
 
-        connect(m_sorters.at(index), &SorterValue::dataChanged, this, onSortersChanged);
+        connect(m_sorters.at(index), &Sorter::dataChanged, this, onSortersChanged);
     });
 
     connect(this, &SortFilterProxyModel::sourceModelRoleNamesChanged, this, [this]() {
@@ -98,7 +97,7 @@ QQmlListProperty<Filter> SortFilterProxyModel::filters()
     return m_filters.property();
 }
 
-QQmlListProperty<SorterValue> SortFilterProxyModel::sorters()
+QQmlListProperty<Sorter> SortFilterProxyModel::sorters()
 {
     return m_sorters.property();
 }
@@ -203,23 +202,18 @@ bool SortFilterProxyModel::filterAcceptsRow(int sourceRow, const QModelIndex& so
 
 bool SortFilterProxyModel::lessThan(const QModelIndex& left, const QModelIndex& right) const
 {
-    SorterValue* sorter = currentSorterValue();
+    Sorter* sorter = currentSorter();
     if (!sorter) {
         return false;
     }
 
-    const int sorterRoleKey = roleFromRoleName(sorter->roleName());
-
-    Val leftData = Val::fromQVariant(sourceModel()->data(left, sorterRoleKey));
-    Val rightData = Val::fromQVariant(sourceModel()->data(right, sorterRoleKey));
-
-    return leftData < rightData;
+    return sorter->lessThan(left, right, *this);
 }
 
-SorterValue* SortFilterProxyModel::currentSorterValue() const
+Sorter* SortFilterProxyModel::currentSorter() const
 {
-    const QList<SorterValue*> sorterList = m_sorters.list();
-    for (SorterValue* sorter : sorterList) {
+    const QList<Sorter*> sorterList = m_sorters.list();
+    for (Sorter* sorter : sorterList) {
         if (sorter->enabled()) {
             return sorter;
         }

src/framework/uicomponents/qml/Muse/UiComponents/sortfilterproxymodel.h

@@ -30,16 +30,16 @@
 #include <QtQmlIntegration/qqmlintegration.h>
 
 #include "filter.h"
-#include "sortervalue.h"
 #include "qmllistproperty.h"
+#include "sorter.h"
 
 namespace muse::uicomponents {
 class SortFilterProxyModel : public QSortFilterProxyModel
 {
     Q_OBJECT
     Q_PROPERTY(int rowCount READ rowCount NOTIFY rowCountChanged)
     Q_PROPERTY(QQmlListProperty<muse::uicomponents::Filter> filters READ filters CONSTANT)
-    Q_PROPERTY(QQmlListProperty<muse::uicomponents::SorterValue> sorters READ sorters CONSTANT)
+    Q_PROPERTY(QQmlListProperty<muse::uicomponents::Sorter> sorters READ sorters CONSTANT)
     Q_PROPERTY(QList<int> alwaysIncludeIndices READ alwaysIncludeIndices WRITE setAlwaysIncludeIndices NOTIFY alwaysIncludeIndicesChanged)
     Q_PROPERTY(QList<int> alwaysExcludeIndices READ alwaysExcludeIndices WRITE setAlwaysExcludeIndices NOTIFY alwaysExcludeIndicesChanged)
 
@@ -49,7 +49,7 @@ class SortFilterProxyModel : public QSortFilterProxyModel
     explicit SortFilterProxyModel(QObject* parent = nullptr);
 
     QQmlListProperty<Filter> filters();
-    QQmlListProperty<SorterValue> sorters();
+    QQmlListProperty<Sorter> sorters();
 
     QList<int> alwaysIncludeIndices() const;
     void setAlwaysIncludeIndices(const QList<int>& indices);
@@ -75,10 +75,10 @@ class SortFilterProxyModel : public QSortFilterProxyModel
     bool lessThan(const QModelIndex& left, const QModelIndex& right) const override;
 
 private:
-    SorterValue* currentSorterValue() const;
+    Sorter* currentSorter() const;
 
     QmlListProperty<Filter> m_filters;
-    QmlListProperty<SorterValue> m_sorters;
+    QmlListProperty<Sorter> m_sorters;
 
     QList<int> m_alwaysIncludeIndices;
     QList<int> m_alwaysExcludeIndices;