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) 2026 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 <QByteArray>
      26              : 
      27              :  #include "modularity/imoduleinterface.h"
      28              :  #include "global/async/notification.h"
      29              :  #include "global/types/retval.h"
      30              : 
      31              :  #include "uiaction.h"
      32              :  #include "toolconfig.h"
      33              : 
      34              : namespace muse::ui {
      35              : class IUiState : MODULE_CONTEXT_INTERFACE
      36              : {
      37           12 :     INTERFACE_ID(IUiState)
      38              : 
      39              : public:
      40            3 :     virtual ~IUiState() = default;
      41              : 
      42              :     virtual QByteArray windowGeometry() const = 0;
      43              :     virtual void setWindowGeometry(const QByteArray& state) = 0;
      44              :     virtual async::Notification windowGeometryChanged() const = 0;
      45              : 
      46              :     virtual ValNt<QByteArray> pageState(const QString& pageName) const = 0;
      47              :     virtual void setPageState(const QString& pageName, const QByteArray& state) = 0;
      48              : 
      49              :     virtual ToolConfig toolConfig(const QString& toolName, const ToolConfig& defaultConfig) const = 0;
      50              :     virtual void setToolConfig(const QString& toolName, const ToolConfig& config) = 0;
      51              :     virtual async::Notification toolConfigChanged(const QString& toolName) const = 0;
      52              : 
      53              :     virtual QString uiItemState(const QString& itemName) const = 0;
      54              :     virtual void setUiItemState(const QString& itemName, const QString& value) = 0;
      55              :     virtual async::Notification uiItemStateChanged(const QString& itemName) const = 0;
      56              : 
      57              :     virtual bool isVisible(const QString& key, bool def = true) const = 0;
      58              :     virtual void setIsVisible(const QString& key, bool val) = 0;
      59              :     virtual async::Notification isVisibleChanged(const QString& key) const = 0;
      60              : };
      61              : }