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              : 
      23              : #pragma once
      24              : 
      25              : #include <QObject>
      26              : #include <qqmlintegration.h>
      27              : 
      28              : #include "ui/inavigation.h"
      29              : 
      30              : namespace muse::ui {
      31              : class NavigationEvent : public QObject
      32              : {
      33              :     Q_OBJECT
      34              :     QML_ELEMENT;
      35              :     QML_UNCREATABLE("Must be created in C++ only")
      36              :     Q_PROPERTY(Type type READ type CONSTANT)
      37              :     Q_PROPERTY(bool accepted READ accepted WRITE setAccepted)
      38              : 
      39              : public:
      40              :     NavigationEvent(INavigation::EventPtr event = nullptr);
      41              : 
      42              :     //! NOTE Please sync with INavigation::Event::Type
      43              :     enum Type {
      44              :         Undefined = 0,
      45              :         Left,
      46              :         Right,
      47              :         Up,
      48              :         Down,
      49              :         Trigger,
      50              :         Escape,
      51              :         AboutActive
      52              :     };
      53            0 :     Q_ENUM(Type)
      54              : 
      55              :     void setEvent(INavigation::EventPtr event);
      56              : 
      57              :     Type type() const;
      58              :     bool accepted() const;
      59              :     void setAccepted(bool accepted);
      60              : 
      61              :     Q_INVOKABLE QVariant data(const QString& key) const;
      62              :     Q_INVOKABLE void setData(const QString& key, const QVariant& val);
      63              : 
      64              : private:
      65              :     INavigation::EventPtr m_event;
      66              : };
      67              : }