 |
MuseScore Plugins
3.2.3
Plugins API for MuseScore
|
13 #ifndef __PLUGIN_API_SCORE_H__
14 #define __PLUGIN_API_SCORE_H__
16 #include "scoreelement.h"
19 #include "libmscore/score.h"
86 Score(
Ms::
Score* s =
nullptr, Ownership o = Ownership::SCORE)
89 Ms::Score* score() {
return toScore(e); }
90 const Ms::Score* score()
const {
return toScore(e); }
92 QString
composer() {
return score()->metaTag(
"composer"); }
93 int duration() {
return score()->duration(); }
96 bool hasLyrics() {
return score()->hasLyrics(); }
97 int keysig() {
return score()->keysig(); }
98 int lyricCount() {
return score()->lyricCount(); }
99 QString
lyricist() {
return score()->metaTag(
"lyricist"); }
100 QString
title() {
return score()->metaTag(
"workTitle"); }
104 Q_INVOKABLE QString
metaTag(
const QString& tag)
const {
return score()->metaTag(tag); }
106 Q_INVOKABLE
void setMetaTag(
const QString& tag,
const QString& val) { score()->setMetaTag(tag, val); }
112 Q_INVOKABLE
void addText(
const QString&
type,
const QString& text);
125 QString
name()
const {
return score()->masterScore()->title(); }
126 void setName(
const QString&
name) { score()->masterScore()->setName(
name); }
129 Q_INVOKABLE QString extractLyrics() {
return score()->extractLyrics(); }
135 int nmeasures()
const {
return score()->nmeasures(); }
136 int npages()
const {
return score()->npages(); }
137 int nstaves()
const {
return score()->nstaves(); }
138 int ntracks()
const {
return score()->ntracks(); }
149 Q_INVOKABLE
void startCmd() { score()->startCmd(); }
159 Q_INVOKABLE
void endCmd(
bool rollback =
false) { score()->endCmd(rollback); }
165 QQmlListProperty<Part>
parts() {
return wrapContainerProperty<Part>(
this, score()->
parts()); }
166 QQmlListProperty<Excerpt>
excerpts() {
return wrapExcerptsContainerProperty<Excerpt>(
this, score()->
excerpts()); }
Ms::PluginAPI::Measure lastMeasure
Last measure of the score (read only)
Definition: score.h:54
Q_INVOKABLE void startCmd()
For "dock" type plugins: to be used before score modifications to make them undoable.
Definition: score.h:149
int npages
Number of pages (read only)
Definition: score.h:66
int duration
Duration of score in seconds (read only).
Definition: score.h:37
bool hasHarmonies
Whether score has harmonies (chord symbols) (read only).
Definition: score.h:47
QString name
Name of this element's type, not localized.
Definition: scoreelement.h:54
bool hasLyrics
Whether score has lyrics (read only).
Definition: score.h:49
Base class for most of object wrappers exposed to QML.
Definition: scoreelement.h:42
int ntracks
Number of tracks (nstaves * 4) (read only)
Definition: score.h:70
QString composer
Composer of the score, as taken from the score properties (read only).
Definition: score.h:35
Definition: elements.h:519
Ms::PluginAPI::Measure firstMeasure
First measure of the score (read only)
Definition: score.h:41
Q_INVOKABLE Ms::PluginAPI::Cursor * newCursor()
Creates and returns a cursor to be used to navigate in the score.
Definition: score.cpp:28
Q_INVOKABLE void addText(const QString &type, const QString &text)
Adds a header text to the score.
Definition: score.cpp:45
QQmlListProperty< Ms::PluginAPI::Excerpt > excerpts
List of the excerpts (linked parts) (read only)
Definition: score.h:39
QString mscoreRevision
MuseScore revision the score has been last saved with (includes autosave) (read only)
Definition: score.h:82
Ms::PluginAPI::Measure lastMeasureMM
Last multimeasure rest measure of the score (read only).
Definition: score.h:56
QString scoreName
Name of the score, without path leading to it and extension.
Definition: score.h:62
int nmeasures
Number of measures (read only)
Definition: score.h:64
QQmlListProperty< Ms::PluginAPI::Part > parts
The list of parts.
Definition: score.h:73
QString lyricist
Lyricist of score, as taken from the score properties.
Definition: score.h:75
int nstaves
Number of staves (read only)
Definition: score.h:68
Definition: elements.h:459
int type
Type of this element.
Definition: scoreelement.h:48
QString title
Title of score, as taken from the score properties' workTitle (read only).
Definition: score.h:78
Q_INVOKABLE void endCmd(bool rollback=false)
For "dock" type plugins: to be used after score modifications to make them undoable.
Definition: score.h:159
Main class of the plugins framework. Named as MuseScore in QML.
Definition: qmlpluginapi.h:55
int harmonyCount
Number of harmony items (chord symbols) in the score (read only).
Definition: score.h:45
Ms::PluginAPI::Segment lastSegment
Last score segment (read only)
Definition: score.h:58
Q_INVOKABLE void setMetaTag(const QString &tag, const QString &val)
Sets the metatag named tag to val.
Definition: score.h:106
Cursor can be used by plugins to manipulate the score.
Definition: cursor.h:43
Q_INVOKABLE QString metaTag(const QString &tag) const
Returns as a string the metatag named tag.
Definition: score.h:104
Ms::PluginAPI::Measure firstMeasureMM
First multimeasure rest measure of the score (read only).
Definition: score.h:43
Q_INVOKABLE void appendMeasures(int n)
Appends a number of measures to this score.
Definition: score.h:111
Definition: cursor.cpp:29
int lyricCount
Number of lyrics items (syllables) in the score (read only).
Definition: score.h:60
int keysig
Key signature at the start of the score, in number of accidentals, negative for flats,...
Definition: score.h:52
QString mscoreVersion
MuseScore version the score has been last saved with (includes autosave) (read only)
Definition: score.h:80