1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 (define (define-grob-property symbol type? description)
9 (if (not (equal? (object-property symbol 'backend-doc) #f))
10 (ly:error (_ "symbol ~S redefined") symbol))
12 (set-object-property! symbol 'backend-type? type?)
13 (set-object-property! symbol 'backend-doc description)
16 ;; put this in an alist?
18 all-user-grob-properties
22 (apply define-grob-property x))
25 (X-extent-callback ,procedure? "Procedure that calculates the
26 extent of this object. If this value is set to @code{#f}, the object
27 is empty in the X direction. The procedure takes a grob and axis
28 argument, and returns a number-pair.
31 (X-offset-callbacks ,list? "A list of functions determining this
32 objects' position relative to its parent. The last one in the list is
33 called first. The functions take a grob and axis argument. ")
35 (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
36 (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
38 (accidentals ,list? "List of alteration numbers.")
39 (add-stem-support ,boolean? "If set, the Stem object is included in this script's support")
41 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
42 @code{0}: around center of width, @code{1}: right side.")
43 (arpeggio-direction ,ly:dir? "If set, put an
44 arrow on the arpeggio squiggly line.")
46 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
47 where a horizontal beam fits that is larger than this number, make a kneed beam.")
48 (axes ,list? "list of axis numbers.
49 In the case of alignment grobs, this should contain only one number.")
51 (balloon-text ,markup? "Text to add to help balloon")
52 (balloon-text-props ,list? "Font properties
54 (balloon-text-offset ,number-pair?
55 "Where to put text relative to balloon.")
56 (balloon-padding ,ly:dimension? "Text to add to help balloon")
57 (balloon-original-callback ,procedure? "The
58 original stencil drawer to draw the balloon around.")
61 (bar-size ,ly:dimension? "size of a bar line.")
62 (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
63 (barre-type ,symbol? "Type of barre indication used in a fret diagram.
64 Choices include @code{curved} and @code{straight}.")
65 (base-shortest-duration ,ly:moment?
66 "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.")
67 (baseline-skip ,ly:dimension? "Distance between base lines of
68 multiple lines of text.")
69 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
70 (beam-width ,ly:dimension? "width of the tremolo sign.")
71 (beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
72 (beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
73 (beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
75 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
76 when their direction is forced. It is a list, since the value is different
77 depending on the number flags/beams.")
79 "Pair of number lists. Each number list specifies which
80 beams to make. 0 is the central beam, 1 is the next beam toward the
81 note etc. This information is used to determine how to connect the
82 beaming patterns from stem to stem inside a beam.")
85 (before-line-breaking-callback ,procedure? "This procedure is
86 called before line breaking, but after splitting breakable items at
87 potential line breaks.")
88 (between-cols ,pair? "Where to attach a loose column to")
89 (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
90 (bracket-flare ,number-pair? "A pair of numbers specifying how
91 much edges of brackets should slant outward. Value 0.0 means straight
93 (break-align-symbol ,symbol? "This key is used for aligning and
94 spacing breakable items.")
95 (break-align-orders ,vector? " Defines the order in which
96 prefatory matter (clefs, key signatures) appears. The format is a
97 vector of length 3, where each element is one order for end-of-line,
98 middle of line, and start-of-line respectively. An order is a list of
101 For example, clefs are put after key signatures by setting
104 \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3
112 (break-glyph-function ,procedure? "This function determines the
113 appearance of a bar line at the line break. It takes a glyph and
114 break-direction and returns the glyph at a line break.")
115 (break-overshoot ,number-pair? "How much does a broken spanner
116 stick out of its bounds?")
117 (breakable ,boolean? "Can this object appear at a line break,
118 like clefs and bar lines?")
119 (c0-position ,integer? "An integer indicating the position of
121 (cautionary-style ,symbol? "How to print cautionary
122 accidentals. Choices are @code{smaller} or
123 @code{parentheses}.")
124 (cautionary ,boolean? "Is this a cautionary accidental?")
125 (concaveness ,number? "A beam is concave when its inner stems are
126 closer to the beam than the two outside stems. This number is a
127 measure of the closeness of the inner stems. It is used for damping
128 the slope of the beam.")
129 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
131 (color ,color? "The color of this grob.")
133 (context ,ly:context? "Originating context of the grob")
136 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
138 (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
139 100000: horizontal beams.")
140 (dash-period ,number? "the length of one dash + white space. If
141 negative, no line is drawn at all.")
143 (dash-fraction ,number? "Size of the dashes, relative to
144 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
147 (arrow ,boolean? "Add an arrow to the line.")
148 (arrow-length ,number? "Arrow length.")
149 (arrow-width ,number? "Arrow width.")
151 ;; todo: why is this tunable?
152 (dir-function ,procedure? "The function to determine the
153 direction of a beam. Choices include:
156 @item beam-dir-majority
157 number count of up or down notes
159 mean center distance of all notes
160 @item beam-dir-median.
161 mean center distance weighted per note
166 (direction ,ly:dir? "Up or down, left or right?")
167 (dot-color ,symbol? "Color of dots. Options include
168 @code{black} and @code{white}.")
169 (dot-radius ,number? "Radius of dots.")
170 (dot-count ,integer? "The number of dots.")
171 (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
172 (edge-height ,pair? "A pair of number specifying the heights of
173 the vertical edges '(@var{left-height} . @var{right-height}).")
174 (edge-text ,pair? "A pair specifying the texts to be set at the
175 edges '(@var{left-text} . @var{right-text}).")
176 (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
178 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
181 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
183 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
185 (X-extent ,number-pair? "Hard coded extent in X direction. ")
186 (Y-extent ,number-pair? "See @code{X-extent}.")
188 (extra-offset ,number-pair? "A pair representing an offset. This
189 offset is added just before outputting the symbol, so the typesetting
190 engine is completely oblivious to it.")
192 (finger-code ,symbol? "Code for the type of fingering indication in a
193 fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
195 "a string determining what style of flag-glyph is
196 typeset on a Stem. Valid options include @code{()} and
197 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
199 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
200 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
201 (font-encoding ,symbol? "The font encoding is the broadest
202 category for selecting a font. Options include: @code{fetaMusic},
203 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
205 (font-name ,string? "Specifies a file name (without extension) of
206 the font to load. This setting override selection using
207 @code{font-family}, @code{font-series} and @code{font-shape}.")
208 (font-magnification ,number? "Magnification of the font, when it
209 is selected with @code{font-name}.")
211 (font-size ,number? "The font size, compared the `normal'
212 size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
213 Each step of 1 is approximately 12% larger, 6 steps are exactly a
214 factor 2 larger. Fractional values are allowed.")
216 (font-series ,symbol? "Select the series of a font. Choices
217 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
218 (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
219 @code{italic}, @code{caps}.")
221 (forced-distance ,ly:dimension? "A fixed distance between object
222 reference points in an alignment.")
224 (force-hshift ,number? "This specifies a manual shift for notes
225 in collisions. The unit is the note head width of the first voice
226 note. This is used by @internalsref{note-collision-interface}.")
228 (fraction ,number-pair? "Numerator and denominator of a time
230 (french-beaming ,boolean? "Use French beaming style for this
231 stem. The stem will stop at the innermost beams.")
232 (fret-count ,integer? "The number of frets in a fret diagram.")
234 ;; ugh: double, change.
235 (full-size-change ,boolean? "Don't make a change clef smaller.")
236 (non-default ,boolean? "Set for manually specified clefs.")
239 (glyph ,string? "a string determining what (style) of glyph is
240 typeset. Valid choices depend on the function that is reading this
242 (glyph-name ,string? "a name of character within font.")
243 (glyph-name-procedure ,procedure? "Return the name of a character
244 within font, to use for printing a symbol.")
246 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
247 (gap-count ,integer? "Number of gapped beams for tremolo.")
248 (grace-space-factor ,number? "Space grace notes at this fraction
249 of the @code{spacing-increment}.")
251 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
252 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
253 (height ,ly:dimension? "Height of an object in staffspace.")
254 (height-limit ,ly:dimension? "Maximum slur height: the longer the
255 slur, the closer it is to this height.")
257 (horizontal-shift ,integer? "An integer that identifies ranking
258 of note-column for horizontal shifting. This is used by
259 @internalsref{note-collision-interface}.")
260 (inside-slur ,boolean? "If set, this script should be inside the
261 slur. If set to false, the script places itself around the slur. If
262 unset, script and slur ignore each other ")
263 (inspect-quants ,number-pair? "If debugging is set,
264 set beam quant to this position, and print the respective scores.")
266 (keep-inside-line ,boolean? "If set, this column cannot have
267 things sticking into the margin.")
268 (kern ,ly:dimension? "Amount of extra white space to add. For
269 bar line, this is the amount of space after a thick line.")
270 (knee ,boolean? "Is this beam kneed?")
271 (knee-spacing-correction ,number? "Factor for the optical
272 correction amount for kneed beams. Set between 0 for no correction and
273 1 for full correction.")
274 (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
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 line thickness, 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 (length-fraction ,number? "Length of ledger line as fraction of note head size.")
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-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.")
307 (minimum-distance ,ly:dimension? "Minimum distance between rest
309 (minimum-X-extent ,number-pair? "Minimum size of an object in X
310 dimension, measured in staff space.")
311 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
312 (minimum-length ,ly:dimension? "Try to make a spanner at least
313 this long. This requires an appropriate routine for the
314 @code{spacing-procedure} property.")
315 (minimum-space ,ly:dimension? "Minimum distance that the victim
316 should move (after padding).")
317 (print-function ,procedure? "Function taking grob as argument,
318 returning a @code{Stencil} object.")
319 (neutral-direction ,ly:dir? "Which direction to take in the
320 center of the staff.")
321 (neutral-position ,number? "Position (in half staff spaces) where
322 to flip the direction of custos stem.")
324 (new-accidentals ,list? "List of @code{(@var{pitch}
325 . @var{accidental})} pairs.")
326 (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
327 (note-names ,vector? "Vector of strings containing names for
328 easy-notation note heads.")
329 (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
330 (no-spacing-rods ,boolean? "Items with this property do not cause
331 spacing constraints.")
332 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
333 get stems extending to the middle staff line.")
334 (number-type ,symbol? "Type of numbers to use in label. Choices
335 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
337 (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
340 (enclose-bounds ,number?
341 "How much of the bound a spanner should enclose:
342 +1 = completely, 0 = center, -1 not at all.")
344 (padding ,ly:dimension? "Add this much extra space between
345 objects that are next to each other.")
346 (page-penalty ,number? "Penalty for page break at
347 this column. 10000 or more means forbid linebreak, -10000 or less
348 means force page break. Other values influence page breaking decisions
350 (penalty ,number? "Penalty for line break at
351 this column. 10000 or more means forbid line break, -10000 or less
352 means force line break. Other values influence line breaking decisions
356 "Pair of staff coordinates @code{(@var{left}
357 . @var{right})}, where both @var{left} and @var{right} are in the
358 staff-space unit of the current staff.")
360 (ratio ,number? "Parameter for slur shape. The higher this number, the
361 quicker the slur attains it @code{height-limit}.")
362 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
363 (right-padding ,ly:dimension? "Space to insert between note and
365 (right-position ,number? "Vertical position of right part of spanner.")
366 (script-priority ,number? "A sorting key that determines in what
367 order a script is within a stack of scripts.")
369 (self-alignment-X ,number? "Specify alignment of an object. The
370 value -1 means left aligned, 0 centered, and 1 right-aligned in X
371 direction. Values in between may also be specified.")
372 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
375 (shorten-pair ,number-pair? "The lengths to shorten a
376 text-spanner on both sides, for example a pedal bracket")
377 (common-shortest-duration ,ly:moment?
378 "The most common shortest note length.
379 This is used in spacing. Enlarging this will set the score tighter.")
380 (shortest-duration-space ,ly:dimension? "Start with this much
381 space for the shortest duration. This is expressed in
382 @code{spacing-increment} as unit. See also
383 @internalsref{spacing-spanner-interface}.")
384 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
385 (shortest-starter-duration ,ly:moment? "The duration of the shortest
386 note that starts here.")
387 (side-relative-direction ,ly:dir?
388 "Multiply direction of
389 @code{direction-source} with this to get the direction of this
391 (size ,number? "Size of object, relative to standard size.")
392 (slope ,number? "The slope of this object.")
393 (slur-padding ,number? "Extra distance between slur and script.")
395 "An alist of scoring parameters for slur formatting")
396 (space-alist ,list? "A table that specifies distances between
397 prefatory items, like clef and time-signature. The format is an alist
398 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
399 . @var{distance})}, where @var{type} can be the symbols
400 @code{minimum-space} or @code{extra-space}.")
401 (space-function ,procedure? "Calculate the vertical space between
402 two beams. This function takes a beam grob and the maximum number of
405 (spacing-increment ,number? "Add this much space for a doubled
406 duration. Typically, the width of a note head. See also
407 @internalsref{spacing-spanner-interface}.")
409 (spacing-procedure ,procedure? "Procedure for calculating spacing
410 parameters. The routine is called after
411 @code{before-line-breaking-callback}.")
412 (stacking-dir ,ly:dir? "Stack objects in which direction?")
413 (staff-space ,ly:dimension? "Amount of space between staff lines,
414 expressed in global staffspace.")
415 (staff-position ,number? "Vertical position, measured in half
416 staff spaces, counted from the middle line.")
417 (staffline-clearance ,ly:dimension? "How far away ties keep from
419 (stemlet-length ,number? "How long should a stem over a rest be?")
420 (stem-attachment-function ,procedure? "A function that calculates
421 where a stem attaches to the note head? This is a fallback when this
422 information is not specified in the font. The function takes a grob
423 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
424 location in terms of note head bounding box.")
426 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
428 (stem-shorten ,list? "How much a stem in a forced direction
429 should be shortened. The list gives an amount depending on the number
433 (stem-spacing-correction ,number? "Optical correction amount for
434 stems that are placed in tight configurations. For opposite
435 directions, this amount is the correction for two normal sized stems
436 that overlap completely.")
438 (same-direction-correction ,number? "Optical correction amount
439 for stems that are placed in tight configurations. This amount is used
440 for stems with the same direction to compensate for note-head to stem distance.")
441 (string-count ,integer? "The number of strings in a fret diagram.")
442 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
444 (style ,symbol? "This setting determines in what style a grob is
445 typeset. Valid choices depend on the @code{print-function} that is
446 reading this property.")
447 (text ,markup? "Text markup. See @usermanref{Text markup}.")
448 ;;FIXME -- Should both be the same?
449 (thick-thickness ,number? "Bar line thickness, measured in
450 @code{linethickness}.")
451 (thickness ,number? "Bar line thickness, measured in
452 @code{linethickness}.")
453 (thin-kern ,number? "The space after a hair-line in a bar line.")
455 (threshold ,number-pair? "(@var{min} . @var{max}), where
456 @var{min} and @var{max} are dimensions in staff space.")
457 (transparent ,boolean? "This is almost the same as setting
458 @code{print-function} to @code{#f}, but this retains the dimensions of
459 this grob, which means that grobs can be erased individually.")
460 (bracket-visibility ,boolean-or-symbol? "This controls the
461 visibility of the tuplet bracket. Setting it to false will prevent
462 printing of the bracket. Setting the property to @code{'if-no-beam}
463 will make it print only if there is no beam associated with this
465 (number-visibility ,boolean-or-symbol? "Like
466 @code{bracket-visibility}, but for the number.")
468 (break-visibility ,vector? "A vector of 3 booleans, #(end-of-line unbroken begin-of-line).
469 #t means visible, #f means killed.")
470 (flag-count ,number? "The number of tremolo beams.")
472 (when ,ly:moment? "Global time step associated with this column
474 (word-space ,ly:dimension? "space to insert between lyrics or
476 (width ,ly:dimension? "The width of a grob measured in staff space.")
477 (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
478 (y-offset ,ly:dimension? "Extra vertical offset for ties away
479 from the center line.")
480 (zigzag-length ,ly:dimension? "The length of the lines of a
481 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
483 (zigzag-width ,ly:dimension? "The width of one
484 zigzag-squiggle. This number will be adjusted slightly so that the
485 glissando line can be constructed from a whole number of squiggles.")
487 (avoid-note-head ,boolean? "If set, the stem of a chord does not
488 pass through all note heads, but starts at the last note head. ")
489 (staff-padding ,ly:dimension?
490 "Maintain this much space between reference points
491 and the staff. Its effect is to align objects of differing
492 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
501 (define (define-internal-grob-property symbol type? description)
502 (define-grob-property symbol type? description)
503 (set-object-property! symbol 'backend-internal #t)
508 (define-public all-internal-grob-properties
511 (apply define-internal-grob-property x))
514 (axis-group-parent-X ,ly:grob? "Containing X axis group")
515 (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
516 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
517 (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")
518 (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
519 (all-elements ,ly:grob-array? "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 (direction-source ,ly:grob? "in case side-relative-direction is
524 set, which grob to get the direction from .")
525 (dot ,ly:grob? "reference to Dots object.")
526 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
527 (stem ,ly:grob? "pointer to Stem object.")
528 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
530 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
531 (rest ,ly:grob? "the staff symbol grob that we're in.")
532 (rests ,ly:grob-array? "A list of rest objects.")
533 (rest-collision ,ly:grob? "rest collision that a rest is in.")
534 (accidental-grob ,ly:grob? "Accidental for this note.")
535 (bars ,ly:grob-array? "list of bar line pointers.")
536 (bounded-by-me ,ly:grob-array? "list of spanners that have this
537 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
538 (columns ,ly:grob-array? "list of grobs, typically containing
539 paper-columns or note-column objects.")
540 (conditional-elements ,ly:grob-array? "Internal use only")
541 (dependencies ,ly:grob-array? "list of score-grob pointers that indicate who to compute first for certain global passes.")
542 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
543 in addition to notes and stems.")
544 (elements ,ly:grob-array? "list of grobs, type depending on the Grob where this is set in.")
545 (heads ,ly:grob-array? "List of note heads.")
546 (items-worth-living ,ly:grob-array? "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 ,ly:grob-array? "List of note head grobs")
550 (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
551 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
552 (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
553 (tuplets ,ly:grob-array? "list of smaller tuplet brackets")
555 (left-neighbors ,ly:grob-array? " 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 ,ly:grob-array? "see left-neighbors")
562 (left-items ,ly:grob-array? "")
563 (right-items ,ly:grob-array? "")
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 ,string? "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 (position-callbacks ,list? "list of
592 functions set spanner positions.")
594 ;;; add-join would be enough if in Mensural_ligature::brew_ligature_primitive
595 ;;; the next note could be seen
596 (join-right-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 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
605 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
607 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
608 (shorten ,ly:dimension? "The amount of space that a
609 stem. Internally used to distribute beam shortening over stems. ")
610 (slur ,ly:grob? "A pointer to a slur object")
611 (use-breve-rest ,boolean? "Use breve rests for measures longer
615 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")
620 ;; there are too many properties for ancient notation
621 ;; probably neume-types (a list of symbols) would also work.
623 (auctum ,boolean? "is this neume augmented?")
624 (ascendens ,boolean? "is this neume of an ascending?")
625 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
626 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
627 (cavum ,boolean? "is this neume outlined?")
628 (descendens ,boolean? "is this neume of a descendent type?")
629 (deminutum ,boolean? "is this neume deminished?")
630 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
631 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
632 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
633 (linea ,boolean? "attach vertical lines to this neume?")
636 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
637 (context-info ,integer? "DOCME")
638 (inclinatum ,boolean? "is this neume an inclinatum?")
639 (oriscus ,boolean? "is this neume an oriscus?")
640 (quilisma ,boolean? "is this neume a quilisma?")
641 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
643 (prefix-set ,number? "")
644 (stropha ,boolean? "Is this neume a stropha?")
645 (virga ,boolean? "Is this neume a virga?")
646 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
648 ;; end ancient notation
652 (define-public all-backend-properties
654 all-internal-grob-properties
655 all-user-grob-properties))