MuseScore Plugins 3.2.3
Plugins API for MuseScore
Namespaces | Classes | Enumerations | Functions | Variables
Ms Namespace Reference

Namespaces

namespace  PluginAPI
 Contains items exposed to the QML plugins framework.
 

Classes

class  Beam
 
class  LayoutBreak
 symbols for line break, page break etc. More...
 
class  Lyrics
 
class  MScore
 
class  Note
 Graphic representation of a note. More...
 
class  NoteHead
 

Enumerations

enum class  ElementType {
  INVALID = 0 , BRACKET_ITEM , PART , STAFF ,
  SCORE , SYMBOL , TEXT , MEASURE_NUMBER ,
  INSTRUMENT_NAME , SLUR_SEGMENT , TIE_SEGMENT , BAR_LINE ,
  STAFF_LINES , SYSTEM_DIVIDER , STEM_SLASH , ARPEGGIO ,
  ACCIDENTAL , LEDGER_LINE , STEM , NOTE ,
  CLEF , KEYSIG , AMBITUS , TIMESIG ,
  REST , BREATH , REPEAT_MEASURE , TIE ,
  ARTICULATION , FERMATA , CHORDLINE , DYNAMIC ,
  BEAM , HOOK , LYRICS , FIGURED_BASS ,
  MARKER , JUMP , FINGERING , TUPLET ,
  TEMPO_TEXT , STAFF_TEXT , SYSTEM_TEXT , REHEARSAL_MARK ,
  INSTRUMENT_CHANGE , STAFFTYPE_CHANGE , HARMONY , FRET_DIAGRAM ,
  BEND , TREMOLOBAR , VOLTA , HAIRPIN_SEGMENT ,
  OTTAVA_SEGMENT , TRILL_SEGMENT , LET_RING_SEGMENT , VIBRATO_SEGMENT ,
  PALM_MUTE_SEGMENT , TEXTLINE_SEGMENT , VOLTA_SEGMENT , PEDAL_SEGMENT ,
  LYRICSLINE_SEGMENT , GLISSANDO_SEGMENT , LAYOUT_BREAK , SPACER ,
  STAFF_STATE , NOTEHEAD , NOTEDOT , TREMOLO ,
  IMAGE , MEASURE , SELECTION , LASSO ,
  SHADOW_NOTE , TAB_DURATION_SYMBOL , FSYMBOL , PAGE ,
  HAIRPIN , OTTAVA , PEDAL , TRILL ,
  LET_RING , VIBRATO , PALM_MUTE , TEXTLINE ,
  TEXTLINE_BASE , NOTELINE , LYRICSLINE , GLISSANDO ,
  BRACKET , SEGMENT , SYSTEM , COMPOUND ,
  CHORD , SLUR , ELEMENT , ELEMENT_LIST ,
  STAFF_LIST , MEASURE_LIST , HBOX , VBOX ,
  TBOX , FBOX , ICON , OSSIA ,
  BAGPIPE_EMBELLISHMENT , STICKING , MAXTYPE
}
 
