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 (alteration-alist ,list? "List of @code{(@var{pitch}
40 . @var{accidental})} pairs for key signature.")
41 (add-stem-support ,boolean? "If set, the Stem object is included in this script's support")
43 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
44 @code{0}: around center of width, @code{1}: right side.")
45 (arpeggio-direction ,ly:dir? "If set, put an
46 arrow on the arpeggio squiggly line.")
48 (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
49 where a horizontal beam fits that is larger than this number, make a kneed beam.")
50 (axes ,list? "list of axis numbers.
51 In the case of alignment grobs, this should contain only one number.")
53 (balloon-text ,markup? "Text to add to help balloon")
54 (balloon-text-props ,list? "Font properties
56 (balloon-text-offset ,number-pair?
57 "Where to put text relative to balloon.")
58 (balloon-padding ,ly:dimension? "Text to add to help balloon")
59 (balloon-original-callback ,procedure? "The
60 original stencil drawer to draw the balloon around.")
63 (bar-size ,ly:dimension? "size of a bar line.")
64 (barre-type ,symbol? "Type of barre indication used in a fret diagram.
65 Choices include @code{curved} and @code{straight}.")
66 (base-shortest-duration ,ly:moment?
67 "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.")
68 (baseline-skip ,ly:dimension? "Distance between base lines of
69 multiple lines of text.")
70 (beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
71 (beam-width ,ly:dimension? "width of the tremolo sign.")
72 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
73 when their direction is forced. It is a list, since the value is different
74 depending on the number flags/beams.")
76 "Pair of number lists. Each number list specifies which
77 beams to make. 0 is the central beam, 1 is the next beam toward the
78 note etc. This information is used to determine how to connect the
79 beaming patterns from stem to stem inside a beam.")
82 (before-line-breaking ,boolean? "Dummy property, used to trigger a callback function.")
83 (between-cols ,pair? "Where to attach a loose column to")
84 (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
85 (bracket-flare ,number-pair? "A pair of numbers specifying how
86 much edges of brackets should slant outward. Value 0.0 means straight
88 (break-align-symbol ,symbol? "This key is used for aligning and
89 spacing breakable items.")
90 (break-align-orders ,vector? " Defines the order in which
91 prefatory matter (clefs, key signatures) appears. The format is a
92 vector of length 3, where each element is one order for end-of-line,
93 middle of line, and start-of-line respectively. An order is a list of
96 For example, clefs are put after key signatures by setting
99 \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3
107 (break-overshoot ,number-pair? "How much does a broken spanner
108 stick out of its bounds?")
109 (bracket-visibility ,boolean-or-symbol? "This controls the
110 visibility of the tuplet bracket. Setting it to false will prevent
111 printing of the bracket. Setting the property to @code{'if-no-beam}
112 will make it print only if there is no beam associated with this
114 (break-visibility ,vector? "A vector of 3 booleans, #(end-of-line unbroken begin-of-line).
115 #t means visible, #f means killed.")
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 (callbacks ,list? "An alist of (@var{symbol} . @var{procedure})
125 pairs. When the grob property @var{symbol} is requested,
126 @var{procedure} is invoked. The return value, if it is unequal to
127 @code{#<unspecified>} is recorded as the value of the property.")
128 (cautionary ,boolean? "Is this a cautionary accidental?")
129 (concaveness ,number? "A beam is concave when its inner stems are
130 closer to the beam than the two outside stems. This number is a
131 measure of the closeness of the inner stems. It is used for damping
132 the slope of the beam.")
133 (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
135 (color ,color? "The color of this grob.")
137 (context ,ly:context? "Originating context of the grob")
140 (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
142 (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
143 100000: horizontal beams.")
144 (dash-period ,number? "the length of one dash + white space. If
145 negative, no line is drawn at all.")
147 (dash-fraction ,number? "Size of the dashes, relative to
148 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
151 (arrow ,boolean? "Add an arrow to the line.")
152 (arrow-length ,number? "Arrow length.")
153 (arrow-width ,number? "Arrow width.")
155 ;; todo: why is this tunable?
156 (dir-function ,procedure? "The function to determine the
157 direction of a beam. Choices include:
160 @item beam-dir-majority
161 number count of up or down notes
163 mean center distance of all notes
164 @item beam-dir-median.
165 mean center distance weighted per note
170 (direction ,ly:dir? "Up or down, left or right?")
171 (dot-color ,symbol? "Color of dots. Options include
172 @code{black} and @code{white}.")
173 (dot-radius ,number? "Radius of dots.")
174 (dot-count ,integer? "The number of dots.")
175 (duration-log ,integer? "The 2-log of the note head 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 (edge-text ,pair? "A pair specifying the texts to be set at the
179 edges '(@var{left-text} . @var{right-text}).")
180 (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
182 (enclose-bounds ,number?
183 "How much of the bound a spanner should enclose:
184 +1 = completely, 0 = center, -1 not at all.")
186 (expand-limit ,integer? "maximum number of measures expanded in church rests.")
189 (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
191 (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
193 (X-extent ,number-pair? "Hard coded extent in X direction. ")
194 (Y-extent ,number-pair? "See @code{X-extent}.")
196 (extra-offset ,number-pair? "A pair representing an offset. This
197 offset is added just before outputting the symbol, so the typesetting
198 engine is completely oblivious to it.")
200 (finger-code ,symbol? "Code for the type of fingering indication in a
201 fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
202 (flag-count ,number? "The number of tremolo beams.")
204 "a string determining what style of flag-glyph is
205 typeset on a Stem. Valid options include @code{()} and
206 @code{mensural}. Additionally, @code{\"no-flag\"} switches off the
209 (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
210 (strict-note-spacing ,boolean? "If set, unbroken columns
211 with non-musical material (clefs, barlines, etc.) are not spaced
212 separately, but put before musical columns.")
213 (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
214 (font-encoding ,symbol? "The font encoding is the broadest
215 category for selecting a font. Options include: @code{fetaMusic},
216 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
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 (forced-distance ,ly:dimension? "A fixed distance between object
235 reference points in an alignment.")
237 (force-hshift ,number? "This specifies a manual shift for notes
238 in collisions. The unit is the note head width of the first voice
239 note. This is used by @internalsref{note-collision-interface}.")
241 (fraction ,number-pair? "Numerator and denominator of a time
243 (french-beaming ,boolean? "Use French beaming style for this
244 stem. The stem will stop at the innermost beams.")
245 (fret-count ,integer? "The number of frets in a fret diagram.")
247 ;; ugh: double, change.
248 (full-size-change ,boolean? "Don't make a change clef smaller.")
249 (non-default ,boolean? "Set for manually specified clefs.")
252 (glyph ,string? "a string determining what (style) of glyph is
253 typeset. Valid choices depend on the function that is reading this
255 (glyph-name-procedure ,procedure? "Return the name of a character
256 within font, to use for printing a symbol.")
258 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
259 (gap-count ,integer? "Number of gapped beams for tremolo.")
260 (grace-space-factor ,number? "Space grace notes at this fraction
261 of the @code{spacing-increment}.")
263 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
264 (hair-thickness ,number? "Thickness of the thin line in a bar line.")
265 (height ,ly:dimension? "Height of an object in staffspace.")
266 (height-limit ,ly:dimension? "Maximum slur height: the longer the
267 slur, the closer it is to this height.")
269 (horizontal-shift ,integer? "An integer that identifies ranking
270 of note-column for horizontal shifting. This is used by
271 @internalsref{note-collision-interface}.")
272 (avoid-slur ,symbol? "Method of handling slur collisions.
273 Choices are @code{around}, @code{inside}, @code{outside}. If unset, script
274 and slur ignore eachother.")
275 (inspect-quants ,number-pair? "If debugging is set,
276 set beam quant to this position, and print the respective scores.")
277 (implicit ,boolean? "Is this an implicit bass figure?")
278 (keep-inside-line ,boolean? "If set, this column cannot have
279 things sticking into the margin.")
280 (kern ,ly:dimension? "Amount of extra white space to add. For
281 bar line, this is the amount of space after a thick line.")
282 (knee ,boolean? "Is this beam kneed?")
283 (knee-spacing-correction ,number? "Factor for the optical
284 correction amount for kneed beams. Set between 0 for no correction and
285 1 for full correction.")
286 (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
287 (layer ,number? "The output layer [0..2]: layers define the order
288 of printing objects. Objects in lower layers are overprinted by
289 objects in higher layers.")
290 (ledger-line-thickness ,number-pair?
291 "The thickness of ledger lines: it is the
292 sum of 2 numbers. The first is the factor for line thickness, and the
293 second for staff space. Both contributions are added.")
294 (left-padding ,ly:dimension? "The amount of space that is put
295 left to a group of accidentals.")
296 (length ,ly:dimension? "User override for the stem length of
298 (length-fraction ,number? "Length of ledger line as fraction of note head size.")
300 (line-break-system-details ,list?
301 "Alist of properties to use when this
302 column is the start of a system.")
304 (line-count ,integer? "The number of staff lines.")
305 (measure-length ,ly:moment? "Length of a
306 measure. Used in some spacing situations.")
308 (measure-count ,integer? "The number of measures for a
310 (merge-differently-headed ,boolean? "Merge
311 note heads in collisions, even if they have different note heads. The
312 smaller of the two heads will be rendered invisible. This used
313 polyphonic guitar notation. The value of this setting is used by
314 @internalsref{note-collision-interface} .")
316 (merge-differently-dotted ,boolean? "Merge note heads in
317 collisions, even if they have a different number of dots. This normal
318 notation for some types of polyphonic music. ")
320 (minimum-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.")
321 (minimum-distance ,ly:dimension? "Minimum distance between rest
323 (minimum-X-extent ,number-pair? "Minimum size of an object in X
324 dimension, measured in staff space.")
325 (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
326 (minimum-length ,ly:dimension? "Try to make a spanner at least
327 this long. This requires an appropriate routine for the
328 @code{spacing-procedure} property.")
329 (minimum-space ,ly:dimension? "Minimum distance that the victim
330 should move (after padding).")
331 (neutral-direction ,ly:dir? "Which direction to take in the
332 center of the staff.")
333 (neutral-position ,number? "Position (in half staff spaces) where
334 to flip the direction of custos stem.")
336 (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
337 (note-names ,vector? "Vector of strings containing names for
338 easy-notation note heads.")
339 (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
340 (no-spacing-rods ,boolean? "Items with this property do not cause
341 spacing constraints.")
342 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
343 get stems extending to the middle staff line.")
344 (number-type ,symbol? "Type of numbers to use in label. Choices
345 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
346 (number-visibility ,boolean-or-symbol? "Like
347 @code{bracket-visibility}, but for the number.")
351 (packed-spacing ,boolean? "If set, the notes are spaced as
352 tightly as possible.")
353 (padding ,ly:dimension? "Add this much extra space between
354 objects that are next to each other.")
355 (page-penalty ,number? "Penalty for page break at
356 this column. 10000 or more means forbid linebreak, -10000 or less
357 means force page break. Other values influence page breaking decisions
359 (penalty ,number? "Penalty for line break at
360 this column. 10000 or more means forbid line break, -10000 or less
361 means force line break. Other values influence line breaking decisions
365 "Pair of staff coordinates @code{(@var{left}
366 . @var{right})}, where both @var{left} and @var{right} are in the
367 staff-space unit of the current staff.")
368 (print-function ,procedure? "Function taking grob as argument,
369 returning a @code{Stencil} object.")
371 (ratio ,number? "Parameter for slur shape. The higher this number, the
372 quicker the slur attains it @code{height-limit}.")
373 (remove-first ,boolean? "Remove the first staff of a orchestral score?")
374 (right-padding ,ly:dimension? "Space to insert between note and
376 (script-priority ,number? "A sorting key that determines in what
377 order a script is within a stack of scripts.")
379 (self-alignment-X ,number? "Specify alignment of an object. The
380 value -1 means left aligned, 0 centered, and 1 right-aligned in X
381 direction. Values in between may also be specified.")
382 (self-alignment-Y ,number? "like @code{self-alignment-X} but for
385 (shorten-pair ,number-pair? "The lengths to shorten a
386 text-spanner on both sides, for example a pedal bracket")
387 (common-shortest-duration ,ly:moment?
388 "The most common shortest note length.
389 This is used in spacing. Enlarging this will set the score tighter.")
390 (shortest-duration-space ,ly:dimension? "Start with this much
391 space for the shortest duration. This is expressed in
392 @code{spacing-increment} as unit. See also
393 @internalsref{spacing-spanner-interface}.")
394 (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
395 (shortest-starter-duration ,ly:moment? "The duration of the shortest
396 note that starts here.")
397 (side-relative-direction ,ly:dir?
398 "Multiply direction of
399 @code{direction-source} with this to get the direction of this
401 (size ,number? "Size of object, relative to standard size.")
402 (slope ,number? "The slope of this object.")
403 (slur-padding ,number? "Extra distance between slur and script.")
405 "An alist of scoring parameters for slur formatting")
406 (space-alist ,list? "A table that specifies distances between
407 prefatory items, like clef and time-signature. The format is an alist
408 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
409 . @var{distance})}, where @var{type} can be the symbols
410 @code{minimum-space} or @code{extra-space}.")
411 (space-function ,procedure? "Calculate the vertical space between
412 two beams. This function takes a beam grob and the maximum number of
415 (spacing-increment ,number? "Add this much space for a doubled
416 duration. Typically, the width of a note head. See also
417 @internalsref{spacing-spanner-interface}.")
419 (spacing-procedure ,procedure? "Procedure for calculating spacing
420 parameters. The routine is called after
421 @code{before-line-breaking-callback}.")
422 (stacking-dir ,ly:dir? "Stack objects in which direction?")
423 (staff-space ,ly:dimension? "Amount of space between staff lines,
424 expressed in global staffspace.")
425 (staff-position ,number? "Vertical position, measured in half
426 staff spaces, counted from the middle line.")
428 (stemlet-length ,number? "How long should a stem over a rest be?")
429 (stem-attachment-function ,procedure? "A function that calculates
430 where a stem attaches to the note head? This is a fallback when this
431 information is not specified in the font. The function takes a grob
432 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
433 location in terms of note head bounding box.")
435 (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
438 (stem-spacing-correction ,number? "Optical correction amount for
439 stems that are placed in tight configurations. For opposite
440 directions, this amount is the correction for two normal sized stems
441 that overlap completely.")
443 (same-direction-correction ,number? "Optical correction amount
444 for stems that are placed in tight configurations. This amount is used
445 for stems with the same direction to compensate for note-head to stem distance.")
446 (string-count ,integer? "The number of strings in a fret diagram.")
447 (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
449 (style ,symbol? "This setting determines in what style a grob is
450 typeset. Valid choices depend on the @code{print-function} that is
451 reading this property.")
452 (text ,markup? "Text markup. See @usermanref{Text markup}.")
453 ;;FIXME -- Should both be the same?
454 (text-direction ,ly:dir? "This controls the ordering of the
455 words. The default RIGHT is for roman text. Arabic or hebrew should
457 (thick-thickness ,number? "Bar line thickness, measured in
458 @code{linethickness}.")
459 (thickness ,number? "Bar line thickness, measured in
460 @code{linethickness}.")
461 (thin-kern ,number? "The space after a hair-line in a bar line.")
463 (threshold ,number-pair? "(@var{min} . @var{max}), where
464 @var{min} and @var{max} are dimensions in staff space.")
465 (tie-configuration ,list? "List of (@var{position} . @var{dir})
466 pairs, indicating the desired tie configuration.")
467 (transparent ,boolean? "This is almost the same as setting
468 @code{print-function} to @code{#f}, but this retains the dimensions of
469 this grob, which means that grobs can be erased individually.")
470 (uniform-stretching ,boolean? "If set, items stretch proportional
471 to their durations. This looks better in complex polyphonic patterns")
472 (used ,boolean? "If set, this spacing column is kept in the spacing problem")
473 (when ,ly:moment? "Global time step associated with this column
475 (word-space ,ly:dimension? "space to insert between words in texts.")
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 (zigzag-length ,ly:dimension? "The length of the lines of a
479 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
481 (zigzag-width ,ly:dimension? "The width of one
482 zigzag-squiggle. This number will be adjusted slightly so that the
483 glissando line can be constructed from a whole number of squiggles.")
485 (avoid-note-head ,boolean? "If set, the stem of a chord does not
486 pass through all note heads, but starts at the last note head. ")
487 (staff-padding ,ly:dimension?
488 "Maintain this much space between reference points
489 and the staff. Its effect is to align objects of differing
490 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
499 (define (define-internal-grob-property symbol type? description)
500 (define-grob-property symbol type? description)
501 (set-object-property! symbol 'backend-internal #t)
506 (define-public all-internal-grob-properties
509 (apply define-internal-grob-property x))
512 (axis-group-parent-X ,ly:grob? "Containing X axis group")
513 (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
514 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
515 (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")
516 (after-line-breaking ,boolean? "Dummy property, used to trigger callback for after-line-breaking")
517 (all-elements ,ly:grob-array? "list of all grobs in this line. Its
518 function is to protect objects from being garbage collected.")
519 (arpeggio ,ly:grob? "pointer to arpeggio object.")
520 (beam ,ly:grob? "pointer to the beam, if applicable.")
521 (direction-source ,ly:grob? "in case side-relative-direction is
522 set, which grob to get the direction from .")
523 (dot ,ly:grob? "reference to Dots object.")
524 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
525 (glyph-name ,string? "a name of character within font.")
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
539 (columns ,ly:grob-array? "list of grobs, typically containing
540 paper-columns or note-column objects.")
541 (conditional-elements ,ly:grob-array? "Internal use only")
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
545 where this is set in.")
546 (heads ,ly:grob-array? "List of note heads.")
547 (items-worth-living ,ly:grob-array? "A list of interesting items. If
548 empty in a particular staff, then that staff is erased.")
549 (details ,list? "alist of parameters for detailed grob behavior.")
550 (note-heads ,ly:grob-array? "List of note head grobs")
551 (note-head ,ly:grob? "A single note head")
552 (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
553 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
554 (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
555 (tuplets ,ly:grob-array? "list of smaller tuplet brackets")
557 (left-neighbors ,ly:grob-array? " List of
558 spacing-wish grobs that are close to the current column.
560 The closest spacing-wishes determine the actual distances between the
563 (right-neighbors ,ly:grob-array? "see left-neighbors")
564 (left-items ,ly:grob-array? "")
565 (right-items ,ly:grob-array? "")
566 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
567 (font ,ly:font-metric? "Cached font metric object")
569 (positioning-done ,boolean?
570 "Used to signal that a positioning element
571 did its job. This ensures that a positioning is only done once.")
574 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
575 acts as an index for looking up a Stencil object.")
577 (meta ,list? "Contains meta information. It is an alist with the
578 entries @code{name} and @code{interfaces}.")
581 ;; TODO: use interface for this!
582 (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
583 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
585 (quant-score ,string? "Beam quanting score -- can be stored for
588 (least-squares-dy ,number?
589 "ideal beam slope, without damping.")
590 (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
591 (stem-info ,pair? "caching of stem parameters")
592 (note-columns ,pair? "list of NoteColumn grobs.")
594 (position-callbacks ,list? "list of
595 functions set spanner positions.")
597 ;;; add-join would be enough if in Mensural_ligature::brew_ligature_primitive
598 ;;; the next note could be seen
599 (join-right-amount ,number? "")
601 (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")
602 (head-width ,ly:dimension? "width of this ligature head")
604 ;; [TODO: change this]
605 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
606 (stencil ,ly:stencil? "Cached output of the print-function.")
607 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
608 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
610 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
611 (shorten ,ly:dimension? "The amount of space that a
612 stem. Internally used to distribute beam shortening over stems. ")
613 (slur ,ly:grob? "A pointer to a slur object")
614 (use-breve-rest ,boolean? "Use breve rests for measures longer
618 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")
623 ;; there are too many properties for ancient notation
624 ;; probably neume-types (a list of symbols) would also work.
626 (auctum ,boolean? "is this neume augmented?")
627 (ascendens ,boolean? "is this neume of an ascending?")
628 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
629 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
630 (cavum ,boolean? "is this neume outlined?")
631 (descendens ,boolean? "is this neume of a descendent type?")
632 (deminutum ,boolean? "is this neume deminished?")
633 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
634 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
635 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
636 (linea ,boolean? "attach vertical lines to this neume?")
639 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
640 (context-info ,integer? "DOCME")
641 (inclinatum ,boolean? "is this neume an inclinatum?")
642 (oriscus ,boolean? "is this neume an oriscus?")
643 (quilisma ,boolean? "is this neume a quilisma?")
644 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
646 (prefix-set ,number? "")
647 (stropha ,boolean? "Is this neume a stropha?")
648 (virga ,boolean? "Is this neume a virga?")
649 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
651 ;; end ancient notation
655 (define-public all-backend-properties
657 all-internal-grob-properties
658 all-user-grob-properties))