Add option for "invert score" to follow app theme

Author: Reedbeta

src/appshell/qml/Preferences/AppearancePreferencesPage.qml

@@ -214,7 +214,7 @@ PreferencesPage {
         SeparatorLine {}
 
         ThemeAdditionalOptionsSection {
-            scoreInversionEnabled: appearanceModel.scoreInversionEnabled
+            scoreInversionMode: appearanceModel.scoreInversionMode
 
             navigation.section: root.navigationSection
             navigation.order: root.navigationOrderStart + 7
@@ -229,8 +229,8 @@ PreferencesPage {
                 }
             }
 
-            onScoreInversionEnableChangeRequested: function(enable) {
-                appearanceModel.scoreInversionEnabled = enable
+            onScoreInversionModeChangeRequested: function(mode) {
+                appearanceModel.scoreInversionMode = mode
             }
         }
     }

src/appshell/qml/Preferences/internal/ThemeAdditionalOptionsSection.qml

@@ -26,23 +26,31 @@ import Muse.UiComponents 1.0
 BaseSection {
     id: root
 
-    property alias scoreInversionEnabled: scoreInversionEnable.checked
+    property int scoreInversionMode: 0
 
     signal resetThemeToDefaultRequested()
-    signal scoreInversionEnableChangeRequested(bool enable)
+    signal scoreInversionModeChangeRequested(int mode)
 
-    CheckBox {
-        id: scoreInversionEnable
+    ComboBoxWithTitle {
+        id: scoreInversionModeDropdown
         width: parent.width
 
-        text: qsTrc("appshell/preferences", "Invert score")
+        title: qsTrc("appshell/preferences", "Invert score:")
 
-        navigation.name: "ScoreInversionBox"
+        navigation.name: "ScoreInversionModeDropdown"
         navigation.panel: root.navigation
         navigation.row: 0
 
-        onClicked: {
-            root.scoreInversionEnableChangeRequested(!checked)
+        model: [
+            { text: qsTrc("appshell/preferences", "Disabled"), value: 0 },
+            { text: qsTrc("appshell/preferences", "Follow app theme"), value: 1 },
+            { text: qsTrc("appshell/preferences", "Always"), value: 2 },
+        ]
+
+        currentIndex: scoreInversionModeDropdown.indexOfValue(root.scoreInversionMode)
+
+        onValueEdited: function(newIndex, newValue) {
+            root.scoreInversionModeChangeRequested(newValue)
         }
     }
 

src/appshell/view/preferences/appearancepreferencesmodel.cpp

@@ -57,7 +57,7 @@ void AppearancePreferencesModel::init()
     });
 
     engravingConfiguration()->scoreInversionChanged().onNotify(this, [this]() {
-        emit invertScoreColorChanged();
+        emit scoreInversionModeChanged();
         emit foregroundColorChanged();
     });
 
@@ -252,9 +252,9 @@ QString AppearancePreferencesModel::foregroundWallpaperPath() const
     return notationConfiguration()->foregroundWallpaperPath().toQString();
 }
 
-bool AppearancePreferencesModel::scoreInversionEnabled() const
+int AppearancePreferencesModel::scoreInversionMode() const
 {
-    return engravingConfiguration()->scoreInversionEnabled();
+    return static_cast<int>(engravingConfiguration()->scoreInversionMode());
 }
 
 void AppearancePreferencesModel::setCurrentThemeCode(const QString& themeCode)
@@ -362,12 +362,12 @@ void AppearancePreferencesModel::setForegroundWallpaperPath(const QString& path)
     emit foregroundWallpaperPathChanged();
 }
 
