Staff Class Reference

Inheritance diagram for Staff:

Collaboration diagram for Staff:

Properties
bool	small
qreal	mag
QColor	color
	Staff color. More...
bool	playbackVoice1
	Whether voice 1 participates in playback. More...
bool	playbackVoice2
	Whether voice 2 participates in playback. More...
bool	playbackVoice3
	Whether voice 3 participates in playback. More...
bool	playbackVoice4
	Whether voice 4 participates in playback. More...
int	staffBarlineSpan
int	staffBarlineSpanFrom
int	staffBarlineSpanTo
qreal	staffUserdist
	User-defined amount of additional space before this staff. More...
Ms::PluginAPI::Part	part
	Part which this staff belongs to. More...
Properties inherited from ScoreElement
int	type
	Type of this element. More...
QString	name
	Name of this element's type, not localized. More...

Additional Inherited Members
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...

Detailed Description

Since

MuseScore 3.5

Property Documentation

color

QColor color

readwrite

Staff color.

See https://doc.qt.io/qt-5/qml-color.html for the reference on color type in QML.

part

Part * part

read

Part which this staff belongs to.

playbackVoice1

bool playbackVoice1

readwrite

Whether voice 1 participates in playback.

playbackVoice2

bool playbackVoice2

readwrite

Whether voice 2 participates in playback.

playbackVoice3

bool playbackVoice3

readwrite

Whether voice 3 participates in playback.

playbackVoice4

bool playbackVoice4

readwrite

Whether voice 4 participates in playback.

staffUserdist

qreal staffUserdist

readwrite

User-defined amount of additional space before this staff.

It is recommended to consider adding a spacer instead as it allows adjusting staff spacing locally as opposed to this property.

See also

Element::space

---

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

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