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 "notation/inotation_fwd.h"
      27              : #include "inotationwriter.h"
      28              : #include "internal/exporttype.h"
      29              : 
      30              : namespace mu::project {
      31              : struct ExportInfo {
      32              :     QString id;
      33              :     muse::io::path_t exportDirPath;
      34              :     INotationWriter::UnitType unitType;
      35              :     std::vector<notation::INotationWeakPtr> notations;
      36              : };
      37              : 
      38              : class IExportProjectScenario : MODULE_CONTEXT_INTERFACE
      39              : {
      40            0 :     INTERFACE_ID(IExportProjectScenario)
      41              : 
      42              : public:
      43              :     virtual std::vector<INotationWriter::UnitType> supportedUnitTypes(const ExportType& exportType) const = 0;
      44              : 
      45              :     virtual muse::RetVal<muse::io::path_t> askExportPath(const notation::INotationPtrList& notations, const ExportType& exportType,
      46              :                                                          INotationWriter::UnitType unitType = INotationWriter::UnitType::PER_PART,
      47              :                                                          muse::io::path_t defaultPath = "") const = 0;
      48              : 
      49              :     virtual bool exportScores(notation::INotationPtrList notations, const muse::io::path_t destinationPath,
      50              :                               INotationWriter::UnitType unitType = INotationWriter::UnitType::PER_PART,
      51              :                               bool openDestinationFolderOnExport = false) const = 0;
      52              : 
      53              :     virtual const ExportInfo& exportInfo() const = 0;
      54              :     virtual void setExportInfo(const ExportInfo& exportInfo) = 0;
      55              : };
      56              : }