-void AppearancePreferencesModel::setScoreInversionEnabled(bool value)
+void AppearancePreferencesModel::setScoreInversionMode(int mode)
 {
-    if (value == scoreInversionEnabled()) {
+    if (mode == scoreInversionMode()) {
         return;
     }
 
-    engravingConfiguration()->setScoreInversionEnabled(value);
-    emit invertScoreColorChanged();
+    engravingConfiguration()->setScoreInversionMode(static_cast<mu::engraving::ScoreInversionMode>(mode));
+    emit scoreInversionModeChanged();
 }

src/appshell/view/preferences/appearancepreferencesmodel.h

@@ -58,7 +58,7 @@ class AppearancePreferencesModel : public QObject, public muse::Injectable, publ
     Q_PROPERTY(
         QString foregroundWallpaperPath READ foregroundWallpaperPath WRITE setForegroundWallpaperPath NOTIFY foregroundWallpaperPathChanged)
 
-    Q_PROPERTY(bool scoreInversionEnabled READ scoreInversionEnabled WRITE setScoreInversionEnabled NOTIFY invertScoreColorChanged)
+    Q_PROPERTY(int scoreInversionMode READ scoreInversionMode WRITE setScoreInversionMode NOTIFY scoreInversionModeChanged)
 
     muse::Inject<muse::ui::IUiConfiguration> uiConfiguration = { this };
     muse::Inject<notation::INotationConfiguration> notationConfiguration = { this };
@@ -100,7 +100,7 @@ class AppearancePreferencesModel : public QObject, public muse::Injectable, publ
     QColor foregroundColor() const;
     QString foregroundWallpaperPath() const;
 
-    bool scoreInversionEnabled() const;
+    int scoreInversionMode() const;
 
     Q_INVOKABLE void resetAppearancePreferencesToDefault();
     Q_INVOKABLE void setNewColor(const QColor& newColor, ColorType colorType);
@@ -121,7 +121,7 @@ public slots:
     void setForegroundUseColor(bool value);
     void setForegroundColor(const QColor& color);
     void setForegroundWallpaperPath(const QString& path);
-    void setScoreInversionEnabled(bool value);
+    void setScoreInversionMode(int mode);
 
 signals:
     void isFollowSystemThemeChanged();
@@ -134,7 +134,7 @@ public slots:
     void foregroundUseColorChanged();
     void foregroundColorChanged();
     void foregroundWallpaperPathChanged();
-    void invertScoreColorChanged();
+    void scoreInversionModeChanged();
 
 private:
     muse::ui::ThemeInfo currentTheme() const;

src/engraving/iengravingconfiguration.h

@@ -73,7 +73,8 @@ class IEngravingConfiguration : MODULE_EXPORT_INTERFACE
     virtual muse::async::Channel<voice_idx_t, Color> selectionColorChanged() const = 0;
 
     virtual bool scoreInversionEnabled() const = 0;
-    virtual void setScoreInversionEnabled(bool value) = 0;
+    virtual ScoreInversionMode scoreInversionMode() const = 0;
+    virtual void setScoreInversionMode(ScoreInversionMode mode) = 0;
     virtual muse::async::Notification scoreInversionChanged() const = 0;
 
     virtual bool dynamicsApplyToAllVoices() const = 0;

src/engraving/internal/engravingconfiguration.cpp

@@ -44,6 +44,7 @@ static const Settings::Key DEFAULT_STYLE_FILE_PATH("engraving", "engraving/style
 static const Settings::Key PART_STYLE_FILE_PATH("engraving", "engraving/style/partStyleFile");
 
 static const Settings::Key INVERT_SCORE_COLOR("engraving", "engraving/scoreColorInversion");
+static const Settings::Key SCORE_COLOR_INVERSION_MODE("engraving", "engraving/scoreColorInversionMode");
 
 static const Settings::Key ALL_VOICES_COLOR("engraving", "engraving/colors/allVoicesColor");
 static const Settings::Key FORMATTING_COLOR("engraving", "engraving/colors/formattingColor");
@@ -85,11 +86,17 @@ void EngravingConfiguration::init()
         m_partStyleFilePathChanged.send(val.toPath());
     });
 
+    // TODO: How to upgrade old setting to new one?
     settings()->setDefaultValue(INVERT_SCORE_COLOR, Val(false));
     settings()->valueChanged(INVERT_SCORE_COLOR).onReceive(nullptr, [this](const Val&) {
         m_scoreInversionChanged.notify();
     });
 