enum class  AccidentalType : char {
  NONE , FLAT , NATURAL , SHARP ,
  SHARP2 , FLAT2 , NATURAL_FLAT , NATURAL_SHARP ,
  SHARP_SHARP , FLAT_ARROW_UP , FLAT_ARROW_DOWN , NATURAL_ARROW_UP ,
  NATURAL_ARROW_DOWN , SHARP_ARROW_UP , SHARP_ARROW_DOWN , SHARP2_ARROW_UP ,
  SHARP2_ARROW_DOWN , FLAT2_ARROW_UP , FLAT2_ARROW_DOWN , MIRRORED_FLAT ,
  MIRRORED_FLAT2 , SHARP_SLASH , SHARP_SLASH4 , FLAT_SLASH2 ,
  FLAT_SLASH , SHARP_SLASH3 , SHARP_SLASH2 , DOUBLE_FLAT_ONE_ARROW_DOWN ,
  FLAT_ONE_ARROW_DOWN , NATURAL_ONE_ARROW_DOWN , SHARP_ONE_ARROW_DOWN , DOUBLE_SHARP_ONE_ARROW_DOWN ,
  DOUBLE_FLAT_ONE_ARROW_UP , FLAT_ONE_ARROW_UP , NATURAL_ONE_ARROW_UP , SHARP_ONE_ARROW_UP ,
  DOUBLE_SHARP_ONE_ARROW_UP , DOUBLE_FLAT_TWO_ARROWS_DOWN , FLAT_TWO_ARROWS_DOWN , NATURAL_TWO_ARROWS_DOWN ,
  SHARP_TWO_ARROWS_DOWN , DOUBLE_SHARP_TWO_ARROWS_DOWN , DOUBLE_FLAT_TWO_ARROWS_UP , FLAT_TWO_ARROWS_UP ,
  NATURAL_TWO_ARROWS_UP , SHARP_TWO_ARROWS_UP , DOUBLE_SHARP_TWO_ARROWS_UP , DOUBLE_FLAT_THREE_ARROWS_DOWN ,
  FLAT_THREE_ARROWS_DOWN , NATURAL_THREE_ARROWS_DOWN , SHARP_THREE_ARROWS_DOWN , DOUBLE_SHARP_THREE_ARROWS_DOWN ,
  DOUBLE_FLAT_THREE_ARROWS_UP , FLAT_THREE_ARROWS_UP , NATURAL_THREE_ARROWS_UP , SHARP_THREE_ARROWS_UP ,
  DOUBLE_SHARP_THREE_ARROWS_UP , LOWER_ONE_SEPTIMAL_COMMA , RAISE_ONE_SEPTIMAL_COMMA , LOWER_TWO_SEPTIMAL_COMMAS ,
  RAISE_TWO_SEPTIMAL_COMMAS , LOWER_ONE_UNDECIMAL_QUARTERTONE , RAISE_ONE_UNDECIMAL_QUARTERTONE , LOWER_ONE_TRIDECIMAL_QUARTERTONE ,
  RAISE_ONE_TRIDECIMAL_QUARTERTONE , DOUBLE_FLAT_EQUAL_TEMPERED , FLAT_EQUAL_TEMPERED , NATURAL_EQUAL_TEMPERED ,
  SHARP_EQUAL_TEMPERED , DOUBLE_SHARP_EQUAL_TEMPERED , QUARTER_FLAT_EQUAL_TEMPERED , QUARTER_SHARP_EQUAL_TEMPERED ,
  SORI , KORON , END
}
 
enum class  NoteType {
  NORMAL = 0 , ACCIACCATURA = 0x1 , APPOGGIATURA = 0x2 , GRACE4 = 0x4 ,
  GRACE16 = 0x8 , GRACE32 = 0x10 , GRACE8_AFTER = 0x20 , GRACE16_AFTER = 0x40 ,
  GRACE32_AFTER = 0x80 , INVALID = 0xFF
}
 
enum class  Direction { AUTO , UP , DOWN }
 
enum class  GlissandoType { STRAIGHT , WAVY }
 
enum class  GlissandoStyle { CHROMATIC , WHITE_KEYS , BLACK_KEYS , DIATONIC }
 
enum class  Placement { ABOVE , BELOW }
 
enum class  OffsetType : char { ABS , SPATIUM }
 
enum class  SegmentType {
  Invalid = 0x0 , BeginBarLine = 0x1 , HeaderClef = 0x2 , KeySig = 0x4 ,
  Ambitus = 0x8 , TimeSig = 0x10 , StartRepeatBarLine = 0x20 , Clef = 0x40 ,
  BarLine = 0x80 , Breath = 0x100 , ChordRest = 0x200 , EndBarLine = 0x400 ,
  KeySigAnnounce = 0x800 , TimeSigAnnounce = 0x1000 , All = -1 , BarLineType = BeginBarLine | StartRepeatBarLine | BarLine | EndBarLine
}
 
