1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
10 (define (define-grob-property symbol type? description)
11 (if (not (equal? (object-property symbol 'backend-doc) #f))
13 (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
17 (set-object-property! symbol 'backend-type? type?)
18 (set-object-property! symbol 'backend-doc description)
22 ;; put this in an alist?
24 all-user-grob-properties
28 (apply define-grob-property x))
31 (X-extent-callback ,procedure? "Procedure that calculates the
32 extent of this object. If this value is set to @code{#f}, the object
33 is empty in the X direction. The procedure takes a grob and axis
34 argument, and returns a number-pair.
37 (X-offset-callbacks ,list? "A list of functions determining this
38 objects' position relative to its parent. The last one in the list is
39 called first. The functions take a grob and axis argument. ")
41 (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
42 (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
44 (accidentals ,list? "List of alteration numbers.")
47 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
48 @code{0}: around center of width, @code{1}: right side.")
49 (arch-angle ,number? "Turning angle of the hook of a system brace" )
50 (arch-height ,ly:dimension? "Height of the hook of a system brace.")
51 (arch-thick ,number? "Thickness of the hook of system brace.")
52 (arch-width ,ly:dimension? "Width of the hook of a system brace.")
53 (arpeggio-direction ,ly:dir? "If set, put an
54 arrow on the arpeggio squiggly line.")
55 (attachment ,pair? "Pair of symbols
56 indicating how a slur should be attached at the ends. The format is
57 '(@var{left-type} . @var{right-type}), where both @var{type}s are
58 symbols. The values of these symbols may be @code{alongside-stem},
59 @code{stem}, @code{head} or @code{loose-end}.")
60 (attachment-offset ,pair? "cons of offsets,
61 '(@var{left-offset} . @var{right-offset}). This offset is added to
62 the attachments to prevent ugly slurs. [fixme: we need more
63 documentation here].")
66 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
67 where a horizontal beam fits that is larger than this number, make a kneed beam.")
68 (axes ,list? "list of axis numbers.
69 In the case of alignment grobs, this should contain only one number.")
71 (balloon-text ,markup? "Text to add to help balloon")
72 (balloon-text-props ,list? "Font properties
74 (balloon-text-offset ,number-pair?
75 "Where to put text relative to balloon.")
76 (balloon-padding ,ly:dimension? "Text to add to help balloon")
77 (balloon-original-callback ,procedure? "The
78 original stencil drawer to draw the balloon around.")
81 (bar-size ,ly:dimension? "size of a bar line.")
82 (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
83 (base-shortest-duration ,ly:moment?
84 "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.")
85 (baseline-skip ,ly:dimension? "Distance between base lines of
86 multiple lines of text.")
87 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
88 (beam-width ,ly:dimension? "width of the tremolo sign.")
89 (beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
90 (beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
91 (beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
93 (beamed-stem-shorten ,list? " How much to shorten beamed stems,
94 when their direction is forced. It is a list, since the value is different
95 depending on the number flags/beams.")
97 "Pair of number lists. Each number list specifies which
98 beams to make. 0 is the central beam, 1 is the next beam toward the
99 note etc. This information is used to determine how to connect the
100 beaming patterns from stem to stem inside a beam.")
103 (beautiful ,number? "number that dictates when a slur should be de-uglyfied. It correlates with the enclosed area between noteheads and slurs. A value of 0.1 yields only undisturbed slurs, a value of 5 will tolerate quite high blown slurs.")
104 (before-line-breaking-callback ,procedure? "This procedure is
105 called before line breaking, but after splitting breakable items at
106 potential line breaks.")
107 (between-cols ,pair? "Where to attach a loose column to")
108 (between-system-string ,string? "string
109 to dump between two systems. Useful for forcing page breaks.")
110 (bracket-thick ,number? "width of a system start bracket.")
111 (break-align-symbol ,symbol? "This key is used for aligning and
112 spacing breakable items.")
113 (break-align-orders ,vector? " Defines the order in which
114 prefatory matter (clefs, key signatures) appears. The format is a
115 vector of length 3. Each element is an order for (end-of-line, middle
116 of line, and start-of-line). The order is a list of symbols.
117 Clefs are put after key signatures by setting
120 \\property Score.breakAlignOrder = #(make-vector 3
128 (break-glyph-function ,procedure? "This function determines the
129 appearance of a bar line at the line break. It takes a glyph and
130 break-direction and returns the glyph at a line break.")
131 (breakable ,boolean? "Can this object appear at a line break,
132 like clefs and bar lines?")
133 (c0-position ,integer? "An integer indicating the position of
135 (cautionary-style ,symbol? "How to print cautionary
136 accidentals. Choices are @code{smaller} or
137 @code{parentheses}.")
138 (cautionary ,boolean? "Is this a cautionary accidental?")
139 (concaveness-gap ,ly:dimension? "A beam is printed horizontally
140 if its concaveness-gap is larger than this value. The concaveness-gap
141 is the distance of an inner note head to the line between two outer
143 (concaveness-threshold ,number? "A beam is printed horizontally
144 if its concaveness is bigger than this threshold.
146 Concaveness is calculated as the sum of the vertical distances of
147 inner note heads that fall outside the interval of the two outer
148 note heads, to the vertically nearest outer note head, divided by the
149 square of the inner notes involved.")
150 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
154 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
156 (damping ,integer? "Amount of beam slope damping. 0: no, 1: yes,
157 100000: horizontal beams.")
158 (dash-period ,number? "the length of one dash + white space. If
159 negative, no line is drawn at all.")
161 (dash-fraction ,number? "Size of the dashes, relative to
162 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
165 ;; [FIXME: use dash-period/dash length; see text-spanner]
166 (dashed ,number? " number representing the length of the dashes.")
167 (neutral-direction ,ly:dir? "Which direction to take in the
168 center of the staff.")
169 (neutral-position ,number? "Position (in half staff spaces) where
170 to flip the direction of custos stem.")
173 ;; todo: why is this tunable?
174 (dir-function ,procedure? "The function to determine the
175 direction of a beam. Choices include:
178 @item beam-dir-majority
179 number count of up or down notes
181 mean center distance of all notes
182 @item beam-dir-median.
183 mean center distance weighted per note
188 (direction ,ly:dir? "Up or down, left or right?")
189 (dot-count ,integer? "The number of dots.")
190 (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
191 (edge-height ,pair? "A pair of number specifying the heights of
192 the vertical edges '(@var{left-height} . @var{right-height}).")
193 (bracket-flare ,number-pair? "A pair of numbers specifying how
194 much edges of brackets should slant outward. Value 0.0 means straight
197 (edge-text ,pair? "A pair specifying the texts to be set at the
198 edges '(@var{left-text} . @var{right-text}).")
199 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
202 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
204 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
206 (X-extent ,number-pair? "Hard coded extent in X direction. ")
207 (Y-extent ,number-pair? "See @code{X-extent}.")
209 (extra-offset ,number-pair? "A pair representing an offset. This
210 offset is added just before outputting the symbol, so the typesetting
211 engine is completely oblivious to it.")
214 (extremity-offset-alist ,list? "The offset adds to the centre of
215 the note head, or stem.
217 Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
221 (extremity-function ,procedure? "A function that calculates the
222 attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.")
224 "a string determining what style of flag-glyph is
225 typeset on a Stem. Valid options include @code{()} and
226 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
228 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
229 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
230 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
231 (font-encoding ,symbol? "The font encoding is the broadest category for selecting a font. Options include: @code{music}, @code{number}, @code{text},
232 @code{math}, @code{braces}, @code{dynamic}")
233 (font-name ,string? "Specifies a file name (without extension) of
234 the font to load. This setting override selection using
235 @code{font-family}, @code{font-series} and @code{font-shape}.")
236 (font-magnification ,number? "Magnification of the font, when it
237 is selected with @code{font-name}.")
239 (font-size ,number? "The font size, compared the `normal'
240 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
241 Each step of 1 is approximately 12% larger, 6 steps are exactly a
242 factor 2 larger. Fractional values are allowed.")
244 (font-series ,symbol? "Select the series of a font. Choices
245 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
246 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
247 @code{italic}, @code{caps}.")
249 (force-hshift ,number? "This specifies a manual shift for notes
250 in collisions. The unit is the note head width of the first voice
251 note. This is used by @internalsref{note-collision-interface}.")
253 (fraction ,number-pair? "Numerator and denominator of a time
255 (french-beaming ,boolean? "Use French beaming style for this
256 stem. The stem will stop at the innermost beams.")
258 ;; ugh: double, change.
259 (full-size-change ,boolean? "Don't make a change clef smaller.")
260 (non-default ,boolean? "Set for manually specified clefs.")
263 (glyph ,string? "a string determining what (style) of glyph is
264 typeset. Valid choices depend on the function that is reading this
266 (glyph-name ,string? "a name of character within font.")
267 (glyph-name-procedure ,procedure? "Return the name of a character
268 within font, to use for printing a symbol.")
270 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
271 (gap-count ,integer? "Number of gapped beams for tremolo.")
272 (grace-space-factor ,number? "Space grace notes at this fraction
273 of the @code{spacing-increment}.")
275 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
276 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
277 (height ,ly:dimension? "Height of an object in staffspace.")
278 (height-limit ,ly:dimension? "Maximum slur height: the longer the
279 slur, the closer it is to this height.")
281 (horizontal-shift ,integer? "An integer that identifies ranking
282 of note-column for horizontal shifting. This is used by
283 @internalsref{note-collision-interface}.")
284 (kern ,ly:dimension? "Amount of extra white space to add. For
285 bar line, this is the amount of space after a thick line.")
286 (knee ,boolean? "Is this beam kneed?")
287 (knee-spacing-correction ,number? "Factor for the optical
288 correction amount for kneed beams. Set between 0 for no correction and
289 1 for full correction.")
290 (layer ,number? "The output layer [0..2]: layers define the order
291 of printing objects. Objects in lower layers are overprinted by
292 objects in higher layers.")
293 (ledger-line-thickness ,number-pair?
294 "The thickness of ledger lines: it is the
295 sum of 2 numbers. The first is the factor for line thickness, and the
296 second for staff space. Both contributions are added.")
297 (left-position ,number? "Vertical position of left part of spanner.")
298 (left-padding ,ly:dimension? "The amount of space that is put
299 left to a group of accidentals.")
300 (length ,ly:dimension? "User override for the stem length of
302 (lengths ,list? "Default stem lengths. The list gives a length
303 for each flag-count.")
304 (line-count ,integer? "The number of staff lines.")
305 (measure-length ,ly:moment? "Length of a
306 measure. Used in some spacing situations.")
308 (measure-count ,integer? "The number of measures for a
310 (merge-differently-headed ,boolean? "Merge
311 note heads in collisions, even if they have different note heads. The
312 smaller of the two heads will be rendered invisible. This used
313 polyphonic guitar notation. The value of this setting is used by
314 @internalsref{note-collision-interface} .")
316 (merge-differently-dotted ,boolean? "Merge note heads in
317 collisions, even if they have a different number of dots. This normal
318 notation for some types of polyphonic music. ")
320 (minimum-distance ,ly:dimension? "Minimum distance between rest
322 (minimum-X-extent ,number-pair? "Minimum size of an object in X
323 dimension, measured in staff space.")
324 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
325 (minimum-length ,ly:dimension? "Try to make a spanner at least
326 this long. This requires an appropriate routine for the
327 @code{spacing-procedure} property.")
328 (minimum-space ,ly:dimension? "Minimum distance that the victim
329 should move (after padding).")
330 (print-function ,procedure? "Function taking grob as argument,
331 returning a @code{Stencil} object.")
332 (new-accidentals ,list? "List of @code{(@var{pitch}
333 . @var{accidental})} pairs.")
334 (note-names ,vector? "Vector of strings containing names for
335 easy-notation note heads.")
336 (no-spacing-rods ,boolean? "Items with this property do not cause
337 spacing constraints.")
338 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
339 get stems extending to the middle staff line.")
341 (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
344 (enclose-bounds ,number?
345 "How much of the bound a spanner should enclose:
346 +1 = completely, 0 = center, -1 not at all.")
348 (padding ,ly:dimension? "Add this much extra space between
349 objects that are next to each other.")
350 (penalty ,number? "Penalty for breaking at
351 this column. 10000 or more means forbid linebreak, -10000 or less
352 means force linebreak. Other values influence linebreaking decisions
355 (pitch-max ,ly:pitch? "Top pitch for ambitus.")
356 (pitch-min ,ly:pitch? "Bottom pitch for ambitus.")
359 "Pair of staff coordinates @code{(@var{left}
360 . @var{right})}, where both @var{left} and @var{right} are in the
361 staff-space unit of the current staff.")
363 (ratio ,number? "Parameter for slur shape. The higher this number, the
364 quicker the slur attains it @code{height-limit}.")
365 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
366 (right-padding ,ly:dimension? "Space to insert between note and
368 (right-position ,number? "Vertical position of right part of spanner.")
369 (script-priority ,number? "A sorting key that determines in what
370 order a script is within a stack of scripts.")
372 (self-alignment-X ,number? "Specify alignment of an object. The
373 value -1 means left aligned, 0 centered, and 1 right-aligned in X
374 direction. Values in between may also be specified.")
375 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
378 (shorten-pair ,number-pair? "The lengths to shorten a
379 text-spanner on both sides, for example a pedal bracket")
380 (common-shortest-duration ,ly:moment?
381 "The most common shortest note length.
382 This is used in spacing. Enlarging this will set the score tighter.")
383 (shortest-duration-space ,ly:dimension? "Start with this much
384 space for the shortest duration. This is expressed in
385 @code{spacing-increment} as unit. See also
386 @internalsref{spacing-spanner-interface}.")
387 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
388 (shortest-starter-duration ,ly:moment? "The duration of the shortest
389 note that starts here.")
390 (side-relative-direction ,ly:dir?
391 "Multiply direction of
392 @code{direction-source} with this to get the direction of this
394 (slope ,number? "The slope of this object.")
395 (slope-limit ,number? "Set slope to zero if slope is running away
398 (space-alist ,list? "A table that specifies distances between
399 prefatory items, like clef and time-signature. The format is an alist
400 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
401 . @var{distance})}, where @var{type} can be the symbols
402 @code{minimum-space} or @code{extra-space}.")
403 (space-function ,procedure? "Calculate the vertical space between
404 two beams. This function takes a beam grob and the maximum number of
407 (spacing-increment ,number? "Add this much space for a doubled
408 duration. Typically, the width of a note head. See also
409 @internalsref{spacing-spanner-interface}.")
411 (spacing-procedure ,procedure? "Procedure for calculating spacing
412 parameters. The routine is called after
413 @code{before-line-breaking-callback}.")
414 (stacking-dir ,ly:dir? "Stack objects in which direction?")
415 (staff-space ,ly:dimension? "Amount of space between staff lines,
416 expressed in global staffspace.")
417 (staff-position ,number? "Vertical position, measured in half
418 staff spaces, counted from the middle line.")
419 (staffline-clearance ,ly:dimension? "How far away ties keep from
422 (stem-attachment-function ,procedure? "A function that calculates
423 where a stem attaches to the note head? This is a fallback when this
424 information is not specified in the font. The function takes a grob
425 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
426 location in terms of note head bounding box.")
428 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
430 (stem-shorten ,list? "How much a stem in a forced direction
431 should be shortened. The list gives an amount depending on the number
435 (stem-spacing-correction ,number? "Optical correction amount for
436 stems that are placed in tight configurations. For opposite
437 directions, this amount is the correction for two normal sized stems
438 that overlap completely.")
439 (style ,symbol? "This setting determines in what style a grob is
440 typeset. Valid choices depend on the @code{print-function} that is
441 reading this property.")
442 (text ,markup? "Text markup. See @usermanref{Text markup}.")
443 (thick-thickness ,number? "Bar line thickness, measured in
444 @code{linethickness}.")
445 (thickness ,number? "Bar line thickness, measured in
446 @code{linethickness}.")
447 (thin-kern ,number? "The space after a hair-line in a bar line.")
448 (forced-distance ,ly:dimension? "A fixed distance between object
449 reference points in an alignment.")
451 (threshold ,number-pair? "(@var{min} . @var{max}), where
452 @var{min} and @var{max} are dimensions in staff space.")
453 (transparent ,boolean? "This is almost the same as setting
454 @code{print-function} to @code{#f}, but this retains the dimensions of
455 this grob, which means that grobs can be erased individually.")
456 (bracket-visibility ,boolean-or-symbol? "This controls the
457 visibility of the tuplet bracket. Setting it to false will prevent
458 printing of the bracket. Setting the property to @code{'if-no-beam}
459 will make it print only if there is no beam associated with this
461 (number-visibility ,boolean-or-symbol? "Like
462 @code{bracket-visibility}, but for the number.")
465 (break-visibility ,procedure? "A function that takes the break
466 direction and returns a cons of booleans containing (@var{transparent}
467 . @var{empty}). The following variables are predefined:
468 @code{all-visible}, @code{begin-of-line-visible},
469 @code{end-of-line-visible}, @code{begin-of-line-invisible},
470 @code{end-of-line-invisible}, @code{all-invisible}.")
471 (flag-count ,number? "The number of tremolo beams.")
473 (when ,ly:moment? "Global time step associated with this column
475 (word-space ,ly:dimension? "space to insert between lyrics or
477 (width ,ly:dimension? "The width of a grob measured in staff space.")
478 (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
479 (y-free ,ly:dimension? "The minimal vertical gap between slur and
480 note heads or stems.")
481 (y-offset ,ly:dimension? "Extra vertical offset for ties away
482 from the center line.")
483 (zigzag-length ,ly:dimension? "The length of the lines of a
484 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
486 (zigzag-width ,ly:dimension? "The width of one
487 zigzag-squiggle. This number will be adjusted slightly so that the
488 glissando line can be constructed from a whole number of squiggles.")
490 (avoid-note-head ,boolean? "If set, the stem of a chord does not
491 pass through all note heads, but starts at the last note head. ")
492 (staff-padding ,ly:dimension?
493 "Maintain this much space between reference points
494 and the staff. Its effect is to align objects of differing
495 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
504 (define (define-internal-grob-property symbol type? description)
505 (define-grob-property symbol type? description)
506 (set-object-property! symbol 'backend-internal #t)
511 (define-public all-internal-grob-properties
514 (apply define-internal-grob-property x))
517 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
518 (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
519 (all-elements ,grob-list? "list of all grobs in this line. Its
520 function is to protect objects from being garbage collected.")
521 (arpeggio ,ly:grob? "pointer to arpeggio object.")
522 (beam ,ly:grob? "pointer to the beam, if applicable.")
523 (center-element ,ly:grob? "grob which will be at the center of
524 the group after aligning (when using
525 Align_interface::center_on_element).")
526 (direction-source ,ly:grob? "in case side-relative-direction is
527 set, which grob to get the direction from .")
528 (dot ,ly:grob? "reference to Dots object.")
529 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
530 (stem ,ly:grob? "pointer to Stem object.")
531 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
533 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
534 (rest ,ly:grob? "the staff symbol grob that we're in.")
535 (rest-collision ,ly:grob? "rest collision that a rest is in.")
536 (accidental-grob ,ly:grob? "Accidental for this note.")
537 (bars ,grob-list? "list of bar line pointers.")
538 (bounded-by-me ,grob-list? "list of spanners that have this
539 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
540 (columns ,grob-list? "list of grobs, typically containing
541 paper-columns or note-column objects.")
542 (conditional-elements ,grob-list? "Internal use only")
543 (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
544 (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
545 (heads ,grob-list? "List of note heads.")
546 (items-worth-living ,grob-list? "A list of interesting items. If
547 empty in a particular staff, then that staff is erased.")
548 (details ,list? "alist of parameters for detailed grob behavior.")
549 (note-heads ,grob-list? "List of note head grobs")
550 (side-support-elements ,grob-list? "the support, a list of grobs.")
551 (spacing-wishes ,grob-list? "List of note spacing or staff spacing objects.")
552 (stems ,grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
555 (left-neighbors ,grob-list? " List of
556 spacing-wish grobs that are close to the current column.
558 The closest spacing-wishes determine the actual distances between the
561 (right-neighbors ,grob-list? "see left-neighbors")
562 (left-items ,grob-list? "")
563 (right-items ,grob-list? "")
564 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
565 (font ,ly:font-metric? "Cached font metric object")
567 (positioning-done ,boolean?
568 "Used to signal that a positioning element
569 did its job. This ensures that a positioning is only done once.")
572 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
573 acts as an index for looking up a Stencil object.")
575 (meta ,list? "Contains meta information. It is an alist with the
576 entries @code{name} and @code{interfaces}.")
579 ;; TODO: use interface for this!
580 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
581 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
582 (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
583 (quant-score ,number? "Beam quanting score -- can be stored for
585 (least-squares-dy ,number?
586 "ideal beam slope, without damping.")
587 (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
588 (stem-info ,pair? "caching of stem parameters")
589 (note-columns ,pair? "list of NoteColumn grobs.")
591 (if-text-padding ,number? "padding in case texts are there.")
592 (position-callbacks ,list? "list of
593 functions set spanner positions.")
595 ;;; Junk me, replace it by add-join.
596 (join-left-amount ,number? "")
598 (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")
599 (head-width ,ly:dimension? "width of this ligature head")
601 ;; [TODO: change this]
602 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
603 (stencil ,ly:stencil? "Cached output of the print-function.")
604 (de-uglify-parameters ,list? "list of 3 real constants. They
605 define the valid areas for the middle control points. They are
607 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
608 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
610 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
611 (shorten ,ly:dimension? "The amount of space that a
612 stem. Internally used to distribute beam shortening over stems. ")
614 (use-breve-rest ,boolean? "Use breve rests for measures longer
623 ;; there are too many properties for ancient notation
624 ;; probably neume-types (a list of symbols) would also work.
626 (auctum ,boolean? "is this neume augmented?")
627 (ascendens ,boolean? "is this neume of an ascending?")
628 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
629 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
630 (cavum ,boolean? "is this neume outlined?")
631 (descendens ,boolean? "is this neume of a descendent type?")
632 (deminutum ,boolean? "is this neume deminished?")
633 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
634 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
635 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
636 (linea ,boolean? "attach vertical lines to this neume?")
639 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
640 (join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")
641 (context-info ,integer? "DOCME")
642 (inclinatum ,boolean? "is this neume an inclinatum?")
643 (note-head-style ,string? "name of the font character to be used as note heads in the ambitus grob.")
644 (oriscus ,boolean? "is this neume an oriscus?")
645 (quilisma ,boolean? "is this neume a quilisma?")
646 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
648 (prefix-set ,number? "")
649 (stropha ,boolean? "Is this neume a stropha?")
650 (virga ,boolean? "Is this neume a virga?")
651 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
653 ;; end ancient notation
656 (accidentals-style ,symbol? "style for ambitus.")
660 (define-public all-backend-properties
662 all-internal-grob-properties
663 all-user-grob-properties))