1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
|
//=============================================================================
// MuseScore
// Music Composition & Notation
//
// Copyright (C) 2019 Werner Schweer
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2
// as published by the Free Software Foundation and appearing in
// the file LICENCE.GPL
//=============================================================================
#ifndef __PLUGIN_API_ELEMENTS_H__
#define __PLUGIN_API_ELEMENTS_H__
#include "scoreelement.h"
#include "libmscore/element.h"
#include "libmscore/chord.h"
#include "libmscore/lyrics.h"
#include "libmscore/measure.h"
#include "libmscore/note.h"
#include "libmscore/notedot.h"
#include "libmscore/segment.h"
#include "libmscore/accidental.h"
#include "libmscore/types.h"
namespace Ms {
namespace PluginAPI {
class Element;
//---------------------------------------------------------
// wrap
//---------------------------------------------------------
extern Element* wrap(Ms::Element* se, Ownership own = Ownership::SCORE);
// TODO: add RESET functions
#define API_PROPERTY(name, pid) \
Q_PROPERTY(QVariant name READ get_##name WRITE set_##name) \
QVariant get_##name() const { return get(Ms::Pid::pid); } \
void set_##name(QVariant val) { set(Ms::Pid::pid, val); }
/**
* API_PROPERTY flavor which allows to define the property type.
* Can be used if it is known that this property is always valid
* for this type, otherwise this macro won't allow an `undefined`
* value to be exposed to QML in case of invalid property.
*/
#define API_PROPERTY_T(type, name, pid) \
Q_PROPERTY(type name READ get_##name WRITE set_##name) \
type get_##name() const { return get(Ms::Pid::pid).value<type>(); } \
void set_##name(type val) { set(Ms::Pid::pid, QVariant::fromValue(val)); }
#define API_PROPERTY_READ_ONLY(name, pid) \
Q_PROPERTY(QVariant name READ get_##name) \
QVariant get_##name() const { return get(Ms::Pid::pid); }
#define API_PROPERTY_READ_ONLY_T(type, name, pid) \
Q_PROPERTY(type name READ get_##name) \
type get_##name() const { return get(Ms::Pid::pid).value<type>(); } \
//---------------------------------------------------------
// Element
// Element wrapper
//---------------------------------------------------------
class Element : public Ms::PluginAPI::ScoreElement {
Q_OBJECT
/**
* X-axis offset from a reference position in spatium units.
* \see Element::offset
*/
Q_PROPERTY(qreal offsetX READ offsetX WRITE setOffsetX)
/**
* Y-axis offset from a reference position in spatium units.
* \see Element::offset
*/
Q_PROPERTY(qreal offsetY READ offsetY WRITE setOffsetY)
/**
* Parent element for this element.
* \since 3.3
*/
Q_PROPERTY(Ms::PluginAPI::Element* parent READ parent)
API_PROPERTY( subtype, SUBTYPE )
API_PROPERTY_READ_ONLY_T( bool, selected, SELECTED )
API_PROPERTY_READ_ONLY_T( bool, generated, GENERATED )
/**
* Element color. See https://doc.qt.io/qt-5/qml-color.html
* for the reference on color type in QML.
*/
API_PROPERTY_T( QColor, color, COLOR )
API_PROPERTY_T( bool, visible, VISIBLE )
/** Stacking order of this element */
API_PROPERTY_T( int, z, Z )
API_PROPERTY( small, SMALL )
API_PROPERTY( showCourtesy, SHOW_COURTESY )
API_PROPERTY( lineType, LINE_TYPE )
API_PROPERTY( line, LINE )
API_PROPERTY( fixed, FIXED )
API_PROPERTY( fixedLine, FIXED_LINE )
/** Notehead type, one of PluginAPI::PluginAPI::NoteHeadType values */
API_PROPERTY( headType, HEAD_TYPE )
/** Notehead group, one of PluginAPI::PluginAPI::NoteHeadGroup values */
API_PROPERTY( headGroup, HEAD_GROUP )
API_PROPERTY( articulationAnchor, ARTICULATION_ANCHOR )
API_PROPERTY( direction, DIRECTION )
API_PROPERTY( stemDirection, STEM_DIRECTION )
API_PROPERTY( noStem, NO_STEM )
API_PROPERTY( slurDirection, SLUR_DIRECTION )
API_PROPERTY( leadingSpace, LEADING_SPACE )
API_PROPERTY( distribute, DISTRIBUTE )
API_PROPERTY( mirrorHead, MIRROR_HEAD )
API_PROPERTY( dotPosition, DOT_POSITION )
API_PROPERTY( tuning, TUNING )
API_PROPERTY( pause, PAUSE )
API_PROPERTY( barlineType, BARLINE_TYPE )
API_PROPERTY( barlineSpan, BARLINE_SPAN )
API_PROPERTY( barlineSpanFrom, BARLINE_SPAN_FROM )
API_PROPERTY( barlineSpanTo, BARLINE_SPAN_TO )
/**
* Offset from a reference position in spatium units.
* Use `Qt.point(x, y)` to create a point value which can be
* assigned to this property.
* \see Element::offsetX
* \see Element::offsetY
*/
API_PROPERTY_T( QPointF, offset, OFFSET )
API_PROPERTY( fret, FRET )
API_PROPERTY( string, STRING )
API_PROPERTY( ghost, GHOST )
API_PROPERTY( play, PLAY )
API_PROPERTY( timesigNominal, TIMESIG_NOMINAL )
API_PROPERTY( timesigActual, TIMESIG_ACTUAL )
API_PROPERTY( numberType, NUMBER_TYPE )
API_PROPERTY( bracketType, BRACKET_TYPE )
API_PROPERTY( normalNotes, NORMAL_NOTES )
API_PROPERTY( actualNotes, ACTUAL_NOTES )
API_PROPERTY( p1, P1 )
API_PROPERTY( p2, P2 )
API_PROPERTY( growLeft, GROW_LEFT )
API_PROPERTY( growRight, GROW_RIGHT )
API_PROPERTY( boxHeight, BOX_HEIGHT )
API_PROPERTY( boxWidth, BOX_WIDTH )
API_PROPERTY( topGap, TOP_GAP )
API_PROPERTY( bottomGap, BOTTOM_GAP )
API_PROPERTY( leftMargin, LEFT_MARGIN )
API_PROPERTY( rightMargin, RIGHT_MARGIN )
API_PROPERTY( topMargin, TOP_MARGIN )
API_PROPERTY( bottomMargin, BOTTOM_MARGIN )
API_PROPERTY( layoutBreakType, LAYOUT_BREAK )
API_PROPERTY( autoscale, AUTOSCALE )
API_PROPERTY( size, SIZE )
API_PROPERTY( scale, SCALE )
API_PROPERTY( lockAspectRatio, LOCK_ASPECT_RATIO )
API_PROPERTY( sizeIsSpatium, SIZE_IS_SPATIUM )
API_PROPERTY( text, TEXT )
API_PROPERTY( beamPos, BEAM_POS )
API_PROPERTY( beamMode, BEAM_MODE )
API_PROPERTY( beamNoSlope, BEAM_NO_SLOPE )
API_PROPERTY( userLen, USER_LEN )
API_PROPERTY( space, SPACE )
API_PROPERTY( tempo, TEMPO )
API_PROPERTY( tempoFollowText, TEMPO_FOLLOW_TEXT )
API_PROPERTY( accidentalBracket, ACCIDENTAL_BRACKET )
API_PROPERTY( numeratorString, NUMERATOR_STRING )
API_PROPERTY( denominatorString, DENOMINATOR_STRING )
API_PROPERTY( fbprefix, FBPREFIX )
API_PROPERTY( fbdigit, FBDIGIT )
API_PROPERTY( fbsuffix, FBSUFFIX )
API_PROPERTY( fbcontinuationline, FBCONTINUATIONLINE )
API_PROPERTY( ottavaType, OTTAVA_TYPE )
API_PROPERTY( numbersOnly, NUMBERS_ONLY )
API_PROPERTY( trillType, TRILL_TYPE )
API_PROPERTY( vibratoType, VIBRATO_TYPE )
API_PROPERTY( hairpinCircledTip, HAIRPIN_CIRCLEDTIP )
API_PROPERTY( hairpinType, HAIRPIN_TYPE )
API_PROPERTY( hairpinHeight, HAIRPIN_HEIGHT )
API_PROPERTY( hairpinContHeight, HAIRPIN_CONT_HEIGHT )
API_PROPERTY( veloChange, VELO_CHANGE )
API_PROPERTY( singleNoteDynamics, SINGLE_NOTE_DYNAMICS )
API_PROPERTY( veloChangeMethod, VELO_CHANGE_METHOD )
API_PROPERTY( veloChangeSpeed, VELO_CHANGE_SPEED )
API_PROPERTY( dynamicRange, DYNAMIC_RANGE )
API_PROPERTY( placement, PLACEMENT )
API_PROPERTY( velocity, VELOCITY )
API_PROPERTY( jumpTo, JUMP_TO )
API_PROPERTY( playUntil, PLAY_UNTIL )
API_PROPERTY( continueAt, CONTINUE_AT )
API_PROPERTY( label, LABEL )
API_PROPERTY( markerType, MARKER_TYPE )
API_PROPERTY( arpUserLen1, ARP_USER_LEN1 )
API_PROPERTY( arpUserLen2, ARP_USER_LEN2 )
API_PROPERTY( measureNumberMode, MEASURE_NUMBER_MODE )
API_PROPERTY( glissType, GLISS_TYPE )
API_PROPERTY( glissText, GLISS_TEXT )
API_PROPERTY( glissShowText, GLISS_SHOW_TEXT )
API_PROPERTY( diagonal, DIAGONAL )
API_PROPERTY( groups, GROUPS )
API_PROPERTY( lineStyle, LINE_STYLE )
API_PROPERTY( lineColor, COLOR )
API_PROPERTY( lineWidth, LINE_WIDTH )
API_PROPERTY( lassoPos, LASSO_POS )
API_PROPERTY( lassoSize, LASSO_SIZE )
API_PROPERTY( timeStretch, TIME_STRETCH )
API_PROPERTY( ornamentStyle, ORNAMENT_STYLE )
API_PROPERTY( timesig, TIMESIG )
API_PROPERTY( timesigGlobal, TIMESIG_GLOBAL )
API_PROPERTY( timesigStretch, TIMESIG_STRETCH )
API_PROPERTY( timesigType, TIMESIG_TYPE )
API_PROPERTY( spannerTick, SPANNER_TICK )
API_PROPERTY( spannerTicks, SPANNER_TICKS )
API_PROPERTY( spannerTrack2, SPANNER_TRACK2 )
API_PROPERTY( userOff2, OFFSET2 )
API_PROPERTY( breakMmr, BREAK_MMR )
API_PROPERTY( repeatCount, REPEAT_COUNT )
API_PROPERTY( userStretch, USER_STRETCH )
API_PROPERTY( noOffset, NO_OFFSET )
API_PROPERTY( irregular, IRREGULAR )
API_PROPERTY( anchor, ANCHOR )
API_PROPERTY( slurUoff1, SLUR_UOFF1 )
API_PROPERTY( slurUoff2, SLUR_UOFF2 )
API_PROPERTY( slurUoff3, SLUR_UOFF3 )
API_PROPERTY( slurUoff4, SLUR_UOFF4 )
API_PROPERTY( staffMove, STAFF_MOVE )
API_PROPERTY( verse, VERSE )
API_PROPERTY( syllabic, SYLLABIC )
API_PROPERTY( lyricTicks, LYRIC_TICKS )
API_PROPERTY( volta_ending, VOLTA_ENDING )
API_PROPERTY( lineVisible, LINE_VISIBLE )
API_PROPERTY( mag, MAG )
API_PROPERTY( useDrumset, USE_DRUMSET )
API_PROPERTY( duration, DURATION )
API_PROPERTY( durationType, DURATION_TYPE )
API_PROPERTY( role, ROLE )
API_PROPERTY_T( int, track, TRACK )
API_PROPERTY( glissandoStyle, GLISSANDO_STYLE )
API_PROPERTY( fretStrings, FRET_STRINGS )
API_PROPERTY( fretFrets, FRET_FRETS )
/*API_PROPERTY( fretBarre, FRET_BARRE )*/
API_PROPERTY( fretOffset, FRET_OFFSET )
API_PROPERTY( fretNumPos, FRET_NUM_POS )
API_PROPERTY( systemBracket, SYSTEM_BRACKET )
API_PROPERTY( gap, GAP )
/** Whether this element participates in autoplacement */
API_PROPERTY_T( bool, autoplace, AUTOPLACE )
API_PROPERTY( dashLineLen, DASH_LINE_LEN )
API_PROPERTY( dashGapLen, DASH_GAP_LEN )
// API_PROPERTY_READ_ONLY( tick, TICK ) // wasn't available in 2.X, disabled due to fractions transition
API_PROPERTY( playbackVoice1, PLAYBACK_VOICE1 )
API_PROPERTY( playbackVoice2, PLAYBACK_VOICE2 )
API_PROPERTY( playbackVoice3, PLAYBACK_VOICE3 )
API_PROPERTY( playbackVoice4, PLAYBACK_VOICE4 )
API_PROPERTY( symbol, SYMBOL )
API_PROPERTY( playRepeats, PLAY_REPEATS )
API_PROPERTY( createSystemHeader, CREATE_SYSTEM_HEADER )
API_PROPERTY( staffLines, STAFF_LINES )
API_PROPERTY( lineDistance, LINE_DISTANCE )
API_PROPERTY( stepOffset, STEP_OFFSET )
API_PROPERTY( staffShowBarlines, STAFF_SHOW_BARLINES )
API_PROPERTY( staffShowLedgerlines, STAFF_SHOW_LEDGERLINES )
API_PROPERTY( staffSlashStyle, STAFF_SLASH_STYLE )
API_PROPERTY( staffNoteheadScheme, STAFF_NOTEHEAD_SCHEME )
API_PROPERTY( staffGenClef, STAFF_GEN_CLEF )
API_PROPERTY( staffGenTimesig, STAFF_GEN_TIMESIG )
API_PROPERTY( staffGenKeysig, STAFF_GEN_KEYSIG )
API_PROPERTY( staffYoffset, STAFF_YOFFSET )
API_PROPERTY( staffUserdist, STAFF_USERDIST )
API_PROPERTY( staffBarlineSpan, STAFF_BARLINE_SPAN )
API_PROPERTY( staffBarlineSpanFrom, STAFF_BARLINE_SPAN_FROM )
API_PROPERTY( staffBarlineSpanTo, STAFF_BARLINE_SPAN_TO )
API_PROPERTY( bracketSpan, BRACKET_SPAN )
API_PROPERTY( bracketColumn, BRACKET_COLUMN )
API_PROPERTY( inameLayoutPosition, INAME_LAYOUT_POSITION )
API_PROPERTY( subStyle, SUB_STYLE )
API_PROPERTY( fontFace, FONT_FACE )
API_PROPERTY( fontSize, FONT_SIZE )
API_PROPERTY( fontStyle, FONT_STYLE )
API_PROPERTY( frameType, FRAME_TYPE )
API_PROPERTY( frameWidth, FRAME_WIDTH )
API_PROPERTY( framePadding, FRAME_PADDING )
API_PROPERTY( frameRound, FRAME_ROUND )
API_PROPERTY( frameFgColor, FRAME_FG_COLOR )
API_PROPERTY( frameBgColor, FRAME_BG_COLOR )
API_PROPERTY( sizeSpatiumDependent, SIZE_SPATIUM_DEPENDENT )
API_PROPERTY( align, ALIGN )
API_PROPERTY( systemFlag, SYSTEM_FLAG )
API_PROPERTY( beginText, BEGIN_TEXT )
API_PROPERTY( beginTextAlign, BEGIN_TEXT_ALIGN )
API_PROPERTY( beginTextPlace, BEGIN_TEXT_PLACE )
API_PROPERTY( beginHookType, BEGIN_HOOK_TYPE )
API_PROPERTY( beginHookHeight, BEGIN_HOOK_HEIGHT )
API_PROPERTY( beginFontFace, BEGIN_FONT_FACE )
API_PROPERTY( beginFontSize, BEGIN_FONT_SIZE )
API_PROPERTY( beginFontStyle, BEGIN_FONT_STYLE )
API_PROPERTY( beginTextOffset, BEGIN_TEXT_OFFSET )
API_PROPERTY( continueText, CONTINUE_TEXT )
API_PROPERTY( continueTextAlign, CONTINUE_TEXT_ALIGN )
API_PROPERTY( continueTextPlace, CONTINUE_TEXT_PLACE )
API_PROPERTY( continueFontFace, CONTINUE_FONT_FACE )
API_PROPERTY( continueFontSize, CONTINUE_FONT_SIZE )
API_PROPERTY( continueFontStyle, CONTINUE_FONT_STYLE )
API_PROPERTY( continueTextOffset, CONTINUE_TEXT_OFFSET )
API_PROPERTY( endText, END_TEXT )
API_PROPERTY( endTextAlign, END_TEXT_ALIGN )
API_PROPERTY( endTextPlace, END_TEXT_PLACE )
API_PROPERTY( endHookType, END_HOOK_TYPE )
API_PROPERTY( endHookHeight, END_HOOK_HEIGHT )
API_PROPERTY( endFontFace, END_FONT_FACE )
API_PROPERTY( endFontSize, END_FONT_SIZE )
API_PROPERTY( endFontStyle, END_FONT_STYLE )
API_PROPERTY( endTextOffset, END_TEXT_OFFSET )
API_PROPERTY( posAbove, POS_ABOVE )
API_PROPERTY_T( int, voice, VOICE )
API_PROPERTY_READ_ONLY( position, POSITION ) // TODO: needed?
qreal offsetX() const { return element()->offset().x() / element()->spatium(); }
qreal offsetY() const { return element()->offset().y() / element()->spatium(); }
void setOffsetX(qreal offX);
void setOffsetY(qreal offY);
Ms::PluginAPI::Element* parent() const { return wrap(element()->parent()); }
public:
/// \cond MS_INTERNAL
Element(Ms::Element* e = nullptr, Ownership own = Ownership::PLUGIN)
: Ms::PluginAPI::ScoreElement(e, own) {}
/// \brief Returns the underlying Ms::Element
/// \{
Ms::Element* element() { return toElement(e); }
const Ms::Element* element() const { return toElement(e); }
/// \}
/// \endcond
/// Create a copy of the element
Q_INVOKABLE Ms::PluginAPI::Element* clone() const { return wrap(element()->clone(), Ownership::PLUGIN); }
Q_INVOKABLE QString subtypeName() const { return element()->subtypeName(); }
/// Deprecated: same as ScoreElement::name. Left for compatibility purposes.
Q_INVOKABLE QString _name() const { return name(); }
};
//---------------------------------------------------------
// Note
// Note wrapper
//---------------------------------------------------------
class Note : public Element {
Q_OBJECT
Q_PROPERTY(Ms::PluginAPI::Element* accidental READ accidental)
Q_PROPERTY(Ms::AccidentalType accidentalType READ accidentalType WRITE setAccidentalType)
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> dots READ dots)
// Q_PROPERTY(int dotsCount READ qmlDotsCount)
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> elements READ elements)
// Q_PROPERTY(int fret READ fret WRITE undoSetFret)
// Q_PROPERTY(bool ghost READ ghost WRITE undoSetGhost)
// Q_PROPERTY(Ms::NoteHead::Group headGroup READ headGroup WRITE undoSetHeadGroup)
// Q_PROPERTY(Ms::NoteHead::Type headType READ headType WRITE undoSetHeadType)
// Q_PROPERTY(bool hidden READ hidden)
// Q_PROPERTY(int line READ line)
// Q_PROPERTY(bool mirror READ mirror)
// Q_PROPERTY(int pitch READ pitch WRITE undoSetPitch)
// Q_PROPERTY(bool play READ play WRITE undoSetPlay)
// Q_PROPERTY(int ppitch READ ppitch)
// Q_PROPERTY(bool small READ small WRITE undoSetSmall)
// Q_PROPERTY(int string READ string WRITE undoSetString)
// Q_PROPERTY(int subchannel READ subchannel)
// Q_PROPERTY(Ms::Tie* tieBack READ tieBack)
// Q_PROPERTY(Ms::Tie* tieFor READ tieFor)
/// The NoteType of the note.
/// \since MuseScore 3.2.1
Q_PROPERTY(Ms::NoteType noteType READ noteType)
/** MIDI pitch of this note */
API_PROPERTY_T( int, pitch, PITCH )
/**
* Concert pitch of the note
* \see https://musescore.org/plugin-development/tonal-pitch-class-enum
*/
API_PROPERTY_T( int, tpc1, TPC1 )
/**
* Transposing pitch of the note
* \see https://musescore.org/plugin-development/tonal-pitch-class-enum
*/
API_PROPERTY_T( int, tpc2, TPC2 )
/**
* Concert or transposing pitch of this note,
* as per current "Concert Pitch" setting value.
* \see https://musescore.org/plugin-development/tonal-pitch-class-enum
*/
Q_PROPERTY(int tpc READ tpc WRITE setTpc)
// Q_PROPERTY(qreal tuning READ tuning WRITE undoSetTuning)
// Q_PROPERTY(Ms::MScore::Direction userDotPosition READ userDotPosition WRITE undoSetUserDotPosition)
// Q_PROPERTY(Ms::MScore::DirectionH userMirror READ userMirror WRITE undoSetUserMirror)
/** See PluginAPI::PluginAPI::NoteValueType */
API_PROPERTY( veloType, VELO_TYPE )
API_PROPERTY_T( int, veloOffset, VELO_OFFSET )
public:
/// \cond MS_INTERNAL
Note(Ms::Note* c = nullptr, Ownership own = Ownership::PLUGIN)
: Element(c, own) {}
Ms::Note* note() { return toNote(e); }
const Ms::Note* note() const { return toNote(e); }
int tpc() const { return note()->tpc(); }
void setTpc(int val);
QQmlListProperty<Element> dots() { return wrapContainerProperty<Element>(this, note()->dots()); }
QQmlListProperty<Element> elements() { return wrapContainerProperty<Element>(this, note()->el()); }
Element* accidental() { return wrap<Element>(note()->accidental()); }
Ms::AccidentalType accidentalType() { return note()->accidentalType(); }
void setAccidentalType(Ms::AccidentalType t) { note()->setAccidentalType(t); }
Ms::NoteType noteType() { return note()->noteType(); }
/// \endcond
};
//---------------------------------------------------------
// Chord
// Chord wrapper
//---------------------------------------------------------
class Chord : public Element {
Q_OBJECT
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Chord> graceNotes READ graceNotes)
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Note> notes READ notes )
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> lyrics READ lyrics ) // TODO: move to ChordRest
//Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> stem READ stem )
//Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> stemSlash READ stemSlash )
//Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> beam READ beam )
//Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> hook READ hook )
/// The NoteType of the chord.
/// \since MuseScore 3.2.1
Q_PROPERTY(Ms::NoteType noteType READ noteType)
public:
/// \cond MS_INTERNAL
Chord(Ms::Chord* c = nullptr, Ownership own = Ownership::PLUGIN)
: Element(c, own) {}
Ms::Chord* chord() { return toChord(e); }
const Ms::Chord* chord() const { return toChord(e); }
QQmlListProperty<Chord> graceNotes() { return wrapContainerProperty<Chord>(this, chord()->graceNotes()); }
QQmlListProperty<Note> notes() { return wrapContainerProperty<Note>(this, chord()->notes()); }
QQmlListProperty<Element> lyrics() { return wrapContainerProperty<Element>(this, chord()->lyrics()); } // TODO: move to ChordRest // TODO: special type for Lyrics?
//QQmlListProperty<Element> stem() { return wrapContainerProperty<Element>(this, chord()->stem()); }
//QQmlListProperty<Element> stemSlash() { return wrapContainerProperty<Element>(this, chord()->stemSlash()); }
//QQmlListProperty<Element> beam() { return wrapContainerProperty<Element>(this, chord()->beam()); }
//QQmlListProperty<Element> hook() { return wrapContainerProperty<Element>(this, chord()->hook()); }
Ms::NoteType noteType() { return chord()->noteType(); }
/// \endcond
/// Add to a chord's elements.
/// \since MuseScore 3.3
Q_INVOKABLE void add(Ms::PluginAPI::Element* wrapped);
/// Remove a chord's element.
/// \since MuseScore 3.3
Q_INVOKABLE void remove(Ms::PluginAPI::Element* wrapped);
};
//---------------------------------------------------------
// Segment
// Segment
//---------------------------------------------------------
class Segment : public Element {
Q_OBJECT
/**
* The list of annotations. Articulations, staff/system/expression
* text are examples of what is considered to be segment annotations.
*/
Q_PROPERTY(QQmlListProperty<Ms::PluginAPI::Element> annotations READ annotations)
/// \brief Next segment in this measure
/// \returns The next segment in this segment's measure.
/// Null if there is no such segment.
Q_PROPERTY(Ms::PluginAPI::Segment* nextInMeasure READ nextInMeasure)
/// \brief Next segment in this score.\ Doesn't stop at measure border.
/// \returns The next segment in this score. Null if there is
/// no such segment (i.e. this is the last segment in the score).
Q_PROPERTY(Ms::PluginAPI::Segment* next READ nextInScore)
/// \brief Previous segment in this measure
/// \returns The previous segment in this segment's measure.
/// Null if there is no such segment.
Q_PROPERTY(Ms::PluginAPI::Segment* prevInMeasure READ prevInMeasure)
/// \brief Previous segment in this score.\ Doesn't stop at measure border.
/// \returns The previous segment in this score. Null if there is
/// no such segment (i.e. this is the first segment in the score).
Q_PROPERTY(Ms::PluginAPI::Segment* prev READ prevInScore)
// segmentType was read&write in MuseScore 2.X plugin API.
// Allowing plugins to change random segments types doesn't seem to be a
// good idea though.
/// Type of this segment, one of PluginAPI::PluginAPI::Segment values.
Q_PROPERTY(Ms::SegmentType segmentType READ segmentType)
Q_PROPERTY(int tick READ tick) // TODO: revise libmscore (or this API):
// Pid::TICK is relative or absolute in different contexts
public:
/// \cond MS_INTERNAL
Segment(Ms::Segment* s = nullptr, Ownership own = Ownership::SCORE)
: Element(s, own) {}
Ms::Segment* segment() { return toSegment(e); }
const Ms::Segment* segment() const { return toSegment(e); }
int tick() const { return segment()->tick().ticks(); }
Ms::SegmentType segmentType() const { return segment()->segmentType(); }
Segment* nextInScore() { return wrap<Segment>(segment()->next1()); }
Segment* nextInMeasure() { return wrap<Segment>(segment()->next()); }
Segment* prevInScore() { return wrap<Segment>(segment()->prev1()); }
Segment* prevInMeasure() { return wrap<Segment>(segment()->prev()); }
QQmlListProperty<Element> annotations() { return wrapContainerProperty<Element>(this, segment()->annotations()); }
/// \endcond
/// \return Element at the given \p track (null if there is no such an element)
/// \param track track number
Q_INVOKABLE Ms::PluginAPI::Element* elementAt(int track);
};
//---------------------------------------------------------
// Measure
// Measure wrapper
//---------------------------------------------------------
class Measure : public Element {
Q_OBJECT
/// The first segment of this measure
Q_PROPERTY(Ms::PluginAPI::Segment* firstSegment READ firstSegment)
/// The last segment of this measure
Q_PROPERTY(Ms::PluginAPI::Segment* lastSegment READ lastSegment)
// TODO: to MeasureBase?
// Q_PROPERTY(bool lineBreak READ lineBreak WRITE undoSetLineBreak)
Q_PROPERTY(Ms::PluginAPI::Measure* nextMeasure READ nextMeasure)
// Q_PROPERTY(Ms::Measure* nextMeasureMM READ nextMeasureMM)
// Q_PROPERTY(bool pageBreak READ pageBreak WRITE undoSetPageBreak)
Q_PROPERTY(Ms::PluginAPI::Measure* prevMeasure READ prevMeasure)
// Q_PROPERTY(Ms::Measure* prevMeasureMM READ prevMeasureMM)
public:
/// \cond MS_INTERNAL
Measure(Ms::Measure* m = nullptr, Ownership own = Ownership::SCORE)
: Element(m, own) {}
Ms::Measure* measure() { return toMeasure(e); }
const Ms::Measure* measure() const { return toMeasure(e); }
Segment* firstSegment() { return wrap<Segment>(measure()->firstEnabled(), Ownership::SCORE); }
Segment* lastSegment() { return wrap<Segment>(measure()->last(), Ownership::SCORE); }
Measure* prevMeasure() { return wrap<Measure>(measure()->prevMeasure(), Ownership::SCORE); }
Measure* nextMeasure() { return wrap<Measure>(measure()->nextMeasure(), Ownership::SCORE); }
/// \endcond
};
#undef API_PROPERTY
#undef API_PROPERTY_T
#undef API_PROPERTY_READ_ONLY
#undef API_PROPERTY_READ_ONLY_T
} // namespace PluginAPI
} // namespace Ms
#endif
|
