1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 (define (define-grob-property symbol type? description)
9 (if (not (equal? (object-property symbol 'backend-doc) #f))
10 (ly:error (_ "symbol ~S redefined") symbol))
12 (set-object-property! symbol 'backend-type? type?)
13 (set-object-property! symbol 'backend-doc description)
16 ;; put this in an alist?
18 all-user-grob-properties
22 (apply define-grob-property x))
25 (X-offset ,number? "The horizontal amount that this object is moved relative to its X-parent")
26 (Y-offset ,number? "The vertical amount that this object is moved
27 relative to its X-parent")
28 (self-X-offset ,number? "")
29 (self-Y-offset ,number? "")
30 (accidentals ,list? "List of alteration numbers")
31 (alteration-alist ,list? "List of @code{(@var{pitch}
32 . @var{accidental})} pairs for key signature.")
33 (add-stem-support ,boolean? "If set, the Stem object is included in this script's support")
35 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
36 @code{0}: around center of width, @code{1}: right side.")
37 (arpeggio-direction ,ly:dir? "If set, put an
38 arrow on the arpeggio squiggly line.")
40 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
41 where a horizontal beam fits that is larger than this number, make a kneed beam.")
42 (average-spacing-wishes ,boolean? "If set, the spacing wishes are averaged over staves.")
43 (axes ,list? "list of axis numbers.
44 In the case of alignment grobs, this should contain only one number.")
46 (balloon-text ,markup? "Text to add to help balloon")
47 (balloon-text-props ,list? "Font properties
49 (balloon-text-offset ,number-pair?
50 "Where to put text relative to balloon.")
51 (balloon-padding ,ly:dimension? "Text to add to help balloon")
52 (original-stencil ,ly:stencil? "The
53 original stencil drawer to draw the balloon around.")
56 (bar-size ,ly:dimension? "size of a bar line.")
57 (barre-type ,symbol? "Type of barre indication used in a fret diagram.
58 Choices include @code{curved} and @code{straight}.")
59 (base-shortest-duration ,ly:moment?
60 "Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.")
61 (baseline-skip ,ly:dimension? "Distance between base lines of
62 multiple lines of text.")
63 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
64 (beam-width ,ly:dimension? "width of the tremolo sign.")
65 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
66 when their direction is forced. It is a list, since the value is different
67 depending on the number flags/beams.")
69 "Pair of number lists. Each number list specifies which
70 beams to make. 0 is the central beam, 1 is the next beam toward the
71 note etc. This information is used to determine how to connect the
72 beaming patterns from stem to stem inside a beam.")
75 (before-line-breaking ,boolean? "Dummy property, used to trigger a callback function.")
76 (between-cols ,pair? "Where to attach a loose column to")
77 (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
78 (bracket-flare ,number-pair? "A pair of numbers specifying how
79 much edges of brackets should slant outward. Value 0.0 means straight
81 (break-align-symbol ,symbol? "This key is used for aligning and
82 spacing breakable items.")
83 (break-align-orders ,vector? " Defines the order in which
84 prefatory matter (clefs, key signatures) appears. The format is a
85 vector of length 3, where each element is one order for end-of-line,
86 middle of line, and start-of-line respectively. An order is a list of
89 For example, clefs are put after key signatures by setting
92 \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3
100 (break-overshoot ,number-pair? "How much does a broken spanner
101 stick out of its bounds?")
102 (bracket-visibility ,boolean-or-symbol? "This controls the
103 visibility of the tuplet bracket. Setting it to false will prevent
104 printing of the bracket. Setting the property to @code{'if-no-beam}
105 will make it print only if there is no beam associated with this
107 (break-visibility ,vector? "A vector of 3 booleans, #(end-of-line unbroken begin-of-line).
108 #t means visible, #f means killed.")
110 (breakable ,boolean? "Can this object appear at a line break,
111 like clefs and bar lines?")
112 (c0-position ,integer? "An integer indicating the position of
114 (cautionary-style ,symbol? "How to print cautionary
115 accidentals. Choices are @code{smaller} or
116 @code{parentheses}.")
117 (cautionary ,boolean? "Is this a cautionary accidental?")
118 (concaveness ,number? "A beam is concave when its inner stems are
119 closer to the beam than the two outside stems. This number is a
120 measure of the closeness of the inner stems. It is used for damping
121 the slope of the beam.")
122 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
124 (color ,color? "The color of this grob.")
127 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
129 (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
130 100000: horizontal beams.")
131 (dash-period ,number? "the length of one dash + white space. If
132 negative, no line is drawn at all.")
134 (dash-fraction ,number? "Size of the dashes, relative to
135 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
138 (arrow ,boolean? "Add an arrow to the line.")
139 (arrow-length ,number? "Arrow length.")
140 (arrow-width ,number? "Arrow width.")
143 (direction ,ly:dir? "Up or down, left or right?")
144 (dot-color ,symbol? "Color of dots. Options include
145 @code{black} and @code{white}.")
146 (dot-radius ,number? "Radius of dots.")
147 (dot-count ,integer? "The number of dots.")
148 (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
149 (edge-height ,pair? "A pair of number specifying the heights of
150 the vertical edges '(@var{left-height} . @var{right-height}).")
151 (edge-text ,pair? "A pair specifying the texts to be set at the
152 edges '(@var{left-text} . @var{right-text}).")
153 (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
155 (enclose-bounds ,number?
156 "How much of the bound a spanner should enclose:
157 +1 = completely, 0 = center, -1 not at all.")
159 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
162 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
164 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
166 (X-extent ,number-pair? "Hard coded extent in X direction. ")
167 (Y-extent ,number-pair? "See @code{X-extent}.")
169 (extra-offset ,number-pair? "A pair representing an offset. This
170 offset is added just before outputting the symbol, so the typesetting
171 engine is completely oblivious to it.")
173 (finger-code ,symbol? "Code for the type of fingering indication in a
174 fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
175 (flag-count ,number? "The number of tremolo beams.")
177 "a string determining what style of flag-glyph is
178 typeset on a Stem. Valid options include @code{()} and
179 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
182 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
183 (font-encoding ,symbol? "The font encoding is the broadest
184 category for selecting a font. Options include: @code{fetaMusic},
185 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
187 (font-name ,string? "Specifies a file name (without extension) of
188 the font to load. This setting override selection using
189 @code{font-family}, @code{font-series} and @code{font-shape}.")
190 (font-magnification ,number? "Magnification of the font, when it
191 is selected with @code{font-name}.")
193 (font-size ,number? "The font size, compared the `normal'
194 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
195 Each step of 1 is approximately 12% larger, 6 steps are exactly a
196 factor 2 larger. Fractional values are allowed.")
198 (font-series ,symbol? "Select the series of a font. Choices
199 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
200 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
201 @code{italic}, @code{caps}.")
203 (forced-distance ,ly:dimension? "A fixed distance between object
204 reference points in an alignment.")
206 (force-hshift ,number? "This specifies a manual shift for notes
207 in collisions. The unit is the note head width of the first voice
208 note. This is used by @internalsref{note-collision-interface}.")
210 (fraction ,number-pair? "Numerator and denominator of a time
212 (french-beaming ,boolean? "Use French beaming style for this
213 stem. The stem will stop at the innermost beams.")
214 (fret-count ,integer? "The number of frets in a fret diagram.")
216 ;; ugh: double, change.
217 (full-size-change ,boolean? "Don't make a change clef smaller.")
218 (non-default ,boolean? "Set for manually specified clefs.")
221 (glyph ,string? "a string determining what (style) of glyph is
222 typeset. Valid choices depend on the function that is reading this
224 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
225 (gap-count ,integer? "Number of gapped beams for tremolo.")
226 (grace-space-factor ,number? "Space grace notes at this fraction
227 of the @code{spacing-increment}.")
229 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
230 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
231 (height ,ly:dimension? "Height of an object in staffspace.")
232 (height-limit ,ly:dimension? "Maximum slur height: the longer the
233 slur, the closer it is to this height.")
235 (horizontal-shift ,integer? "An integer that identifies ranking
236 of note-column for horizontal shifting. This is used by
237 @internalsref{note-collision-interface}.")
238 (avoid-slur ,symbol? "Method of handling slur collisions.
239 Choices are @code{around}, @code{inside}, @code{outside}. If unset, script
240 and slur ignore eachother.")
241 (inspect-quants ,number-pair? "If debugging is set,
242 set beam quant to this position, and print the respective scores.")
243 (implicit ,boolean? "Is this an implicit bass figure?")
244 (keep-inside-line ,boolean? "If set, this column cannot have
245 things sticking into the margin.")
246 (kern ,ly:dimension? "Amount of extra white space to add. For
247 bar line, this is the amount of space after a thick line.")
248 (knee ,boolean? "Is this beam kneed?")
249 (knee-spacing-correction ,number? "Factor for the optical
250 correction amount for kneed beams. Set between 0 for no correction and
251 1 for full correction.")
252 (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
253 (layer ,number? "The output layer [0..2]: layers define the order
254 of printing objects. Objects in lower layers are overprinted by
255 objects in higher layers.")
256 (ledger-line-thickness ,number-pair?
257 "The thickness of ledger lines: it is the
258 sum of 2 numbers. The first is the factor for line thickness, and the
259 second for staff space. Both contributions are added.")
260 (left-padding ,ly:dimension? "The amount of space that is put
261 left to a group of accidentals.")
263 (length ,ly:dimension? "User override for the stem length of
265 (length-fraction ,number? "Multiplier for lengths. Used for
266 determining ledger lines and stem lengths.")
268 (line-break-system-details ,list?
269 "Alist of properties to use when this
270 column is the start of a system.")
272 (line-count ,integer? "The number of staff lines.")
273 (measure-length ,ly:moment? "Length of a
274 measure. Used in some spacing situations.")
276 (measure-count ,integer? "The number of measures for a
278 (merge-differently-headed ,boolean? "Merge
279 note heads in collisions, even if they have different note heads. The
280 smaller of the two heads will be rendered invisible. This used
281 polyphonic guitar notation. The value of this setting is used by
282 @internalsref{note-collision-interface} .")
284 (merge-differently-dotted ,boolean? "Merge note heads in
285 collisions, even if they have a different number of dots. This normal
286 notation for some types of polyphonic music. ")
288 (minimum-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.")
289 (minimum-distance ,ly:dimension? "Minimum distance between rest
291 (minimum-X-extent ,number-pair? "Minimum size of an object in X
292 dimension, measured in staff space.")
293 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
294 (minimum-length ,ly:dimension? "Try to make a spanner at least
295 this long. This requires an appropriate callback for the
296 @code{springs-and-rods} property.")
297 (minimum-space ,ly:dimension? "Minimum distance that the victim
298 should move (after padding).")
299 (neutral-direction ,ly:dir? "Which direction to take in the
300 center of the staff.")
301 (neutral-position ,number? "Position (in half staff spaces) where
302 to flip the direction of custos stem.")
304 (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
305 (note-names ,vector? "Vector of strings containing names for
306 easy-notation note heads.")
307 (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
308 (no-spacing-rods ,boolean? "Items with this property do not cause
309 spacing constraints.")
310 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
311 get stems extending to the middle staff line.")
312 (number-type ,symbol? "Type of numbers to use in label. Choices
313 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
314 (number-visibility ,boolean-or-symbol? "Like
315 @code{bracket-visibility}, but for the number.")
319 (packed-spacing ,boolean? "If set, the notes are spaced as
320 tightly as possible.")
321 (padding ,ly:dimension? "Add this much extra space between
322 objects that are next to each other.")
323 (page-penalty ,number? "Penalty for page break at
324 this column. 10000 or more means forbid linebreak, -10000 or less
325 means force page break. Other values influence page breaking decisions
327 (penalty ,number? "Penalty for line break at
328 this column. 10000 or more means forbid line break, -10000 or less
329 means force line break. Other values influence line breaking decisions
333 "Pair of staff coordinates @code{(@var{left}
334 . @var{right})}, where both @var{left} and @var{right} are in the
335 staff-space unit of the current staff.")
336 (ratio ,number? "Parameter for slur shape. The higher this number, the
337 quicker the slur attains it @code{height-limit}.")
339 (remove-empty ,boolean? "If set, remove group if it contains no
340 @code{interesting-items}")
341 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
342 (right-padding ,ly:dimension? "Space to insert between note and
344 (same-direction-correction ,number? "Optical correction amount
345 for stems that are placed in tight configurations. This amount is used
346 for stems with the same direction to compensate for note-head to stem distance.")
347 (script-priority ,number? "A sorting key that determines in what
348 order a script is within a stack of scripts.")
350 (self-alignment-X ,number? "Specify alignment of an object. The
351 value -1 means left aligned, 0 centered, and 1 right-aligned in X
352 direction. Values in between may also be specified.")
353 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
356 (shorten-pair ,number-pair? "The lengths to shorten a
357 text-spanner on both sides, for example a pedal bracket")
358 (common-shortest-duration ,ly:moment?
359 "The most common shortest note length.
360 This is used in spacing. Enlarging this will set the score tighter.")
361 (shortest-duration-space ,ly:dimension? "Start with this much
362 space for the shortest duration. This is expressed in
363 @code{spacing-increment} as unit. See also
364 @internalsref{spacing-spanner-interface}.")
365 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
366 (shortest-starter-duration ,ly:moment? "The duration of the shortest
367 note that starts here.")
368 (side-relative-direction ,ly:dir?
369 "Multiply direction of
370 @code{direction-source} with this to get the direction of this
372 (side-axis ,number? "Is this object horizontally or vertically next to another object?")
373 (size ,number? "Size of object, relative to standard size.")
374 (slope ,number? "The slope of this object.")
375 (slur-padding ,number? "Extra distance between slur and script.")
377 "An alist of scoring parameters for slur formatting")
378 (space-alist ,list? "A table that specifies distances between
379 prefatory items, like clef and time-signature. The format is an alist
380 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
381 . @var{distance})}, where @var{type} can be the symbols
382 @code{minimum-space} or @code{extra-space}.")
384 (spacing-increment ,number? "Add this much space for a doubled
385 duration. Typically, the width of a note head. See also
386 @internalsref{spacing-spanner-interface}.")
388 (springs-and-rods ,boolean? "Dummy variable for triggering spacing routines.")
389 (stacking-dir ,ly:dir? "Stack objects in which direction?")
390 (staff-space ,ly:dimension? "Amount of space between staff lines,
391 expressed in global staffspace.")
392 (staff-position ,number? "Vertical position, measured in half
393 staff spaces, counted from the middle line.")
395 (stemlet-length ,number? "How long should a stem over a rest be?")
396 (stem-attachment ,number-pair? "A (@var{x} . @var{y}) pair where the stem attaches to the notehead.")
398 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
401 (stem-spacing-correction ,number? "Optical correction amount for
402 stems that are placed in tight configurations. For opposite
403 directions, this amount is the correction for two normal sized stems
404 that overlap completely.")
406 (strict-note-spacing ,boolean? "If set, unbroken columns
407 with non-musical material (clefs, barlines, etc.) are not spaced
408 separately, but put before musical columns.")
409 (string-count ,integer? "The number of strings in a fret diagram.")
410 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
412 (style ,symbol? "This setting determines in what style a grob is
413 typeset. Valid choices depend on the @code{stencil} callback reading
415 (styles ,list? "A list of style symbols.")
416 (text ,markup? "Text markup. See @usermanref{Text markup}.")
417 ;;FIXME -- Should both be the same?
418 (text-direction ,ly:dir? "This controls the ordering of the
419 words. The default RIGHT is for roman text. Arabic or hebrew should
421 (thick-thickness ,number? "Bar line thickness, measured in
422 @code{linethickness}.")
423 (thickness ,number? "Bar line thickness, measured in
424 @code{linethickness}.")
425 (thin-kern ,number? "The space after a hair-line in a bar line.")
427 (threshold ,number-pair? "(@var{min} . @var{max}), where
428 @var{min} and @var{max} are dimensions in staff space.")
429 (tie-configuration ,list? "List of (@var{position} . @var{dir})
430 pairs, indicating the desired tie configuration.")
431 (transparent ,boolean? "This makes the grob invisible.")
432 (uniform-stretching ,boolean? "If set, items stretch proportional
433 to their durations. This looks better in complex polyphonic patterns")
434 (used ,boolean? "If set, this spacing column is kept in the spacing problem")
435 (when ,ly:moment? "Global time step associated with this column
437 (word-space ,ly:dimension? "space to insert between words in texts.")
438 (width ,ly:dimension? "The width of a grob measured in staff space.")
439 (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
440 (zigzag-length ,ly:dimension? "The length of the lines of a
441 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
443 (zigzag-width ,ly:dimension? "The width of one
444 zigzag-squiggle. This number will be adjusted slightly so that the
445 glissando line can be constructed from a whole number of squiggles.")
447 (avoid-note-head ,boolean? "If set, the stem of a chord does not
448 pass through all note heads, but starts at the last note head. ")
449 (staff-padding ,ly:dimension?
450 "Maintain this much space between reference points
451 and the staff. Its effect is to align objects of differing
452 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
461 (define (define-internal-grob-property symbol type? description)
462 (define-grob-property symbol type? description)
463 (set-object-property! symbol 'backend-internal #t)
468 (define-public all-internal-grob-properties
471 (apply define-internal-grob-property x))
474 (axis-group-parent-X ,ly:grob? "Containing X axis group")
475 (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
476 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
477 (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")
478 (after-line-breaking ,boolean? "Dummy property, used to trigger callback for after-line-breaking")
479 (all-elements ,ly:grob-array? "list of all grobs in this line. Its
480 function is to protect objects from being garbage collected.")
481 (arpeggio ,ly:grob? "pointer to arpeggio object.")
482 (beam ,ly:grob? "pointer to the beam, if applicable.")
483 (direction-source ,ly:grob? "in case side-relative-direction is
484 set, which grob to get the direction from .")
485 (dot ,ly:grob? "reference to Dots object.")
486 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
487 (glyph-name ,string? "a name of character within font.")
488 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
489 (stem ,ly:grob? "pointer to Stem object.")
490 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
492 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
493 (rest ,ly:grob? "the staff symbol grob that we're in.")
494 (rests ,ly:grob-array? "A list of rest objects.")
495 (rest-collision ,ly:grob? "rest collision that a rest is in.")
496 (accidental-grob ,ly:grob? "Accidental for this note.")
497 (bars ,ly:grob-array? "list of bar line pointers.")
498 (bounded-by-me ,ly:grob-array? "list of spanners that have this
499 column as start/begin point. Only columns that have grobs or act as
501 (columns ,ly:grob-array? "list of grobs, typically containing
502 paper-columns or note-column objects.")
503 (conditional-elements ,ly:grob-array? "Internal use only")
504 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
505 in addition to notes and stems.")
506 (elements ,ly:grob-array? "list of grobs, type depending on the Grob
507 where this is set in.")
508 (heads ,ly:grob-array? "List of note heads.")
509 (items-worth-living ,ly:grob-array? "A list of interesting items. If
510 empty in a particular staff, then that staff is erased.")
511 (details ,list? "alist of parameters for detailed grob behavior.")
512 (note-heads ,ly:grob-array? "List of note head grobs")
513 (note-head ,ly:grob? "A single note head")
514 (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
515 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
516 (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
517 (tuplets ,ly:grob-array? "list of smaller tuplet brackets")
519 (left-neighbors ,ly:grob-array? " List of
520 spacing-wish grobs that are close to the current column.
522 The closest spacing-wishes determine the actual distances between the
525 (right-neighbors ,ly:grob-array? "see left-neighbors")
526 (left-items ,ly:grob-array? "")
527 (right-items ,ly:grob-array? "")
528 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
529 (font ,ly:font-metric? "Cached font metric object")
531 (positioning-done ,boolean?
532 "Used to signal that a positioning element
533 did its job. This ensures that a positioning is only done once.")
536 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
537 acts as an index for looking up a Stencil object.")
539 (meta ,list? "Contains meta information. It is an alist with the
540 entries @code{name} and @code{interfaces}.")
543 ;; TODO: use interface for this!
544 (quantized-positions ,number-pair? "Beam positions after quanting.")
545 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
546 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
548 (quantize-position ,boolean? "If set, a vertical alignment is aligned to be within staff spaces.")
549 (quant-score ,string? "Beam quanting score -- can be stored for
552 (least-squares-dy ,number?
553 "ideal beam slope, without damping.")
554 (stem-info ,pair? "caching of stem parameters")
555 (note-columns ,pair? "list of NoteColumn grobs.")
557 ;;; add-join would be enough if in Mensural_ligature::brew_ligature_primitive
558 ;;; the next note could be seen
559 (join-right-amount ,number? "")
561 (delta-pitch ,number? "the interval between this and the next note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
562 (head-width ,ly:dimension? "width of this ligature head")
564 ;; [TODO: change this]
565 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
566 (stencil ,ly:stencil? "The symbol to print.")
567 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
568 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
570 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
571 (shorten ,ly:dimension? "The amount of space that a
572 stem. Internally used to distribute beam shortening over stems. ")
573 (slur ,ly:grob? "A pointer to a slur object")
574 (staff-hierarchy ,pair? "A nested list of staff symbol grobs.")
575 (use-breve-rest ,boolean? "Use breve rests for measures longer
579 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")
582 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
584 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
586 ;; there are too many properties for ancient notation
587 ;; probably neume-types (a list of symbols) would also work.
589 (auctum ,boolean? "is this neume augmented?")
590 (ascendens ,boolean? "is this neume of an ascending?")
591 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
592 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
593 (cavum ,boolean? "is this neume outlined?")
594 (descendens ,boolean? "is this neume of a descendent type?")
595 (deminutum ,boolean? "is this neume deminished?")
596 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
597 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
598 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
599 (linea ,boolean? "attach vertical lines to this neume?")
602 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
603 (context-info ,integer? "DOCME")
604 (inclinatum ,boolean? "is this neume an inclinatum?")
605 (oriscus ,boolean? "is this neume an oriscus?")
606 (quilisma ,boolean? "is this neume a quilisma?")
607 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
609 (prefix-set ,number? "")
610 (stropha ,boolean? "Is this neume a stropha?")
611 (virga ,boolean? "Is this neume a virga?")
612 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
614 ;; end ancient notation
618 (define-public all-backend-properties
620 all-internal-grob-properties
621 all-user-grob-properties))