Main class of the plugins framework. Named as MuseScore in QML. More...

#include <qmlpluginapi.h>

Inheritance diagram for Ms::PluginAPI::PluginAPI:

Collaboration diagram for Ms::PluginAPI::PluginAPI:

Signals
void	run ()
	Indicates that the plugin was launched. More...

void	scoreStateChanged (const QMap< QString, QVariant > &state)
	Notifies plugin about changes in score state. More...

Public Member Functions
	PluginAPI (QQuickItem *parent=0)

void	runPlugin () override

void	endCmd (const QMap< QString, QVariant > &stateInfo) override

Score *	curScore () const

QQmlListProperty< Score >	scores ()

Q_INVOKABLE Ms::PluginAPI::Score *	newScore (const QString &name, const QString &part, int measures)

Q_INVOKABLE Ms::PluginAPI::Element *	newElement (int)
	Creates a new element with the given type. More...

Q_INVOKABLE void	removeElement (Ms::PluginAPI::Element *wrapped)
	Disposes of an Element and its children. More...

Q_INVOKABLE void	cmd (const QString &)

Q_INVOKABLE Ms::PluginAPI::MsProcess *	newQProcess ()
	Not enabled currently (so excluded from plugin docs) More...

Q_INVOKABLE bool	writeScore (Ms::PluginAPI::Score *, const QString &name, const QString &ext)
	Writes a score to a file. More...

Q_INVOKABLE Ms::PluginAPI::Score *	readScore (const QString &name, bool noninteractive=false)
	Reads the score from a file and opens it in a new tab. More...

Q_INVOKABLE void	closeScore (Ms::PluginAPI::Score *)

Q_INVOKABLE void	log (const QString &)

Q_INVOKABLE void	logn (const QString &)

Q_INVOKABLE void	log2 (const QString &, const QString &)

Q_INVOKABLE void	openLog (const QString &)

Q_INVOKABLE void	closeLog ()

Q_INVOKABLE Ms::PluginAPI::FractionWrapper *	fraction (int numerator, int denominator) const
	Creates a new fraction with the given numerator and denominator. More...

Public Member Functions inherited from Ms::QmlPlugin
	QmlPlugin (QQuickItem *parent=0)

void	setMenuPath (const QString &s)

QString	menuPath () const

void	setVersion (const QString &s)

QString	version () const

void	setDescription (const QString &s)

QString	description () const

void	setFilePath (const QString s)

QString	filePath () const

void	setPluginType (const QString &s)

QString	pluginType () const

void	setDockArea (const QString &s)

QString	dockArea () const

void	setRequiresScore (bool b)

bool	requiresScore () const

int	division () const

int	mscoreVersion () const

int	mscoreMajorVersion () const

int	mscoreMinorVersion () const

int	mscoreUpdateVersion () const

qreal	mscoreDPI () const

Static Public Member Functions
static void	registerQmlTypes ()

Properties
QString	menuPath
	Path where the plugin is placed in menu. More...

QString	filePath
	Source file path, without the file name (read only) More...

QString	version
	Version of this plugin. More...

QString	description
	Human-readable plugin description, displayed in Plugin Manager. More...

QString	pluginType
	Type may be dialog, dock, or not defined. More...

QString	dockArea
	Where to dock on main screen. More...

bool	requiresScore
	Whether the plugin requires an existing score to run, default is `true` More...

int	division
	Number of MIDI ticks for 1/4 note (read only) More...

int	mscoreVersion
	Complete version number of MuseScore in the form: MMmmuu (read only) More...

int	mscoreMajorVersion
	1st part of the MuseScore version (read only) More...

int	mscoreMinorVersion
	2nd part of the MuseScore version (read only) More...

int	mscoreUpdateVersion
	3rd part of the MuseScore version (read only) More...

qreal	mscoreDPI
	(read-only) More...

Ms::PluginAPI::Score	curScore
	Current score, if any (read only) More...

QQmlListProperty< Ms::PluginAPI::Score >	scores
	List of currently open scores (read only). More...

Ms::PluginAPI::Enum	Element
	Contains Ms::ElementType enumeration values. More...

Ms::PluginAPI::Enum	Accidental
	Contains Ms::AccidentalType enumeration values. More...

Ms::PluginAPI::Enum	Beam
	Contains Ms::Beam::Mode enumeration values. More...

