Skip to content

Commit e881c62

Browse files
juli27juli27
committed
uicomponents: Add sorter base class
1 parent db83464 commit e881c62

8 files changed

Lines changed: 178 additions & 85 deletions

File tree

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ qt_add_qml_module(muse_uicomponents_qml
7676
selectableitemlistmodel.h
7777
selectmultipledirectoriesmodel.cpp
7878
selectmultipledirectoriesmodel.h
79+
sorter.cpp
80+
sorter.h
7981
sortervalue.cpp
8082
sortervalue.h
8183
sortfilterproxymodel.cpp

‎framework/uicomponents/qml/Muse/UiComponents/ValueList.qml‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,18 @@ Item {
8181
property real spacing: 4
8282
property real sideMargin: 30
8383

84-
function toggleSorter(sorter) {
84+
function toggleSorter(sorter: Sorter) {
8585
if (!sorter.enabled) {
86-
setSorterEnabled(sorter, true)
86+
sorter.sortOrder = Qt.AscendingOrder
87+
sorter.enabled = true
8788
} else if (sorter.sortOrder === Qt.AscendingOrder) {
8889
sorter.sortOrder = Qt.DescendingOrder
8990
} else {
90-
setSorterEnabled(sorter, false)
91+
sorter.enabled = false
9192
}
9293

9394
selectionModel.clear()
9495
}
95-
96-
function setSorterEnabled(sorter, enable) {
97-
sorter.enabled = enable
98-
}
9996
}
10097

10198
Rectangle {
@@ -187,7 +184,7 @@ Item {
187184
}
188185

189186
prv.toggleSorter(keySorter)
190-
prv.setSorterEnabled(valueSorter, false)
187+
valueSorter.enabled = false
191188
}
192189
}
193190

@@ -218,7 +215,7 @@ Item {
218215
}
219216

220217
prv.toggleSorter(valueSorter)
221-
prv.setSorterEnabled(keySorter, false)
218+
keySorter.enabled = false
222219
}
223220
}
224221
}

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* SPDX-License-Identifier: GPL-3.0-only
3+
* MuseScore-CLA-applies
4+
*
5+
* MuseScore
6+
* Music Composition & Notation
7+
*
8+
* Copyright (C) 2026 MuseScore Limited and others
9+
*
10+
* This program is free software: you can redistribute it and/or modify
11+
* it under the terms of the GNU General Public License version 3 as
12+
* published by the Free Software Foundation.
13+
*
14+
* This program is distributed in the hope that it will be useful,
15+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
* GNU General Public License for more details.
18+
*
19+
* You should have received a copy of the GNU General Public License
20+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
21+
*/
22+
23+
#include "sorter.h"
24+
25+
namespace muse::uicomponents {
26+
Sorter::Sorter(QObject* parent)
27+
: QObject(parent)
28+
{
29+
}
30+
31+
Qt::SortOrder Sorter::sortOrder() const
32+
{
33+
return m_sortOrder;
34+
}
35+
36+
void Sorter::setSortOrder(const Qt::SortOrder sortOrder)
37+
{
38+
if (m_sortOrder == sortOrder) {
39+
return;
40+
}
41+
42+
m_sortOrder = sortOrder;
43+
emit dataChanged();
44+
}
45+
46+
bool Sorter::enabled() const
47+
{
48+
return m_enabled;
49+
}
50+
51+
void Sorter::setEnabled(const bool enabled)
52+
{
53+
if (m_enabled == enabled) {
54+
return;
55+
}
56+
57+
m_enabled = enabled;
58+
emit dataChanged();
59+
}
60+
}

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/*
2+
* SPDX-License-Identifier: GPL-3.0-only
3+
* MuseScore-CLA-applies
4+
*
5+
* MuseScore
6+
* Music Composition & Notation
7+
*
8+
* Copyright (C) 2026 MuseScore Limited and others
9+
*
10+
* This program is free software: you can redistribute it and/or modify
11+
* it under the terms of the GNU General Public License version 3 as
12+
* published by the Free Software Foundation.
13+
*
14+
* This program is distributed in the hope that it will be useful,
15+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
* GNU General Public License for more details.
18+
*
19+
* You should have received a copy of the GNU General Public License
20+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
21+
*/
22+
23+
#pragma once
24+
25+
#include <QObject>
26+
#include <Qt>
27+
#include <QtQmlIntegration/qqmlintegration.h>
28+
29+
class QModelIndex;
30+
31+
namespace muse::uicomponents {
32+
class SortFilterProxyModel;
33+
34+
class Sorter : public QObject
35+
{
36+
Q_OBJECT
37+
Q_PROPERTY(Qt::SortOrder sortOrder READ sortOrder WRITE setSortOrder NOTIFY dataChanged)
38+
Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY dataChanged)
39+
40+
QML_ELEMENT;
41+
QML_UNCREATABLE("")
42+
43+
public:
44+
explicit Sorter(QObject* parent = nullptr);
45+
46+
virtual bool lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight, const SortFilterProxyModel&) = 0;
47+
48+
Qt::SortOrder sortOrder() const;
49+
void setSortOrder(Qt::SortOrder sortOrder);
50+
51+
bool enabled() const;
52+
void setEnabled(bool enabled);
53+
54+
signals:
55+
void dataChanged();
56+
57+
private:
58+
Qt::SortOrder m_sortOrder = Qt::AscendingOrder;
59+
bool m_enabled = false;
60+
};
61+
}

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

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,40 @@
1919
* You should have received a copy of the GNU General Public License
2020
* along with this program. If not, see <https://www.gnu.org/licenses/>.
2121
*/
22+
2223
#include "sortervalue.h"
2324

