3b27da04a0
Updates the documentation for classes named from M to P to proposal A) in http://dev-list.musescore.org/Plugin-documentation-generated-manual-td7579164.html Properties are also sorted in alphabetical order for easier identification. No attempt made to evaluate what to include and what to exclude from documentation: anything which is currently documented is retained. Case by case decisions can always be made. Description of methods for `QProcess` and `ScoreView` (in file libmscore/plugins.h) are stubs.
153 lines
4.7 KiB
C++
153 lines
4.7 KiB
C++
//=============================================================================
|
|
// MuseScore
|
|
// Music Composition & Notation
|
|
//
|
|
// Copyright (C) 2012 Werner Schweer
|
|
//
|
|
// 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 __PLUGINS_H__
|
|
#define __PLUGINS_H__
|
|
|
|
#include "config.h"
|
|
|
|
#ifdef SCRIPT_INTERFACE
|
|
#include "libmscore/element.h"
|
|
#include "libmscore/score.h"
|
|
#include "libmscore/utils.h"
|
|
|
|
namespace Ms {
|
|
|
|
//---------------------------------------------------------
|
|
// @@ FileIO
|
|
// @P source string
|
|
//---------------------------------------------------------
|
|
|
|
class FileIO : public QObject {
|
|
Q_OBJECT
|
|
|
|
public:
|
|
Q_PROPERTY(QString source
|
|
READ source
|
|
WRITE setSource
|
|
NOTIFY sourceChanged)
|
|
explicit FileIO(QObject *parent = 0);
|
|
|
|
//@ reads file contents and returns a string
|
|
Q_INVOKABLE QString read();
|
|
//@ return true if the file exists
|
|
Q_INVOKABLE bool exists();
|
|
//@ write a string to the file
|
|
Q_INVOKABLE bool write(const QString& data);
|
|
//@ removes the file
|
|
Q_INVOKABLE bool remove();
|
|
//@ returns a path suitable for a temporary file
|
|
Q_INVOKABLE QString tempPath() {QDir dir; return dir.tempPath();};
|
|
//@ returns the file modification time
|
|
Q_INVOKABLE int modifiedTime();
|
|
|
|
QString source() { return mSource; };
|
|
|
|
public slots:
|
|
void setSource(const QString& source) { mSource = source; };
|
|
|
|
signals:
|
|
void sourceChanged(const QString& source);
|
|
void error(const QString& msg);
|
|
|
|
private:
|
|
QString mSource;
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// MsProcess
|
|
// @@ QProcess
|
|
//---------------------------------------------------------
|
|
|
|
class MsProcess : public QProcess {
|
|
Q_OBJECT
|
|
|
|
public:
|
|
MsProcess(QObject* parent = 0) : QProcess(parent) {}
|
|
|
|
public slots:
|
|
//@ --
|
|
Q_INVOKABLE void start(const QString& program) { QProcess::start(program); }
|
|
//@ --
|
|
Q_INVOKABLE bool waitForFinished(int msecs = 30000) { return QProcess::waitForFinished(msecs); }
|
|
//@ --
|
|
Q_INVOKABLE QByteArray readAllStandardOutput() { return QProcess::readAllStandardOutput(); }
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// @@ ScoreView
|
|
/// This is an GUI element to show a score.
|
|
//
|
|
// @P color color background color
|
|
// @P scale float scaling factor
|
|
//---------------------------------------------------------
|
|
|
|
class MsScoreView : public QQuickPaintedItem, public MuseScoreView {
|
|
Q_OBJECT
|
|
Q_PROPERTY(QColor color READ color WRITE setColor)
|
|
Q_PROPERTY(qreal scale READ scale WRITE setScale)
|
|
|
|
Score* score;
|
|
int _currentPage;
|
|
QColor _color;
|
|
qreal mag;
|
|
int playPos;
|
|
QRectF _boundingRect;
|
|
|
|
QNetworkAccessManager* networkManager;
|
|
|
|
virtual void dataChanged(const QRectF&) { update(); }
|
|
virtual void updateAll() { update(); }
|
|
virtual void adjustCanvasPosition(const Element*, bool) {}
|
|
virtual void removeScore() {}
|
|
virtual void changeEditElement(Element*) {}
|
|
virtual int gripCount() const { return 0; }
|
|
virtual const QRectF& getGrip(Grip) const override;
|
|
virtual const QTransform& matrix() const;
|
|
virtual void setDropRectangle(const QRectF&) {}
|
|
virtual void cmdAddSlur(Note*, Note*) {}
|
|
virtual void cmdAddHairpin(bool) {}
|
|
virtual void startEdit() {}
|
|
virtual void startEdit(Element*, Grip) {}
|
|
virtual Element* elementNear(QPointF) { return 0; }
|
|
|
|
virtual void paint(QPainter*);
|
|
|
|
virtual void setCursor(const QCursor&) {}
|
|
virtual QCursor cursor() const { return QCursor(); }
|
|
virtual QRectF boundingRect() const { return _boundingRect; }
|
|
virtual void drawBackground(QPainter*, const QRectF&) const {}
|
|
|
|
public slots:
|
|
//@ --
|
|
Q_INVOKABLE void setScore(Score*);
|
|
//@ --
|
|
Q_INVOKABLE void setCurrentPage(int n);
|
|
//@ --
|
|
Q_INVOKABLE void nextPage();
|
|
//@ --
|
|
Q_INVOKABLE void prevPage();
|
|
|
|
public:
|
|
MsScoreView(QQuickItem* parent = 0);
|
|
virtual ~MsScoreView() {}
|
|
QColor color() const { return _color; }
|
|
void setColor(const QColor& c) { _color = c; }
|
|
qreal scale() const { return mag; }
|
|
void setScale(qreal v) { mag = v; }
|
|
};
|
|
} // namespace Ms
|
|
#endif
|
|
|
|
#endif
|
|
|
|
|