Ms::PluginAPI::Enum	Placement
	Contains Ms::Placement enumeration values. More...

Ms::PluginAPI::Enum	Glissando
	Contains Ms::GlissandoType enumeration values. More...

Ms::PluginAPI::Enum	LayoutBreak
	Contains Ms::LayoutBreak::Type enumeration values. More...

Ms::PluginAPI::Enum	Lyrics
	Contains Ms::Lyrics::Syllabic enumeration values. More...

Ms::PluginAPI::Enum	Direction
	Contains Ms::Direction enumeration values. More...

Ms::PluginAPI::Enum	DirectionH
	Contains Ms::MScore::DirectionH enumeration values. More...

Ms::PluginAPI::Enum	OrnamentStyle
	Contains Ms::MScore::OrnamentStyle enumeration values. More...

Ms::PluginAPI::Enum	GlissandoStyle
	Contains Ms::GlissandoStyle enumeration values. More...

Ms::PluginAPI::Enum	Tid
	Contains Ms::Tid enumeration values. More...

Ms::PluginAPI::Enum	Align
	Contains Ms::Align enumeration values. More...

Ms::PluginAPI::Enum	NoteType
	Contains Ms::NoteType enumeration values. More...

Ms::PluginAPI::Enum	PlayEventType
	Contains Ms::PlayEventType enumeration values. More...

Ms::PluginAPI::Enum	NoteHeadType
	Contains Ms::NoteHead::Type enumeration values. More...

Ms::PluginAPI::Enum	NoteHeadGroup
	Contains Ms::NoteHead::Group enumeration values. More...

Ms::PluginAPI::Enum	NoteValueType
	Contains Ms::Note::ValueType enumeration values. More...

Ms::PluginAPI::Enum	Segment
	Contains Ms::SegmentType enumeration values. More...

Ms::PluginAPI::Enum	Spanner

Static Private Member Functions
static Enum *	get_elementTypeEnum ()

static Enum *	get_accidentalTypeEnum ()

static Enum *	get_beamModeEnum ()

static Enum *	get_placementEnum ()

static Enum *	get_glissandoTypeEnum ()

static Enum *	get_layoutBreakTypeEnum ()

static Enum *	get_lyricsSyllabicEnum ()

static Enum *	get_directionEnum ()

static Enum *	get_directionHEnum ()

static Enum *	get_ornamentStyleEnum ()

static Enum *	get_glissandoStyleEnum ()

static Enum *	get_tidEnum ()

static Enum *	get_alignEnum ()

static Enum *	get_noteTypeEnum ()

static Enum *	get_playEventTypeEnum ()

static Enum *	get_noteHeadTypeEnum ()

static Enum *	get_noteHeadGroupEnum ()

static Enum *	get_noteValueTypeEnum ()

static Enum *	get_segmentTypeEnum ()

static Enum *	get_spannerAnchorEnum ()

static void	initEnums ()

Private Attributes
QFile	logFile

Static Private Attributes
static Enum *	elementTypeEnum

static Enum *	accidentalTypeEnum

static Enum *	beamModeEnum

static Enum *	placementEnum

static Enum *	glissandoTypeEnum

static Enum *	layoutBreakTypeEnum

static Enum *	lyricsSyllabicEnum

static Enum *	directionEnum

static Enum *	directionHEnum

static Enum *	ornamentStyleEnum

static Enum *	glissandoStyleEnum

static Enum *	tidEnum

static Enum *	alignEnum

static Enum *	noteTypeEnum

static Enum *	playEventTypeEnum

static Enum *	noteHeadTypeEnum

static Enum *	noteHeadGroupEnum

static Enum *	noteValueTypeEnum

static Enum *	segmentTypeEnum

static Enum *	spannerAnchorEnum

Additional Inherited Members
Public Slots inherited from Ms::QmlPlugin
Protected Member Functions inherited from Ms::QmlPlugin
MuseScoreCore *	msc ()

const MuseScoreCore *	msc () const

Protected Attributes inherited from Ms::QmlPlugin
QString	_filePath

Detailed Description

Main class of the plugins framework. Named as MuseScore in QML.

This class is exposed to QML plugins framework under MuseScore name and is the root component of each MuseScore plugin.

Constructor & Destructor Documentation

◆ PluginAPI()

