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 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
52 arpeggio squiggly line.")
53 (arrow-length ,number? "Arrow length.")
54 (arrow-width ,number? "Arrow width.")
55 (auto-knee-gap ,ly:dimension? "If a gap is found between note
56 heads where a horizontal beam fits that is larger than this number,
58 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
59 averaged over staves.")
60 (avoid-note-head ,boolean? "If set, the stem of a chord does not
61 pass through all note heads, but starts at the last note head.")
62 (avoid-slur ,symbol? "Method of handling slur collisions.
63 Choices are @code{inside}, @code{outside}, @code{around}, and
64 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
65 grob inside the slur. @code{outside} moves the grob vertically to the
66 outside of the slur. @code{around} moves the grob vertically to the
67 outside of the slur only if there is a collision. @code{ignore} does
68 not move either. In grobs whose notational significance depends on
69 vertical position (such as accidentals, clefs, etc.), @code{outside}
70 and @code{around} behave like @code{ignore}.")
71 (axes ,list? "List of axis numbers. In the case of alignment
72 grobs, this should contain only one number.")
78 (base-shortest-duration ,ly:moment? "Spacing is based on the
79 shortest notes in a piece. Normally, pieces are spaced as if notes at
80 least as short as this are present.")
81 (baseline-skip ,ly:dimension? "Distance between base lines of
82 multiple lines of text.")
83 (beam-thickness ,ly:dimension? "Beam thickness, measured in
84 @code{staff-space} units.")
85 (beam-width ,ly:dimension? "Width of the tremolo sign.")
86 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
87 when their direction is forced. It is a list, since the value is
88 different depending on the number of flags and beams.")
89 (beaming ,pair? "Pair of number lists. Each number list
90 specifies which beams to make. @code{0}@tie{}is the central beam,
91 @code{1}@tie{}is the next beam toward the note, etc. This information
92 is used to determine how to connect the beaming patterns from stem to
94 (beamlet-default-length ,pair? "A pair of numbers. The first
95 number specifies the default length of a beamlet that sticks out of
96 the left hand side of this stem; the second number specifies the
97 default length of the beamlet to the right. The actual length of a
98 beamlet is determined by taking either the default length or the
99 length specified by @code{beamlet-max-length-proportion}, whichever is
101 (beamlet-max-length-proportion ,pair? "The maximum length of a
102 beamlet, as a proportion of the distance between two adjacent stems.")
103 (before-line-breaking ,boolean? "Dummy property, used to trigger
104 a callback function.")
105 (between-cols ,pair? "Where to attach a loose column to.")
106 (bound-details ,list? "An alist of properties for determining
107 attachments of spanners to edges.")
108 (bound-padding ,number? "The amount of padding to insert around
110 (bracket-flare ,number-pair? "A pair of numbers specifying how
111 much edges of brackets should slant outward. Value @code{0.0} means
113 (bracket-visibility ,boolean-or-symbol? "This controls the
114 visibility of the tuplet bracket. Setting it to false prevents
115 printing of the bracket. Setting the property to @code{if-no-beam}
116 makes it print only if there is no beam associated with this tuplet
118 (break-align-anchor ,number? "Grobs aligned to this break-align
119 grob will have their X-offsets shifted by this number. In bar lines,
120 for example, this is used to position grobs relative to the (visual)
121 center of the bar line.")
122 (break-align-anchor-alignment ,number? "Read by
123 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
124 aligning an anchor to a grob's extent.")
125 (break-align-orders ,vector? "Defines the order in which
126 prefatory matter (clefs, key signatures) appears. The format is a
127 vector of length@tie{}3, where each element is one order for
128 end-of-line, middle of line, and start-of-line, respectively. An
129 order is a list of symbols.
131 For example, clefs are put after key signatures by setting
134 \\override Score.BreakAlignment #'break-align-orders =
135 #(make-vector 3 '(span-bar
142 (break-align-symbol ,symbol? "This key is used for aligning and
143 spacing breakable items.")
144 (break-align-symbols ,list? "A list of symbols that determine
145 which break-aligned grobs to align this to. If the grob selected by
146 the first symbol in the list is invisible due to break-visibility, we
147 will align to the next grob (and so on). Choices are @code{left-edge},
148 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
149 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
151 (break-overshoot ,number-pair? "How much does a broken spanner
152 stick out of its bounds?")
153 (break-visibility ,vector? "A vector of 3@tie{}booleans,
154 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
155 @code{#t} means visible, @code{#f} means killed.")
156 (breakable ,boolean? "Allow breaks here.")
162 (c0-position ,integer? "An integer indicating the position of
164 (circled-tip ,boolean? "Put a circle at start/end of
165 hairpins (al/del niente).")
166 (clip-edges ,boolean? "Allow outward pointing beamlets at the
168 (collapse-height ,ly:dimension? "Minimum height of system start
169 delimiter. If equal or smaller, the bracket/brace/line is removed.")
170 (color ,color? "The color of this grob.")
171 (common-shortest-duration ,ly:moment? "The most common shortest
172 note length. This is used in spacing. Enlarging this sets the score
174 (concaveness ,number? "A beam is concave if its inner stems are
175 closer to the beam than the two outside stems. This number is a
176 measure of the closeness of the inner stems. It is used for damping
177 the slope of the beam.")
178 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
179 this grob looks as a continued break.")
180 (control-points ,list? "List of offsets (number pairs) that form
181 control points for the tie, slur, or bracket shape. For B@'eziers,
182 this should list the control points of a third-order B@'ezier curve.")
188 (damping ,number? "Amount of beam slope damping.")
189 (dash-definition ,pair? "List of @code{dash-elements} defining the
190 dash structure. Each @code{dash-element} has a starting t value,
191 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
192 (dash-fraction ,number? "Size of the dashes, relative to
193 @code{dash-period}. Should be between @code{0.0} (no line) and
194 @code{1.0} (continuous line).")
195 (dash-period ,number? "The length of one dash together with
196 whitespace. If negative, no line is drawn at all.")
197 (default-direction ,ly:dir? "Direction determined by note head
199 (default-staff-staff-spacing ,list? "The settings to use for
200 @code{staff-staff-spacing} when it is unset, for ungrouped staves
201 and for grouped staves that do not have the relevant
202 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
203 @code{staffgroup-staff-spacing}).")
204 (details ,list? "Alist of parameters for detailed grob behavior.
205 More information on the allowed parameters for a grob can be found by
206 looking at the top of the Internals Reference page for each interface
207 having a @code{details} property.")
208 (digit-names ,vector? "Names for string finger digits.")
209 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
210 @code{#X}), then this property determines whether the object is placed
211 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
212 other object. Otherwise, it determines whether the object is placed
213 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
214 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
215 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
216 @code{#CENTER}=@code{0}.")
217 (dot-count ,integer? "The number of dots.")
218 (dot-negative-kern ,number? "The space to remove between a dot
219 and a slash in percent repeat glyphs. Larger values bring the two
220 elements closer together.")
221 (dot-placement-list ,list? "List consisting of
222 @code{(@var{description} @var{string-number} @var{fret-number}
223 @var{finger-number})} entries used to define fret diagrams.")
224 (duration-log ,integer? "The 2-log of the note head duration,
225 i.e., @code{0} = whole note, @code{1} = half note, etc.")
231 (eccentricity ,number? "How asymmetrical to make a slur.
232 Positive means move the center to the right.")
233 (edge-height ,pair? "A pair of numbers specifying the heights of
234 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
235 (edge-text ,pair? "A pair specifying the texts to be set at the
236 edges: @code{(@var{left-text} . @var{right-text})}.")
237 (expand-limit ,integer? "Maximum number of measures expanded in
240 (extra-dy ,number? "Slope glissandi this much extra.")
241 (extra-offset ,number-pair? "A pair representing an offset. This
242 offset is added just before outputting the symbol, so the typesetting
243 engine is completely oblivious to it. The values are measured in
244 @code{staff-space} units of the staff's @code{StaffSymbol}.")
245 (extra-spacing-height ,number-pair? "In the horizontal spacing
246 problem, we increase the height of each item by this amount (by adding
247 the @q{car} to the bottom of the item and adding the @q{cdr} to the
248 top of the item). In order to make a grob infinitely high (to prevent
249 the horizontal spacing problem from placing any other grobs above or
250 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
251 (extra-spacing-width ,number-pair? "In the horizontal spacing
252 problem, we pad each item by this amount (by adding the @q{car} on the
253 left side of the item and adding the @q{cdr} on the right side of the
254 item). In order to make a grob take up no horizontal space at all,
255 set this to @code{(+inf.0 . -inf.0)}.")
256 (extra-X-extent ,number-pair? "A grob is enlarged in
257 X@tie{}dimension by this much.")
258 (extra-Y-extent ,number-pair? "A grob is enlarged in
259 Y@tie{}dimension by this much.")
265 (flag ,ly:stencil? "A function returning the full flag stencil
266 for the @code{Stem}, which is passed to the function as the only
267 argument. The default ly:stem::calc-stencil function uses the
268 @code{flag-style} property to determine the correct glyph for the
269 flag. By providing your own function, you can create arbitrary
271 (flag-count ,number? "The number of tremolo beams.")
272 (flag-style ,symbol? "A symbol determining what style of flag
273 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
274 for standard flags, @code{'mensural} and @code{'no-flag}, which
275 switches off the flag.")
276 (font-encoding ,symbol? "The font encoding is the broadest
277 category for selecting a font. Currently, only lilypond's system
278 fonts (Emmentaler) are using this property. Available
279 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
280 @code{fetaText} (Emmentaler).")
281 (font-family ,symbol? "The font family is the broadest category
282 for selecting text fonts. Options include: @code{sans},
284 (font-name ,string? "Specifies a file name (without extension) of
285 the font to load. This setting overrides selection using
286 @code{font-family}, @code{font-series} and @code{font-shape}.")
287 (font-series ,symbol? "Select the series of a font. Choices
288 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
289 (font-shape ,symbol? "Select the shape of a font. Choices
290 include @code{upright}, @code{italic}, @code{caps}.")
291 (font-size ,number? "The font size, compared to the
292 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
293 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
294 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
295 larger. Fractional values are allowed.")
296 (force-hshift ,number? "This specifies a manual shift for notes
297 in collisions. The unit is the note head width of the first voice
298 note. This is used by @rinternals{note-collision-interface}.")
299 (fraction ,number-pair? "Numerator and denominator of a time
301 (french-beaming ,boolean? "Use French beaming style for this
302 stem. The stem stops at the innermost beams.")
303 (fret-diagram-details ,list? "An alist of detailed grob
304 properties for fret diagrams. Each alist entry consists of a
305 @code{(@var{property} . @var{value})} pair. The properties which can
306 be included in @code{fret-diagram-details} include the following:
310 @code{barre-type} -- Type of barre indication used. Choices include
311 @code{curved}, @code{straight}, and @code{none}. Default
314 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
315 fret-space. Default value@tie{}0.5.
317 @code{dot-color} -- Color of dots. Options include @code{black} and
318 @code{white}. Default @code{black}.
320 @code{dot-label-font-mag} -- Magnification for font used to label fret
321 dots. Default value@tie{}1.
323 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
324 dots without labels, 0.95-@code{dot-radius} for dots with labels.
326 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
327 value 0.425 for labeled dots, 0.25 for unlabeled dots.
329 @code{finger-code} -- Code for the type of fingering indication used.
330 Options include @code{none}, @code{in-dot}, and @code{below-string}.
331 Default @code{none} for markup fret diagrams, @code{below-string} for
332 @code{FretBoards} fret diagrams.
334 @code{fret-count} -- The number of frets. Default@tie{}4.
336 @code{fret-label-font-mag} -- The magnification of the font used to
337 label the lowest fret number. Default@tie{}0.5.
339 @code{fret-label-vertical-offset} -- The offset of the fret label from
340 the center of the fret in direction parallel to strings.
343 @code{label-dir} -- Side to which the fret label is attached.
344 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
345 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
347 @code{mute-string} -- Character string to be used to indicate muted
348 string. Default @code{\"x\"}.
350 @code{number-type} -- Type of numbers to use in fret label. Choices
351 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
352 Default @code{roman-lower}.
354 @code{open-string} -- Character string to be used to indicate open
355 string. Default @code{\"o\"}.
357 @code{orientation} -- Orientation of fret-diagram. Options include
358 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
359 Default @code{normal}.
361 @code{string-count} -- The number of strings. Default@tie{}6.
363 @code{string-label-font-mag} -- The magnification of the font used to
364 label fingerings at the string, rather than in the dot. Default value
365 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
366 @code{opposing-landscape}.
368 @code{string-thickness-factor} -- Factor for changing thickness of
369 each string in the fret diagram. Thickness of string @var{k} is given
371 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
374 @code{top-fret-thickness} -- The thickness of the top fret line, as a
375 multiple of the standard thickness. Default value@tie{}3.
377 @code{xo-font-magnification} -- Magnification used for mute and open
378 string indicators. Default value@tie{}0.5.
380 @code{xo-padding} -- Padding for open and mute indicators from top
381 fret. Default value 0.25.
383 ;; ugh: double, change.
384 (full-length-padding ,number? "How much padding to use at the
385 right side of a full-length tuplet bracket.")
386 (full-length-to-extent ,boolean? "Run to the extent of the column
387 for a full-length tuplet bracket.")
388 (full-measure-extra-space ,number? "Extra space that is allocated
389 at the beginning of a measure with only one note. This property is
390 read from the NonMusicalPaperColumn that begins the measure.")
391 (full-size-change ,boolean? "Don't make a change clef smaller.")
397 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
398 (gap-count ,integer? "Number of gapped beams for tremolo.")
399 (glyph ,string? "A string determining what @q{style} of glyph is
400 typeset. Valid choices depend on the function that is reading this
402 (glyph-name ,string? "The glyph name within the font.")
403 (glyph-name-alist ,list? "An alist of key-string pairs.")
404 (graphical ,boolean? "Display in graphical (vs. text) form.")
405 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
411 (hair-thickness ,number? "Thickness of the thin line in a bar
413 (harp-pedal-details ,list? "An alist of detailed grob properties
414 for harp pedal diagrams. Each alist entry consists of a
415 @code{(@var{property} . @var{value})} pair. The properties which can
416 be included in harp-pedal-details include the following:
420 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
421 boxes above/below the horizontal line. Default value@tie{}0.8.
423 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
425 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
427 @code{space-before-divider} -- Space between boxes before the first
428 divider (so that the diagram can be made symmetric). Default
431 @code{space-after-divider} -- Space between boxes after the first
432 divider. Default value@tie{}0.8.
434 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
435 of the ellipse around circled pedals. Default value@tie{}0.5.
437 @code{circle-x-padding} -- Padding in X direction of the ellipse
438 around circled pedals. Default value 0.15.
440 @code{circle-y-padding} -- Padding in Y direction of the ellipse
441 around circled pedals. Default value@tie{}0.2.
443 (head-direction ,ly:dir? "Are the note heads left or right in a
445 (height ,ly:dimension? "Height of an object in @code{staff-space}
447 (height-limit ,ly:dimension? "Maximum slur height: The longer the
448 slur, the closer it is to this height.")
449 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
450 that appears on a tied note after a line break will not be displayed.")
451 (horizontal-shift ,integer? "An integer that identifies ranking
452 of @code{NoteColumn}s for horizontal shifting. This is used by
453 @rinternals{note-collision-interface}.")
454 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
455 left and one to the right of this grob.")
461 (ignore-collision ,boolean? "If set, don't do note collision
462 resolution on this @code{NoteColumn}.")
463 (implicit ,boolean? "Is this an implicit bass figure?")
464 (inspect-index ,integer? "If debugging is set, set beam and slur
465 configuration to this index, and print the respective scores.")
466 (inspect-quants ,number-pair? "If debugging is set, set beam and
467 slur quants to this position, and print the respective scores.")
473 (keep-inside-line ,boolean? "If set, this column cannot have
474 objects sticking into the margin.")
475 (kern ,ly:dimension? "Amount of extra white space to add. For
476 bar lines, this is the amount of space after a thick line.")
477 (knee ,boolean? "Is this beam kneed?")
478 (knee-spacing-correction ,number? "Factor for the optical
479 correction amount for kneed beams. Set between @code{0} for no
480 correction and @code{1} for full correction.")
486 (labels ,list? "List of labels (symbols) placed on a column.")
487 (layer ,integer? "An integer which determines the order of printing
488 objects. Objects with the lowest value of layer are drawn first, then
489 objects with progressively higher values are drawn, so objects with
490 higher values overwrite objects with lower values. By default most
491 objects are assigned a layer value of 1.")
492 (ledger-line-thickness ,number-pair? "The thickness of ledger
493 lines. It is the sum of 2@tie{}numbers: The first is the factor for
494 line thickness, and the second for staff space. Both contributions
496 (left-bound-info ,list? "An alist of properties for determining
497 attachments of spanners to edges.")
498 (left-padding ,ly:dimension? "The amount of space that is put
499 left to an object (e.g., a lyric extender).")
500 (length ,ly:dimension? "User override for the stem length of
502 (length-fraction ,number? "Multiplier for lengths. Used for
503 determining ledger lines and stem lengths.")
504 (line-break-penalty ,number? "Penalty for a line break at this
505 column. This affects the choices of the line breaker; it avoids a
506 line break at a column with a positive penalty and prefers a line
507 break at a column with a negative penalty.")
508 (line-break-permission ,symbol? "Instructs the line breaker on
509 whether to put a line break at this column. Can be @code{force} or
511 (line-break-system-details ,list? "An alist of properties to use
512 if this column is the start of a system.")
513 (line-count ,integer? "The number of staff lines.")
514 (line-positions ,list? "Vertical positions of staff lines.")
515 (line-thickness ,number? "The thickness of the tie or slur
517 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
523 (max-beam-connect ,integer? "Maximum number of beams to connect
524 to beams from this stem. Further beams are typeset as beamlets.")
525 (max-stretch ,number? "The maximum amount that this
526 @code{VerticalAxisGroup} can be vertically stretched (for example, in
527 order to better fill a page).")
528 (measure-count ,integer? "The number of measures for a
529 multi-measure rest.")
530 (measure-length ,ly:moment? "Length of a measure. Used in some
531 spacing situations.")
532 (merge-differently-dotted ,boolean? "Merge note heads in
533 collisions, even if they have a different number of dots. This is
534 normal notation for some types of polyphonic music.
536 @code{merge-differently-dotted} only applies to opposing stem
537 directions (i.e., voice 1 &@tie{}2).")
538 (merge-differently-headed ,boolean? "Merge note heads in
539 collisions, even if they have different note heads. The smaller of
540 the two heads is rendered invisible. This is used in polyphonic
541 guitar notation. The value of this setting is used by
542 @rinternals{note-collision-interface}.
544 @code{merge-differently-headed} only applies to opposing stem
545 directions (i.e., voice 1 &@tie{}2).")
546 (minimum-distance ,ly:dimension? "Minimum distance between rest
548 (minimum-length ,ly:dimension? "Try to make a spanner at least
549 this long, normally in the horizontal direction. This requires an
550 appropriate callback for the @code{springs-and-rods} property. If
551 added to a @code{Tie}, this sets the minimum distance between
553 (minimum-length-fraction ,number? "Minimum length of ledger line
554 as fraction of note head size.")
555 (minimum-space ,ly:dimension? "Minimum distance that the victim
556 should move (after padding).")
557 (minimum-X-extent ,number-pair? "Minimum size of an object in
558 X@tie{}dimension, measured in @code{staff-space} units.")
559 (minimum-Y-extent ,number-pair? "Minimum size of an object in
560 Y@tie{}dimension, measured in @code{staff-space} units.")
566 (neutral-direction ,ly:dir? "Which direction to take in the
567 center of the staff.")
568 (neutral-position ,number? "Position (in half staff spaces) where
569 to flip the direction of custos stem.")
570 (next ,ly:grob? "Object that is next relation (e.g., the lyric
571 syllable following an extender).")
572 (no-alignment ,boolean? "If set, don't place this grob in a
573 @code{VerticalAlignment}; rather, place it using its own
574 @code{Y-offset} callback.")
575 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
577 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
578 get stems extending to the middle staff line.")
579 (non-break-align-symbols ,list? "A list of symbols that determine
580 which NON-break-aligned interfaces to align this to.")
581 (non-default ,boolean? "Set for manually specified clefs.")
582 (non-musical ,boolean? "True if the grob belongs to a
583 @code{NonMusicalPaperColumn}.")
584 (nonstaff-nonstaff-spacing ,list? "The spacing alist
585 controlling the distance between the current non-staff line and
586 the next non-staff line in the direction of @code{staff-affinity},
587 if both are on the same side of the related staff, and
588 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
589 @code{staff-staff-spacing} for a description of the alist
591 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
592 controlling the distance between the current non-staff line and
593 the nearest staff in the direction of @code{staff-affinity}, if
594 there are no non-staff lines between the two, and
595 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
596 @code{staff-affinity} is @code{CENTER}, then
597 @code{nonstaff-relatedstaff-spacing} is used for the nearest
598 staves on @emph{both} sides, even if other non-staff lines appear
599 between the current one and either of the staves. See
600 @code{staff-staff-spacing} for a description of the alist
602 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
603 controlling the distance between the current non-staff line and
604 the nearest staff in the opposite direction from
605 @code{staff-affinity}, if there are no other non-staff lines
606 between the two, and @code{staff-affinity} is either @code{UP} or
607 @code{DOWN}. See @code{staff-staff-spacing} for a description of
608 the alist structure.")
609 (note-names ,vector? "Vector of strings containing names for
610 easy-notation note heads.")
616 (outside-staff-horizontal-padding ,number? "By default, an
617 outside-staff-object can be placed so that is it very close to another
618 grob horizontally. If this property is set, the outside-staff-object
619 is raised so that it is not so close to its neighbor.")
620 (outside-staff-padding ,number? "The padding to place between
621 this grob and the staff when spacing according to
622 @code{outside-staff-priority}.")
623 (outside-staff-priority ,number? "If set, the grob is positioned
624 outside the staff in such a way as to avoid all collisions. In case
625 of a potential collision, the grob with the smaller
626 @code{outside-staff-priority} is closer to the staff.")
632 (packed-spacing ,boolean? "If set, the notes are spaced as
633 tightly as possible.")
634 (padding ,ly:dimension? "Add this much extra space between
635 objects that are next to each other.")
636 (padding-pairs ,list? "An alist mapping @code{(@var{name}
637 . @var{name})} to distances.")
638 (page-break-penalty ,number? "Penalty for page break at this
639 column. This affects the choices of the page breaker; it avoids a
640 page break at a column with a positive penalty and prefers a page
641 break at a column with a negative penalty.")
642 (page-break-permission ,symbol? "Instructs the page breaker on
643 whether to put a page break at this column. Can be @code{force} or
645 (page-turn-penalty ,number? "Penalty for a page turn at this
646 column. This affects the choices of the page breaker; it avoids a
647 page turn at a column with a positive penalty and prefers a page turn
648 at a column with a negative penalty.")
649 (page-turn-permission ,symbol? "Instructs the page breaker on
650 whether to put a page turn at this column. Can be @code{force} or
652 (parenthesized ,boolean? "Parenthesize this grob.")
653 (positions ,number-pair? "Pair of staff coordinates
654 @code{(@var{left} . @var{right})}, where both @var{left} and
655 @var{right} are in @code{staff-space} units of the current staff. For
656 slurs, this value selects which slur candidate to use; if extreme
657 positions are requested, the closest one is taken.")
658 (prefer-dotted-right ,boolean? "For note collisions, prefer to
659 shift dotted up-note to the right, rather than shifting just the
666 (ratio ,number? "Parameter for slur shape. The higher this
667 number, the quicker the slur attains its @code{height-limit}.")
668 (remove-empty ,boolean? "If set, remove group if it contains no
670 (remove-first ,boolean? "Remove the first staff of an orchestral
672 (restore-first ,boolean? "Print a natural before the
674 (rhythmic-location ,rhythmic-location? "Where (bar number,
675 measure position) in the score.")
676 (right-bound-info ,list? "An alist of properties for determining
677 attachments of spanners to edges.")
678 (right-padding ,ly:dimension? "Space to insert on the right side
679 of an object (e.g., between note and its accidentals).")
680 (rotation ,list? "Number of degrees to rotate this object, and
681 what point to rotate around. For example, @code{#'(45 0 0)} rotates
682 by 45 degrees around the center of this object.")
688 (same-direction-correction ,number? "Optical correction amount
689 for stems that are placed in tight configurations. This amount is
690 used for stems with the same direction to compensate for note head to
692 (script-priority ,number? "A sorting key that determines in what
693 order a script is within a stack of scripts.")
694 (self-alignment-X ,number? "Specify alignment of an object. The
695 value @code{-1} means left aligned, @code{0}@tie{}centered, and
696 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
697 values may also be specified.")
698 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
700 (shorten-pair ,number-pair? "The lengths to shorten a
701 text-spanner on both sides, for example a pedal bracket. Positive
702 values shorten the text-spanner, while negative values lengthen it.")
703 (shortest-duration-space ,ly:dimension? "Start with this much
704 space for the shortest duration. This is expressed in
705 @code{spacing-increment} as unit. See also
706 @rinternals{spacing-spanner-interface}.")
707 (shortest-playing-duration ,ly:moment? "The duration of the
708 shortest note playing here.")
709 (shortest-starter-duration ,ly:moment? "The duration of the
710 shortest note that starts here.")
711 (side-axis ,number? "If the value is @code{#X} (or
712 equivalently@tie{}@code{0}), the object is placed horizontally next to
713 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
715 (side-relative-direction ,ly:dir? "Multiply direction of
716 @code{direction-source} with this to get the direction of this
718 (size ,number? "Size of object, relative to standard size.")
719 (skyline-horizontal-padding ,number? "For determining the
720 vertical distance between two staves, it is possible to have a
721 configuration which would result in a tight interleaving of grobs from
722 the top staff and the bottom staff. The larger this parameter is, the
723 farther apart the staves are placed in such a configuration.")
724 (skyline-vertical-padding ,number? "The amount by which the left
725 and right skylines of a column are padded vertically, beyond the
726 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
727 grobs in the column. Increase this to prevent interleaving of grobs
728 from adjacent columns.")
729 (slash-negative-kern ,number? "The space to remove between
730 slashes in percent repeat glyphs. Larger values bring the two
731 elements closer together.")
732 (slope ,number? "The slope of this object.")
733 (slur-padding ,number? "Extra distance between slur and script.")
734 (space-alist ,list? "A table that specifies distances between
735 prefatory items, like clef and time-signature. The format is an alist
736 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
737 . @var{distance})}, where @var{type} can be the symbols
738 @code{minimum-space} or @code{extra-space}.")
739 (space-to-barline ,boolean? "If set, the distance between a note
740 and the following non-musical column will be measured to the bar line
741 instead of to the beginning of the non-musical column. If there is a
742 clef change followed by a bar line, for example, this means that we
743 will try to space the non-musical column as though the clef is not
745 (spacing-increment ,number? "Add this much space for a doubled
746 duration. Typically, the width of a note head. See also
747 @rinternals{spacing-spanner-interface}.")
748 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
749 spacing relative to its left and right @code{BreakAlignment}s.
751 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
752 bounds (i.e., clefs, key signatures and time signatures) using the following
756 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
758 (springs-and-rods ,boolean? "Dummy variable for triggering
760 (stacking-dir ,ly:dir? "Stack objects in which direction?")
761 (staff-affinity ,ly:dir? "The direction of the staff to use
762 for spacing the current non-staff line. Choices are @code{UP},
763 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
764 line will be placed equidistant between the two nearest staves on
765 either side, unless collisions or other spacing constraints
766 prevent this. Setting @code{staff-affinity} for a staff causes it
767 to be treated as a non-staff line. Setting @code{staff-affinity}
768 to @code{#f} causes a non-staff line to be treated as a staff.")
769 (staff-padding ,ly:dimension? "Maintain this much space between
770 reference points and the staff. Its effect is to align objects of
771 differing sizes (like the dynamics @b{p} and @b{f}) on their
773 (staff-position ,number? "Vertical position, measured in half
774 staff spaces, counted from the middle line.")
775 (staff-space ,ly:dimension? "Amount of space between staff lines,
776 expressed in global @code{staff-space}.")
777 (staff-staff-spacing ,list? "When applied to a staff-group's
778 @code{StaffGrouper} grob, this spacing alist controls the distance
779 between consecutive staves within the staff-group. When applied
780 to a staff's @code{VerticalAxisGroup} grob, it controls the
781 distance between the staff and the nearest staff below it in the
782 same system, replacing any settings inherited from the
783 @code{StaffGrouper} grob of the containing staff-group, if there
784 is one. This property remains in effect even when non-staff lines
785 appear between staves. The alist can contain the following keys:
790 @code{basic-distance} -- the vertical distance, measured in
791 staff-spaces, between the reference points of the two items when
792 no collisions would result, and no stretching or compressing is in
796 @code{minimum-distance} -- the smallest allowable vertical
797 distance, measured in staff-spaces, between the reference points
798 of the two items, when compressing is in effect.
801 @code{padding} -- the minimum required amount of unobstructed
802 vertical whitespace between the bounding boxes (or skylines) of
803 the two items, measured in staff-spaces.
806 @code{stretchability} -- a unitless measure of the dimension's
807 relative propensity to stretch. If zero, the distance will not
808 stretch (unless collisions would result).
811 (staffgroup-staff-spacing ,list? "The spacing alist
812 controlling the distance between the last staff of the current
813 staff-group and the staff just below it in the same system, even
814 if one or more non-staff lines exist between the two staves. If
815 the @code{staff-staff-spacing} property of the staff's
816 @code{VerticalAxisGroup} grob is set, that is used instead. See
817 @code{staff-staff-spacing} for a description of the alist
819 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
820 pair where the stem attaches to the notehead.")
821 (stem-end-position ,number? "Where does the stem end (the end is
822 opposite to the support-head)?")
824 (stem-spacing-correction ,number? "Optical correction amount for
825 stems that are placed in tight configurations. For opposite
826 directions, this amount is the correction for two normal sized stems
827 that overlap completely.")
828 (stemlet-length ,number? "How long should be a stem over a
830 (stencil ,ly:stencil? "The symbol to print.")
831 (stencils ,list? "Multiple stencils, used as intermediate
833 (strict-grace-spacing ,boolean? "If set, main notes are spaced
834 normally, then grace notes are put left of the musical columns for the
836 (strict-note-spacing ,boolean? "If set, unbroken columns with
837 non-musical material (clefs, bar lines, etc.) are not spaced
838 separately, but put before musical columns.")
839 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
841 (style ,symbol? "This setting determines in what style a grob is
842 typeset. Valid choices depend on the @code{stencil} callback reading
849 (text ,markup? "Text markup. See @ruser{Formatting text}.")
850 ;;FIXME -- Should both be the same?
851 (text-direction ,ly:dir? "This controls the ordering of the
852 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
853 should use @code{LEFT}.")
854 (thick-thickness ,number? "Bar line thickness, measured in
855 @code{line-thickness}.")
856 (thickness ,number? "Line thickness, generally measured in
857 @code{line-thickness}.")
858 (thin-kern ,number? "The space after a hair-line in a bar line.")
859 (tie-configuration ,list? "List of @code{(@var{position} .
860 @var{dir})} pairs, indicating the desired tie configuration, where
861 @var{position} is the offset from the center of the staff in staff
862 space and @var{dir} indicates the direction of the tie
863 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
864 in the list causes the corresponding tie to be formatted
866 (to-barline ,boolean? "If true, the spanner will stop at the bar
867 line just before it would otherwise stop.")
868 (toward-stem-shift ,number? "Amount by which scripts are shifted
869 toward the stem if their direction coincides with the stem direction.
870 @code{0.0} means keep the default position (centered on the note
871 head), @code{1.0} means centered on the stem. Interpolated values are
873 (transparent ,boolean? "This makes the grob invisible.")
879 (uniform-stretching ,boolean? "If set, items stretch
880 proportionally to their durations. This looks better in complex
881 polyphonic patterns.")
882 (used ,boolean? "If set, this spacing column is kept in the
889 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
890 one below this grob.")
896 (when ,ly:moment? "Global time step associated with this column
898 (whiteout ,boolean? "If true, the grob is printed over a white
899 background to white-out underlying material, if the grob is visible.
900 Usually #f by default.")
901 (width ,ly:dimension? "The width of a grob measured in staff
903 (word-space ,ly:dimension? "Space to insert between words in
910 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
911 (X-offset ,number? "The horizontal amount that this object is
912 moved relative to its X-parent.")
918 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
919 (Y-offset ,number? "The vertical amount that this object is moved
920 relative to its Y-parent.")
925 (zigzag-length ,ly:dimension? "The length of the lines of a
926 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
927 gives 60-degree zigzags.")
928 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
929 This number is adjusted slightly so that the glissando line can be
930 constructed from a whole number of squiggles.")
938 (define (define-internal-grob-property symbol type? description)
939 (define-grob-property symbol type? description)
940 (set-object-property! symbol 'backend-internal #t)
945 (define-public all-internal-grob-properties
948 (apply define-internal-grob-property x))
952 ;; grobs & grob arrays. (alphabetical)
953 (accidental-grob ,ly:grob? "The accidental for this note.")
954 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
955 @var{groblist})} entries.")
956 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
958 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
959 function is to protect objects from being garbage collected.")
960 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
961 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
962 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
964 (bars ,ly:grob-array? "An array of bar line pointers.")
965 (beam ,ly:grob? "A pointer to the beam, if applicable.")
966 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
967 column as start/begin point. Only columns that have grobs or act as
969 (bracket ,ly:grob? "The bracket for a number.")
971 (columns ,ly:grob-array? "An array of grobs, typically containing
972 @code{PaperColumn} or @code{NoteColumn} objects.")
973 (conditional-elements ,ly:grob-array? "Internal use only.")
974 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
977 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
978 set, which grob to get the direction from.")
979 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
980 (dot ,ly:grob? "A reference to a @code{Dots} object.")
981 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
983 (elements ,ly:grob-array? "An array of grobs; the type is depending on
984 the grob where this is set in.")
985 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
986 in addition to notes and stems.")
988 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
990 (grace-spacing ,ly:grob? "A run of grace notes.")
992 (heads ,ly:grob-array? "An array of note heads.")
994 (items-worth-living ,ly:grob-array? "An array of interesting items. If
995 empty in a particular staff, then that staff is erased.")
997 (keep-alive-with ,ly:grob-array? "An array of other
998 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1000 (left-items ,ly:grob-array? "DOCME")
1001 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1004 (normal-stems ,ly:grob-array? "An array of visible stems.")
1005 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1006 (note-head ,ly:grob? "A single note head.")
1007 (note-heads ,ly:grob-array? "An array of note head grobs.")
1008 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1010 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1011 that are relevant for finding the @code{pure-Y-extent}")
1012 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1013 relevant for finding the @code{pure-Y-extent}.")
1014 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1015 relevant for finding the @code{pure-Y-extent}.")
1016 (pure-Y-common ,ly:grob? "A cache of the
1017 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1019 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1020 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1021 (rests ,ly:grob-array? "An array of rest objects.")
1022 (right-items ,ly:grob-array? "DOCME")
1023 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1025 (side-support-elements ,ly:grob-array? "The side support, an array of
1027 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1028 (spacing ,ly:grob? "The spacing spanner governing this section.")
1029 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1031 (span-start ,boolean? "Is the note head at the start of a spanner?")
1032 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1033 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1034 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1035 (stems ,ly:grob-array? "An array of stem objects.")
1037 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1038 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1039 (tuplet-number ,ly:grob? "The number for a bracket.")
1040 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1041 (X-common ,ly:grob? "Common reference point for axis group.")
1042 (Y-common ,ly:grob? "See @code{X-common}.")
1046 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1047 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1050 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1051 This may differ from @code{Y-extent} because it does not include the dots in
1052 a repeat bar line.")
1053 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1054 @code{FretBoard} be visible only at beginning of line or at
1057 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1058 translator) that was the cause for this grob.")
1059 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1060 depend on inter-staff spacing.")
1062 (delta-position ,number? "The vertical position difference.")
1064 (font ,ly:font-metric? "A cached font metric object.")
1065 (forced ,boolean? "Manually forced accidental.")
1067 (head-width ,ly:dimension? "The width of this ligature head.")
1069 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1070 @var{strength}))} pairs.")
1071 (important-column-ranks ,vector? "A cache of columns that contain
1072 @code{items-worth-living} data.")
1073 (interfaces ,list? "A list of symbols indicating the interfaces
1074 supported by this object. It is initialized from the @code{meta} field.")
1076 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1078 (maybe-loose ,boolean? "Used to mark a breakable column that is
1079 loose if and only if it is in the middle of a line.")
1080 (meta ,list? "Provide meta information. It is an alist with the
1081 entries @code{name} and @code{interfaces}.")
1082 (minimum-distances ,list? "A list of rods that have the format
1083 @code{(@var{obj} . @var{dist})}.")
1085 (positioning-done ,boolean? "Used to signal that a positioning element
1086 did its job. This ensures that a positioning is only done once.")
1087 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1088 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1089 cyclic dependencies.")
1090 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1091 to be within staff spaces.")
1092 (quantized-positions ,number-pair? "The beam positions after
1095 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1096 acts as an index for looking up a @code{Stencil} object.")
1097 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1098 Internally used to distribute beam shortening over stems.")
1099 (stem-info ,pair? "A cache of stem parameters.")
1100 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1101 top-margin of the page) of the system to which this staff belongs.")
1103 (use-breve-rest ,boolean? "Use breve rests for measures longer
1104 than a whole rest.")
1110 ;; There are too many properties for ancient notation;
1111 ;; probably neume-types (a list of symbols) would also work.
1113 ;; However, such a list would consist of a couple of dozens of
1114 ;; entries, since head prefixes may be combined in many ways. If
1115 ;; the macros in `gregorian.ly' would directly set prefix-set,
1116 ;; all the head prefixes could be junked; however, such macros
1117 ;; would be quite numerous, I guess. --jr
1119 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1121 (add-join ,boolean? "Is this ligature head-joined with the next one
1122 by a vertical line?")
1123 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1124 an additional stem on the right side?")
1125 (ascendens ,boolean? "Is this neume of ascending type?")
1126 (auctum ,boolean? "Is this neume liquescentically augmented?")
1128 (cavum ,boolean? "Is this neume outlined?")
1129 (context-info ,integer? "Within a ligature, the final glyph or shape of
1130 a head may be affected by the left and/or right neighbour head.
1131 @code{context-info} holds for each head such information about the left and
1132 right neighbour, encoded as a bit mask.")
1134 (deminutum ,boolean? "Is this neume deminished?")
1135 (descendens ,boolean? "Is this neume of descendent type?")
1137 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1138 grob (in @code{staff-space} units).")
1139 (flexa-interval ,integer? "The interval spanned by the two notes of a
1140 flexa shape (1 is a second, 7 is an octave).")
1141 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1142 ligature grob in (in @code{staff-space} units).")
1143 (ligature-flexa ,boolean? "request joining note to the previous one
1146 (inclinatum ,boolean? "Is this neume an inclinatum?")
1149 (linea ,boolean? "Attach vertical lines to this neume?")
1151 (oriscus ,boolean? "Is this neume an oriscus?")
1153 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1155 (prefix-set ,number? "A bit mask that holds all Gregorian head
1156 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1157 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1158 similar to a note head that is part of a ligature.")
1160 (quilisma ,boolean? "Is this neume a quilisma?")
1162 (stropha ,boolean? "Is this neume a stropha?")
1164 (virga ,boolean? "Is this neume a virga?")
1166 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1170 (define-public all-backend-properties
1172 all-internal-grob-properties
1173 all-user-grob-properties))