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              : #ifndef MU_BRAILLE_INOTATIONBRAILLE_H
      24              : #define MU_BRAILLE_INOTATIONBRAILLE_H
      25              : 
      26              : #include "modularity/imoduleinterface.h"
      27              : #include "types/retval.h"
      28              : 
      29              : #include "brailletypes.h"
      30              : 
      31              : namespace mu::braille {
      32              : class INotationBraille : MODULE_CONTEXT_INTERFACE
      33              : {
      34            0 :     INTERFACE_ID(INotationBraille)
      35              : 
      36              : public:
      37            0 :     virtual ~INotationBraille() = default;
      38              : 
      39              :     virtual muse::ValCh<std::string> brailleInfo() const = 0;
      40              :     virtual muse::ValCh<int> cursorPosition() const = 0;
      41              :     virtual muse::ValCh<int> currentItemPositionStart() const = 0;
      42              :     virtual muse::ValCh<int> currentItemPositionEnd() const = 0;
      43              :     virtual muse::ValCh<std::string> keys() const = 0;
      44              :     virtual muse::ValCh<bool> enabled() const = 0;
      45              :     virtual muse::ValCh<BrailleIntervalDirection> intervalDirection() const = 0;
      46              :     virtual muse::ValCh<int> mode() const = 0;
      47              :     virtual muse::ValCh<std::string> cursorColor() const = 0;
      48              : 
      49              :     virtual void setEnabled(const bool enabled) = 0;
      50              :     virtual void setIntervalDirection(const BrailleIntervalDirection direction) = 0;
      51              : 
      52              :     virtual void setCursorPosition(const int pos) = 0;
      53              :     virtual void setCurrentItemPosition(const int, const int) = 0;
      54              :     virtual void setKeys(const QString&) = 0;
      55              : 
      56              :     virtual void setMode(const BrailleMode) = 0;
      57              :     virtual void toggleMode() = 0;
      58              :     virtual bool isNavigationMode() = 0;
      59              :     virtual bool isBrailleInputMode() = 0;
      60              : 
      61              :     virtual void setCursorColor(const QString) = 0;
      62              : };
      63              : }
      64              : 
      65              : #endif // MU_NOTATION_INOTATIONBRAILLE_H