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-append "Redefining ~S" symbol)
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.")
46 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
47 @code{0}: around center of width, @code{1}: right side.")
48 (arch-angle ,number? "Turning angle of the hook of a system brace" )
49 (arch-height ,ly:dimension? "Height of the hook of a system brace.")
50 (arch-thick ,number? "Thickness of the hook of system brace.")
51 (arch-width ,ly:dimension? "Width of the hook of a system brace.")
52 (arpeggio-direction ,ly:dir? "If set, put an
53 arrow on the arpeggio squiggly line.")
54 (attachment ,pair? "Pair of symbols
55 indicating how a slur should be attached at the ends. The format is
56 '(@var{left-type} . @var{right-type}), where both @var{type}s are
57 symbols. The values of these symbols may be @code{alongside-stem},
58 @code{stem}, @code{head} or @code{loose-end}.")
59 (attachment-offset ,pair? "cons of offsets,
60 '(@var{left-offset} . @var{right-offset}). This offset is added to
61 the attachments to prevent ugly slurs. [fixme: we need more
62 documentation here].")
65 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
66 where a horizontal beam fits that is larger than this number, make a kneed beam.")
67 (axes ,list? "list of axis numbers.
68 In the case of alignment grobs, this should contain only one number.")
70 (balloon-text ,markup? "Text to add to help balloon")
71 (balloon-text-props ,list? "Font properties
73 (balloon-text-offset ,number-pair?
74 "Where to put text relative to balloon.")
75 (balloon-padding ,ly:dimension? "Text to add to help balloon")
76 (balloon-original-callback ,procedure? "The
77 original stencil drawer to draw the balloon around.")
80 (bar-size ,ly:dimension? "size of a bar line.")
81 (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
82 (barre-type ,symbol? "Type of barre indication used in a fret diagram.
83 Choices include @code{curved} and @code{straight}.")
84 (base-shortest-duration ,ly:moment?
85 "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.")
86 (baseline-skip ,ly:dimension? "Distance between base lines of
87 multiple lines of text.")
88 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
89 (beam-width ,ly:dimension? "width of the tremolo sign.")
90 (beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
91 (beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
92 (beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
94 (beamed-stem-shorten ,list? " How much to shorten beamed stems,
95 when their direction is forced. It is a list, since the value is different
96 depending on the number flags/beams.")
98 "Pair of number lists. Each number list specifies which
99 beams to make. 0 is the central beam, 1 is the next beam toward the
100 note etc. This information is used to determine how to connect the
101 beaming patterns from stem to stem inside a beam.")
104 (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.")
105 (before-line-breaking-callback ,procedure? "This procedure is
106 called before line breaking, but after splitting breakable items at
107 potential line breaks.")
108 (between-cols ,pair? "Where to attach a loose column to")
109 (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
110 (bracket-flare ,number-pair? "A pair of numbers specifying how
111 much edges of brackets should slant outward. Value 0.0 means straight
113 (bracket-thick ,number? "width of a system start bracket.")
114 (break-align-symbol ,symbol? "This key is used for aligning and
115 spacing breakable items.")
116 (break-align-orders ,vector? " Defines the order in which
117 prefatory matter (clefs, key signatures) appears. The format is a
118 vector of length 3, where each element is one order for end-of-line,
119 middle of line, and start-of-line respectively. An order is a list of
122 For example, clefs are put after key signatures by setting
125 \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3
133 (break-glyph-function ,procedure? "This function determines the
134 appearance of a bar line at the line break. It takes a glyph and
135 break-direction and returns the glyph at a line break.")
136 (breakable ,boolean? "Can this object appear at a line break,
137 like clefs and bar lines?")
138 (c0-position ,integer? "An integer indicating the position of
140 (cautionary-style ,symbol? "How to print cautionary
141 accidentals. Choices are @code{smaller} or
142 @code{parentheses}.")
143 (cautionary ,boolean? "Is this a cautionary accidental?")
144 (concaveness-gap ,ly:dimension? "A beam is printed horizontally
145 if its concaveness-gap is larger than this value. The concaveness-gap
146 is the distance of an inner note head to the line between two outer
148 (concaveness-threshold ,number? "A beam is printed horizontally
149 if its concaveness is bigger than this threshold.
151 Concaveness is calculated as the sum of the vertical distances of
152 inner note heads that fall outside the interval of the two outer
153 note heads, to the vertically nearest outer note head, divided by the
154 square of the inner notes involved.")
155 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
159 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
161 (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
162 100000: horizontal beams.")
163 (dash-period ,number? "the length of one dash + white space. If
164 negative, no line is drawn at all.")
166 (dash-fraction ,number? "Size of the dashes, relative to
167 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
170 ;; [FIXME: use dash-period/dash length; see text-spanner]
171 (dashed ,number? " number representing the length of the dashes.")
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-color ,symbol? "Color of dots. Options include
190 @code{black} and @code{white}.")
191 (dot-radius ,number? "Radius of dots.")
192 (dot-count ,integer? "The number of dots.")
193 (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
194 (edge-height ,pair? "A pair of number specifying the heights of
195 the vertical edges '(@var{left-height} . @var{right-height}).")
196 (edge-text ,pair? "A pair specifying the texts to be set at the
197 edges '(@var{left-text} . @var{right-text}).")
198 (excentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
200 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
203 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
205 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
207 (X-extent ,number-pair? "Hard coded extent in X direction. ")
208 (Y-extent ,number-pair? "See @code{X-extent}.")
210 (extra-offset ,number-pair? "A pair representing an offset. This
211 offset is added just before outputting the symbol, so the typesetting
212 engine is completely oblivious to it.")
215 (extremity-offset-alist ,list? "The offset adds to the centre of
216 the note head, or stem.
218 Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
222 (extremity-function ,procedure? "A function that calculates the
223 attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.")
224 (finger-code ,symbol? "Code for the type of fingering indication in a
225 fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
227 "a string determining what style of flag-glyph is
228 typeset on a Stem. Valid options include @code{()} and
229 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
231 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
232 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
233 (font-encoding ,symbol? "The font encoding is the broadest
234 category for selecting a font. Options include: @code{fetaMusic},
235 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
237 (font-name ,string? "Specifies a file name (without extension) of
238 the font to load. This setting override selection using
239 @code{font-family}, @code{font-series} and @code{font-shape}.")
240 (font-magnification ,number? "Magnification of the font, when it
241 is selected with @code{font-name}.")
243 (font-size ,number? "The font size, compared the `normal'
244 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
245 Each step of 1 is approximately 12% larger, 6 steps are exactly a
246 factor 2 larger. Fractional values are allowed.")
248 (font-series ,symbol? "Select the series of a font. Choices
249 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
250 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
251 @code{italic}, @code{caps}.")
253 (forced-distance ,ly:dimension? "A fixed distance between object
254 reference points in an alignment.")
256 (force-hshift ,number? "This specifies a manual shift for notes
257 in collisions. The unit is the note head width of the first voice
258 note. This is used by @internalsref{note-collision-interface}.")
260 (fraction ,number-pair? "Numerator and denominator of a time
262 (french-beaming ,boolean? "Use French beaming style for this
263 stem. The stem will stop at the innermost beams.")
264 (fret-count ,integer? "The number of frets in a fret diagram.")
266 ;; ugh: double, change.
267 (full-size-change ,boolean? "Don't make a change clef smaller.")
268 (non-default ,boolean? "Set for manually specified clefs.")
271 (glyph ,string? "a string determining what (style) of glyph is
272 typeset. Valid choices depend on the function that is reading this
274 (glyph-name ,string? "a name of character within font.")
275 (glyph-name-procedure ,procedure? "Return the name of a character
276 within font, to use for printing a symbol.")
278 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
279 (gap-count ,integer? "Number of gapped beams for tremolo.")
280 (grace-space-factor ,number? "Space grace notes at this fraction
281 of the @code{spacing-increment}.")
283 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
284 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
285 (height ,ly:dimension? "Height of an object in staffspace.")
286 (height-limit ,ly:dimension? "Maximum slur height: the longer the
287 slur, the closer it is to this height.")
289 (horizontal-shift ,integer? "An integer that identifies ranking
290 of note-column for horizontal shifting. This is used by
291 @internalsref{note-collision-interface}.")
292 (inside-slur ,boolean? "If set, this script should be inside the
293 slur. If set to false, the script places itself around the slur. If
294 unset, script and slur ignore each other ")
295 (inspect-quants ,number-pair? "If debugging is set,
296 set beam quant to this position, and print the respective scores.")
298 (kern ,ly:dimension? "Amount of extra white space to add. For
299 bar line, this is the amount of space after a thick line.")
300 (knee ,boolean? "Is this beam kneed?")
301 (knee-spacing-correction ,number? "Factor for the optical
302 correction amount for kneed beams. Set between 0 for no correction and
303 1 for full correction.")
304 (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
305 (layer ,number? "The output layer [0..2]: layers define the order
306 of printing objects. Objects in lower layers are overprinted by
307 objects in higher layers.")
308 (ledger-line-thickness ,number-pair?
309 "The thickness of ledger lines: it is the
310 sum of 2 numbers. The first is the factor for line thickness, and the
311 second for staff space. Both contributions are added.")
312 (left-position ,number? "Vertical position of left part of spanner.")
313 (left-padding ,ly:dimension? "The amount of space that is put
314 left to a group of accidentals.")
315 (length ,ly:dimension? "User override for the stem length of
317 (lengths ,list? "Default stem lengths. The list gives a length
318 for each flag-count.")
319 (line-count ,integer? "The number of staff lines.")
320 (measure-length ,ly:moment? "Length of a
321 measure. Used in some spacing situations.")
323 (measure-count ,integer? "The number of measures for a
325 (merge-differently-headed ,boolean? "Merge
326 note heads in collisions, even if they have different note heads. The
327 smaller of the two heads will be rendered invisible. This used
328 polyphonic guitar notation. The value of this setting is used by
329 @internalsref{note-collision-interface} .")
331 (merge-differently-dotted ,boolean? "Merge note heads in
332 collisions, even if they have a different number of dots. This normal
333 notation for some types of polyphonic music. ")
335 (minimum-distance ,ly:dimension? "Minimum distance between rest
337 (minimum-X-extent ,number-pair? "Minimum size of an object in X
338 dimension, measured in staff space.")
339 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
340 (minimum-length ,ly:dimension? "Try to make a spanner at least
341 this long. This requires an appropriate routine for the
342 @code{spacing-procedure} property.")
343 (minimum-space ,ly:dimension? "Minimum distance that the victim
344 should move (after padding).")
345 (print-function ,procedure? "Function taking grob as argument,
346 returning a @code{Stencil} object.")
347 (neutral-direction ,ly:dir? "Which direction to take in the
348 center of the staff.")
349 (neutral-position ,number? "Position (in half staff spaces) where
350 to flip the direction of custos stem.")
352 (new-accidentals ,list? "List of @code{(@var{pitch}
353 . @var{accidental})} pairs.")
354 (note-names ,vector? "Vector of strings containing names for
355 easy-notation note heads.")
356 (no-spacing-rods ,boolean? "Items with this property do not cause
357 spacing constraints.")
358 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
359 get stems extending to the middle staff line.")
360 (number-type ,symbol? "Type of numbers to use in label. Choices
361 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
363 (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
366 (enclose-bounds ,number?
367 "How much of the bound a spanner should enclose:
368 +1 = completely, 0 = center, -1 not at all.")
370 (padding ,ly:dimension? "Add this much extra space between
371 objects that are next to each other.")
372 (page-penalty ,number? "Penalty for page break at
373 this column. 10000 or more means forbid linebreak, -10000 or less
374 means force page break. Other values influence page breaking decisions
376 (penalty ,number? "Penalty for line break at
377 this column. 10000 or more means forbid line break, -10000 or less
378 means force line break. Other values influence line breaking decisions
382 "Pair of staff coordinates @code{(@var{left}
383 . @var{right})}, where both @var{left} and @var{right} are in the
384 staff-space unit of the current staff.")
386 (ratio ,number? "Parameter for slur shape. The higher this number, the
387 quicker the slur attains it @code{height-limit}.")
388 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
389 (right-padding ,ly:dimension? "Space to insert between note and
391 (right-position ,number? "Vertical position of right part of spanner.")
392 (script-priority ,number? "A sorting key that determines in what
393 order a script is within a stack of scripts.")
395 (self-alignment-X ,number? "Specify alignment of an object. The
396 value -1 means left aligned, 0 centered, and 1 right-aligned in X
397 direction. Values in between may also be specified.")
398 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
401 (shorten-pair ,number-pair? "The lengths to shorten a
402 text-spanner on both sides, for example a pedal bracket")
403 (common-shortest-duration ,ly:moment?
404 "The most common shortest note length.
405 This is used in spacing. Enlarging this will set the score tighter.")
406 (shortest-duration-space ,ly:dimension? "Start with this much
407 space for the shortest duration. This is expressed in
408 @code{spacing-increment} as unit. See also
409 @internalsref{spacing-spanner-interface}.")
410 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
411 (shortest-starter-duration ,ly:moment? "The duration of the shortest
412 note that starts here.")
413 (side-relative-direction ,ly:dir?
414 "Multiply direction of
415 @code{direction-source} with this to get the direction of this
417 (size ,number? "Size of object, relative to standard size.")
418 (slope ,number? "The slope of this object.")
419 (slope-limit ,number? "Set slope to zero if slope is running away
422 "An alist of scoring parameters for slur formatting")
423 (space-alist ,list? "A table that specifies distances between
424 prefatory items, like clef and time-signature. The format is an alist
425 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
426 . @var{distance})}, where @var{type} can be the symbols
427 @code{minimum-space} or @code{extra-space}.")
428 (space-function ,procedure? "Calculate the vertical space between
429 two beams. This function takes a beam grob and the maximum number of
432 (spacing-increment ,number? "Add this much space for a doubled
433 duration. Typically, the width of a note head. See also
434 @internalsref{spacing-spanner-interface}.")
436 (spacing-procedure ,procedure? "Procedure for calculating spacing
437 parameters. The routine is called after
438 @code{before-line-breaking-callback}.")
439 (stacking-dir ,ly:dir? "Stack objects in which direction?")
440 (staff-space ,ly:dimension? "Amount of space between staff lines,
441 expressed in global staffspace.")
442 (staff-position ,number? "Vertical position, measured in half
443 staff spaces, counted from the middle line.")
444 (staffline-clearance ,ly:dimension? "How far away ties keep from
447 (stem-attachment-function ,procedure? "A function that calculates
448 where a stem attaches to the note head? This is a fallback when this
449 information is not specified in the font. The function takes a grob
450 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
451 location in terms of note head bounding box.")
453 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
455 (stem-shorten ,list? "How much a stem in a forced direction
456 should be shortened. The list gives an amount depending on the number
460 (stem-spacing-correction ,number? "Optical correction amount for
461 stems that are placed in tight configurations. For opposite
462 directions, this amount is the correction for two normal sized stems
463 that overlap completely.")
464 (string-count ,integer? "The number of strings in a fret diagram.")
465 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
467 (style ,symbol? "This setting determines in what style a grob is
468 typeset. Valid choices depend on the @code{print-function} that is
469 reading this property.")
470 (text ,markup? "Text markup. See @usermanref{Text markup}.")
471 ;;FIXME -- Should both be the same?
472 (thick-thickness ,number? "Bar line thickness, measured in
473 @code{linethickness}.")
474 (thickness ,number? "Bar line thickness, measured in
475 @code{linethickness}.")
476 (thin-kern ,number? "The space after a hair-line in a bar line.")
478 (threshold ,number-pair? "(@var{min} . @var{max}), where
479 @var{min} and @var{max} are dimensions in staff space.")
480 (transparent ,boolean? "This is almost the same as setting
481 @code{print-function} to @code{#f}, but this retains the dimensions of
482 this grob, which means that grobs can be erased individually.")
483 (bracket-visibility ,boolean-or-symbol? "This controls the
484 visibility of the tuplet bracket. Setting it to false will prevent
485 printing of the bracket. Setting the property to @code{'if-no-beam}
486 will make it print only if there is no beam associated with this
488 (number-visibility ,boolean-or-symbol? "Like
489 @code{bracket-visibility}, but for the number.")
492 (break-visibility ,procedure? "A function that takes the break
493 direction and returns a cons of booleans containing (@var{transparent}
494 . @var{empty}). The following variables are predefined:
495 @code{all-visible}, @code{begin-of-line-visible},
496 @code{end-of-line-visible}, @code{begin-of-line-invisible},
497 @code{end-of-line-invisible}, @code{all-invisible}.")
498 (flag-count ,number? "The number of tremolo beams.")
500 (when ,ly:moment? "Global time step associated with this column
502 (word-space ,ly:dimension? "space to insert between lyrics or
504 (width ,ly:dimension? "The width of a grob measured in staff space.")
505 (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
506 (y-free ,ly:dimension? "The minimal vertical gap between slur and
507 note heads or stems.")
508 (y-offset ,ly:dimension? "Extra vertical offset for ties away
509 from the center line.")
510 (zigzag-length ,ly:dimension? "The length of the lines of a
511 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
513 (zigzag-width ,ly:dimension? "The width of one
514 zigzag-squiggle. This number will be adjusted slightly so that the
515 glissando line can be constructed from a whole number of squiggles.")
517 (avoid-note-head ,boolean? "If set, the stem of a chord does not
518 pass through all note heads, but starts at the last note head. ")
519 (staff-padding ,ly:dimension?
520 "Maintain this much space between reference points
521 and the staff. Its effect is to align objects of differing
522 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
531 (define (define-internal-grob-property symbol type? description)
532 (define-grob-property symbol type? description)
533 (set-object-property! symbol 'backend-internal #t)
538 (define-public all-internal-grob-properties
541 (apply define-internal-grob-property x))
544 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
545 (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
546 (all-elements ,grob-list? "list of all grobs in this line. Its
547 function is to protect objects from being garbage collected.")
548 (arpeggio ,ly:grob? "pointer to arpeggio object.")
549 (beam ,ly:grob? "pointer to the beam, if applicable.")
550 (center-element ,ly:grob? "grob which will be at the center of
551 the group after aligning (when using
552 Align_interface::center_on_element).")
553 (direction-source ,ly:grob? "in case side-relative-direction is
554 set, which grob to get the direction from .")
555 (dot ,ly:grob? "reference to Dots object.")
556 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
557 (stem ,ly:grob? "pointer to Stem object.")
558 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
560 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
561 (rest ,ly:grob? "the staff symbol grob that we're in.")
562 (rest-collision ,ly:grob? "rest collision that a rest is in.")
563 (accidental-grob ,ly:grob? "Accidental for this note.")
564 (bars ,grob-list? "list of bar line pointers.")
565 (bounded-by-me ,grob-list? "list of spanners that have this
566 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
567 (columns ,grob-list? "list of grobs, typically containing
568 paper-columns or note-column objects.")
569 (conditional-elements ,grob-list? "Internal use only")
570 (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
571 (encompass-objects ,grob-list? "Objects that a slur should avoid
572 in addition to notes and stems.")
573 (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
574 (heads ,grob-list? "List of note heads.")
575 (items-worth-living ,grob-list? "A list of interesting items. If
576 empty in a particular staff, then that staff is erased.")
577 (details ,list? "alist of parameters for detailed grob behavior.")
578 (note-heads ,grob-list? "List of note head grobs")
579 (side-support-elements ,grob-list? "the support, a list of grobs.")
580 (spacing-wishes ,grob-list? "List of note spacing or staff spacing objects.")
581 (stems ,grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
584 (left-neighbors ,grob-list? " List of
585 spacing-wish grobs that are close to the current column.
587 The closest spacing-wishes determine the actual distances between the
590 (right-neighbors ,grob-list? "see left-neighbors")
591 (left-items ,grob-list? "")
592 (right-items ,grob-list? "")
593 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
594 (font ,ly:font-metric? "Cached font metric object")
596 (positioning-done ,boolean?
597 "Used to signal that a positioning element
598 did its job. This ensures that a positioning is only done once.")
601 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
602 acts as an index for looking up a Stencil object.")
604 (meta ,list? "Contains meta information. It is an alist with the
605 entries @code{name} and @code{interfaces}.")
608 ;; TODO: use interface for this!
609 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
610 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
611 (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
612 (quant-score ,string? "Beam quanting score -- can be stored for
614 (least-squares-dy ,number?
615 "ideal beam slope, without damping.")
616 (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
617 (stem-info ,pair? "caching of stem parameters")
618 (note-columns ,pair? "list of NoteColumn grobs.")
620 (position-callbacks ,list? "list of
621 functions set spanner positions.")
623 ;;; Junk me, replace it by add-join.
624 (join-left-amount ,number? "")
626 (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")
627 (head-width ,ly:dimension? "width of this ligature head")
629 ;; [TODO: change this]
630 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
631 (stencil ,ly:stencil? "Cached output of the print-function.")
632 (de-uglify-parameters ,list? "list of 3 real constants. They
633 define the valid areas for the middle control points. They are
635 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
636 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
638 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
639 (shorten ,ly:dimension? "The amount of space that a
640 stem. Internally used to distribute beam shortening over stems. ")
641 (slur ,ly:grob? "A pointer to a slur object")
642 (use-breve-rest ,boolean? "Use breve rests for measures longer
651 ;; there are too many properties for ancient notation
652 ;; probably neume-types (a list of symbols) would also work.
654 (auctum ,boolean? "is this neume augmented?")
655 (ascendens ,boolean? "is this neume of an ascending?")
656 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
657 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
658 (cavum ,boolean? "is this neume outlined?")
659 (descendens ,boolean? "is this neume of a descendent type?")
660 (deminutum ,boolean? "is this neume deminished?")
661 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
662 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
663 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
664 (linea ,boolean? "attach vertical lines to this neume?")
667 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
668 (join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")
669 (context-info ,integer? "DOCME")
670 (inclinatum ,boolean? "is this neume an inclinatum?")
671 (oriscus ,boolean? "is this neume an oriscus?")
672 (quilisma ,boolean? "is this neume a quilisma?")
673 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
675 (prefix-set ,number? "")
676 (stropha ,boolean? "Is this neume a stropha?")
677 (virga ,boolean? "Is this neume a virga?")
678 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
680 ;; end ancient notation
684 (define-public all-backend-properties
686 all-internal-grob-properties
687 all-user-grob-properties))