Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-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              : #ifndef MUSE_WORKSPACE_IWORKSPACEMANAGER_H
      23              : #define MUSE_WORKSPACE_IWORKSPACEMANAGER_H
      24              : 
      25              : #include "modularity/imoduleinterface.h"
      26              : 
      27              : #include "iworkspace.h"
      28              : #include "types/retval.h"
      29              : #include "async/notification.h"
      30              : 
      31              : namespace muse::workspace {
      32              : class IWorkspaceManager : MODULE_CONTEXT_INTERFACE
      33              : {
      34            0 :     INTERFACE_ID(IWorkspaceManager)
      35              : 
      36              : public:
      37            3 :     virtual ~IWorkspaceManager() = default;
      38              : 
      39              :     //! NOTE Default from user app data, writable, full managed
      40              :     virtual IWorkspacePtr defaultWorkspace() const = 0;
      41              : 
      42              :     //! NOTE Current selected by a user, writable, optionally managed
      43              :     virtual IWorkspacePtr currentWorkspace() const = 0;
      44              :     virtual async::Notification currentWorkspaceAboutToBeChanged() const = 0;
      45              :     virtual async::Notification currentWorkspaceChanged() const = 0;
      46              : 
      47              :     virtual IWorkspacePtrList workspaces() const = 0;
      48              :     virtual Ret setWorkspaces(const IWorkspacePtrList& workspaces) = 0;
      49              :     virtual async::Notification workspacesListChanged() const = 0;
      50              : 
      51              :     virtual IWorkspacePtr cloneWorkspace(const IWorkspacePtr& workspace, const std::string& newWorkspaceName) const = 0;
      52              : 
      53              :     virtual void changeCurrentWorkspace(const std::string& newWorkspaceName) = 0;
      54              :     virtual void createAndAppendNewWorkspace() = 0;
      55              :     virtual void openConfigureWorkspacesDialog() = 0;
      56              : };
      57              : }
      58              : 
      59              : #endif // MUSE_WORKSPACE_IWORKSPACEMANAGER_H