Ms::PluginAPI::PluginAPI::PluginAPI ( QQuickItem * parent = 0 )

Member Function Documentation

◆ closeLog()

void Ms::PluginAPI::PluginAPI::closeLog ( )

◆ closeScore()

void Ms::PluginAPI::PluginAPI::closeScore ( Ms::PluginAPI::Score * score )

◆ cmd()

void Ms::PluginAPI::PluginAPI::cmd ( const QString & s )

◆ curScore()

Score* Ms::PluginAPI::PluginAPI::curScore ( ) const

◆ endCmd()

void Ms::PluginAPI::PluginAPI::endCmd ( const QMap< QString, QVariant > & stateInfo )

inlineoverridevirtual

Implements Ms::QmlPlugin.

◆ fraction()

FractionWrapper * Ms::PluginAPI::PluginAPI::fraction	(	int	numerator,
		int	denominator
	)		const

Creates a new fraction with the given numerator and denominator.

◆ get_accidentalTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_accidentalTypeEnum ( )

inlinestaticprivate

◆ get_alignEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_alignEnum ( )

inlinestaticprivate

◆ get_beamModeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_beamModeEnum ( )

inlinestaticprivate

◆ get_directionEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_directionEnum ( )

inlinestaticprivate

◆ get_directionHEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_directionHEnum ( )

inlinestaticprivate

◆ get_elementTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_elementTypeEnum ( )

inlinestaticprivate

◆ get_glissandoStyleEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_glissandoStyleEnum ( )

inlinestaticprivate

◆ get_glissandoTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_glissandoTypeEnum ( )

inlinestaticprivate

◆ get_layoutBreakTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_layoutBreakTypeEnum ( )

inlinestaticprivate

◆ get_lyricsSyllabicEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_lyricsSyllabicEnum ( )

inlinestaticprivate

◆ get_noteHeadGroupEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_noteHeadGroupEnum ( )

inlinestaticprivate

◆ get_noteHeadTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_noteHeadTypeEnum ( )

inlinestaticprivate

◆ get_noteTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_noteTypeEnum ( )

inlinestaticprivate

◆ get_noteValueTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_noteValueTypeEnum ( )

inlinestaticprivate

◆ get_ornamentStyleEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_ornamentStyleEnum ( )

inlinestaticprivate

◆ get_placementEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_placementEnum ( )

inlinestaticprivate

◆ get_playEventTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_playEventTypeEnum ( )

inlinestaticprivate

◆ get_segmentTypeEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_segmentTypeEnum ( )

inlinestaticprivate

◆ get_spannerAnchorEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_spannerAnchorEnum ( )

inlinestaticprivate

◆ get_tidEnum()

static Enum* Ms::PluginAPI::PluginAPI::get_tidEnum ( )

inlinestaticprivate

◆ initEnums()

void Ms::PluginAPI::PluginAPI::initEnums ( )

staticprivate

◆ log()

void Ms::PluginAPI::PluginAPI::log ( const QString & txt )

◆ log2()

void Ms::PluginAPI::PluginAPI::log2	(	const QString &	txt,
		const QString &	txt2
	)

◆ logn()

void Ms::PluginAPI::PluginAPI::logn ( const QString & txt )

◆ newElement()

Element * Ms::PluginAPI::PluginAPI::newElement ( int elementType )

Creates a new element with the given type.

The element can be then added to a score via Cursor::add.

Parameters

elementType Element type, should be the value from PluginAPI::PluginAPI::Element enumeration.

◆ newQProcess()

MsProcess * Ms::PluginAPI::PluginAPI::newQProcess ( )

Not enabled currently (so excluded from plugin docs)

◆ newScore()

Score * Ms::PluginAPI::PluginAPI::newScore	(	const QString &	name,
		const QString &	part,
		int	measures
	)

◆ openLog()

void Ms::PluginAPI::PluginAPI::openLog ( const QString & name )

◆ readScore()

Score * Ms::PluginAPI::PluginAPI::readScore	(	const QString &	name,
		bool	noninteractive = `false`
	)

Reads the score from a file and opens it in a new tab.

Parameters

name	Path to the file to be opened.
noninteractive	Can be used to avoid a "save changes" dialog on closing a score that is either imported or was created with an older version of MuseScore.

◆ registerQmlTypes()

