#include <elements.h>

Inheritance diagram for Ms::PluginAPI::Note:

Collaboration diagram for Ms::PluginAPI::Note:

[legend]

Public Member Functions
	Note (Ms::Note *c=nullptr, Ownership own=Ownership::PLUGIN)

Ms::Note *	note ()

const Ms::Note *	note () const

int	tpc () const

void	setTpc (int val)

Ms::PluginAPI::Tie *	tieBack () const

Ms::PluginAPI::Tie *	tieForward () const

Ms::PluginAPI::Note *	firstTiedNote ()

Ms::PluginAPI::Note *	lastTiedNote ()

QQmlListProperty< Element >	dots ()

QQmlListProperty< Element >	elements ()

QQmlListProperty< PlayEvent >	playEvents ()

Element *	accidental ()

Ms::AccidentalType	accidentalType ()

void	setAccidentalType (Ms::AccidentalType t)

Ms::NoteType	noteType ()

Q_INVOKABLE Ms::PluginAPI::PlayEvent *	createPlayEvent ()
	Creates a PlayEvent object for use in Javascript. More...

Q_INVOKABLE void	add (Ms::PluginAPI::Element *wrapped)
	Add to a note's elements. More...

Q_INVOKABLE void	remove (Ms::PluginAPI::Element *wrapped)
	Remove a note's element. More...

Public Member Functions inherited from Ms::PluginAPI::Element
	Element (Ms::Element *e=nullptr, Ownership own=Ownership::PLUGIN)

Q_INVOKABLE Ms::PluginAPI::Element *	clone () const

Q_INVOKABLE QString	subtypeName () const

Q_INVOKABLE QString	_name () const
	Deprecated: same as ScoreElement::name. Left for compatibility purposes. More...

Ms::Element *	element ()
	Returns the underlying Ms::Element. More...

const Ms::Element *	element () const
	Returns the underlying Ms::Element. More...

Public Member Functions inherited from Ms::PluginAPI::ScoreElement
	ScoreElement (Ms::ScoreElement *_e=nullptr, Ownership own=Ownership::PLUGIN)

	ScoreElement (const ScoreElement &)=delete

ScoreElement &	operator= (const ScoreElement &)=delete

virtual	~ScoreElement ()

Ownership	ownership () const

void	setOwnership (Ownership o)

Ms::ScoreElement *	element ()

const Ms::ScoreElement *	element () const

QString	name () const

int	type () const

QVariant	get (Ms::Pid pid) const

void	set (Ms::Pid pid, QVariant val)

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...

Static Public Member Functions
static void	addInternal (Ms::Note note, Ms::Element el)

static bool	isChildAllowed (Ms::ElementType elementType)
	Check if element type can be a child of note. More...

Properties
Ms::PluginAPI::Element	accidental

Ms::AccidentalType	accidentalType

QQmlListProperty< Ms::PluginAPI::Element >	dots

QQmlListProperty< Ms::PluginAPI::Element >	elements

QQmlListProperty< Ms::PluginAPI::PlayEvent >	playEvents
	List of PlayEvents associated with this note. More...

Ms::PluginAPI::Tie	tieBack
	Backward tie for this Note. More...

Ms::PluginAPI::Tie	tieForward
	Forward tie for this Note. More...

Ms::PluginAPI::Note	firstTiedNote
	The first note of a series of ties to this note. More...

Ms::PluginAPI::Note	lastTiedNote
	The last note of a series of ties to this note. More...

Ms::NoteType	noteType
	The NoteType of the note. More...

int	pitch
	MIDI pitch of this note. More...

int	tpc1
	Concert pitch of the note. More...

int	tpc2
	Transposing pitch of the note. More...

int	tpc
	Concert or transposing pitch of this note, as per current "Concert Pitch" setting value. More...

QVariant	veloType
	See PluginAPI::PluginAPI::NoteValueType. More...

int	veloOffset

Properties inherited from Ms::PluginAPI::Element
Ms::PluginAPI::Element	parent
	Parent element for this element. More...

qreal	offsetX
	X-axis offset from a reference position in spatium units. More...

qreal	offsetY
	Y-axis offset from a reference position in spatium units. More...

qreal	posX
	Reference position of this element relative to its parent element. More...

qreal	posY
	Reference position of this element relative to its parent element. More...

QRectF	bbox
	Bounding box of this element. More...

QVariant	subtype

bool	selected

bool	generated

QColor	color
	Element color. More...

bool	visible

int	z
	Stacking order of this element. More...

QVariant	small

QVariant	showCourtesy

QVariant	lineType

QVariant	line

QVariant	fixed

QVariant	fixedLine

QVariant	headType
	Notehead type, one of PluginAPI::PluginAPI::NoteHeadType values. More...

