palettemodel_list.h

Go to the documentation of this file.

//=============================================================================
//  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.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
//=============================================================================

#ifndef __PALETTEMODEL_H__
#define __PALETTEMODEL_H__

#include "libmscore/element.h"

namespace Ms {

//---------------------------------------------------------
//   PaletteCell
//---------------------------------------------------------

struct PaletteCell {
      std::unique_ptr<Element> element;
      QString name;           // used for tool tip
      QString tag;

      bool drawStaff { false };
      double x       { 0.0   }; // TODO: remove?
      double y       { 0.0   }; // TODO: remove?
      double xoffset { 0.0   };
      double yoffset { 0.0   };      // in spatium units of "gscore"
      qreal mag      { 1.0   };
      bool readOnly  { false };

      PaletteCell() = default;
      PaletteCell(std::unique_ptr<Element> e, const QString& _name, QString _tag = QString(), qreal _mag = 1.0)
         : element(std::move(e)), name(_name), tag(_tag), mag(_mag) {}
         // TODO: drawStaff/needsStaff (see palette.cpp)

      };

//---------------------------------------------------------
//   PaletteCellIconEngine
//---------------------------------------------------------

class PaletteCellIconEngine : public QIconEngine {
      const PaletteCell* _cell;

   public:
      PaletteCellIconEngine(const PaletteCell* cell) : _cell(cell) {}

      QIconEngine* clone() const override { return new PaletteCellIconEngine(_cell); }

//       QList<QSize> availableSizes(QIcon::Mode /*mode*/, QIcon::State /*state*/) const override { return { QSize(64, 64) }; }

      void paint(QPainter* painter, const QRect& rect, QIcon::Mode mode, QIcon::State state) override;
      };

//---------------------------------------------------------
//   PaletteModel
//---------------------------------------------------------

class PaletteModel : public QAbstractListModel {
      Q_OBJECT

      std::vector<std::unique_ptr<PaletteCell>> cells; // unique_ptr to avoid moving PaletteCell objects; needed for PaletteCellIconEngine

   public:
      PaletteModel(QObject* parent = nullptr) : QAbstractListModel(parent) {}
      PaletteModel(std::vector<std::unique_ptr<PaletteCell>> c, QObject* parent = nullptr)
         : QAbstractListModel(parent), cells(std::move(c)) {}

      void insert(int idx, Element* e, const QString& name, QString tag = QString(), qreal mag = 1.0);
      void append(Element* e, const QString& name, QString tag = QString(), qreal mag = 1.0);

      int rowCount(const QModelIndex& parent = QModelIndex()) const override;
      QVariant data(const QModelIndex& index, int role) const override;
//       QVariant headerData(int section, Qt::Orientation orientation, int role) const override // TODO: headerData: palette name?

      Qt::ItemFlags flags(const QModelIndex &index) const override;

      QMimeData* mimeData(const QModelIndexList& indexes) const override;
      QStringList mimeTypes() const override;

      static constexpr int paletteElementRole = Qt::UserRole;
      };

} // namespace Ms

Q_DECLARE_METATYPE(const Ms::PaletteCell*);

#endif