void Ms::PluginAPI::PluginAPI::registerQmlTypes ( )

static

◆ removeElement()

void Ms::PluginAPI::PluginAPI::removeElement ( Ms::PluginAPI::Element * wrapped )

Disposes of an Element and its children.

Parameters

Element type.

Since: MuseScore 3.3

◆ run

void Ms::PluginAPI::PluginAPI::run ( )

signal

Indicates that the plugin was launched.

Implement onRun() function in your plugin to handle this signal.

◆ runPlugin()

void Ms::PluginAPI::PluginAPI::runPlugin ( )

inlineoverridevirtual

Implements Ms::QmlPlugin.

◆ scores()

QQmlListProperty<Score> Ms::PluginAPI::PluginAPI::scores ( )

◆ scoreStateChanged

void Ms::PluginAPI::PluginAPI::scoreStateChanged ( const QMap< QString, QVariant > & state )

signal

Notifies plugin about changes in score state.

Called after each user (or plugin) action which may have changed a score. Implement onScoreStateChanged() function in your plugin to handle this signal.

state variable is available within the handler with following fields:

selectionChanged
excerptsChanged
instrumentsChanged
startLayoutTick
endLayoutTick

If a plugin modifies score in this handler, then it should:

enclose all modifications within Score::startCmd() / Score::endCmd()
take care of preventing an infinite recursion, as plugin-originated changes will trigger this signal again after calling Score::endCmd()

Example:

import QtQuick 2.0
import MuseScore 3.0
MuseScore {
    menuPath: "Plugins.selectionChangeExample"
    pluginType: "dock"
    dockArea:   "left"
    implicitHeight: 75 // necessary for dock widget to appear with nonzero height
    implicitWidth: 150
    Text {
       // A label which will display pitch of the currently selected note
       id: pitchLabel
       anchors.fill: parent
    }
    onScoreStateChanged: {
        if (state.selectionChanged) {
            var el = curScore ? curScore.selection.elements[0] : null;
            if (el && el.type == Element.NOTE)
                pitchLabel.text = el.pitch;
            else
                pitchLabel.text = "no note selected";
        }
    }
}

Warning: This functionality is considered experimental. This API may change in future versions of MuseScore.

Since: MuseScore 3.3

◆ writeScore()

bool Ms::PluginAPI::PluginAPI::writeScore	(	Ms::PluginAPI::Score *	s,
		const QString &	name,
		const QString &	ext
	)

Writes a score to a file.

Parameters

s	The score which should be saved.
name	Path where to save the score, with or without the filename extension (the extension is determined by `ext` parameter).
ext	Filename extension without the dot, e.g. `"mscz"` or `"pdf"`. Determines the file format to be used.

Member Data Documentation

◆ accidentalTypeEnum

Enum * Ms::PluginAPI::PluginAPI::accidentalTypeEnum

staticprivate

◆ alignEnum

Enum * Ms::PluginAPI::PluginAPI::alignEnum

staticprivate

◆ beamModeEnum

Enum * Ms::PluginAPI::PluginAPI::beamModeEnum

staticprivate

◆ directionEnum

Enum * Ms::PluginAPI::PluginAPI::directionEnum

staticprivate

◆ directionHEnum

Enum * Ms::PluginAPI::PluginAPI::directionHEnum

staticprivate

◆ elementTypeEnum

Enum * Ms::PluginAPI::PluginAPI::elementTypeEnum

staticprivate

◆ glissandoStyleEnum

Enum * Ms::PluginAPI::PluginAPI::glissandoStyleEnum

staticprivate

◆ glissandoTypeEnum

Enum * Ms::PluginAPI::PluginAPI::glissandoTypeEnum

staticprivate

◆ layoutBreakTypeEnum

Enum * Ms::PluginAPI::PluginAPI::layoutBreakTypeEnum

staticprivate

◆ logFile

QFile Ms::PluginAPI::PluginAPI::logFile

private

◆ lyricsSyllabicEnum

Enum * Ms::PluginAPI::PluginAPI::lyricsSyllabicEnum

staticprivate

◆ noteHeadGroupEnum

Enum * Ms::PluginAPI::PluginAPI::noteHeadGroupEnum

staticprivate

◆ noteHeadTypeEnum

Enum * Ms::PluginAPI::PluginAPI::noteHeadTypeEnum