QVariant	headGroup
	Notehead group, one of PluginAPI::PluginAPI::NoteHeadGroup values. More...

QVariant	articulationAnchor

QVariant	direction

QVariant	stemDirection

QVariant	noStem

QVariant	slurDirection

QVariant	leadingSpace

QVariant	distribute

QVariant	mirrorHead

QVariant	dotPosition

QVariant	tuning

QVariant	pause

QVariant	barlineType

QVariant	barlineSpan

QVariant	barlineSpanFrom

QVariant	barlineSpanTo

QPointF	offset
	Offset from a reference position in spatium units. More...

QVariant	fret

QVariant	string

QVariant	ghost

QVariant	play

QVariant	timesigNominal

QVariant	timesigActual

QVariant	numberType

QVariant	bracketType

QVariant	normalNotes

QVariant	actualNotes

QVariant	p1

QVariant	p2

QVariant	growLeft

QVariant	growRight

QVariant	boxHeight

QVariant	boxWidth

QVariant	topGap

QVariant	bottomGap

QVariant	leftMargin

QVariant	rightMargin

QVariant	topMargin

QVariant	bottomMargin

QVariant	layoutBreakType

QVariant	autoscale

QVariant	size

QVariant	scale

QVariant	lockAspectRatio

QVariant	sizeIsSpatium

QVariant	text

QVariant	beamPos

QVariant	beamMode

QVariant	beamNoSlope

QVariant	userLen

QVariant	space

QVariant	tempo

QVariant	tempoFollowText

QVariant	accidentalBracket

QVariant	numeratorString

QVariant	denominatorString

QVariant	fbprefix

QVariant	fbdigit

QVariant	fbsuffix

QVariant	fbcontinuationline

QVariant	ottavaType

QVariant	numbersOnly

QVariant	trillType

QVariant	vibratoType

QVariant	hairpinCircledTip

QVariant	hairpinType

QVariant	hairpinHeight

QVariant	hairpinContHeight

QVariant	veloChange

QVariant	singleNoteDynamics

QVariant	veloChangeMethod

QVariant	veloChangeSpeed

QVariant	dynamicRange

QVariant	placement

QVariant	velocity

QVariant	jumpTo

QVariant	playUntil

QVariant	continueAt

QVariant	label

QVariant	markerType

QVariant	arpUserLen1

QVariant	arpUserLen2

QVariant	measureNumberMode

QVariant	glissType

QVariant	glissText

QVariant	glissShowText

QVariant	diagonal

QVariant	groups

QVariant	lineStyle

QVariant	lineColor

QVariant	lineWidth

QVariant	lassoPos

QVariant	lassoSize

QVariant	timeStretch

QVariant	ornamentStyle

QVariant	timesig

QVariant	timesigGlobal

QVariant	timesigStretch

QVariant	timesigType

QVariant	spannerTick

QVariant	spannerTicks

QVariant	spannerTrack2

QVariant	userOff2

QVariant	breakMmr

QVariant	repeatCount

QVariant	userStretch

QVariant	noOffset

QVariant	irregular

QVariant	anchor

QVariant	slurUoff1

QVariant	slurUoff2

QVariant	slurUoff3

QVariant	slurUoff4

QVariant	staffMove

QVariant	verse

QVariant	syllabic

QVariant	lyricTicks

QVariant	volta_ending

QVariant	lineVisible

QVariant	mag

QVariant	useDrumset

QVariant	duration

QVariant	durationType

QVariant	role

int	track

QVariant	glissandoStyle

QVariant	fretStrings

QVariant	fretFrets

QVariant	fretOffset

QVariant	fretNumPos

QVariant	systemBracket

QVariant	gap

bool	autoplace
	Whether this element participates in autoplacement. More...

QVariant	dashLineLen

QVariant	dashGapLen

QVariant	playbackVoice1

QVariant	playbackVoice2

QVariant	playbackVoice3

QVariant	playbackVoice4

QVariant	symbol

QVariant	playRepeats

QVariant	createSystemHeader

QVariant	staffLines

QVariant	lineDistance

QVariant	stepOffset

QVariant	staffShowBarlines

QVariant	staffShowLedgerlines

QVariant	staffStemless

QVariant	staffNoteheadScheme

QVariant	staffGenClef

QVariant	staffGenTimesig

QVariant	staffGenKeysig

QVariant	staffYoffset

QVariant	staffUserdist

QVariant	staffBarlineSpan

QVariant	staffBarlineSpanFrom

QVariant	staffBarlineSpanTo

QVariant	bracketSpan

QVariant	bracketColumn

QVariant	inameLayoutPosition

QVariant	subStyle

QVariant	fontFace

QVariant	fontSize

QVariant	fontStyle

QVariant	frameType

QVariant	frameWidth

QVariant	framePadding