25+
#include "sortfilterproxymodel.h"
26+
2427
using namespace muse::uicomponents;
2528

2629
SorterValue::SorterValue(QObject* parent)
27-
: QObject(parent)
30+
: Sorter(parent)
2831
{
2932
}
3033

31-
QString SorterValue::roleName() const
34+
bool SorterValue::lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight,
35+
const SortFilterProxyModel& proxyModel)
3236
{
33-
return m_roleName;
34-
}
37+
const int roleId = proxyModel.roleIdFromName(m_roleName);
38+
if (roleId < 0) {
39+
return sourceLeft < sourceRight;
40+
}
3541

36-
Qt::SortOrder SorterValue::sortOrder() const
37-
{
38-
return m_sortOrder;
42+
const QAbstractItemModel* sourceModel = proxyModel.sourceModel();
43+
const QVariant leftData = sourceModel->data(sourceLeft, roleId);
44+
const QVariant rightData = sourceModel->data(sourceRight, roleId);
45+
const QPartialOrdering ordering = QVariant::compare(leftData, rightData);
46+
if (ordering == QPartialOrdering::Unordered || ordering == QPartialOrdering::Equivalent) {
47+
return sourceLeft < sourceRight;
48+
}
49+
50+
return ordering == QPartialOrdering::Less;
3951
}
4052

41-
bool SorterValue::enabled() const
53+
QString SorterValue::roleName() const
4254
{
43-
return m_enabled;
55+
return m_roleName;
4456
}
4557

4658
void SorterValue::setRoleName(QString roleName)
@@ -52,28 +64,3 @@ void SorterValue::setRoleName(QString roleName)
5264
m_roleName = roleName;
5365
emit dataChanged();
5466
}
55-
56-
void SorterValue::setSortOrder(Qt::SortOrder sortOrder)
57-
{
58-
if (m_sortOrder == sortOrder) {
59-
return;
60-
}
61-
62-
m_sortOrder = sortOrder;
63-
emit dataChanged();
64-
}
65-
66-
void SorterValue::setEnabled(bool enabled)
67-
{
68-
if (m_enabled == enabled) {
69-
return;
70-
}
71-
72-
m_enabled = enabled;
73-
74-
if (!enabled) {
75-
m_sortOrder = Qt::AscendingOrder;
76-
}
77-
78-
emit dataChanged();
79-
}

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

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,38 +22,28 @@
2222

2323
#pragma once
2424

25-
#include <qqmlintegration.h>
25+
#include <QString>
26+
#include <QtQmlIntegration/qqmlintegration.h>
2627

27-
#include <QObject>
28+
#include "sorter.h"
2829

