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) 2025 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 <QObject>
      26              : #include <QQmlParserStatus>
      27              : #include <qqmlintegration.h>
      28              : 
      29              : #include "modularity/ioc.h"
      30              : #include "internal/toursprovider.h"
      31              : 
      32              : namespace muse::tours {
      33              : class ToursProviderModel : public QObject, public QQmlParserStatus, public muse::Contextable
      34              : {
      35              :     Q_OBJECT
      36              :     Q_INTERFACES(QQmlParserStatus)
      37              : 
      38              :     Q_PROPERTY(bool canControlTourPopupClosing READ canControlTourPopupClosing CONSTANT)
      39              : 
      40              :     QML_ELEMENT
      41              : 
      42              :     ContextInject<IToursProvider> provider = { this };
      43              : 
      44              : public:
      45              :     explicit ToursProviderModel(QObject* parent = nullptr);
      46              : 
      47              :     Q_INVOKABLE void showNext();
      48              :     Q_INVOKABLE void onTourStepClosed(QQuickItem* parentItem);
      49              : 
      50              :     bool canControlTourPopupClosing() const;
      51              : 
      52              : signals:
      53              :     void openTourStep(const QQuickItem* parentItem, const QString& title, const QString& description, const QString& previewImageOrGifUrl,
      54              :                       const QString& videoExplanationUrl, int index, int total);
      55              :     void closeCurrentTourStep();
      56              : 
      57              : private:
      58              : 
      59              :     void classBegin() override;
      60            0 :     void componentComplete() override {}
      61              :     void init();
      62              : 
      63              :     muse::tours::ToursProvider* toursProvider() const;
      64              : };
      65              : }