staticprivate

◆ noteTypeEnum

Enum * Ms::PluginAPI::PluginAPI::noteTypeEnum

staticprivate

◆ noteValueTypeEnum

Enum * Ms::PluginAPI::PluginAPI::noteValueTypeEnum

staticprivate

◆ ornamentStyleEnum

Enum * Ms::PluginAPI::PluginAPI::ornamentStyleEnum

staticprivate

◆ placementEnum

Enum * Ms::PluginAPI::PluginAPI::placementEnum

staticprivate

◆ playEventTypeEnum

Enum * Ms::PluginAPI::PluginAPI::playEventTypeEnum

staticprivate

◆ segmentTypeEnum

Enum * Ms::PluginAPI::PluginAPI::segmentTypeEnum

staticprivate

◆ spannerAnchorEnum

Enum * Ms::PluginAPI::PluginAPI::spannerAnchorEnum

staticprivate

◆ tidEnum

Enum * Ms::PluginAPI::PluginAPI::tidEnum

staticprivate

Property Documentation

◆ Accidental

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Accidental

read

Contains Ms::AccidentalType enumeration values.

◆ Align

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Align

read

Contains Ms::Align enumeration values.

Since: MuseScore 3.3

◆ Beam

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Beam

read

Contains Ms::Beam::Mode enumeration values.

◆ curScore

Score * Ms::PluginAPI::PluginAPI::curScore

read

Current score, if any (read only)

◆ description

QString Ms::PluginAPI::PluginAPI::description

readwrite

Human-readable plugin description, displayed in Plugin Manager.

◆ Direction

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Direction

read

Contains Ms::Direction enumeration values.

Note: In MuseScore 2.X this enumeration was available as MScore.UP, MScore.DOWN, MScore.AUTO.

◆ DirectionH

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::DirectionH

read

Contains Ms::MScore::DirectionH enumeration values.

Note: In MuseScore 2.X this enumeration was available as MScore.LEFT, MScore.RIGHT, MScore.AUTO.

◆ division

int Ms::PluginAPI::PluginAPI::division

read

Number of MIDI ticks for 1/4 note (read only)

See also: ticklength

◆ dockArea

QString Ms::PluginAPI::PluginAPI::dockArea

readwrite

Where to dock on main screen.

Possible values: left, top, bottom, right

◆ Element

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Element

read

Contains Ms::ElementType enumeration values.

◆ filePath

QString Ms::PluginAPI::PluginAPI::filePath

read

Source file path, without the file name (read only)

◆ Glissando

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Glissando

read

Contains Ms::GlissandoType enumeration values.

◆ GlissandoStyle

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::GlissandoStyle

read

Contains Ms::GlissandoStyle enumeration values.

Note: In MuseScore 2.X this enumeration was available as MScore.CHROMATIC, MScore.WHITE_KEYS, MScore.BLACK_KEYS, MScore.DIATONIC.

◆ LayoutBreak

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::LayoutBreak

read

Contains Ms::LayoutBreak::Type enumeration values.

◆ Lyrics

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Lyrics

read

Contains Ms::Lyrics::Syllabic enumeration values.

◆ menuPath

QString Ms::PluginAPI::PluginAPI::menuPath

readwrite

Path where the plugin is placed in menu.

◆ mscoreDPI

qreal Ms::PluginAPI::PluginAPI::mscoreDPI

read

(read-only)

◆ mscoreMajorVersion

int Ms::PluginAPI::PluginAPI::mscoreMajorVersion

read

1st part of the MuseScore version (read only)

◆ mscoreMinorVersion

int Ms::PluginAPI::PluginAPI::mscoreMinorVersion

read

2nd part of the MuseScore version (read only)

◆ mscoreUpdateVersion

int Ms::PluginAPI::PluginAPI::mscoreUpdateVersion

read

3rd part of the MuseScore version (read only)

◆ mscoreVersion

int Ms::PluginAPI::PluginAPI::mscoreVersion

read

Complete version number of MuseScore in the form: MMmmuu (read only)

◆ NoteHeadGroup

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::NoteHeadGroup

read

Contains Ms::NoteHead::Group enumeration values.

Note: In MuseScore 2.X this enumeration was available in NoteHead class (e.g. NoteHead.HEAD_TRIANGLE).

◆ NoteHeadType

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::NoteHeadType