QVariant	frameRound

QVariant	frameFgColor

QVariant	frameBgColor

QVariant	sizeSpatiumDependent

QVariant	align

QVariant	systemFlag

QVariant	beginText

QVariant	beginTextAlign

QVariant	beginTextPlace

QVariant	beginHookType

QVariant	beginHookHeight

QVariant	beginFontFace

QVariant	beginFontSize

QVariant	beginFontStyle

QVariant	beginTextOffset

QVariant	continueText

QVariant	continueTextAlign

QVariant	continueTextPlace

QVariant	continueFontFace

QVariant	continueFontSize

QVariant	continueFontStyle

QVariant	continueTextOffset

QVariant	endText

QVariant	endTextAlign

QVariant	endTextPlace

QVariant	endHookType

QVariant	endHookHeight

QVariant	endFontFace

QVariant	endFontSize

QVariant	endFontStyle

QVariant	endTextOffset

QVariant	posAbove

int	voice

QVariant	position

Properties inherited from Ms::PluginAPI::ScoreElement
int	type
	Type of this element. More...

QString	name
	Name of this element's type, not localized. More...

Private Member Functions
int	get_pitch () const

void	set_pitch (int val)

int	get_tpc1 () const

void	set_tpc1 (int val)

int	get_tpc2 () const

void	set_tpc2 (int val)

QVariant	get_veloType () const

void	set_veloType (QVariant val)

int	get_veloOffset () const

void	set_veloOffset (int val)

Additional Inherited Members
Protected Attributes inherited from Ms::PluginAPI::ScoreElement
Ms::ScoreElement *const	e

Related Functions inherited from Ms::PluginAPI::ScoreElement
template<class Wrapper , class T >
Wrapper *	wrap (T *t, Ownership own=Ownership::SCORE)

Constructor & Destructor Documentation

◆ Note()

Ms::PluginAPI::Note::Note	(	Ms::Note *	c = `nullptr`,
		Ownership	own = `Ownership::PLUGIN`
	)

inline

Member Function Documentation

◆ accidental()

Element* Ms::PluginAPI::Note::accidental ( )

inline

◆ accidentalType()

Ms::AccidentalType Ms::PluginAPI::Note::accidentalType ( )

inline

◆ add()

void Ms::PluginAPI::Note::add ( Ms::PluginAPI::Element * wrapped )

Add to a note's elements.

Since: MuseScore 3.3.3

◆ addInternal()

void Ms::PluginAPI::Note::addInternal	(	Ms::Note *	note,
		Ms::Element *	s
	)

static

Since: MuseScore 3.3.3

◆ createPlayEvent()

Q_INVOKABLE Ms::PluginAPI::PlayEvent* Ms::PluginAPI::Note::createPlayEvent ( )

inline

Creates a PlayEvent object for use in Javascript.

Since: MuseScore 3.3

◆ dots()

QQmlListProperty<Element> Ms::PluginAPI::Note::dots ( )

inline

◆ elements()

QQmlListProperty<Element> Ms::PluginAPI::Note::elements ( )

inline

◆ firstTiedNote()

Ms::PluginAPI::Note* Ms::PluginAPI::Note::firstTiedNote ( )

inline

◆ get_pitch()

int Ms::PluginAPI::Note::get_pitch ( ) const

inlineprivate

◆ get_tpc1()

int Ms::PluginAPI::Note::get_tpc1 ( ) const

inlineprivate

◆ get_tpc2()

int Ms::PluginAPI::Note::get_tpc2 ( ) const

inlineprivate

◆ get_veloOffset()

int Ms::PluginAPI::Note::get_veloOffset ( ) const

inlineprivate

◆ get_veloType()

QVariant Ms::PluginAPI::Note::get_veloType ( ) const

inlineprivate

◆ isChildAllowed()

bool Ms::PluginAPI::Note::isChildAllowed ( Ms::ElementType elementType )

static

Check if element type can be a child of note.

Since: MuseScore 3.3.3

◆ lastTiedNote()

Ms::PluginAPI::Note* Ms::PluginAPI::Note::lastTiedNote ( )

inline

◆ note() [1/2]

Ms::Note* Ms::PluginAPI::Note::note ( )

inline

◆ note() [2/2]

const Ms::Note* Ms::PluginAPI::Note::note ( ) const

inline

◆ noteType()

Ms::NoteType Ms::PluginAPI::Note::noteType ( )

inline

◆ playEvents()

QQmlListProperty<PlayEvent> Ms::PluginAPI::Note::playEvents ( )

inline

◆ remove()

void Ms::PluginAPI::Note::remove ( Ms::PluginAPI::Element * wrapped )

Remove a note's element.

Since: MuseScore 3.3.3

◆ set_pitch()

void Ms::PluginAPI::Note::set_pitch ( int val )

