Ms::PluginAPI::Part Class Reference

#include <part.h>

Inheritance diagram for Ms::PluginAPI::Part:

Collaboration diagram for Ms::PluginAPI::Part:

Public Member Functions
	Part (Ms::Part *p=nullptr, Ownership o=Ownership::SCORE)
Ms::Part *	part ()
const Ms::Part *	part () const
int	startTrack () const
int	endTrack () const
QString	instrumentId () const
int	harmonyCount () const
bool	hasPitchedStaff () const
bool	hasTabStaff () const
bool	hasDrumStaff () const
int	lyricCount () const
int	midiChannel () const
int	midiProgram () const
QString	longName () const
QString	shortName () const
QString	partName () const
bool	show () const
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...

Properties
int	startTrack
int	endTrack
QString	instrumentId
	The string identifier for the current instrument. More...
int	harmonyCount
	The number of Chord Symbols. More...
bool	hasDrumStaff
	Whether it is a percussion staff. More...
bool	hasPitchedStaff
	Whether it is a 'normal' staff with notes. More...
bool	hasTabStaff
	Whether it is a tablature staff. More...
int	lyricCount
	The number of lyrics syllables. More...
int	midiChannel
	One of 16 music channels that can be assigned an instrument. More...
int	midiProgram
	One of the 128 different instruments in General MIDI. More...
QString	longName
	The long name for the current instrument. More...
QString	shortName
	The short name for the current instrument. More...
QString	partName
	The name of the current part of music. More...
bool	show
	Whether part is shown or hidden. More...
Properties inherited from Ms::PluginAPI::ScoreElement
int	type
	Type of this element. More...
QString	name
	Name of this element's type, not localized. More...

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

Part()

Ms::PluginAPI::Part::Part ( Ms::Part *  p = nullptr, Ownership  o = Ownership::SCORE  )

inline

Member Function Documentation

endTrack()

int Ms::PluginAPI::Part::endTrack ( ) const

inline

harmonyCount()

int Ms::PluginAPI::Part::harmonyCount ( ) const

inline

hasDrumStaff()

bool Ms::PluginAPI::Part::hasDrumStaff ( ) const

inline

hasPitchedStaff()

bool Ms::PluginAPI::Part::hasPitchedStaff ( ) const

inline

hasTabStaff()

bool Ms::PluginAPI::Part::hasTabStaff ( ) const

inline

instrumentId()

QString Ms::PluginAPI::Part::instrumentId ( ) const

inline

longName()

QString Ms::PluginAPI::Part::longName ( ) const

inline

lyricCount()

int Ms::PluginAPI::Part::lyricCount ( ) const

inline

midiChannel()

int Ms::PluginAPI::Part::midiChannel ( ) const

inline

midiProgram()

int Ms::PluginAPI::Part::midiProgram ( ) const

inline

part() [1/2]

Ms::Part* Ms::PluginAPI::Part::part ( )

inline

part() [2/2]

const Ms::Part* Ms::PluginAPI::Part::part ( ) const

inline

partName()

QString Ms::PluginAPI::Part::partName ( ) const

inline

shortName()

QString Ms::PluginAPI::Part::shortName ( ) const

inline

show()

bool Ms::PluginAPI::Part::show ( ) const

inline

startTrack()

int Ms::PluginAPI::Part::startTrack ( ) const

inline

Property Documentation

endTrack

int Ms::PluginAPI::Part::endTrack

read

harmonyCount

int Ms::PluginAPI::Part::harmonyCount

read

The number of Chord Symbols.

Since

MuseScore 3.2.1

hasDrumStaff

bool Ms::PluginAPI::Part::hasDrumStaff

read

Whether it is a percussion staff.

Since

MuseScore 3.2.1

hasPitchedStaff

bool Ms::PluginAPI::Part::hasPitchedStaff

read

Whether it is a 'normal' staff with notes.

Since

MuseScore 3.2.1

hasTabStaff

bool Ms::PluginAPI::Part::hasTabStaff

read

Whether it is a tablature staff.

Since

MuseScore 3.2.1

instrumentId

QString Ms::PluginAPI::Part::instrumentId

read

The string identifier for the current instrument.

Since

MuseScore 3.2

longName

QString Ms::PluginAPI::Part::longName

read

The long name for the current instrument.

Note that this property was writeable in MuseScore v2.x

Since

MuseScore 3.2.1

lyricCount

int Ms::PluginAPI::Part::lyricCount

read

The number of lyrics syllables.

Since

MuseScore 3.2.1

midiChannel

int Ms::PluginAPI::Part::midiChannel

read

One of 16 music channels that can be assigned an instrument.

Since

MuseScore 3.2.1

midiProgram

int Ms::PluginAPI::Part::midiProgram

read

One of the 128 different instruments in General MIDI.

Since

MuseScore 3.2.1

partName

QString Ms::PluginAPI::Part::partName

read

The name of the current part of music.

It is shown in Mixer.

Note that this property was writeable in MuseScore v2.x

Since

MuseScore 3.2.1

shortName

QString Ms::PluginAPI::Part::shortName

read

The short name for the current instrument.

Note that this property was writeable in MuseScore v2.x

Since

MuseScore 3.2.1

show

bool Ms::PluginAPI::Part::show

read

Whether part is shown or hidden.

Note that this property was writeable in MuseScore v2.x

Since

MuseScore 3.2.1

startTrack

int Ms::PluginAPI::Part::startTrack

read

---

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

• mscore/plugin/api/part.h