read

Contains Ms::NoteHead::Type enumeration values.

Note: In MuseScore 2.X this enumeration was available in NoteHead class (e.g. NoteHead.HEAD_QUARTER).

◆ NoteType

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::NoteType

read

Contains Ms::NoteType enumeration values.

Since: MuseScore 3.2.1

◆ NoteValueType

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::NoteValueType

read

Contains Ms::Note::ValueType enumeration values.

Note: In MuseScore 2.X this enumeration was available as Note.OFFSET_VAL, Note.USER_VAL

◆ OrnamentStyle

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::OrnamentStyle

read

Contains Ms::MScore::OrnamentStyle enumeration values.

Note: In MuseScore 2.X this enumeration was available as MScore.DEFAULT, MScore.BAROQUE.

◆ Placement

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Placement

read

Contains Ms::Placement enumeration values.

Note: In MuseScore 2.X this enumeration was available as Element.ABOVE and Element.BELOW.

◆ PlayEventType

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::PlayEventType

read

Contains Ms::PlayEventType enumeration values.

Since: MuseScore 3.3

◆ pluginType

QString Ms::PluginAPI::PluginAPI::pluginType

readwrite

Type may be dialog, dock, or not defined.

◆ requiresScore

bool Ms::PluginAPI::PluginAPI::requiresScore

readwrite

Whether the plugin requires an existing score to run, default is true

◆ scores

QQmlListProperty< Score > Ms::PluginAPI::PluginAPI::scores

read

List of currently open scores (read only).

Since: MuseScore 3.2

◆ Segment

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Segment

read

Contains Ms::SegmentType enumeration values.

◆ Spanner

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Spanner

read

◆ Tid

Ms::PluginAPI::Enum Ms::PluginAPI::PluginAPI::Tid

read

Contains Ms::Tid enumeration values.

Note: In MuseScore 2.X this enumeration was available as TextStyleType (TextStyleType.TITLE etc.)

◆ version

QString Ms::PluginAPI::PluginAPI::version

readwrite

Version of this plugin.

The documentation for this class was generated from the following files:

mscore/plugin/api/qmlpluginapi.h
mscore/plugin/api/qmlpluginapi.cpp

Signals

Public Member Functions

Static Public Member Functions

Properties

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PluginAPI()

Member Function Documentation

◆ closeLog()

◆ closeScore()

◆ cmd()

◆ curScore()

◆ endCmd()

◆ fraction()

◆ get_accidentalTypeEnum()

◆ get_alignEnum()

◆ get_beamModeEnum()

◆ get_directionEnum()

◆ get_directionHEnum()

◆ get_elementTypeEnum()

◆ get_glissandoStyleEnum()

◆ get_glissandoTypeEnum()

◆ get_layoutBreakTypeEnum()

◆ get_lyricsSyllabicEnum()

◆ get_noteHeadGroupEnum()

◆ get_noteHeadTypeEnum()

◆ get_noteTypeEnum()

◆ get_noteValueTypeEnum()

◆ get_ornamentStyleEnum()

◆ get_placementEnum()

◆ get_playEventTypeEnum()

◆ get_segmentTypeEnum()

◆ get_spannerAnchorEnum()

◆ get_tidEnum()

◆ initEnums()

◆ log()

◆ log2()

◆ logn()

◆ newElement()

◆ newQProcess()

◆ newScore()

◆ openLog()

◆ readScore()

◆ registerQmlTypes()

◆ removeElement()

◆ run

◆ runPlugin()

◆ scores()

◆ scoreStateChanged

◆ writeScore()

Member Data Documentation

◆ accidentalTypeEnum

◆ alignEnum

◆ beamModeEnum

◆ directionEnum

◆ directionHEnum

◆ elementTypeEnum

◆ glissandoStyleEnum

◆ glissandoTypeEnum

◆ layoutBreakTypeEnum

◆ logFile

◆ lyricsSyllabicEnum

◆ noteHeadGroupEnum

◆ noteHeadTypeEnum

◆ noteTypeEnum

◆ noteValueTypeEnum

◆ ornamentStyleEnum

◆ placementEnum

◆ playEventTypeEnum

◆ segmentTypeEnum

◆ spannerAnchorEnum

◆ tidEnum

Property Documentation

◆ Accidental

◆ Align

◆ Beam