MuseScore Plugins
3.5
Plugins API for MuseScore
|
Public Member Functions | |
Q_INVOKABLE QString | metaTag (const QString &tag) const |
Returns as a string the metatag named tag . | |
Q_INVOKABLE void | setMetaTag (const QString &tag, const QString &val) |
Sets the metatag named tag to val . | |
Q_INVOKABLE void | appendPart (const QString &instrumentId) |
Appends a part with the instrument defined by instrumentId to this score. More... | |
Q_INVOKABLE void | appendPartByMusicXmlId (const QString &instrumentMusicXmlId) |
Appends a part with the instrument defined by the given MusicXML ID to this score. More... | |
Q_INVOKABLE void | appendMeasures (int n) |
Appends a number of measures to this score. | |
Q_INVOKABLE void | addText (const QString &type, const QString &text) |
Adds a header text to the score. More... | |
Q_INVOKABLE Ms::PluginAPI::Cursor * | newCursor () |
Creates and returns a cursor to be used to navigate in the score. | |
Q_INVOKABLE Ms::PluginAPI::Segment * | firstSegment () |
Q_INVOKABLE QString | extractLyrics () |
Q_INVOKABLE void | startCmd () |
For "dock" type plugins: to be used before score modifications to make them undoable. More... | |
Q_INVOKABLE void | endCmd (bool rollback=false) |
For "dock" type plugins: to be used after score modifications to make them undoable. More... | |
Q_INVOKABLE void | createPlayEvents () |
Create PlayEvents for all notes based on ornamentation. More... | |
Public Member Functions inherited from ScoreElement | |
Q_INVOKABLE QString | userName () const |
Human-readable element type name. More... | |
Q_INVOKABLE bool | is (Ms::PluginAPI::ScoreElement *other) |
Checks whether two variables represent the same object. More... | |
Properties | |
QString | composer |
Composer of the score, as taken from the score properties (read only). More... | |
int | duration |
Duration of score in seconds (read only). More... | |
QQmlListProperty< Ms::PluginAPI::Excerpt > | excerpts |
List of the excerpts (linked parts) (read only) | |
Ms::PluginAPI::Measure | firstMeasure |
First measure of the score (read only) | |
Ms::PluginAPI::Measure | firstMeasureMM |
First multimeasure rest measure of the score (read only). More... | |
int | harmonyCount |
Number of harmony items (chord symbols) in the score (read only). More... | |
bool | hasHarmonies |
Whether score has harmonies (chord symbols) (read only). More... | |
bool | hasLyrics |
Whether score has lyrics (read only). More... | |
int | keysig |
Key signature at the start of the score, in number of accidentals, negative for flats, postitive for sharps (read only). More... | |
Ms::PluginAPI::Measure | lastMeasure |
Last measure of the score (read only) | |
Ms::PluginAPI::Measure | lastMeasureMM |
Last multimeasure rest measure of the score (read only). More... | |
Ms::PluginAPI::Segment | lastSegment |
Last score segment (read only) | |
int | lyricCount |
Number of lyrics items (syllables) in the score (read only). More... | |
QString | scoreName |
Name of the score, without path leading to it and extension. More... | |
int | nmeasures |
Number of measures (read only) | |
int | npages |
Number of pages (read only) | |
int | nstaves |
Number of staves (read only) | |
int | ntracks |
Number of tracks (nstaves * 4) (read only) | |
QQmlListProperty< Ms::PluginAPI::Part > | parts |
The list of parts. | |
QString | lyricist |
Lyricist of score, as taken from the score properties. More... | |
QString | title |
Title of score, as taken from the score properties' workTitle (read only). More... | |
QString | mscoreVersion |
MuseScore version the score has been last saved with (includes autosave) (read only) | |
QString | mscoreRevision |
MuseScore revision the score has been last saved with (includes autosave) (read only) | |
Ms::PluginAPI::Selection | selection |
Current selections for the score. More... | |
Ms::PluginAPI::MStyle | style |
Style settings for this score. More... | |
int | pageNumberOffset |
Page numbering offset. More... | |
QQmlListProperty< Ms::PluginAPI::Staff > | staves |
List of staves in this score. More... | |
Properties inherited from ScoreElement | |
int | type |
Type of this element. More... | |
QString | name |
Name of this element's type, not localized. More... | |
void addText | ( | const QString & | type, |
const QString & | txt | ||
) |
Adds a header text to the score.
type | One of the following values:
|
txt | Text to be added. |
void appendPart | ( | const QString & | instrumentId | ) |
Appends a part with the instrument defined by instrumentId
to this score.
instrumentId | - ID of the instrument to be added, as listed in instruments.xml file. |
void appendPartByMusicXmlId | ( | const QString & | instrumentMusicXmlId | ) |
Appends a part with the instrument defined by the given MusicXML ID to this score.
instrumentMusicXmlId | - MusicXML Sound ID of the instrument to be added. |
|
inline |
|
inline |
For "dock" type plugins: to be used after score modifications to make them undoable.
Ends an undoable command. Should be used at least once by "dock" type plugins in case they modify the score.
rollback | If true, reverts all the changes made since the last startCmd() invocation. |
void startCmd | ( | ) |
For "dock" type plugins: to be used before score modifications to make them undoable.
Starts an undoable command. Must be accompanied by a corresponding endCmd() call. Should be used at least once by "dock" type plugins in case they modify the score.
|
read |
Composer of the score, as taken from the score properties (read only).
|
read |
Duration of score in seconds (read only).
|
read |
First multimeasure rest measure of the score (read only).
|
read |
Number of harmony items (chord symbols) in the score (read only).
|
read |
Whether score has harmonies (chord symbols) (read only).
|
read |
Whether score has lyrics (read only).
|
read |
Key signature at the start of the score, in number of accidentals, negative for flats, postitive for sharps (read only).
|
read |
Last multimeasure rest measure of the score (read only).
|
read |
Number of lyrics items (syllables) in the score (read only).
|
read |
Lyricist of score, as taken from the score properties.
|
readwrite |
Page numbering offset.
The user-visible number of the given page
is defined as
|
readwrite |
Name of the score, without path leading to it and extension.
|
read |
Current selections for the score.
|
read |
List of staves in this score.
|
read |
Style settings for this score.
|
read |
Title of score, as taken from the score properties' workTitle (read only).