enum class  Tid {
  DEFAULT , TITLE , SUBTITLE , COMPOSER ,
  POET , LYRICS_ODD , LYRICS_EVEN , FINGERING ,
  LH_GUITAR_FINGERING , RH_GUITAR_FINGERING , STRING_NUMBER , INSTRUMENT_LONG ,
  INSTRUMENT_SHORT , INSTRUMENT_EXCERPT , DYNAMICS , EXPRESSION ,
  TEMPO , METRONOME , MEASURE_NUMBER , TRANSLATOR ,
  TUPLET , SYSTEM , STAFF , HARMONY_A ,
  HARMONY_B , REHEARSAL_MARK , REPEAT_LEFT , REPEAT_RIGHT ,
  FRAME , TEXTLINE , GLISSANDO , OTTAVA ,
  VOLTA , PEDAL , LET_RING , PALM_MUTE ,
  HAIRPIN , BEND , HEADER , FOOTER ,
  INSTRUMENT_CHANGE , STICKING , USER1 , USER2 ,
  USER3 , USER4 , USER5 , USER6 ,
  TEXT_STYLES
}
 Enumerates the list of built-in text substyles. More...
 
enum class  Align : char {
  LEFT = 0 , RIGHT = 1 , HCENTER = 2 , TOP = 0 ,
  BOTTOM = 4 , VCENTER = 8 , BASELINE = 16 , CENTER = Align::HCENTER | Align::VCENTER ,
  HMASK = Align::LEFT | Align::RIGHT | Align::HCENTER , VMASK = Align::TOP | Align::BOTTOM | Align::VCENTER | Align::BASELINE
}
 
enum class  FontStyle : char { Normal = 0 , Bold = 1 , Italic = 2 , Underline = 4 }
 
enum class  TupletNumberType : char { SHOW_NUMBER , SHOW_RELATION , NO_TEXT }
 
enum class  TupletBracketType : char { AUTO_BRACKET , SHOW_BRACKET , SHOW_NO_BRACKET }
 
enum class  BracketType : signed char {
  NORMAL , BRACE , SQUARE , LINE ,
  NO_BRACKET = -1
}
 
enum class  PlaceText : char { AUTO , ABOVE , BELOW , LEFT }
 
enum class  TransposeDirection : char { UP , DOWN , CLOSEST }
 
enum class  TransposeMode : char { BY_KEY , BY_INTERVAL , DIATONICALLY }
 
enum class  SelectType : char { SINGLE , RANGE , ADD }
 
enum class  AccidentalVal : signed char {
  SHARP2 = 2 , SHARP = 1 , NATURAL = 0 , FLAT = -1 ,
  FLAT2 = -2
}
 
enum class  KeySigNatural : char { NONE = 0 , BEFORE = 1 , AFTER = 2 }
 
enum class  UpDownMode : char { CHROMATIC , OCTAVE , DIATONIC }
 
enum class  StaffGroup : char { STANDARD , PERCUSSION , TAB }
 
enum class  NoteHeadScheme : char {
  HEAD_NORMAL = 0 , HEAD_PITCHNAME , HEAD_PITCHNAME_GERMAN , HEAD_SOLFEGE ,
  HEAD_SOLFEGE_FIXED , HEAD_SHAPE_NOTE_4 , HEAD_SHAPE_NOTE_7_AIKIN , HEAD_SHAPE_NOTE_7_FUNK ,
  HEAD_SHAPE_NOTE_7_WALKER , HEAD_SCHEMES
}
 
enum class  BarLineType {
  NORMAL = 1 , DOUBLE = 2 , START_REPEAT = 4 , END_REPEAT = 8 ,
  BROKEN = 0x10 , END = 0x20 , END_START_REPEAT = 0x40 , DOTTED = 0x80
}
 
