Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-Studio-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2021 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 "modularity/imoduleinterface.h"
      26              : #include "types/ret.h"
      27              : 
      28              : #include "io/path.h"
      29              : #include "appshelltypes.h"
      30              : #include "async/notification.h"
      31              : 
      32              : namespace mu::appshell {
      33              : class IAppShellConfiguration : MODULE_GLOBAL_INTERFACE
      34              : {
      35            0 :     INTERFACE_ID(IAppshellConfiguration)
      36              : 
      37              : public:
      38            0 :     virtual ~IAppShellConfiguration() = default;
      39              : 
      40              :     virtual bool hasCompletedFirstLaunchSetup() const = 0;
      41              :     virtual void setHasCompletedFirstLaunchSetup(bool has) = 0;
      42              : 
      43              :     virtual bool welcomeDialogShowOnStartup() const = 0;
      44              :     virtual void setWelcomeDialogShowOnStartup(bool show) = 0;
      45              :     virtual muse::async::Notification welcomeDialogShowOnStartupChanged() const = 0;
      46              : 
      47              :     virtual std::string welcomeDialogLastShownVersion() const = 0;
      48              :     virtual void setWelcomeDialogLastShownVersion(const std::string& version) = 0;
      49              : 
      50              :     virtual int welcomeDialogLastShownIndex() const = 0;
      51              :     virtual void setWelcomeDialogLastShownIndex(int index) = 0;
      52              : 
      53              :     virtual StartupModeType startupModeType() const = 0;
      54              :     virtual void setStartupModeType(StartupModeType type) = 0;
      55              :     virtual muse::async::Notification startupModeTypeChanged() const = 0;
      56              : 
      57              :     virtual muse::io::path_t startupScorePath() const = 0;
      58              :     virtual void setStartupScorePath(const muse::io::path_t& scorePath) = 0;
      59              :     virtual muse::async::Notification startupScorePathChanged() const = 0;
      60              : 
      61              :     virtual std::string handbookUrl() const = 0;
      62              :     virtual std::string askForHelpUrl() const = 0;
      63              :     virtual std::string accessibilityStatementUrl() const = 0;
      64              :     virtual std::string museScoreUrl() const = 0;
      65              :     virtual std::string museScoreForumUrl() const = 0;
      66              :     virtual std::string museScoreContributionUrl() const = 0;
      67              :     virtual std::string museHubFreeMuseSoundsUrl() const = 0;
      68              :     virtual std::string musicXMLLicenseUrl() const = 0;
      69              :     virtual std::string musicXMLLicenseDeedUrl() const = 0;
      70              : 
      71              :     virtual std::string museScoreVersion() const = 0;
      72              :     virtual std::string museScoreRevision() const = 0;
      73              : 
      74              :     virtual bool needShowSplashScreen() const = 0;
      75              :     virtual void setNeedShowSplashScreen(bool show) = 0;
      76              : 
      77              :     virtual const QString& preferencesDialogLastOpenedPageId() const = 0;
      78              :     virtual void setPreferencesDialogLastOpenedPageId(const QString& lastOpenedPageId) = 0;
      79              : 
      80              :     virtual void startEditSettings() = 0;
      81              :     virtual void applySettings() = 0;
      82              :     virtual void rollbackSettings() = 0;
      83              : 
      84              :     virtual void revertToFactorySettings(bool keepDefaultSettings = false, bool notifyAboutChanges = true,
      85              :                                          bool notifyOtherInstances = true) const = 0;
      86              : 
      87              :     virtual muse::io::paths_t sessionProjectsPaths() const = 0;
      88              :     virtual muse::Ret setSessionProjectsPaths(const muse::io::paths_t& paths) = 0;
      89              : };
      90              : }