inlineprivate

◆ set_tpc1()

void Ms::PluginAPI::Note::set_tpc1 ( int val )

inlineprivate

◆ set_tpc2()

void Ms::PluginAPI::Note::set_tpc2 ( int val )

inlineprivate

◆ set_veloOffset()

void Ms::PluginAPI::Note::set_veloOffset ( int val )

inlineprivate

◆ set_veloType()

void Ms::PluginAPI::Note::set_veloType ( QVariant val )

inlineprivate

◆ setAccidentalType()

void Ms::PluginAPI::Note::setAccidentalType ( Ms::AccidentalType t )

inline

◆ setTpc()

void Ms::PluginAPI::Note::setTpc ( int val )

◆ tieBack()

Ms::PluginAPI::Tie* Ms::PluginAPI::Note::tieBack ( ) const

inline

◆ tieForward()

Ms::PluginAPI::Tie* Ms::PluginAPI::Note::tieForward ( ) const

inline

◆ tpc()

int Ms::PluginAPI::Note::tpc ( ) const

inline

Property Documentation

◆ accidental

Ms::PluginAPI::Element Ms::PluginAPI::Note::accidental

read

◆ accidentalType

Ms::AccidentalType Ms::PluginAPI::Note::accidentalType

readwrite

◆ dots

QQmlListProperty<Ms::PluginAPI::Element> Ms::PluginAPI::Note::dots

read

◆ elements

QQmlListProperty<Ms::PluginAPI::Element> Ms::PluginAPI::Note::elements

read

◆ firstTiedNote

Ms::PluginAPI::Note Ms::PluginAPI::Note::firstTiedNote

read

The first note of a series of ties to this note.

This will return the calling note if there is not tieBack.

Since: MuseScore 3.3

◆ lastTiedNote

Ms::PluginAPI::Note Ms::PluginAPI::Note::lastTiedNote

read

The last note of a series of ties to this note.

This will return the calling note if there is not tieForward.

Since: MuseScore 3.3

◆ noteType

Ms::NoteType Ms::PluginAPI::Note::noteType

read

The NoteType of the note.

Since: MuseScore 3.2.1

◆ pitch

int Ms::PluginAPI::Note::pitch

readwrite

MIDI pitch of this note.

See also: pitch

◆ playEvents

QQmlListProperty<Ms::PluginAPI::PlayEvent> Ms::PluginAPI::Note::playEvents

read

List of PlayEvents associated with this note.

Important: You must call Score.createPlayEvents() to see meaningful data in the PlayEvent lists.

Since: MuseScore 3.3

◆ tieBack

Ms::PluginAPI::Tie Ms::PluginAPI::Note::tieBack

read

Backward tie for this Note.

Since: MuseScore 3.3

◆ tieForward

Ms::PluginAPI::Tie Ms::PluginAPI::Note::tieForward

read

Forward tie for this Note.

Since: MuseScore 3.3

◆ tpc

int Ms::PluginAPI::Note::tpc

readwrite

Concert or transposing pitch of this note, as per current "Concert Pitch" setting value.

See also: tpc

◆ tpc1

int Ms::PluginAPI::Note::tpc1

readwrite

Concert pitch of the note.

See also: tpc

◆ tpc2

int Ms::PluginAPI::Note::tpc2

readwrite

Transposing pitch of the note.

See also: tpc

◆ veloOffset

int Ms::PluginAPI::Note::veloOffset

readwrite

◆ veloType

QVariant Ms::PluginAPI::Note::veloType

readwrite

See PluginAPI::PluginAPI::NoteValueType.

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

mscore/plugin/api/elements.h
mscore/plugin/api/elements.cpp

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Note()

Member Function Documentation

◆ accidental()

◆ accidentalType()

◆ add()

◆ addInternal()

◆ createPlayEvent()

◆ dots()

◆ elements()

◆ firstTiedNote()

◆ get_pitch()

◆ get_tpc1()

◆ get_tpc2()

◆ get_veloOffset()

◆ get_veloType()

◆ isChildAllowed()

◆ lastTiedNote()

◆ note() [1/2]

◆ note() [2/2]

◆ noteType()

◆ playEvents()

◆ remove()

◆ set_pitch()

◆ set_tpc1()

◆ set_tpc2()

◆ set_veloOffset()

◆ set_veloType()

◆ setAccidentalType()

◆ setTpc()

◆ tieBack()

◆ tieForward()

◆ tpc()

Property Documentation

◆ accidental

◆ accidentalType

◆ dots

◆ elements

◆ firstTiedNote

◆ lastTiedNote

◆ noteType

◆ pitch

◆ playEvents

◆ tieBack

◆ tieForward

◆ tpc

◆ tpc1

◆ tpc2

◆ veloOffset

◆ veloType