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_UI_IUIACTIONSMODULE_H
      23              : #define MUSE_UI_IUIACTIONSMODULE_H
      24              : 
      25              : #include <memory>
      26              : 
      27              : #include "global/async/channel.h"
      28              : 
      29              : #include "uiaction.h"
      30              : 
      31              : namespace muse::ui {
      32              : class IUiActionsModule
      33              : {
      34              : public:
      35            0 :     virtual ~IUiActionsModule() = default;
      36              : 
      37              :     virtual const UiActionList& actionsList() const = 0;
      38            0 :     virtual async::Channel<UiActionList> actionsChanged() const
      39              :     {
      40              :         //! NOTE Usually actions don't change,
      41              :         //! so let's add a default implementation here.
      42            5 :         static async::Channel<UiActionList> ch;
      43            0 :         return ch;
      44            0 :     }
      45              : 
      46              :     virtual bool actionEnabled(const UiAction& act) const = 0;
      47              :     virtual async::Channel<muse::actions::ActionCodeList> actionEnabledChanged() const = 0;
      48              : 
      49              :     virtual bool actionChecked(const UiAction& act) const = 0;
      50              :     virtual async::Channel<muse::actions::ActionCodeList> actionCheckedChanged() const = 0;
      51              : };
      52              : using IUiActionsModulePtr = std::shared_ptr<IUiActionsModule>;
      53              : }
      54              : 
      55              : #endif // MUSE_UI_IUIACTIONSMODULE_H