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>
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)
16 (set-object-property! symbol 'backend-type? type?)
17 (set-object-property! symbol 'backend-doc description)
20 ;; put this in an alist?
22 all-user-grob-properties
26 (apply define-grob-property x))
29 (X-extent-callback ,procedure? "Procedure that calculates the
30 extent of this object. If this value is set to @code{#f}, the object
31 is empty in the X direction. The procedure takes a grob and axis
32 argument, and returns a number-pair.
35 (X-offset-callbacks ,list? "A list of functions determining this
36 objects' position relative to its parent. The last one in the list is
37 called first. The functions take a grob and axis argument. ")
39 (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
40 (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
42 (accidentals ,list? "List of alteration numbers.")
43 (add-stem-support ,boolean? "If set, the Stem object is included in this script's support")
45 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
46 @code{0}: around center of width, @code{1}: right side.")
47 (arch-angle ,number? "Turning angle of the hook of a system brace" )
48 (arch-height ,ly:dimension? "Height of the hook of a system brace.")
49 (arch-thick ,number? "Thickness of the hook of system brace.")
50 (arch-width ,ly:dimension? "Width of the hook of a system brace.")
51 (arpeggio-direction ,ly:dir? "If set, put an
52 arrow on the arpeggio squiggly line.")
54 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
55 where a horizontal beam fits that is larger than this number, make a kneed beam.")
56 (axes ,list? "list of axis numbers.
57 In the case of alignment grobs, this should contain only one number.")
59 (balloon-text ,markup? "Text to add to help balloon")
60 (balloon-text-props ,list? "Font properties
62 (balloon-text-offset ,number-pair?
63 "Where to put text relative to balloon.")
64 (balloon-padding ,ly:dimension? "Text to add to help balloon")
65 (balloon-original-callback ,procedure? "The
66 original stencil drawer to draw the balloon around.")
69 (bar-size ,ly:dimension? "size of a bar line.")
70 (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
71 (barre-type ,symbol? "Type of barre indication used in a fret diagram.
72 Choices include @code{curved} and @code{straight}.")
73 (base-shortest-duration ,ly:moment?
74 "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.")
75 (baseline-skip ,ly:dimension? "Distance between base lines of
76 multiple lines of text.")
77 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
78 (beam-width ,ly:dimension? "width of the tremolo sign.")
79 (beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
80 (beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
81 (beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
83 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
84 when their direction is forced. It is a list, since the value is different
85 depending on the number flags/beams.")
87 "Pair of number lists. Each number list specifies which
88 beams to make. 0 is the central beam, 1 is the next beam toward the
89 note etc. This information is used to determine how to connect the
90 beaming patterns from stem to stem inside a beam.")
93 (before-line-breaking-callback ,procedure? "This procedure is
94 called before line breaking, but after splitting breakable items at
95 potential line breaks.")
96 (between-cols ,pair? "Where to attach a loose column to")
97 (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
98 (bracket-flare ,number-pair? "A pair of numbers specifying how
99 much edges of brackets should slant outward. Value 0.0 means straight
101 (bracket-thick ,number? "width of a system start bracket.")
102 (break-align-symbol ,symbol? "This key is used for aligning and
103 spacing breakable items.")
104 (break-align-orders ,vector? " Defines the order in which
105 prefatory matter (clefs, key signatures) appears. The format is a
106 vector of length 3, where each element is one order for end-of-line,
107 middle of line, and start-of-line respectively. An order is a list of
110 For example, clefs are put after key signatures by setting
113 \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3
121 (break-glyph-function ,procedure? "This function determines the
122 appearance of a bar line at the line break. It takes a glyph and
123 break-direction and returns the glyph at a line break.")
124 (breakable ,boolean? "Can this object appear at a line break,
125 like clefs and bar lines?")
126 (c0-position ,integer? "An integer indicating the position of
128 (cautionary-style ,symbol? "How to print cautionary
129 accidentals. Choices are @code{smaller} or
130 @code{parentheses}.")
131 (cautionary ,boolean? "Is this a cautionary accidental?")
132 (concaveness ,number? "A beam is concave when its inner stems are
133 closer to the beam than the two outside stems. This number is a
134 measure of the closeness of the inner stems. It is used for damping
135 the slope of the beam.")
136 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
138 (context ,ly:context? "Originating context of the grob")
141 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
143 (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
144 100000: horizontal beams.")
145 (dash-period ,number? "the length of one dash + white space. If
146 negative, no line is drawn at all.")
148 (dash-fraction ,number? "Size of the dashes, relative to
149 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
152 ;; todo: why is this tunable?
153 (dir-function ,procedure? "The function to determine the
154 direction of a beam. Choices include:
157 @item beam-dir-majority
158 number count of up or down notes
160 mean center distance of all notes
161 @item beam-dir-median.
162 mean center distance weighted per note
167 (direction ,ly:dir? "Up or down, left or right?")
168 (dot-color ,symbol? "Color of dots. Options include
169 @code{black} and @code{white}.")
170 (dot-radius ,number? "Radius of dots.")
171 (dot-count ,integer? "The number of dots.")
172 (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
173 (edge-height ,pair? "A pair of number specifying the heights of
174 the vertical edges '(@var{left-height} . @var{right-height}).")
175 (edge-text ,pair? "A pair specifying the texts to be set at the
176 edges '(@var{left-text} . @var{right-text}).")
177 (excentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
179 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
182 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
184 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
186 (X-extent ,number-pair? "Hard coded extent in X direction. ")
187 (Y-extent ,number-pair? "See @code{X-extent}.")
189 (extra-offset ,number-pair? "A pair representing an offset. This
190 offset is added just before outputting the symbol, so the typesetting
191 engine is completely oblivious to it.")
193 (finger-code ,symbol? "Code for the type of fingering indication in a
194 fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
196 "a string determining what style of flag-glyph is
197 typeset on a Stem. Valid options include @code{()} and
198 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
200 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
201 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
202 (font-encoding ,symbol? "The font encoding is the broadest
203 category for selecting a font. Options include: @code{fetaMusic},
204 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
206 (font-name ,string? "Specifies a file name (without extension) of
207 the font to load. This setting override selection using
208 @code{font-family}, @code{font-series} and @code{font-shape}.")
209 (font-magnification ,number? "Magnification of the font, when it
210 is selected with @code{font-name}.")
212 (font-size ,number? "The font size, compared the `normal'
213 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
214 Each step of 1 is approximately 12% larger, 6 steps are exactly a
215 factor 2 larger. Fractional values are allowed.")
217 (font-series ,symbol? "Select the series of a font. Choices
218 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
219 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
220 @code{italic}, @code{caps}.")
222 (forced-distance ,ly:dimension? "A fixed distance between object
223 reference points in an alignment.")
225 (force-hshift ,number? "This specifies a manual shift for notes
226 in collisions. The unit is the note head width of the first voice
227 note. This is used by @internalsref{note-collision-interface}.")
229 (fraction ,number-pair? "Numerator and denominator of a time
231 (french-beaming ,boolean? "Use French beaming style for this
232 stem. The stem will stop at the innermost beams.")
233 (fret-count ,integer? "The number of frets in a fret diagram.")
235 ;; ugh: double, change.
236 (full-size-change ,boolean? "Don't make a change clef smaller.")
237 (non-default ,boolean? "Set for manually specified clefs.")
240 (glyph ,string? "a string determining what (style) of glyph is
241 typeset. Valid choices depend on the function that is reading this
243 (glyph-name ,string? "a name of character within font.")
244 (glyph-name-procedure ,procedure? "Return the name of a character
245 within font, to use for printing a symbol.")
247 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
248 (gap-count ,integer? "Number of gapped beams for tremolo.")
249 (grace-space-factor ,number? "Space grace notes at this fraction
250 of the @code{spacing-increment}.")
252 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
253 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
254 (height ,ly:dimension? "Height of an object in staffspace.")
255 (height-limit ,ly:dimension? "Maximum slur height: the longer the
256 slur, the closer it is to this height.")
258 (horizontal-shift ,integer? "An integer that identifies ranking
259 of note-column for horizontal shifting. This is used by
260 @internalsref{note-collision-interface}.")
261 (inside-slur ,boolean? "If set, this script should be inside the
262 slur. If set to false, the script places itself around the slur. If
263 unset, script and slur ignore each other ")
264 (inspect-quants ,number-pair? "If debugging is set,
265 set beam quant to this position, and print the respective scores.")
267 (allow-outside-line ,boolean? "If set, allow this column to
268 things sticking into the margin.")
269 (kern ,ly:dimension? "Amount of extra white space to add. For
270 bar line, 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 (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
276 (layer ,number? "The output layer [0..2]: layers define the order
277 of printing objects. Objects in lower layers are overprinted by
278 objects in higher layers.")
279 (ledger-line-thickness ,number-pair?
280 "The thickness of ledger lines: it is the
281 sum of 2 numbers. The first is the factor for line thickness, and the
282 second for staff space. Both contributions are added.")
283 (left-position ,number? "Vertical position of left part of spanner.")
284 (left-padding ,ly:dimension? "The amount of space that is put
285 left to a group of accidentals.")
286 (length ,ly:dimension? "User override for the stem length of
288 (lengths ,list? "Default stem lengths. The list gives a length
289 for each flag-count.")
290 (line-count ,integer? "The number of staff lines.")
291 (measure-length ,ly:moment? "Length of a
292 measure. Used in some spacing situations.")
294 (measure-count ,integer? "The number of measures for a
296 (merge-differently-headed ,boolean? "Merge
297 note heads in collisions, even if they have different note heads. The
298 smaller of the two heads will be rendered invisible. This used
299 polyphonic guitar notation. The value of this setting is used by
300 @internalsref{note-collision-interface} .")
302 (merge-differently-dotted ,boolean? "Merge note heads in
303 collisions, even if they have a different number of dots. This normal
304 notation for some types of polyphonic music. ")
306 (minimum-distance ,ly:dimension? "Minimum distance between rest
308 (minimum-X-extent ,number-pair? "Minimum size of an object in X
309 dimension, measured in staff space.")
310 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
311 (minimum-length ,ly:dimension? "Try to make a spanner at least
312 this long. This requires an appropriate routine for the
313 @code{spacing-procedure} property.")
314 (minimum-space ,ly:dimension? "Minimum distance that the victim
315 should move (after padding).")
316 (print-function ,procedure? "Function taking grob as argument,
317 returning a @code{Stencil} object.")
318 (neutral-direction ,ly:dir? "Which direction to take in the
319 center of the staff.")
320 (neutral-position ,number? "Position (in half staff spaces) where
321 to flip the direction of custos stem.")
323 (new-accidentals ,list? "List of @code{(@var{pitch}
324 . @var{accidental})} pairs.")
325 (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
326 (note-names ,vector? "Vector of strings containing names for
327 easy-notation note heads.")
328 (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
329 (no-spacing-rods ,boolean? "Items with this property do not cause
330 spacing constraints.")
331 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
332 get stems extending to the middle staff line.")
333 (number-type ,symbol? "Type of numbers to use in label. Choices
334 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
336 (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
339 (enclose-bounds ,number?
340 "How much of the bound a spanner should enclose:
341 +1 = completely, 0 = center, -1 not at all.")
343 (padding ,ly:dimension? "Add this much extra space between
344 objects that are next to each other.")
345 (page-penalty ,number? "Penalty for page break at
346 this column. 10000 or more means forbid linebreak, -10000 or less
347 means force page break. Other values influence page breaking decisions
349 (penalty ,number? "Penalty for line break at
350 this column. 10000 or more means forbid line break, -10000 or less
351 means force line break. Other values influence line breaking decisions
355 "Pair of staff coordinates @code{(@var{left}
356 . @var{right})}, where both @var{left} and @var{right} are in the
357 staff-space unit of the current staff.")
359 (ratio ,number? "Parameter for slur shape. The higher this number, the
360 quicker the slur attains it @code{height-limit}.")
361 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
362 (right-padding ,ly:dimension? "Space to insert between note and
364 (right-position ,number? "Vertical position of right part of spanner.")
365 (script-priority ,number? "A sorting key that determines in what
366 order a script is within a stack of scripts.")
368 (self-alignment-X ,number? "Specify alignment of an object. The
369 value -1 means left aligned, 0 centered, and 1 right-aligned in X
370 direction. Values in between may also be specified.")
371 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
374 (shorten-pair ,number-pair? "The lengths to shorten a
375 text-spanner on both sides, for example a pedal bracket")
376 (common-shortest-duration ,ly:moment?
377 "The most common shortest note length.
378 This is used in spacing. Enlarging this will set the score tighter.")
379 (shortest-duration-space ,ly:dimension? "Start with this much
380 space for the shortest duration. This is expressed in
381 @code{spacing-increment} as unit. See also
382 @internalsref{spacing-spanner-interface}.")
383 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
384 (shortest-starter-duration ,ly:moment? "The duration of the shortest
385 note that starts here.")
386 (side-relative-direction ,ly:dir?
387 "Multiply direction of
388 @code{direction-source} with this to get the direction of this
390 (size ,number? "Size of object, relative to standard size.")
391 (slope ,number? "The slope of this object.")
392 (slur-padding ,number? "Extra distance between slur and script.")
394 "An alist of scoring parameters for slur formatting")
395 (space-alist ,list? "A table that specifies distances between
396 prefatory items, like clef and time-signature. The format is an alist
397 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
398 . @var{distance})}, where @var{type} can be the symbols
399 @code{minimum-space} or @code{extra-space}.")
400 (space-function ,procedure? "Calculate the vertical space between
401 two beams. This function takes a beam grob and the maximum number of
404 (spacing-increment ,number? "Add this much space for a doubled
405 duration. Typically, the width of a note head. See also
406 @internalsref{spacing-spanner-interface}.")
408 (spacing-procedure ,procedure? "Procedure for calculating spacing
409 parameters. The routine is called after
410 @code{before-line-breaking-callback}.")
411 (stacking-dir ,ly:dir? "Stack objects in which direction?")
412 (staff-space ,ly:dimension? "Amount of space between staff lines,
413 expressed in global staffspace.")
414 (staff-position ,number? "Vertical position, measured in half
415 staff spaces, counted from the middle line.")
416 (staffline-clearance ,ly:dimension? "How far away ties keep from
418 (stemlet-length ,number? "How long should a stem over a rest be?")
419 (stem-attachment-function ,procedure? "A function that calculates
420 where a stem attaches to the note head? This is a fallback when this
421 information is not specified in the font. The function takes a grob
422 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
423 location in terms of note head bounding box.")
425 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
427 (stem-shorten ,list? "How much a stem in a forced direction
428 should be shortened. The list gives an amount depending on the number
432 (stem-spacing-correction ,number? "Optical correction amount for
433 stems that are placed in tight configurations. For opposite
434 directions, this amount is the correction for two normal sized stems
435 that overlap completely.")
438 (string-count ,integer? "The number of strings in a fret diagram.")
439 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
441 (style ,symbol? "This setting determines in what style a grob is
442 typeset. Valid choices depend on the @code{print-function} that is
443 reading this property.")
444 (text ,markup? "Text markup. See @usermanref{Text markup}.")
445 ;;FIXME -- Should both be the same?
446 (thick-thickness ,number? "Bar line thickness, measured in
447 @code{linethickness}.")
448 (thickness ,number? "Bar line thickness, measured in
449 @code{linethickness}.")
450 (thin-kern ,number? "The space after a hair-line in a bar line.")
452 (threshold ,number-pair? "(@var{min} . @var{max}), where
453 @var{min} and @var{max} are dimensions in staff space.")
454 (transparent ,boolean? "This is almost the same as setting
455 @code{print-function} to @code{#f}, but this retains the dimensions of
456 this grob, which means that grobs can be erased individually.")
457 (bracket-visibility ,boolean-or-symbol? "This controls the
458 visibility of the tuplet bracket. Setting it to false will prevent
459 printing of the bracket. Setting the property to @code{'if-no-beam}
460 will make it print only if there is no beam associated with this
462 (number-visibility ,boolean-or-symbol? "Like
463 @code{bracket-visibility}, but for the number.")
466 (break-visibility ,procedure? "A function that takes the break
467 direction and returns a cons of booleans containing (@var{transparent}
468 . @var{empty}). The following variables are predefined:
469 @code{all-visible}, @code{begin-of-line-visible},
470 @code{end-of-line-visible}, @code{begin-of-line-invisible},
471 @code{end-of-line-invisible}, @code{all-invisible}.")
472 (flag-count ,number? "The number of tremolo beams.")
474 (when ,ly:moment? "Global time step associated with this column
476 (word-space ,ly:dimension? "space to insert between lyrics or
478 (width ,ly:dimension? "The width of a grob measured in staff space.")
479 (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
480 (y-offset ,ly:dimension? "Extra vertical offset for ties away
481 from the center line.")
482 (zigzag-length ,ly:dimension? "The length of the lines of a
483 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
485 (zigzag-width ,ly:dimension? "The width of one
486 zigzag-squiggle. This number will be adjusted slightly so that the
487 glissando line can be constructed from a whole number of squiggles.")
489 (avoid-note-head ,boolean? "If set, the stem of a chord does not
490 pass through all note heads, but starts at the last note head. ")
491 (staff-padding ,ly:dimension?
492 "Maintain this much space between reference points
493 and the staff. Its effect is to align objects of differing
494 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
503 (define (define-internal-grob-property symbol type? description)
504 (define-grob-property symbol type? description)
505 (set-object-property! symbol 'backend-internal #t)
510 (define-public all-internal-grob-properties
513 (apply define-internal-grob-property x))
516 (axis-group-parent-X ,ly:grob? "Containing X axis group")
517 (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
518 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
519 (adjacent-hairpins ,grob-list? "List of directly neighboring hairpins")
520 (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
521 (all-elements ,grob-list? "list of all grobs in this line. Its
522 function is to protect objects from being garbage collected.")
523 (arpeggio ,ly:grob? "pointer to arpeggio object.")
524 (beam ,ly:grob? "pointer to the beam, if applicable.")
525 (center-element ,ly:grob? "grob which will be at the center of
526 the group after aligning (when using
527 Align_interface::center_on_element).")
528 (tweak-count ,number? "Number of otherwise unique Grobs.")
529 (tweak-rank ,number? "Identify otherwise unique Grobs.")
530 (direction-source ,ly:grob? "in case side-relative-direction is
531 set, which grob to get the direction from .")
532 (dot ,ly:grob? "reference to Dots object.")
533 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
534 (stem ,ly:grob? "pointer to Stem object.")
535 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
537 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
538 (rest ,ly:grob? "the staff symbol grob that we're in.")
539 (rests ,grob-list? "A list of rest objects.")
540 (rest-collision ,ly:grob? "rest collision that a rest is in.")
541 (accidental-grob ,ly:grob? "Accidental for this note.")
542 (bars ,grob-list? "list of bar line pointers.")
543 (bounded-by-me ,grob-list? "list of spanners that have this
544 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
545 (columns ,grob-list? "list of grobs, typically containing
546 paper-columns or note-column objects.")
547 (conditional-elements ,grob-list? "Internal use only")
548 (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
549 (encompass-objects ,grob-list? "Objects that a slur should avoid
550 in addition to notes and stems.")
551 (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
552 (heads ,grob-list? "List of note heads.")
553 (items-worth-living ,grob-list? "A list of interesting items. If
554 empty in a particular staff, then that staff is erased.")
555 (details ,list? "alist of parameters for detailed grob behavior.")
556 (note-heads ,grob-list? "List of note head grobs")
557 (side-support-elements ,grob-list? "the support, a list of grobs.")
558 (spacing-wishes ,grob-list? "List of note spacing or staff spacing objects.")
559 (stems ,grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
562 (left-neighbors ,grob-list? " List of
563 spacing-wish grobs that are close to the current column.
565 The closest spacing-wishes determine the actual distances between the
568 (right-neighbors ,grob-list? "see left-neighbors")
569 (left-items ,grob-list? "")
570 (right-items ,grob-list? "")
571 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
572 (font ,ly:font-metric? "Cached font metric object")
574 (positioning-done ,boolean?
575 "Used to signal that a positioning element
576 did its job. This ensures that a positioning is only done once.")
579 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
580 acts as an index for looking up a Stencil object.")
582 (meta ,list? "Contains meta information. It is an alist with the
583 entries @code{name} and @code{interfaces}.")
586 ;; TODO: use interface for this!
587 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
588 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
589 (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
590 (quant-score ,string? "Beam quanting score -- can be stored for
592 (least-squares-dy ,number?
593 "ideal beam slope, without damping.")
594 (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
595 (stem-info ,pair? "caching of stem parameters")
596 (note-columns ,pair? "list of NoteColumn grobs.")
598 (position-callbacks ,list? "list of
599 functions set spanner positions.")
601 ;;; Junk me, replace it by add-join.
602 (join-left-amount ,number? "")
604 (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")
605 (head-width ,ly:dimension? "width of this ligature head")
607 ;; [TODO: change this]
608 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
609 (stencil ,ly:stencil? "Cached output of the print-function.")
610 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
611 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
613 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
614 (shorten ,ly:dimension? "The amount of space that a
615 stem. Internally used to distribute beam shortening over stems. ")
616 (slur ,ly:grob? "A pointer to a slur object")
617 (use-breve-rest ,boolean? "Use breve rests for measures longer
621 (spaceable-staves ,grob-list? "Objects to be spaced during page layout.")
626 ;; there are too many properties for ancient notation
627 ;; probably neume-types (a list of symbols) would also work.
629 (auctum ,boolean? "is this neume augmented?")
630 (ascendens ,boolean? "is this neume of an ascending?")
631 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
632 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
633 (cavum ,boolean? "is this neume outlined?")
634 (descendens ,boolean? "is this neume of a descendent type?")
635 (deminutum ,boolean? "is this neume deminished?")
636 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
637 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
638 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
639 (linea ,boolean? "attach vertical lines to this neume?")
642 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
643 (join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")
644 (context-info ,integer? "DOCME")
645 (inclinatum ,boolean? "is this neume an inclinatum?")
646 (oriscus ,boolean? "is this neume an oriscus?")
647 (quilisma ,boolean? "is this neume a quilisma?")
648 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
650 (prefix-set ,number? "")
651 (stropha ,boolean? "Is this neume a stropha?")
652 (virga ,boolean? "Is this neume a virga?")
653 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
655 ;; end ancient notation
659 (define-public all-backend-properties
661 all-internal-grob-properties
662 all-user-grob-properties))