2930
namespace muse::uicomponents {
30-
class SorterValue : public QObject
31+
class SorterValue : public Sorter
3132
{
3233
Q_OBJECT
33-
QML_ELEMENT
34-
3534
Q_PROPERTY(QString roleName READ roleName WRITE setRoleName NOTIFY dataChanged)
36-
Q_PROPERTY(Qt::SortOrder sortOrder READ sortOrder WRITE setSortOrder NOTIFY dataChanged)
37-
Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY dataChanged)
35+
36+
QML_ELEMENT
3837

3938
public:
4039
explicit SorterValue(QObject* parent = nullptr);
4140

42-
QString roleName() const;
43-
Qt::SortOrder sortOrder() const;
44-
bool enabled() const;
41+
bool lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight, const SortFilterProxyModel&) override;
4542

46-
public slots:
43+
QString roleName() const;
4744
void setRoleName(QString roleName);
48-
void setSortOrder(Qt::SortOrder sortOrder);
49-
void setEnabled(bool enabled);
50-
51-
signals:
52-
void dataChanged();
5345

5446
private:
5547
QString m_roleName;
56-
Qt::SortOrder m_sortOrder = Qt::SortOrder::AscendingOrder;
57-
bool m_enabled = false;
5848
};
5949
}

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

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
#include <QtVersionChecks>
2929

3030
#include "global/log.h"
31-
#include "global/types/val.h"
3231

3332
#include "uicomponents/view/modelutils.h"
3433

@@ -69,22 +68,24 @@ SortFilterProxyModel::SortFilterProxyModel(QObject* parent)
6968
});
7069

7170
auto onSortersChanged = [this] {
72-
SorterValue* sorter = currentSorterValue();
71+
Sorter* sorter = currentSorter();
7372
invalidate();
7473

7574
if (!sorter) {
75+
sort(-1, Qt::AscendingOrder);
7676
return;
7777
}
7878

79-
if (sourceModel()) {
80-
sort(0, sorter->sortOrder());
81-
}
79+
sort(0, sorter->sortOrder());
8280
};
8381

8482
connect(m_sorters.notifier(), &QmlListPropertyNotifier::appended, this, [this, onSortersChanged](int index) {
85-
onSortersChanged();
83+
Sorter* sorter = m_sorters.at(index);
84+
if (sorter->enabled()) {
85+
onSortersChanged();
86+
}
8687

87-
connect(m_sorters.at(index), &SorterValue::dataChanged, this, onSortersChanged);
88+
connect(sorter, &Sorter::dataChanged, this, onSortersChanged);
8889
});
8990

9091
connect(this, &SortFilterProxyModel::sourceModelRoleNamesChanged, this, [this]() {
@@ -97,7 +98,7 @@ QQmlListProperty<Filter> SortFilterProxyModel::filters()
9798
return m_filters.property();
9899
}
99100

100-
QQmlListProperty<SorterValue> SortFilterProxyModel::sorters()
101+
QQmlListProperty<Sorter> SortFilterProxyModel::sorters()
101102
{
102103
return m_sorters.property();
103104
}
@@ -194,23 +195,18 @@ bool SortFilterProxyModel::filterAcceptsRow(int sourceRow, const QModelIndex& so
194195

195196
bool SortFilterProxyModel::lessThan(const QModelIndex& left, const QModelIndex& right) const
196197
{
197-
SorterValue* sorter = currentSorterValue();
198+
Sorter* sorter = currentSorter();
198199
if (!sorter) {
199-
return false;
200+
return left < right;
200201
}
201202

202-
int sorterRoleKey = roleIdFromName(sorter->roleName());
203-
204-
Val leftData = Val::fromQVariant(sourceModel()->data(left, sorterRoleKey));
205-
Val rightData = Val::fromQVariant(sourceModel()->data(right, sorterRoleKey));
206-
207-
return leftData < rightData;
203+
return sorter->lessThan(left, right, *this);
208204
}
209205

210-
SorterValue* SortFilterProxyModel::currentSorterValue() const
206+
Sorter* SortFilterProxyModel::currentSorter() const
211207
{
212-
QList<SorterValue*> sorterList = m_sorters.list();
213-
for (SorterValue* sorter : std::as_const(sorterList)) {
208+
const QList<Sorter*> sorterList = m_sorters.list();
209+
for (Sorter* sorter : sorterList) {
214210
if (sorter->enabled()) {
215211
return sorter;
216212
}

0 commit comments

Comments
 (0)