enum class  IconType : signed char {
  NONE = -1 , ACCIACCATURA , APPOGGIATURA , GRACE4 ,
  GRACE16 , GRACE32 , GRACE8_AFTER , GRACE16_AFTER ,
  GRACE32_AFTER , SBEAM , MBEAM , NBEAM ,
  BEAM32 , BEAM64 , AUTOBEAM , FBEAM1 ,
  FBEAM2 , VFRAME , HFRAME , TFRAME ,
  FFRAME , MEASURE , BRACKETS , PARENTHESES
}
 
enum  MsError {
  MS_NO_ERROR , NO_NOTE_SELECTED , NO_CHORD_REST_SELECTED , NO_LYRICS_SELECTED ,
  NO_NOTE_REST_SELECTED , NO_NOTE_SLUR_SELECTED , NO_STAFF_SELECTED , NO_NOTE_FIGUREDBASS_SELECTED ,
  CANNOT_INSERT_TUPLET , CANNOT_SPLIT_TUPLET , CANNOT_SPLIT_MEASURE_FIRST_BEAT , CANNOT_SPLIT_MEASURE_TUPLET ,
  NO_DEST , DEST_TUPLET , TUPLET_CROSSES_BAR , DEST_LOCAL_TIME_SIGNATURE ,
  DEST_TREMOLO , NO_MIME , DEST_NO_CR , CANNOT_CHANGE_LOCAL_TIMESIG
}
 

Functions

constexpr NoteType operator| (NoteType t1, NoteType t2)
 
constexpr bool operator& (NoteType t1, NoteType t2)
 
constexpr SegmentType operator| (const SegmentType t1, const SegmentType t2)
 
constexpr bool operator& (const SegmentType t1, const SegmentType t2)
 
constexpr Align operator| (Align a1, Align a2)
 
constexpr bool operator& (Align a1, Align a2)
 
constexpr Align operator~ (Align a)
 
constexpr FontStyle operator+ (FontStyle a1, FontStyle a2)
 
constexpr FontStyle operator- (FontStyle a1, FontStyle a2)
 
constexpr bool operator& (FontStyle a1, FontStyle a2)
 
Direction toDirection (const QString &)
 
const char * toString (Direction)
 
QString toUserString (Direction)
 
void fillComboBoxDirection (QComboBox *)
 
int staff2track (int staffIdx)
 
int track2staff (int voice)
 
int track2voice (int track)
 
int trackZeroVoice (int track)
 
constexpr BarLineType operator| (BarLineType t1, BarLineType t2)
 
constexpr bool operator& (BarLineType t1, BarLineType t2)
 

Variables

const int STAFF_GROUP_MAX = int(StaffGroup::TAB) + 1
 

Detailed Description

Enumeration Type Documentation

◆ AccidentalType