+    settings()->setDefaultValue(SCORE_COLOR_INVERSION_MODE, Val(ScoreInversionMode::Disabled));
+    settings()->valueChanged(SCORE_COLOR_INVERSION_MODE).onReceive(nullptr, [this](const Val&) {
+        m_scoreInversionChanged.notify();
+    });
+
     for (voice_idx_t voice = 0; voice < VOICES; ++voice) {
         Settings::Key key("engraving", "engraving/colors/voice" + std::to_string(voice + 1));
 
@@ -333,12 +340,22 @@ Color EngravingConfiguration::highlightSelectionColor(voice_idx_t voice) const
 
 bool EngravingConfiguration::scoreInversionEnabled() const
 {
-    return settings()->value(INVERT_SCORE_COLOR).toBool();
+    switch (scoreInversionMode()) {
+    case ScoreInversionMode::Disabled: return false;
+    case ScoreInversionMode::FollowAppTheme: return uiConfiguration()->isDarkMode();
+    case ScoreInversionMode::Always: return true;
+    default: return false;
+    }
+}
+
+ScoreInversionMode EngravingConfiguration::scoreInversionMode() const
+{
+    return settings()->value(SCORE_COLOR_INVERSION_MODE).toEnum<ScoreInversionMode>();
 }
 
-void EngravingConfiguration::setScoreInversionEnabled(bool value)
+void EngravingConfiguration::setScoreInversionMode(ScoreInversionMode mode)
 {
-    settings()->setSharedValue(INVERT_SCORE_COLOR, Val(value));
+    settings()->setSharedValue(SCORE_COLOR_INVERSION_MODE, Val(mode));
 }
 
 bool EngravingConfiguration::dynamicsApplyToAllVoices() const

src/engraving/internal/engravingconfiguration.h

@@ -81,7 +81,8 @@ class EngravingConfiguration : public IEngravingConfiguration, public muse::Inje
     Color highlightSelectionColor(voice_idx_t voice = 0) const override;
 
     bool scoreInversionEnabled() const override;
-    void setScoreInversionEnabled(bool value) override;
+    ScoreInversionMode scoreInversionMode() const override;
+    void setScoreInversionMode(ScoreInversionMode mode) override;
 
     bool dynamicsApplyToAllVoices() const override;
     void setDynamicsApplyToAllVoices(bool v) override;

src/engraving/tests/mocks/engravingconfigurationmock.h

@@ -67,7 +67,8 @@ class EngravingConfigurationMock : public IEngravingConfiguration
     MOCK_METHOD((muse::async::Channel<bool>), dynamicsApplyToAllVoicesChanged, (), (const, override));
 
     MOCK_METHOD(bool, scoreInversionEnabled, (), (const, override));
-    MOCK_METHOD(void, setScoreInversionEnabled, (bool), (override));
+    MOCK_METHOD(ScoreInversionMode, scoreInversionMode, (), (const, override));
+    MOCK_METHOD(void, setScoreInversionMode, (ScoreInversionMode), (override));
     MOCK_METHOD(muse::async::Notification, scoreInversionChanged, (), (const, override));
 
     MOCK_METHOD(Color, formattingColor, (), (const, override));

src/engraving/types/types.h

@@ -1184,6 +1184,16 @@ enum class LayoutFlag : unsigned char {
 };
 
 typedef muse::Flags<LayoutFlag> LayoutFlags;
+
+//---------------------------------------------------------
+//  ScoreInversionMode
+//---------------------------------------------------------
+
+enum class ScoreInversionMode : unsigned char {
+    Disabled,
+    FollowAppTheme,
+    Always
+};
 } // mu::engraving
 
 template<>

src/notation/internal/notationconfiguration.cpp

@@ -530,7 +530,7 @@ void NotationConfiguration::resetForeground()
     settings()->setSharedValue(FOREGROUND_USE_COLOR, settings()->defaultValue(FOREGROUND_USE_COLOR));
     settings()->setSharedValue(FOREGROUND_WALLPAPER_PATH, settings()->defaultValue(FOREGROUND_WALLPAPER_PATH));
 
-    engravingConfiguration()->setScoreInversionEnabled(false);
+    engravingConfiguration()->setScoreInversionMode(mu::engraving::ScoreInversionMode::Disabled);
 }
 
 muse::async::Notification NotationConfiguration::foregroundChanged() const