selection.h

//=============================================================================
//  MuseScore
//  Music Composition & Notation
//
//  Copyright (C) 2019 Werner Schweer and others
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License version 2
//  as published by the Free Software Foundation and appearing in
//  the file LICENCE.GPL
//=============================================================================

#ifndef __PLUGIN_API_SELECTION_H__
#define __PLUGIN_API_SELECTION_H__

#include "elements.h"
#include "score.h"

namespace Ms {
namespace PluginAPI {

//---------------------------------------------------------
//   Selection
//    Wrapper class for internal Ms::Selection
//---------------------------------------------------------

class Selection : public QObject {
      Q_OBJECT
      Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> elements READ elements)

      
      Q_PROPERTY(bool isRange READ isRange)
      Q_PROPERTY(Ms::PluginAPI::Segment* startSegment READ startSegment)
      Q_PROPERTY(Ms::PluginAPI::Segment* endSegment READ endSegment)
      Q_PROPERTY(int startStaff READ startStaff)
      Q_PROPERTY(int endStaff READ endStaff)

   protected:
      Ms::Selection* _select;

      bool checkSelectionIsNotLocked() const;

   public:
      Selection(Ms::Selection* select) : QObject(), _select(select) {}
      virtual ~Selection() { }

      QQmlListProperty<Element> elements()
            { return wrapContainerProperty<Element>(this, _select->elements()); }

      bool isRange() const { return _select->isRange(); }

      Segment* startSegment() const { return wrap<Segment>(_select->startSegment()); }
      Segment* endSegment() const { return wrap<Segment>(_select->endSegment()); }
      int startStaff() const { return _select->staffStart(); }
      int endStaff() const { return _select->staffEnd(); }

      Q_INVOKABLE bool select(Ms::PluginAPI::Element* e, bool add = false);
      Q_INVOKABLE bool selectRange(int startTick, int endTick, int startStaff, int endStaff);
      Q_INVOKABLE bool deselect(Ms::PluginAPI::Element* e);
      Q_INVOKABLE bool clear();
};

extern Selection* selectionWrap(Ms::Selection* select);

} // namespace PluginAPI
} // namespace Ms
#endif