enum class AccidentalType : char
strong
Enumerator
NONE 
FLAT 
NATURAL 
SHARP 
SHARP2 
FLAT2 
NATURAL_FLAT 
NATURAL_SHARP 
SHARP_SHARP 
FLAT_ARROW_UP 
FLAT_ARROW_DOWN 
NATURAL_ARROW_UP 
NATURAL_ARROW_DOWN 
SHARP_ARROW_UP 
SHARP_ARROW_DOWN 
SHARP2_ARROW_UP 
SHARP2_ARROW_DOWN 
FLAT2_ARROW_UP 
FLAT2_ARROW_DOWN 
MIRRORED_FLAT 
MIRRORED_FLAT2 
SHARP_SLASH 
SHARP_SLASH4 
FLAT_SLASH2 
FLAT_SLASH 
SHARP_SLASH3 
SHARP_SLASH2 
DOUBLE_FLAT_ONE_ARROW_DOWN 
FLAT_ONE_ARROW_DOWN 
NATURAL_ONE_ARROW_DOWN 
SHARP_ONE_ARROW_DOWN 
DOUBLE_SHARP_ONE_ARROW_DOWN 
DOUBLE_FLAT_ONE_ARROW_UP 
FLAT_ONE_ARROW_UP 
NATURAL_ONE_ARROW_UP 
SHARP_ONE_ARROW_UP 
DOUBLE_SHARP_ONE_ARROW_UP 
DOUBLE_FLAT_TWO_ARROWS_DOWN 
FLAT_TWO_ARROWS_DOWN 
NATURAL_TWO_ARROWS_DOWN 
SHARP_TWO_ARROWS_DOWN 
DOUBLE_SHARP_TWO_ARROWS_DOWN 
DOUBLE_FLAT_TWO_ARROWS_UP 
FLAT_TWO_ARROWS_UP 
NATURAL_TWO_ARROWS_UP 
SHARP_TWO_ARROWS_UP 
DOUBLE_SHARP_TWO_ARROWS_UP 
DOUBLE_FLAT_THREE_ARROWS_DOWN 
FLAT_THREE_ARROWS_DOWN 
NATURAL_THREE_ARROWS_DOWN 
SHARP_THREE_ARROWS_DOWN 
DOUBLE_SHARP_THREE_ARROWS_DOWN 
DOUBLE_FLAT_THREE_ARROWS_UP 
FLAT_THREE_ARROWS_UP 
NATURAL_THREE_ARROWS_UP 
SHARP_THREE_ARROWS_UP 
DOUBLE_SHARP_THREE_ARROWS_UP 
LOWER_ONE_SEPTIMAL_COMMA 
RAISE_ONE_SEPTIMAL_COMMA 
LOWER_TWO_SEPTIMAL_COMMAS 
RAISE_TWO_SEPTIMAL_COMMAS 
LOWER_ONE_UNDECIMAL_QUARTERTONE 
RAISE_ONE_UNDECIMAL_QUARTERTONE 
LOWER_ONE_TRIDECIMAL_QUARTERTONE 
RAISE_ONE_TRIDECIMAL_QUARTERTONE 
DOUBLE_FLAT_EQUAL_TEMPERED 
FLAT_EQUAL_TEMPERED 
NATURAL_EQUAL_TEMPERED 
SHARP_EQUAL_TEMPERED 
DOUBLE_SHARP_EQUAL_TEMPERED 
QUARTER_FLAT_EQUAL_TEMPERED 
QUARTER_SHARP_EQUAL_TEMPERED 
SORI 
KORON 
END 

◆ Direction

enum class Direction
strong
Enumerator
AUTO 
UP 
DOWN 

◆ ElementType

