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 noteheads
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 pagebreaks.")
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-glyph-function ,procedure? "This function determines the
114 appearance of a barline at the line break. It takes a glyph and
115 break-direction and returns the glyph at a line break.")
116 (breakable ,boolean? "Can this object appear at a line break,
117 like clefs and barlines?")
118 (c0-position ,integer? "An integer indicating the position of
120 (cautionary-style ,symbol? "How to print cautionary
121 accidentals. Choices are @code{smaller} or
122 @code{parentheses}.")
123 (cautionary ,boolean? "Is this a cautionary accidental?")
124 (concaveness-gap ,ly:dimension? "A beam is printed horizontally
125 if its concaveness-gap is larger than this value. The concaveness-gap
126 is the distance of an inner notehead to the line between two outer
128 (concaveness-threshold ,number? "A beam is printed horizontally
129 if its concaveness is bigger than this threshold.
131 Concaveness is calculated as the sum of the vertical distances of
132 inner noteheads that fall outside the interval of the two outer
133 noteheads, to the vertically nearest outer notehead, divided by the
134 square of the inner notes involved.")
135 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
139 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
141 (damping ,integer? "Amount of beam slope damping. 0: no, 1: yes,
142 100000: horizontal beams.")
143 (dash-period ,number? "the length of one dash + white space. If
144 negative, no line is drawn at all.")
146 (dash-fraction ,number? "Size of the dashes, relative to
147 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
150 ;; [FIXME: use dash-period/dash length; see text-spanner]
151 (dashed ,number? " number representing the length of the dashes.")
152 (neutral-direction ,ly:dir? "Which direction to take in the
153 center of the staff.")
154 (neutral-position ,number? "Position (in half staff spaces) where
155 to flip the direction of custos stem.")
158 ;; todo: why is this tunable?
159 (dir-function ,procedure? "The function to determine the
160 direction of a beam. Choices include:
163 @item beam-dir-majority
164 number count of up or down notes
166 mean center distance of all notes
167 @item beam-dir-median.
168 mean center distance weighted per note
173 (direction ,ly:dir? "Up or down, left or right?")
174 (dot-count ,integer? "The number of dots.")
175 (duration-log ,integer? "The 2-log of the notehead duration, i.e. 0=whole note, 1 = half note, etc.")
176 (edge-height ,pair? "A pair of number specifying the heights of
177 the vertical edges '(@var{left-height} . @var{right-height}).")
178 (bracket-flare ,number-pair? "A pair of numbers specifying how
179 much edges of brackets should slant outward. Value 0.0 means straight
182 (edge-text ,pair? "A pair specifying the texts to be set at the
183 edges '(@var{left-text} . @var{right-text}).")
184 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
187 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
189 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
191 (X-extent ,number-pair? "Hard coded extent in X direction. ")
192 (Y-extent ,number-pair? "See @code{X-extent}.")
194 (extra-offset ,number-pair? "A pair representing an offset. This
195 offset is added just before outputting the symbol, so the typesetting
196 engine is completely oblivious to it.")
199 (extremity-offset-alist ,list? "The offset adds to the centre of
200 the notehead, or stem.
202 Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
206 (extremity-function ,procedure? "A function that calculates the
207 attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.")
209 "a string determining what style of flag-glyph is
210 typeset on a Stem. Valid options include @code{()} and
211 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
213 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
214 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
215 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
216 (font-encoding ,symbol? "The font encoding is the broadest category for selecting a font. Options include: @code{music}, @code{number}, @code{text},
217 @code{math}, @code{braces}, @code{dynamic}")
218 (font-name ,string? "Specifies a file name (without extension) of
219 the font to load. This setting override selection using
220 @code{font-family}, @code{font-series} and @code{font-shape}.")
221 (font-magnification ,number? "Magnification of the font, when it
222 is selected with @code{font-name}.")
224 (font-size ,number? "The font size, compared the `normal'
225 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
226 Each step of 1 is approximately 12% larger, 6 steps are exactly a
227 factor 2 larger. Fractional values are allowed.")
229 (font-series ,symbol? "Select the series of a font. Choices
230 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
231 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
232 @code{italic}, @code{caps}.")
234 (force-hshift ,number? "This specifies a manual shift for notes
235 in collisions. The unit is the note head width of the first voice
236 note. This is used by @internalsref{note-collision-interface}.")
238 (fraction ,number-pair? "Numerator and denominator of a time
240 (french-beaming ,boolean? "Use French beaming style for this
241 stem. The stem will stop at the innermost beams.")
243 ;; ugh: double, change.
244 (full-size-change ,boolean? "Don't make a change clef smaller.")
245 (non-default ,boolean? "Set for manually specified clefs.")
248 (glyph ,string? "a string determining what (style) of glyph is
249 typeset. Valid choices depend on the function that is reading this
251 (glyph-name ,string? "a name of character within font.")
252 (glyph-name-procedure ,procedure? "Return the name of a character
253 within font, to use for printing a symbol.")
255 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
256 (gap-count ,integer? "Number of gapped beams for tremolo.")
257 (grace-space-factor ,number? "Space grace notes at this fraction
258 of the @code{spacing-increment}.")
260 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
261 (hair-thickness ,number? "Thickness of the thin line in a barline.")
262 (height ,ly:dimension? "Height of an object in staffspace.")
263 (height-limit ,ly:dimension? "Maximum slur height: the longer the
264 slur, the closer it is to this height.")
266 (horizontal-shift ,integer? "An integer that identifies ranking
267 of note-column for horizontal shifting. This is used by
268 @internalsref{note-collision-interface}.")
269 (kern ,ly:dimension? "Amount of extra white space to add. For
270 barline, this is the amount of space after a thick line.")
271 (knee ,boolean? "Is this beam kneed?")
272 (knee-spacing-correction ,number? "Factor for the optical
273 correction amount for kneed beams. Set between 0 for no correction and
274 1 for full correction.")
275 (layer ,number? "The output layer [0..2]: layers define the order
276 of printing objects. Objects in lower layers are overprinted by
277 objects in higher layers.")
278 (ledger-line-thickness ,number-pair?
279 "The thickness of ledger lines: it is the
280 sum of 2 numbers. The first is the factor for linethickness, and the
281 second for staff space. Both contributions are added.")
282 (left-position ,number? "Vertical position of left part of spanner.")
283 (left-padding ,ly:dimension? "The amount of space that is put
284 left to a group of accidentals.")
285 (length ,ly:dimension? "User override for the stem length of
287 (lengths ,list? "Default stem lengths. The list gives a length
288 for each flag-count.")
289 (line-count ,integer? "The number of staff lines.")
290 (measure-length ,ly:moment? "Length of a
291 measure. Used in some spacing situations.")
293 (measure-count ,integer? "The number of measures for a
295 (merge-differently-headed ,boolean? "Merge
296 noteheads in collisions, even if they have different note heads. The
297 smaller of the two heads will be rendered invisible. This used
298 polyphonic guitar notation. The value of this setting is used by
299 @internalsref{note-collision-interface} .")
301 (merge-differently-dotted ,boolean? "Merge noteheads in
302 collisions, even if they have a different number of dots. This normal
303 notation for some types of polyphonic music. ")
305 (minimum-distance ,ly:dimension? "Minimum distance between rest
307 (minimum-X-extent ,number-pair? "Minimum size of an object in X
308 dimension, measured in staff space.")
309 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
310 (minimum-length ,ly:dimension? "Try to make a spanner at least
311 this long. This requires an appropriate routine for the
312 @code{spacing-procedure} property.")
313 (minimum-space ,ly:dimension? "Minimum distance that the victim
314 should move (after padding).")
315 (print-function ,procedure? "Function taking grob as argument,
316 returning a @code{Stencil} object.")
317 (new-accidentals ,list? "List of @code{(@var{pitch}
318 . @var{accidental})} pairs.")
319 (note-names ,vector? "Vector of strings containing names for
320 easy-notation note heads.")
321 (no-spacing-rods ,boolean? "Items with this property do not cause
322 spacing constraints.")
323 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
324 get stems extending to the middle staff line.")
326 (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
329 (enclose-bounds ,number?
330 "How much of the bound a spanner should enclose:
331 +1 = completely, 0 = center, -1 not at all.")
333 (padding ,ly:dimension? "Add this much extra space between
334 objects that are next to each other.")
335 (penalty ,number? "Penalty for breaking at
336 this column. 10000 or more means forbid linebreak, -10000 or less
337 means force linebreak. Other values influence linebreaking decisions
340 (pitch-max ,ly:pitch? "Top pitch for ambitus.")
341 (pitch-min ,ly:pitch? "Bottom pitch for ambitus.")
344 "Pair of staff coordinates @code{(@var{left}
345 . @var{right})}, where both @var{left} and @var{right} are in the
346 staff-space unit of the current staff.")
348 (ratio ,number? "Parameter for slur shape. The higher this number, the
349 quicker the slur attains it @code{height-limit}.")
350 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
351 (right-padding ,ly:dimension? "Space to insert between note and
353 (right-position ,number? "Vertical position of right part of spanner.")
354 (script-priority ,number? "A sorting key that determines in what
355 order a script is within a stack of scripts.")
357 (self-alignment-X ,number? "Specify alignment of an object. The
358 value -1 means left aligned, 0 centered, and 1 right-aligned in X
359 direction. Values in between may also be specified.")
360 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
363 (shorten-pair ,number-pair? "The lengths to shorten a
364 text-spanner on both sides, for example a pedal bracket")
365 (common-shortest-duration ,ly:moment?
366 "The most common shortest note length.
367 This is used in spacing. Enlarging this will set the score tighter.")
368 (shortest-duration-space ,ly:dimension? "Start with this much
369 space for the shortest duration. This is explessed in
370 @code{spacing-increment} as unit. See also
371 @internalsref{spacing-spanner-interface}.")
372 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
373 (shortest-starter-duration ,ly:moment? "The duration of the shortest
374 note that starts here.")
375 (side-relative-direction ,ly:dir?
376 "Multiply direction of
377 @code{direction-source} with this to get the direction of this
379 (slope ,number? "The slope of this object.")
380 (slope-limit ,number? "Set slope to zero if slope is running away
383 (space-alist ,list? "A table that specifies distances between
384 prefatory itmes, like clef and time-signature. The format is an alist
385 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
386 . @var{distance})}, where @var{type} can be the symbols
387 @code{minimum-space} or @code{extra-space}.")
388 (space-function ,procedure? "Calculate the vertical space between
389 two beams. This function takes a beam grob and the maximum number of
392 (spacing-increment ,number? "Add this much space for a doubled
393 duration. Typically, the width of a note head. See also
394 @internalsref{spacing-spanner-interface}.")
396 (spacing-procedure ,procedure? "Procedure for calculating spacing
397 parameters. The routine is called after
398 @code{before-line-breaking-callback}.")
399 (stacking-dir ,ly:dir? "Stack objects in which direction?")
400 (staff-space ,ly:dimension? "Amount of space between staff lines,
401 expressed in global staffspace.")
402 (staff-position ,number? "Vertical position, measured in half
403 staff spaces, counted from the middle line.")
404 (staffline-clearance ,ly:dimension? "How far away ties keep from
407 (stem-attachment-function ,procedure? "A function that calculates
408 where a stem attaches to the notehead? This is a fallback when this
409 information is not specified in the font. The function takes a grob
410 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
411 location in terms of note head bounding box.")
413 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
415 (stem-shorten ,list? "How much a stem in a forced direction
416 should be shortened. The list gives an amount depending on the number
420 (stem-spacing-correction ,number? "Optical correction amount for
421 stems that are placed in tight configurations. For opposite
422 directions, this amount is the correction for two normal sized stems
423 that overlap completely.")
424 (style ,symbol? "This setting determines in what style a grob is
425 typeset. Valid choices depend on the @code{print-function} that is
426 reading this property.")
427 (text ,markup? "Text markup. See @usermanref{Text markup}.")
428 (thick-thickness ,number? "Bar line thickness, measured in
429 @code{linethickness}.")
430 (thickness ,number? "Bar line thickness, measured in
431 @code{linethickness}.")
432 (thin-kern ,number? "The space after a hair-line in a bar line.")
433 (forced-distance ,ly:dimension? "A fixed distance between object
434 reference points in an alignment.")
436 (threshold ,number-pair? "(@var{min} . @var{max}), where
437 @var{min} and @var{max} are dimensions in staff space.")
438 (transparent ,boolean? "This is almost the same as setting
439 @code{print-function} to @code{#f}, but this retains the dimensions of
440 this grob, which means that grobs can be erased individually.")
441 (bracket-visibility ,boolean-or-symbol? "This controls the
442 visibility of the tuplet bracket. Setting it to false will prevent
443 printing of the bracket. Setting the property to @code{'if-no-beam}
444 will make it print only if there is no beam associated with this
446 (number-visibility ,boolean-or-symbol? "Like
447 @code{bracket-visibility}, but for the number.")
450 (break-visibility ,procedure? "A function that takes the break
451 direction and returns a cons of booleans containing (@var{transparent}
452 . @var{empty}). The following variables are predefined:
453 @code{all-visible}, @code{begin-of-line-visible},
454 @code{end-of-line-visible}, @code{begin-of-line-invisible},
455 @code{end-of-line-invisible}, @code{all-invisible}.")
456 (flag-count ,number? "The number of tremolo beams.")
458 (when ,ly:moment? "Global time step associated with this column
460 (word-space ,ly:dimension? "space to insert between lyrics or
462 (width ,ly:dimension? "The width of a grob measured in staff space.")
463 (x-gap ,ly:dimension? "The horizontal gap between notehead and tie.")
464 (y-free ,ly:dimension? "The minimal vertical gap between slur and
465 noteheads or stems.")
466 (y-offset ,ly:dimension? "Extra vertical offset for ties away
467 from the center line.")
468 (zigzag-length ,ly:dimension? "The length of the lines of a
469 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
471 (zigzag-width ,ly:dimension? "The width of one
472 zigzag-squiggle. This number will be adjusted slightly so that the
473 glissando line can be constructed from a whole number of squiggles.")
475 (avoid-note-head ,boolean? "If set, the stem of a chord does not
476 pass through all note heads, but starts at the last note head. ")
477 (staff-padding ,ly:dimension?
478 "Maintain this much space between reference points
479 and the staff. Its effect is to align objects of differing
480 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
489 (define (define-internal-grob-property symbol type? description)
490 (define-grob-property symbol type? description)
491 (set-object-property! symbol 'backend-internal #t)
496 (define-public all-internal-grob-properties
499 (apply define-internal-grob-property x))
502 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
503 (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
504 (all-elements ,grob-list? "list of all grobs in this line. Its
505 function is to protect objects from being garbage collected.")
506 (arpeggio ,ly:grob? "pointer to arpeggio object.")
507 (beam ,ly:grob? "pointer to the beam, if applicable.")
508 (center-element ,ly:grob? "grob which will be at the center of
509 the group after aligning (when using
510 Align_interface::center_on_element).")
511 (direction-source ,ly:grob? "in case side-relative-direction is
512 set, which grob to get the direction from .")
513 (dot ,ly:grob? "reference to Dots object.")
514 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
515 (stem ,ly:grob? "pointer to Stem object.")
516 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
518 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
519 (rest ,ly:grob? "the staff symbol grob that we're in.")
520 (rest-collision ,ly:grob? "rest collision that a rest is in.")
521 (accidental-grob ,ly:grob? "Accidental for this note.")
522 (bars ,grob-list? "list of barline pointers.")
523 (bounded-by-me ,grob-list? "list of spanners that have this
524 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
525 (columns ,grob-list? "list of grobs, typically containing
526 paper-columns or note-column objects.")
527 (conditional-elements ,grob-list? "Internal use only")
528 (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
529 (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
530 (heads ,grob-list? "List of note heads.")
531 (items-worth-living ,grob-list? "A list of interesting items. If
532 empty in a particular staff, then that staff is erased.")
533 (details ,list? "alist of parameters for detailed grob behavior.")
534 (note-heads ,grob-list? "List of note head grobs")
535 (side-support-elements ,grob-list? "the support, a list of grobs.")
536 (spacing-wishes ,grob-list? "List of note spacing or staff spacing objects.")
537 (stems ,grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
540 (left-neighbors ,grob-list? " List of
541 spacing-wish grobs that are close to the current column.
543 The closest spacing-wishes determine the actual distances between the
546 (right-neighbors ,grob-list? "see left-neighbors")
547 (left-items ,grob-list? "")
548 (right-items ,grob-list? "")
549 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
550 (font ,ly:font-metric? "Cached font metric object")
552 (positioning-done ,boolean?
553 "Used to signal that a positioning element
554 did its job. This ensures that a positioning is only done once.")
557 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
558 acts as an index for looking up a Stencil object.")
560 (meta ,list? "Contains meta information. It is an alist with the
561 entries @code{name} and @code{interfaces}.")
564 ;; TODO: use interface for this!
565 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
566 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
567 (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
568 (quant-score ,number? "Beam quanting score -- can be stored for
570 (least-squares-dy ,number?
571 "ideal beam slope, without damping.")
572 (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
573 (stem-info ,pair? "caching of stem parameters")
574 (note-columns ,pair? "list of NoteColumn grobs.")
576 (if-text-padding ,number? "padding in case texts are there.")
577 (position-callbacks ,list? "list of
578 functions set spanner positions.")
580 ;;; Junk me, replace it by add-join.
581 (join-left-amount ,number? "")
583 (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")
584 (head-width ,ly:dimension? "width of this ligature head")
586 ;; [TODO: change this]
587 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
588 (stencil ,ly:stencil? "Cached output of the print-function.")
589 (de-uglify-parameters ,list? "list of 3 real constants. They
590 define the valid areas for the middle control points. They are
592 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
593 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
595 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
596 (shorten ,ly:dimension? "The amount of space that a
597 stem. Internally used to distribute beam shortening over stems. ")
599 (use-breve-rest ,boolean? "Use breve rests for measures longer
608 ;; there are too many properties for ancient notation
609 ;; probably neume-types (a list of symbols) would also work.
611 (auctum ,boolean? "is this neume augmented?")
612 (ascendens ,boolean? "is this neume of an ascending?")
613 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
614 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
615 (cavum ,boolean? "is this neume outlined?")
616 (descendens ,boolean? "is this neume of a descendent type?")
617 (deminutum ,boolean? "is this neume deminished?")
618 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
619 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
620 (join-heads ,boolean? "Whether to join the noteheads of an ambitus grob with a vertical line.")
621 (linea ,boolean? "attach vertical lines to this neume?")
624 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
625 (join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")
626 (context-info ,integer? "DOCME")
627 (inclinatum ,boolean? "is this neume an inclinatum?")
628 (note-head-style ,string? "name of the font character to be used as note heads in the ambitus grob.")
629 (oriscus ,boolean? "is this neume an oriscus?")
630 (quilisma ,boolean? "is this neume a quilisma?")
631 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
633 (prefix-set ,number? "")
634 (stropha ,boolean? "Is this neume a stropha?")
635 (virga ,boolean? "Is this neume a virga?")
636 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
638 ;; end ancient notation
641 (accidentals-style ,symbol? "style for ambitus.")
645 (define-public all-backend-properties
647 all-internal-grob-properties
648 all-user-grob-properties))