1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 (define (define-grob-property symbol type? description)
20 (if (not (equal? (object-property symbol 'backend-doc) #f))
21 (ly:error (_ "symbol ~S redefined") symbol))
23 (set-object-property! symbol 'backend-type? type?)
24 (set-object-property! symbol 'backend-doc description)
27 ;; put this in an alist?
28 (define-public all-user-grob-properties
31 (apply define-grob-property x))
37 (add-stem-support ,boolean? "If set, the @code{Stem} object is
38 included in this script's support.")
39 (after-line-breaking ,boolean? "Dummy property, used to trigger
40 callback for @code{after-line-breaking}.")
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 (allow-loose-spacing ,boolean? "If set, column can be detached
45 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
46 be created below this bar line.")
47 (alteration ,number? "Alteration numbers for accidental.")
48 (alteration-alist ,list? "List of @code{(@var{pitch}
49 . @var{accidental})} pairs for key signature.")
50 (annotation ,string? "Annotate a grob for debug purposes.")
51 (annotation-balloon ,boolean? "Print the balloon around an annotation.")
52 (annotation-line ,boolean? "Print the line from an annotation to the
53 grob that it annotates.")
54 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
55 arpeggio squiggly line.")
56 (arrow-length ,number? "Arrow length.")
57 (arrow-width ,number? "Arrow width.")
58 (auto-knee-gap ,ly:dimension? "If a gap is found between note
59 heads where a horizontal beam fits that is larger than this number,
61 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
62 averaged over staves.")
63 (avoid-note-head ,boolean? "If set, the stem of a chord does not
64 pass through all note heads, but starts at the last note head.")
65 (avoid-slur ,symbol? "Method of handling slur collisions.
66 Choices are @code{inside}, @code{outside}, @code{around}, and
67 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
68 grob inside the slur. @code{outside} moves the grob vertically to the
69 outside of the slur. @code{around} moves the grob vertically to the
70 outside of the slur only if there is a collision. @code{ignore} does
71 not move either. In grobs whose notational significance depends on
72 vertical position (such as accidentals, clefs, etc.), @code{outside}
73 and @code{around} behave like @code{ignore}.")
74 (axes ,list? "List of axis numbers. In the case of alignment
75 grobs, this should contain only one number.")
81 (base-shortest-duration ,ly:moment? "Spacing is based on the
82 shortest notes in a piece. Normally, pieces are spaced as if notes at
83 least as short as this are present.")
84 (baseline-skip ,ly:dimension? "Distance between base lines of
85 multiple lines of text.")
86 (beam-thickness ,ly:dimension? "Beam thickness, measured in
87 @code{staff-space} units.")
88 (beam-width ,ly:dimension? "Width of the tremolo sign.")
89 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
90 when their direction is forced. It is a list, since the value is
91 different depending on the number of flags and beams.")
92 (beaming ,pair? "Pair of number lists. Each number list
93 specifies which beams to make. @code{0}@tie{}is the central beam,
94 @code{1}@tie{}is the next beam toward the note, etc. This information
95 is used to determine how to connect the beaming patterns from stem to
97 (beamlet-default-length ,pair? "A pair of numbers. The first
98 number specifies the default length of a beamlet that sticks out of
99 the left hand side of this stem; the second number specifies the
100 default length of the beamlet to the right. The actual length of a
101 beamlet is determined by taking either the default length or the
102 length specified by @code{beamlet-max-length-proportion}, whichever is
104 (beamlet-max-length-proportion ,pair? "The maximum length of a
105 beamlet, as a proportion of the distance between two adjacent stems.")
106 (before-line-breaking ,boolean? "Dummy property, used to trigger
107 a callback function.")
108 (between-cols ,pair? "Where to attach a loose column to.")
109 (bound-details ,list? "An alist of properties for determining
110 attachments of spanners to edges.")
111 (bound-padding ,number? "The amount of padding to insert around
113 (bracket-flare ,number-pair? "A pair of numbers specifying how
114 much edges of brackets should slant outward. Value @code{0.0} means
116 (bracket-visibility ,boolean-or-symbol? "This controls the
117 visibility of the tuplet bracket. Setting it to false prevents
118 printing of the bracket. Setting the property to @code{if-no-beam}
119 makes it print only if there is no beam associated with this tuplet
121 (break-align-anchor ,number? "Grobs aligned to this break-align
122 grob will have their X-offsets shifted by this number. In bar lines,
123 for example, this is used to position grobs relative to the (visual)
124 center of the bar line.")
125 (break-align-anchor-alignment ,number? "Read by
126 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
127 aligning an anchor to a grob's extent.")
128 (break-align-orders ,vector? "Defines the order in which
129 prefatory matter (clefs, key signatures) appears. The format is a
130 vector of length@tie{}3, where each element is one order for
131 end-of-line, middle of line, and start-of-line, respectively. An
132 order is a list of symbols.
134 For example, clefs are put after key signatures by setting
137 \\override Score.BreakAlignment #'break-align-orders =
138 #(make-vector 3 '(span-bar
145 (break-align-symbol ,symbol? "This key is used for aligning and
146 spacing breakable items.")
147 (break-align-symbols ,list? "A list of symbols that determine
148 which break-aligned grobs to align this to. If the grob selected by
149 the first symbol in the list is invisible due to break-visibility, we
150 will align to the next grob (and so on). Choices are @code{left-edge},
151 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
152 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
154 (break-overshoot ,number-pair? "How much does a broken spanner
155 stick out of its bounds?")
156 (break-visibility ,vector? "A vector of 3@tie{}booleans,
157 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
158 @code{#t} means visible, @code{#f} means killed.")
159 (breakable ,boolean? "Allow breaks here.")
165 (c0-position ,integer? "An integer indicating the position of
167 (circled-tip ,boolean? "Put a circle at start/end of
168 hairpins (al/del niente).")
169 (clip-edges ,boolean? "Allow outward pointing beamlets at the
171 (collapse-height ,ly:dimension? "Minimum height of system start
172 delimiter. If equal or smaller, the bracket/brace/line is removed.")
173 (collision-interfaces ,list? "A list of interfaces for which
174 automatic beam-collision resolution is run.")
175 (collision-voice-only ,boolean? "Does automatic beam collsion apply
176 only to the voice in which the beam was created?")
177 (color ,color? "The color of this grob.")
178 (common-shortest-duration ,ly:moment? "The most common shortest
179 note length. This is used in spacing. Enlarging this sets the score
181 (concaveness ,number? "A beam is concave if its inner stems are
182 closer to the beam than the two outside stems. This number is a
183 measure of the closeness of the inner stems. It is used for damping
184 the slope of the beam.")
185 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
186 this grob looks as a continued break.")
187 (control-points ,list? "List of offsets (number pairs) that form
188 control points for the tie, slur, or bracket shape. For B@'eziers,
189 this should list the control points of a third-order B@'ezier curve.")
194 (damping ,number? "Amount of beam slope damping.")
195 (dash-definition ,pair? "List of @code{dash-elements} defining the
196 dash structure. Each @code{dash-element} has a starting t value,
197 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
198 (dash-fraction ,number? "Size of the dashes, relative to
199 @code{dash-period}. Should be between @code{0.0} (no line) and
200 @code{1.0} (continuous line).")
201 (dash-period ,number? "The length of one dash together with
202 whitespace. If negative, no line is drawn at all.")
203 (default-direction ,ly:dir? "Direction determined by note head
205 (default-staff-staff-spacing ,list? "The settings to use for
206 @code{staff-staff-spacing} when it is unset, for ungrouped staves
207 and for grouped staves that do not have the relevant
208 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
209 @code{staffgroup-staff-spacing}).")
210 (details ,list? "Alist of parameters for detailed grob behavior.
211 More information on the allowed parameters for a grob can be found by
212 looking at the top of the Internals Reference page for each interface
213 having a @code{details} property.")
214 (digit-names ,vector? "Names for string finger digits.")
215 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
216 @code{#X}), then this property determines whether the object is placed
217 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
218 other object. Otherwise, it determines whether the object is placed
219 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
220 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
221 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
222 @code{#CENTER}=@code{0}.")
223 (dot-count ,integer? "The number of dots.")
224 (dot-negative-kern ,number? "The space to remove between a dot
225 and a slash in percent repeat glyphs. Larger values bring the two
226 elements closer together.")
227 (dot-placement-list ,list? "List consisting of
228 @code{(@var{description} @var{string-number} @var{fret-number}
229 @var{finger-number})} entries used to define fret diagrams.")
230 (duration-log ,integer? "The 2-log of the note head duration,
231 i.e., @code{0} = whole note, @code{1} = half note, etc.")
237 (eccentricity ,number? "How asymmetrical to make a slur.
238 Positive means move the center to the right.")
239 (edge-height ,pair? "A pair of numbers specifying the heights of
240 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
241 (edge-text ,pair? "A pair specifying the texts to be set at the
242 edges: @code{(@var{left-text} . @var{right-text})}.")
243 (expand-limit ,integer? "Maximum number of measures expanded in
246 (extra-dy ,number? "Slope glissandi this much extra.")
247 (extra-offset ,number-pair? "A pair representing an offset. This
248 offset is added just before outputting the symbol, so the typesetting
249 engine is completely oblivious to it. The values are measured in
250 @code{staff-space} units of the staff's @code{StaffSymbol}.")
251 (extra-spacing-height ,number-pair? "In the horizontal spacing
252 problem, we increase the height of each item by this amount (by adding
253 the @q{car} to the bottom of the item and adding the @q{cdr} to the
254 top of the item). In order to make a grob infinitely high (to prevent
255 the horizontal spacing problem from placing any other grobs above or
256 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
257 (extra-spacing-width ,number-pair? "In the horizontal spacing
258 problem, we pad each item by this amount (by adding the @q{car} on the
259 left side of the item and adding the @q{cdr} on the right side of the
260 item). In order to make a grob take up no horizontal space at all,
261 set this to @code{(+inf.0 . -inf.0)}.")
262 (extra-X-extent ,number-pair? "A grob is enlarged in
263 X@tie{}dimension by this much.")
264 (extra-Y-extent ,number-pair? "A grob is enlarged in
265 Y@tie{}dimension by this much.")
271 (flag ,ly:stencil? "A function returning the full flag stencil
272 for the @code{Stem}, which is passed to the function as the only
273 argument. The default ly:stem::calc-stencil function uses the
274 @code{flag-style} property to determine the correct glyph for the
275 flag. By providing your own function, you can create arbitrary
277 (flag-count ,number? "The number of tremolo beams.")
278 (flag-style ,symbol? "A symbol determining what style of flag
279 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
280 for standard flags, @code{'mensural} and @code{'no-flag}, which
281 switches off the flag.")
282 (font-encoding ,symbol? "The font encoding is the broadest
283 category for selecting a font. Currently, only lilypond's system
284 fonts (Emmentaler) are using this property. Available
285 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
286 @code{fetaText} (Emmentaler).")
287 (font-family ,symbol? "The font family is the broadest category
288 for selecting text fonts. Options include: @code{sans},
290 (font-name ,string? "Specifies a file name (without extension) of
291 the font to load. This setting overrides selection using
292 @code{font-family}, @code{font-series} and @code{font-shape}.")
293 (font-series ,symbol? "Select the series of a font. Choices
294 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
295 (font-shape ,symbol? "Select the shape of a font. Choices
296 include @code{upright}, @code{italic}, @code{caps}.")
297 (font-size ,number? "The font size, compared to the
298 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
299 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
300 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
301 larger. Fractional values are allowed.")
302 (footnote-text ,markup? "A footnote for the grob.")
303 (force-hshift ,number? "This specifies a manual shift for notes
304 in collisions. The unit is the note head width of the first voice
305 note. This is used by @rinternals{note-collision-interface}.")
306 (fraction ,number-pair? "Numerator and denominator of a time
308 (french-beaming ,boolean? "Use French beaming style for this
309 stem. The stem stops at the innermost beams.")
310 (fret-diagram-details ,list? "An alist of detailed grob
311 properties for fret diagrams. Each alist entry consists of a
312 @code{(@var{property} . @var{value})} pair. The properties which can
313 be included in @code{fret-diagram-details} include the following:
317 @code{barre-type} -- Type of barre indication used. Choices include
318 @code{curved}, @code{straight}, and @code{none}. Default
321 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
322 fret-space. Default value@tie{}0.5.
324 @code{dot-color} -- Color of dots. Options include @code{black} and
325 @code{white}. Default @code{black}.
327 @code{dot-label-font-mag} -- Magnification for font used to label fret
328 dots. Default value@tie{}1.
330 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
331 dots without labels, 0.95-@code{dot-radius} for dots with labels.
333 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
334 value 0.425 for labeled dots, 0.25 for unlabeled dots.
336 @code{finger-code} -- Code for the type of fingering indication used.
337 Options include @code{none}, @code{in-dot}, and @code{below-string}.
338 Default @code{none} for markup fret diagrams, @code{below-string} for
339 @code{FretBoards} fret diagrams.
341 @code{fret-count} -- The number of frets. Default@tie{}4.
343 @code{fret-label-custom-format} -- The format string to be used label
344 the lowest fret number, when @code{number-type} equals to
345 @code{custom}. Default@tie{}\"~a\".
347 @code{fret-label-font-mag} -- The magnification of the font used to
348 label the lowest fret number. Default@tie{}0.5.
350 @code{fret-label-vertical-offset} -- The offset of the fret label from
351 the center of the fret in direction parallel to strings.
354 @code{label-dir} -- Side to which the fret label is attached.
355 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
356 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
358 @code{mute-string} -- Character string to be used to indicate muted
359 string. Default @code{\"x\"}.
361 @code{number-type} -- Type of numbers to use in fret label. Choices
362 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
363 @code{custom}. In the later case, the format string is supplied by
364 the @code{fret-label-custom-format} property.
365 Default @code{roman-lower}.
367 @code{open-string} -- Character string to be used to indicate open
368 string. Default @code{\"o\"}.
370 @code{orientation} -- Orientation of fret-diagram. Options include
371 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
372 Default @code{normal}.
374 @code{string-count} -- The number of strings. Default@tie{}6.
376 @code{string-label-font-mag} -- The magnification of the font used to
377 label fingerings at the string, rather than in the dot. Default value
378 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
379 @code{opposing-landscape}.
381 @code{string-thickness-factor} -- Factor for changing thickness of
382 each string in the fret diagram. Thickness of string @var{k} is given
384 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
387 @code{top-fret-thickness} -- The thickness of the top fret line, as a
388 multiple of the standard thickness. Default value@tie{}3.
390 @code{xo-font-magnification} -- Magnification used for mute and open
391 string indicators. Default value@tie{}0.5.
393 @code{xo-padding} -- Padding for open and mute indicators from top
394 fret. Default value 0.25.
396 ;; ugh: double, change.
397 (full-length-padding ,number? "How much padding to use at the
398 right side of a full-length tuplet bracket.")
399 (full-length-to-extent ,boolean? "Run to the extent of the column
400 for a full-length tuplet bracket.")
401 (full-measure-extra-space ,number? "Extra space that is allocated
402 at the beginning of a measure with only one note. This property is
403 read from the NonMusicalPaperColumn that begins the measure.")
404 (full-size-change ,boolean? "Don't make a change clef smaller.")
410 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
411 (gap-count ,integer? "Number of gapped beams for tremolo.")
412 (glyph ,string? "A string determining what @q{style} of glyph is
413 typeset. Valid choices depend on the function that is reading this
415 (glyph-name ,string? "The glyph name within the font.")
416 (glyph-name-alist ,list? "An alist of key-string pairs.")
417 (graphical ,boolean? "Display in graphical (vs. text) form.")
418 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
424 (hair-thickness ,number? "Thickness of the thin line in a bar
426 (harp-pedal-details ,list? "An alist of detailed grob properties
427 for harp pedal diagrams. Each alist entry consists of a
428 @code{(@var{property} . @var{value})} pair. The properties which can
429 be included in harp-pedal-details include the following:
433 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
434 boxes above/below the horizontal line. Default value@tie{}0.8.
436 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
438 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
440 @code{space-before-divider} -- Space between boxes before the first
441 divider (so that the diagram can be made symmetric). Default
444 @code{space-after-divider} -- Space between boxes after the first
445 divider. Default value@tie{}0.8.
447 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
448 of the ellipse around circled pedals. Default value@tie{}0.5.
450 @code{circle-x-padding} -- Padding in X direction of the ellipse
451 around circled pedals. Default value 0.15.
453 @code{circle-y-padding} -- Padding in Y direction of the ellipse
454 around circled pedals. Default value@tie{}0.2.
456 (head-direction ,ly:dir? "Are the note heads left or right in a
458 (height ,ly:dimension? "Height of an object in @code{staff-space}
460 (height-limit ,ly:dimension? "Maximum slur height: The longer the
461 slur, the closer it is to this height.")
462 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
463 that appears on a tied note after a line break will not be displayed.")
464 (horizontal-shift ,integer? "An integer that identifies ranking
465 of @code{NoteColumn}s for horizontal shifting. This is used by
466 @rinternals{note-collision-interface}.")
467 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
468 left and one to the right of this grob.")
474 (ignore-collision ,boolean? "If set, don't do note collision
475 resolution on this @code{NoteColumn}.")
476 (implicit ,boolean? "Is this an implicit bass figure?")
477 (inspect-index ,integer? "If debugging is set, set beam and slur
478 configuration to this index, and print the respective scores.")
479 (inspect-quants ,number-pair? "If debugging is set, set beam and
480 slur quants to this position, and print the respective scores.")
486 (keep-inside-line ,boolean? "If set, this column cannot have
487 objects sticking into the margin.")
488 (kern ,ly:dimension? "Amount of extra white space to add. For
489 bar lines, this is the amount of space after a thick line.")
490 (knee ,boolean? "Is this beam kneed?")
491 (knee-spacing-correction ,number? "Factor for the optical
492 correction amount for kneed beams. Set between @code{0} for no
493 correction and @code{1} for full correction.")
499 (labels ,list? "List of labels (symbols) placed on a column.")
500 (layer ,integer? "An integer which determines the order of printing
501 objects. Objects with the lowest value of layer are drawn first, then
502 objects with progressively higher values are drawn, so objects with
503 higher values overwrite objects with lower values. By default most
504 objects are assigned a layer value of 1.")
505 (ledger-line-thickness ,number-pair? "The thickness of ledger
506 lines. It is the sum of 2@tie{}numbers: The first is the factor for
507 line thickness, and the second for staff space. Both contributions
509 (left-bound-info ,list? "An alist of properties for determining
510 attachments of spanners to edges.")
511 (left-padding ,ly:dimension? "The amount of space that is put
512 left to an object (e.g., a lyric extender).")
513 (length ,ly:dimension? "User override for the stem length of
515 (length-fraction ,number? "Multiplier for lengths. Used for
516 determining ledger lines and stem lengths.")
517 (line-break-penalty ,number? "Penalty for a line break at this
518 column. This affects the choices of the line breaker; it avoids a
519 line break at a column with a positive penalty and prefers a line
520 break at a column with a negative penalty.")
521 (line-break-permission ,symbol? "Instructs the line breaker on
522 whether to put a line break at this column. Can be @code{force} or
524 (line-break-system-details ,list? "An alist of properties to use
525 if this column is the start of a system.")
526 (line-count ,integer? "The number of staff lines.")
527 (line-positions ,list? "Vertical positions of staff lines.")
528 (line-thickness ,number? "The thickness of the tie or slur
530 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
536 (max-beam-connect ,integer? "Maximum number of beams to connect
537 to beams from this stem. Further beams are typeset as beamlets.")
538 (max-stretch ,number? "The maximum amount that this
539 @code{VerticalAxisGroup} can be vertically stretched (for example, in
540 order to better fill a page).")
541 (measure-count ,integer? "The number of measures for a
542 multi-measure rest.")
543 (measure-length ,ly:moment? "Length of a measure. Used in some
544 spacing situations.")
545 (merge-differently-dotted ,boolean? "Merge note heads in
546 collisions, even if they have a different number of dots. This is
547 normal notation for some types of polyphonic music.
549 @code{merge-differently-dotted} only applies to opposing stem
550 directions (i.e., voice 1 &@tie{}2).")
551 (merge-differently-headed ,boolean? "Merge note heads in
552 collisions, even if they have different note heads. The smaller of
553 the two heads is rendered invisible. This is used in polyphonic
554 guitar notation. The value of this setting is used by
555 @rinternals{note-collision-interface}.
557 @code{merge-differently-headed} only applies to opposing stem
558 directions (i.e., voice 1 &@tie{}2).")
559 (minimum-distance ,ly:dimension? "Minimum distance between rest
561 (minimum-length ,ly:dimension? "Try to make a spanner at least
562 this long, normally in the horizontal direction. This requires an
563 appropriate callback for the @code{springs-and-rods} property. If
564 added to a @code{Tie}, this sets the minimum distance between
566 (minimum-length-fraction ,number? "Minimum length of ledger line
567 as fraction of note head size.")
568 (minimum-space ,ly:dimension? "Minimum distance that the victim
569 should move (after padding).")
570 (minimum-X-extent ,number-pair? "Minimum size of an object in
571 X@tie{}dimension, measured in @code{staff-space} units.")
572 (minimum-Y-extent ,number-pair? "Minimum size of an object in
573 Y@tie{}dimension, measured in @code{staff-space} units.")
579 (neutral-direction ,ly:dir? "Which direction to take in the
580 center of the staff.")
581 (neutral-position ,number? "Position (in half staff spaces) where
582 to flip the direction of custos stem.")
583 (next ,ly:grob? "Object that is next relation (e.g., the lyric
584 syllable following an extender).")
585 (no-alignment ,boolean? "If set, don't place this grob in a
586 @code{VerticalAlignment}; rather, place it using its own
587 @code{Y-offset} callback.")
588 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
590 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
591 get stems extending to the middle staff line.")
592 (non-break-align-symbols ,list? "A list of symbols that determine
593 which NON-break-aligned interfaces to align this to.")
594 (non-default ,boolean? "Set for manually specified clefs.")
595 (non-musical ,boolean? "True if the grob belongs to a
596 @code{NonMusicalPaperColumn}.")
597 (nonstaff-nonstaff-spacing ,list? "The spacing alist
598 controlling the distance between the current non-staff line and
599 the next non-staff line in the direction of @code{staff-affinity},
600 if both are on the same side of the related staff, and
601 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
602 @code{staff-staff-spacing} for a description of the alist
604 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
605 controlling the distance between the current non-staff line and
606 the nearest staff in the direction of @code{staff-affinity}, if
607 there are no non-staff lines between the two, and
608 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
609 @code{staff-affinity} is @code{CENTER}, then
610 @code{nonstaff-relatedstaff-spacing} is used for the nearest
611 staves on @emph{both} sides, even if other non-staff lines appear
612 between the current one and either of the staves. See
613 @code{staff-staff-spacing} for a description of the alist
615 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
616 controlling the distance between the current non-staff line and
617 the nearest staff in the opposite direction from
618 @code{staff-affinity}, if there are no other non-staff lines
619 between the two, and @code{staff-affinity} is either @code{UP} or
620 @code{DOWN}. See @code{staff-staff-spacing} for a description of
621 the alist structure.")
622 (normalized-endpoints ,pair? "Represents left and right placement
623 over the total spanner, where the width of the spanner is normalized
625 (note-names ,vector? "Vector of strings containing names for
626 easy-notation note heads.")
632 (outside-staff-horizontal-padding ,number? "By default, an
633 outside-staff-object can be placed so that is it very close to another
634 grob horizontally. If this property is set, the outside-staff-object
635 is raised so that it is not so close to its neighbor.")
636 (outside-staff-padding ,number? "The padding to place between
637 this grob and the staff when spacing according to
638 @code{outside-staff-priority}.")
639 (outside-staff-priority ,number? "If set, the grob is positioned
640 outside the staff in such a way as to avoid all collisions. In case
641 of a potential collision, the grob with the smaller
642 @code{outside-staff-priority} is closer to the staff.")
648 (packed-spacing ,boolean? "If set, the notes are spaced as
649 tightly as possible.")
650 (padding ,ly:dimension? "Add this much extra space between
651 objects that are next to each other.")
652 (padding-pairs ,list? "An alist mapping @code{(@var{name}
653 . @var{name})} to distances.")
654 (page-break-penalty ,number? "Penalty for page break at this
655 column. This affects the choices of the page breaker; it avoids a
656 page break at a column with a positive penalty and prefers a page
657 break at a column with a negative penalty.")
658 (page-break-permission ,symbol? "Instructs the page breaker on
659 whether to put a page break at this column. Can be @code{force} or
661 (page-turn-penalty ,number? "Penalty for a page turn at this
662 column. This affects the choices of the page breaker; it avoids a
663 page turn at a column with a positive penalty and prefers a page turn
664 at a column with a negative penalty.")
665 (page-turn-permission ,symbol? "Instructs the page breaker on
666 whether to put a page turn at this column. Can be @code{force} or
668 (parenthesized ,boolean? "Parenthesize this grob.")
669 (positions ,number-pair? "Pair of staff coordinates
670 @code{(@var{left} . @var{right})}, where both @var{left} and
671 @var{right} are in @code{staff-space} units of the current staff. For
672 slurs, this value selects which slur candidate to use; if extreme
673 positions are requested, the closest one is taken.")
674 (prefer-dotted-right ,boolean? "For note collisions, prefer to
675 shift dotted up-note to the right, rather than shifting just the
682 (ratio ,number? "Parameter for slur shape. The higher this
683 number, the quicker the slur attains its @code{height-limit}.")
684 (remove-empty ,boolean? "If set, remove group if it contains no
686 (remove-first ,boolean? "Remove the first staff of an orchestral
688 (restore-first ,boolean? "Print a natural before the
690 (rhythmic-location ,rhythmic-location? "Where (bar number,
691 measure position) in the score.")
692 (right-bound-info ,list? "An alist of properties for determining
693 attachments of spanners to edges.")
694 (right-padding ,ly:dimension? "Space to insert on the right side
695 of an object (e.g., between note and its accidentals).")
696 (rotation ,list? "Number of degrees to rotate this object, and
697 what point to rotate around. For example, @code{#'(45 0 0)} rotates
698 by 45 degrees around the center of this object.")
704 (same-direction-correction ,number? "Optical correction amount
705 for stems that are placed in tight configurations. This amount is
706 used for stems with the same direction to compensate for note head to
708 (script-priority ,number? "A sorting key that determines in what
709 order a script is within a stack of scripts.")
710 (self-alignment-X ,number? "Specify alignment of an object. The
711 value @code{-1} means left aligned, @code{0}@tie{}centered, and
712 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
713 values may also be specified.")
714 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
716 (shorten-pair ,number-pair? "The lengths to shorten a
717 text-spanner on both sides, for example a pedal bracket. Positive
718 values shorten the text-spanner, while negative values lengthen it.")
719 (shortest-duration-space ,ly:dimension? "Start with this much
720 space for the shortest duration. This is expressed in
721 @code{spacing-increment} as unit. See also
722 @rinternals{spacing-spanner-interface}.")
723 (shortest-playing-duration ,ly:moment? "The duration of the
724 shortest note playing here.")
725 (shortest-starter-duration ,ly:moment? "The duration of the
726 shortest note that starts here.")
727 (side-axis ,number? "If the value is @code{#X} (or
728 equivalently@tie{}@code{0}), the object is placed horizontally next to
729 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
731 (side-relative-direction ,ly:dir? "Multiply direction of
732 @code{direction-source} with this to get the direction of this
734 (size ,number? "Size of object, relative to standard size.")
735 (skyline-horizontal-padding ,number? "For determining the
736 vertical distance between two staves, it is possible to have a
737 configuration which would result in a tight interleaving of grobs from
738 the top staff and the bottom staff. The larger this parameter is, the
739 farther apart the staves are placed in such a configuration.")
740 (skyline-vertical-padding ,number? "The amount by which the left
741 and right skylines of a column are padded vertically, beyond the
742 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
743 grobs in the column. Increase this to prevent interleaving of grobs
744 from adjacent columns.")
745 (slash-negative-kern ,number? "The space to remove between
746 slashes in percent repeat glyphs. Larger values bring the two
747 elements closer together.")
748 (slope ,number? "The slope of this object.")
749 (slur-padding ,number? "Extra distance between slur and script.")
750 (space-alist ,list? "A table that specifies distances between
751 prefatory items, like clef and time-signature. The format is an alist
752 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
753 . @var{distance})}, where @var{type} can be the symbols
754 @code{minimum-space} or @code{extra-space}.")
755 (space-to-barline ,boolean? "If set, the distance between a note
756 and the following non-musical column will be measured to the bar line
757 instead of to the beginning of the non-musical column. If there is a
758 clef change followed by a bar line, for example, this means that we
759 will try to space the non-musical column as though the clef is not
761 (spacing-increment ,number? "Add this much space for a doubled
762 duration. Typically, the width of a note head. See also
763 @rinternals{spacing-spanner-interface}.")
764 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
765 spacing relative to its left and right @code{BreakAlignment}s.
767 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
768 bounds (i.e., clefs, key signatures and time signatures) using the following
772 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
774 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
775 (springs-and-rods ,boolean? "Dummy variable for triggering
777 (stacking-dir ,ly:dir? "Stack objects in which direction?")
778 (staff-affinity ,ly:dir? "The direction of the staff to use
779 for spacing the current non-staff line. Choices are @code{UP},
780 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
781 line will be placed equidistant between the two nearest staves on
782 either side, unless collisions or other spacing constraints
783 prevent this. Setting @code{staff-affinity} for a staff causes it
784 to be treated as a non-staff line. Setting @code{staff-affinity}
785 to @code{#f} causes a non-staff line to be treated as a staff.")
786 (staff-padding ,ly:dimension? "Maintain this much space between
787 reference points and the staff. Its effect is to align objects of
788 differing sizes (like the dynamics @b{p} and @b{f}) on their
790 (staff-position ,number? "Vertical position, measured in half
791 staff spaces, counted from the middle line.")
792 (staff-space ,ly:dimension? "Amount of space between staff lines,
793 expressed in global @code{staff-space}.")
794 (staff-staff-spacing ,list? "When applied to a staff-group's
795 @code{StaffGrouper} grob, this spacing alist controls the distance
796 between consecutive staves within the staff-group. When applied
797 to a staff's @code{VerticalAxisGroup} grob, it controls the
798 distance between the staff and the nearest staff below it in the
799 same system, replacing any settings inherited from the
800 @code{StaffGrouper} grob of the containing staff-group, if there
801 is one. This property remains in effect even when non-staff lines
802 appear between staves. The alist can contain the following keys:
807 @code{basic-distance} -- the vertical distance, measured in
808 staff-spaces, between the reference points of the two items when
809 no collisions would result, and no stretching or compressing is in
813 @code{minimum-distance} -- the smallest allowable vertical
814 distance, measured in staff-spaces, between the reference points
815 of the two items, when compressing is in effect.
818 @code{padding} -- the minimum required amount of unobstructed
819 vertical whitespace between the bounding boxes (or skylines) of
820 the two items, measured in staff-spaces.
823 @code{stretchability} -- a unitless measure of the dimension's
824 relative propensity to stretch. If zero, the distance will not
825 stretch (unless collisions would result).
828 (staffgroup-staff-spacing ,list? "The spacing alist
829 controlling the distance between the last staff of the current
830 staff-group and the staff just below it in the same system, even
831 if one or more non-staff lines exist between the two staves. If
832 the @code{staff-staff-spacing} property of the staff's
833 @code{VerticalAxisGroup} grob is set, that is used instead. See
834 @code{staff-staff-spacing} for a description of the alist
836 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
837 pair where the stem attaches to the notehead.")
838 (stem-end-position ,number? "Where does the stem end (the end is
839 opposite to the support-head)?")
841 (stem-spacing-correction ,number? "Optical correction amount for
842 stems that are placed in tight configurations. For opposite
843 directions, this amount is the correction for two normal sized stems
844 that overlap completely.")
845 (stemlet-length ,number? "How long should be a stem over a
847 (stencil ,ly:stencil? "The symbol to print.")
848 (stencils ,list? "Multiple stencils, used as intermediate
850 (strict-grace-spacing ,boolean? "If set, main notes are spaced
851 normally, then grace notes are put left of the musical columns for the
853 (strict-note-spacing ,boolean? "If set, unbroken columns with
854 non-musical material (clefs, bar lines, etc.) are not spaced
855 separately, but put before musical columns.")
856 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
858 (style ,symbol? "This setting determines in what style a grob is
859 typeset. Valid choices depend on the @code{stencil} callback reading
866 (text ,markup? "Text markup. See @ruser{Formatting text}.")
867 ;;FIXME -- Should both be the same?
868 (text-direction ,ly:dir? "This controls the ordering of the
869 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
870 should use @code{LEFT}.")
871 (thick-thickness ,number? "Bar line thickness, measured in
872 @code{line-thickness}.")
873 (thickness ,number? "Line thickness, generally measured in
874 @code{line-thickness}.")
875 (thin-kern ,number? "The space after a hair-line in a bar line.")
876 (tie-configuration ,list? "List of @code{(@var{position} .
877 @var{dir})} pairs, indicating the desired tie configuration, where
878 @var{position} is the offset from the center of the staff in staff
879 space and @var{dir} indicates the direction of the tie
880 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
881 in the list causes the corresponding tie to be formatted
883 (to-barline ,boolean? "If true, the spanner will stop at the bar
884 line just before it would otherwise stop.")
885 (toward-stem-shift ,number? "Amount by which scripts are shifted
886 toward the stem if their direction coincides with the stem direction.
887 @code{0.0} means keep the default position (centered on the note
888 head), @code{1.0} means centered on the stem. Interpolated values are
890 (transparent ,boolean? "This makes the grob invisible.")
896 (uniform-stretching ,boolean? "If set, items stretch
897 proportionally to their durations. This looks better in complex
898 polyphonic patterns.")
899 (used ,boolean? "If set, this spacing column is kept in the
906 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
907 one below this grob.")
913 (when ,ly:moment? "Global time step associated with this column
915 (whiteout ,boolean? "If true, the grob is printed over a white
916 background to white-out underlying material, if the grob is visible.
917 Usually #f by default.")
918 (width ,ly:dimension? "The width of a grob measured in staff
920 (word-space ,ly:dimension? "Space to insert between words in
927 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
928 (X-offset ,number? "The horizontal amount that this object is
929 moved relative to its X-parent.")
935 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
936 (Y-offset ,number? "The vertical amount that this object is moved
937 relative to its Y-parent.")
942 (zigzag-length ,ly:dimension? "The length of the lines of a
943 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
944 gives 60-degree zigzags.")
945 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
946 This number is adjusted slightly so that the glissando line can be
947 constructed from a whole number of squiggles.")
955 (define (define-internal-grob-property symbol type? description)
956 (define-grob-property symbol type? description)
957 (set-object-property! symbol 'backend-internal #t)
962 (define-public all-internal-grob-properties
965 (apply define-internal-grob-property x))
969 ;; grobs & grob arrays. (alphabetical)
970 (accidental-grob ,ly:grob? "The accidental for this note.")
971 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
972 @var{groblist})} entries.")
973 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
975 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
976 function is to protect objects from being garbage collected.")
977 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
978 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
979 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
981 (bars ,ly:grob-array? "An array of bar line pointers.")
982 (beam ,ly:grob? "A pointer to the beam, if applicable.")
983 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
984 column as start/begin point. Only columns that have grobs or act as
986 (bracket ,ly:grob? "The bracket for a number.")
988 (columns ,ly:grob-array? "An array of grobs, typically containing
989 @code{PaperColumn} or @code{NoteColumn} objects.")
990 (conditional-elements ,ly:grob-array? "Internal use only.")
991 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
994 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
995 set, which grob to get the direction from.")
996 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
997 (dot ,ly:grob? "A reference to a @code{Dots} object.")
998 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1000 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1001 the grob where this is set in.")
1002 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1003 in addition to notes and stems.")
1005 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1007 (glissando-index ,integer? "The index of a glissando in its note
1009 (grace-spacing ,ly:grob? "A run of grace notes.")
1011 (heads ,ly:grob-array? "An array of note heads.")
1013 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1014 empty in a particular staff, then that staff is erased.")
1016 (keep-alive-with ,ly:grob-array? "An array of other
1017 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1019 (left-items ,ly:grob-array? "DOCME")
1020 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1023 (normal-stems ,ly:grob-array? "An array of visible stems.")
1024 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1025 (note-head ,ly:grob? "A single note head.")
1026 (note-heads ,ly:grob-array? "An array of note head grobs.")
1027 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1029 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1030 that are relevant for finding the @code{pure-Y-extent}")
1031 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1032 relevant for finding the @code{pure-Y-extent}.")
1033 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1034 relevant for finding the @code{pure-Y-extent}.")
1035 (pure-Y-common ,ly:grob? "A cache of the
1036 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1038 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1039 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1040 (rests ,ly:grob-array? "An array of rest objects.")
1041 (right-items ,ly:grob-array? "DOCME")
1042 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1044 (side-support-elements ,ly:grob-array? "The side support, an array of
1046 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1047 (spacing ,ly:grob? "The spacing spanner governing this section.")
1048 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1050 (span-start ,boolean? "Is the note head at the start of a spanner?")
1051 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1052 LEFT is for the first spanner, and RIGHT is for the last. CENTER will
1053 place it on the broken spanner that falls closest to the center of the length
1054 of the entire spanner, although this behavior is unpredictable in situations
1055 with lots of rhythmic diversity. For predictable results, use LEFT and RIGHT.")
1056 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1057 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1058 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1059 (stems ,ly:grob-array? "An array of stem objects.")
1061 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1062 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1063 (tuplet-number ,ly:grob? "The number for a bracket.")
1064 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1065 (X-common ,ly:grob? "Common reference point for axis group.")
1066 (Y-common ,ly:grob? "See @code{X-common}.")
1070 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1071 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1074 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1075 This may differ from @code{Y-extent} because it does not include the dots in
1076 a repeat bar line.")
1077 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1078 @code{FretBoard} be visible only at beginning of line or at
1081 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1082 translator) that was the cause for this grob.")
1083 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1084 depend on inter-staff spacing.")
1086 (delta-position ,number? "The vertical position difference.")
1088 (font ,ly:font-metric? "A cached font metric object.")
1089 (forced ,boolean? "Manually forced accidental.")
1091 (head-width ,ly:dimension? "The width of this ligature head.")
1093 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1094 @var{strength}))} pairs.")
1095 (important-column-ranks ,vector? "A cache of columns that contain
1096 @code{items-worth-living} data.")
1097 (interfaces ,list? "A list of symbols indicating the interfaces
1098 supported by this object. It is initialized from the @code{meta} field.")
1100 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1102 (maybe-loose ,boolean? "Used to mark a breakable column that is
1103 loose if and only if it is in the middle of a line.")
1104 (meta ,list? "Provide meta information. It is an alist with the
1105 entries @code{name} and @code{interfaces}.")
1106 (minimum-distances ,list? "A list of rods that have the format
1107 @code{(@var{obj} . @var{dist})}.")
1109 (positioning-done ,boolean? "Used to signal that a positioning element
1110 did its job. This ensures that a positioning is only done once.")
1111 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1112 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1113 cyclic dependencies.")
1114 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1115 to be within staff spaces.")
1116 (quantized-positions ,number-pair? "The beam positions after
1119 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1120 acts as an index for looking up a @code{Stencil} object.")
1121 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1122 Internally used to distribute beam shortening over stems.")
1123 (stem-info ,pair? "A cache of stem parameters.")
1124 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1125 top-margin of the page) of the system to which this staff belongs.")
1127 (use-breve-rest ,boolean? "Use breve rests for measures longer
1128 than a whole rest.")
1134 ;; There are too many properties for ancient notation;
1135 ;; probably neume-types (a list of symbols) would also work.
1137 ;; However, such a list would consist of a couple of dozens of
1138 ;; entries, since head prefixes may be combined in many ways. If
1139 ;; the macros in `gregorian.ly' would directly set prefix-set,
1140 ;; all the head prefixes could be junked; however, such macros
1141 ;; would be quite numerous, I guess. --jr
1143 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1145 (add-join ,boolean? "Is this ligature head-joined with the next one
1146 by a vertical line?")
1147 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1148 an additional stem on the right side?")
1149 (ascendens ,boolean? "Is this neume of ascending type?")
1150 (auctum ,boolean? "Is this neume liquescentically augmented?")
1152 (cavum ,boolean? "Is this neume outlined?")
1153 (context-info ,integer? "Within a ligature, the final glyph or shape of
1154 a head may be affected by the left and/or right neighbour head.
1155 @code{context-info} holds for each head such information about the left and
1156 right neighbour, encoded as a bit mask.")
1158 (deminutum ,boolean? "Is this neume deminished?")
1159 (descendens ,boolean? "Is this neume of descendent type?")
1161 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1162 grob (in @code{staff-space} units).")
1163 (flexa-interval ,integer? "The interval spanned by the two notes of a
1164 flexa shape (1 is a second, 7 is an octave).")
1165 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1166 ligature grob in (in @code{staff-space} units).")
1167 (ligature-flexa ,boolean? "request joining note to the previous one
1170 (inclinatum ,boolean? "Is this neume an inclinatum?")
1173 (linea ,boolean? "Attach vertical lines to this neume?")
1175 (oriscus ,boolean? "Is this neume an oriscus?")
1177 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1179 (prefix-set ,number? "A bit mask that holds all Gregorian head
1180 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1181 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1182 similar to a note head that is part of a ligature.")
1184 (quilisma ,boolean? "Is this neume a quilisma?")
1186 (stropha ,boolean? "Is this neume a stropha?")
1188 (virga ,boolean? "Is this neume a virga?")
1190 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1194 (define-public all-backend-properties
1196 all-internal-grob-properties
1197 all-user-grob-properties))