enum class ElementType
strong
Enumerator
INVALID 
BRACKET_ITEM 
PART 
STAFF 
SCORE 
SYMBOL 
TEXT 
MEASURE_NUMBER 
INSTRUMENT_NAME 
SLUR_SEGMENT 
TIE_SEGMENT 
BAR_LINE 
STAFF_LINES 
SYSTEM_DIVIDER 
STEM_SLASH 
ARPEGGIO 
ACCIDENTAL 
LEDGER_LINE 
STEM 
NOTE 
CLEF 
KEYSIG 
AMBITUS 
TIMESIG 
REST 
BREATH 
REPEAT_MEASURE 
TIE 
ARTICULATION 
FERMATA 
CHORDLINE 
DYNAMIC 
BEAM 
HOOK 
LYRICS 
FIGURED_BASS 
MARKER 
JUMP 
FINGERING 
TUPLET 
TEMPO_TEXT 
STAFF_TEXT 
SYSTEM_TEXT 
REHEARSAL_MARK 
INSTRUMENT_CHANGE 
STAFFTYPE_CHANGE 
HARMONY 
FRET_DIAGRAM 
BEND 
TREMOLOBAR 
VOLTA 
HAIRPIN_SEGMENT 
OTTAVA_SEGMENT 
TRILL_SEGMENT 
LET_RING_SEGMENT 
VIBRATO_SEGMENT 
PALM_MUTE_SEGMENT 
TEXTLINE_SEGMENT 
VOLTA_SEGMENT 
PEDAL_SEGMENT 
LYRICSLINE_SEGMENT 
GLISSANDO_SEGMENT 
LAYOUT_BREAK 
SPACER 
STAFF_STATE 
NOTEHEAD 
NOTEDOT 
TREMOLO 
IMAGE 
MEASURE 
SELECTION 
LASSO 
SHADOW_NOTE 
TAB_DURATION_SYMBOL 
FSYMBOL 
PAGE 
HAIRPIN 
OTTAVA 
PEDAL 
TRILL 
LET_RING 
VIBRATO 
PALM_MUTE 
TEXTLINE 
TEXTLINE_BASE 
NOTELINE 
LYRICSLINE 
GLISSANDO 
BRACKET 
SEGMENT 
SYSTEM 
COMPOUND 
CHORD 
SLUR 
ELEMENT 
ELEMENT_LIST 
STAFF_LIST 
MEASURE_LIST 
HBOX 
VBOX 
TBOX 
FBOX 
ICON 
OSSIA 
BAGPIPE_EMBELLISHMENT 
STICKING 
MAXTYPE 

◆ GlissandoStyle

enum class GlissandoStyle
strong
Enumerator
CHROMATIC 
WHITE_KEYS 
BLACK_KEYS 
DIATONIC 

◆ GlissandoType

enum class GlissandoType
strong
Enumerator
STRAIGHT 
WAVY 

◆ NoteType

enum class NoteType
strong
Enumerator
NORMAL 
ACCIACCATURA 
APPOGGIATURA 
GRACE4 
GRACE16 
GRACE32 
GRACE8_AFTER 
GRACE16_AFTER 
GRACE32_AFTER 
INVALID 

◆ OffsetType

enum class OffsetType : char
strong
Enumerator
ABS 

offset in point units

SPATIUM 

offset in staff space units

◆ Placement

enum class Placement
strong
Enumerator
ABOVE 
BELOW 

◆ SegmentType

enum class SegmentType
strong
Enumerator
Invalid 
BeginBarLine 
HeaderClef 
KeySig 
Ambitus 
TimeSig 
StartRepeatBarLine 
Clef 
BarLine 
Breath 
ChordRest 
EndBarLine 
KeySigAnnounce 
TimeSigAnnounce 
All 

Includes all barline types.

BarLineType 

Alias for BeginBarLine | StartRepeatBarLine | BarLine | EndBarLine

◆ Tid

enum class Tid
strong

Enumerates the list of built-in text substyles.

Enumerator
DEFAULT 
TITLE 
SUBTITLE 
COMPOSER 
POET 
LYRICS_ODD 
LYRICS_EVEN 
FINGERING 
LH_GUITAR_FINGERING 
RH_GUITAR_FINGERING 
STRING_NUMBER 
INSTRUMENT_LONG 
INSTRUMENT_SHORT 
INSTRUMENT_EXCERPT 
DYNAMICS 
EXPRESSION 
TEMPO 
METRONOME 
MEASURE_NUMBER 
TRANSLATOR 
TUPLET 
SYSTEM 
STAFF 
HARMONY_A 
HARMONY_B 
REHEARSAL_MARK 
REPEAT_LEFT 
REPEAT_RIGHT 
FRAME 
TEXTLINE 
GLISSANDO 
OTTAVA 
VOLTA 
PEDAL 
LET_RING 
PALM_MUTE 
HAIRPIN 
BEND 
HEADER 
FOOTER 
INSTRUMENT_CHANGE 
STICKING 
USER1 
USER2 
USER3 
USER4 
USER5 
USER6 
TEXT_STYLES