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 (color ,color? "The color of this grob.")
174 (common-shortest-duration ,ly:moment? "The most common shortest
175 note length. This is used in spacing. Enlarging this sets the score
177 (concaveness ,number? "A beam is concave if its inner stems are
178 closer to the beam than the two outside stems. This number is a
179 measure of the closeness of the inner stems. It is used for damping
180 the slope of the beam.")
181 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
182 this grob looks as a continued break.")
183 (control-points ,list? "List of offsets (number pairs) that form
184 control points for the tie, slur, or bracket shape. For B@'eziers,
185 this should list the control points of a third-order B@'ezier curve.")
191 (damping ,number? "Amount of beam slope damping.")
192 (dash-definition ,pair? "List of @code{dash-elements} defining the
193 dash structure. Each @code{dash-element} has a starting t value,
194 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
195 (dash-fraction ,number? "Size of the dashes, relative to
196 @code{dash-period}. Should be between @code{0.0} (no line) and
197 @code{1.0} (continuous line).")
198 (dash-period ,number? "The length of one dash together with
199 whitespace. If negative, no line is drawn at all.")
200 (default-direction ,ly:dir? "Direction determined by note head
202 (default-staff-staff-spacing ,list? "The settings to use for
203 @code{staff-staff-spacing} when it is unset, for ungrouped staves
204 and for grouped staves that do not have the relevant
205 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
206 @code{staffgroup-staff-spacing}).")
207 (details ,list? "Alist of parameters for detailed grob behavior.
208 More information on the allowed parameters for a grob can be found by
209 looking at the top of the Internals Reference page for each interface
210 having a @code{details} property.")
211 (digit-names ,vector? "Names for string finger digits.")
212 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
213 @code{#X}), then this property determines whether the object is placed
214 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
215 other object. Otherwise, it determines whether the object is placed
216 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
217 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
218 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
219 @code{#CENTER}=@code{0}.")
220 (dot-count ,integer? "The number of dots.")
221 (dot-negative-kern ,number? "The space to remove between a dot
222 and a slash in percent repeat glyphs. Larger values bring the two
223 elements closer together.")
224 (dot-placement-list ,list? "List consisting of
225 @code{(@var{description} @var{string-number} @var{fret-number}
226 @var{finger-number})} entries used to define fret diagrams.")
227 (duration-log ,integer? "The 2-log of the note head duration,
228 i.e., @code{0} = whole note, @code{1} = half note, etc.")
234 (eccentricity ,number? "How asymmetrical to make a slur.
235 Positive means move the center to the right.")
236 (edge-height ,pair? "A pair of numbers specifying the heights of
237 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
238 (edge-text ,pair? "A pair specifying the texts to be set at the
239 edges: @code{(@var{left-text} . @var{right-text})}.")
240 (expand-limit ,integer? "Maximum number of measures expanded in
243 (extra-dy ,number? "Slope glissandi this much extra.")
244 (extra-offset ,number-pair? "A pair representing an offset. This
245 offset is added just before outputting the symbol, so the typesetting
246 engine is completely oblivious to it. The values are measured in
247 @code{staff-space} units of the staff's @code{StaffSymbol}.")
248 (extra-spacing-height ,number-pair? "In the horizontal spacing
249 problem, we increase the height of each item by this amount (by adding
250 the @q{car} to the bottom of the item and adding the @q{cdr} to the
251 top of the item). In order to make a grob infinitely high (to prevent
252 the horizontal spacing problem from placing any other grobs above or
253 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
254 (extra-spacing-width ,number-pair? "In the horizontal spacing
255 problem, we pad each item by this amount (by adding the @q{car} on the
256 left side of the item and adding the @q{cdr} on the right side of the
257 item). In order to make a grob take up no horizontal space at all,
258 set this to @code{(+inf.0 . -inf.0)}.")
259 (extra-X-extent ,number-pair? "A grob is enlarged in
260 X@tie{}dimension by this much.")
261 (extra-Y-extent ,number-pair? "A grob is enlarged in
262 Y@tie{}dimension by this much.")
268 (flag ,ly:stencil? "A function returning the full flag stencil
269 for the @code{Stem}, which is passed to the function as the only
270 argument. The default ly:stem::calc-stencil function uses the
271 @code{flag-style} property to determine the correct glyph for the
272 flag. By providing your own function, you can create arbitrary
274 (flag-count ,number? "The number of tremolo beams.")
275 (flag-style ,symbol? "A symbol determining what style of flag
276 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
277 for standard flags, @code{'mensural} and @code{'no-flag}, which
278 switches off the flag.")
279 (font-encoding ,symbol? "The font encoding is the broadest
280 category for selecting a font. Currently, only lilypond's system
281 fonts (Emmentaler) are using this property. Available
282 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
283 @code{fetaText} (Emmentaler).")
284 (font-family ,symbol? "The font family is the broadest category
285 for selecting text fonts. Options include: @code{sans},
287 (font-name ,string? "Specifies a file name (without extension) of
288 the font to load. This setting overrides selection using
289 @code{font-family}, @code{font-series} and @code{font-shape}.")
290 (font-series ,symbol? "Select the series of a font. Choices
291 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
292 (font-shape ,symbol? "Select the shape of a font. Choices
293 include @code{upright}, @code{italic}, @code{caps}.")
294 (font-size ,number? "The font size, compared to the
295 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
296 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
297 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
298 larger. Fractional values are allowed.")
299 (footnote-text ,markup? "A footnote for the grob.")
300 (force-hshift ,number? "This specifies a manual shift for notes
301 in collisions. The unit is the note head width of the first voice
302 note. This is used by @rinternals{note-collision-interface}.")
303 (fraction ,number-pair? "Numerator and denominator of a time
305 (french-beaming ,boolean? "Use French beaming style for this
306 stem. The stem stops at the innermost beams.")
307 (fret-diagram-details ,list? "An alist of detailed grob
308 properties for fret diagrams. Each alist entry consists of a
309 @code{(@var{property} . @var{value})} pair. The properties which can
310 be included in @code{fret-diagram-details} include the following:
314 @code{barre-type} -- Type of barre indication used. Choices include
315 @code{curved}, @code{straight}, and @code{none}. Default
318 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
319 fret-space. Default value@tie{}0.5.
321 @code{dot-color} -- Color of dots. Options include @code{black} and
322 @code{white}. Default @code{black}.
324 @code{dot-label-font-mag} -- Magnification for font used to label fret
325 dots. Default value@tie{}1.
327 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
328 dots without labels, 0.95-@code{dot-radius} for dots with labels.
330 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
331 value 0.425 for labeled dots, 0.25 for unlabeled dots.
333 @code{finger-code} -- Code for the type of fingering indication used.
334 Options include @code{none}, @code{in-dot}, and @code{below-string}.
335 Default @code{none} for markup fret diagrams, @code{below-string} for
336 @code{FretBoards} fret diagrams.
338 @code{fret-count} -- The number of frets. Default@tie{}4.
340 @code{fret-label-custom-format} -- The format string to be used label
341 the lowest fret number, when @code{number-type} equals to
342 @code{custom}. Default@tie{}\"~a\".
344 @code{fret-label-font-mag} -- The magnification of the font used to
345 label the lowest fret number. Default@tie{}0.5.
347 @code{fret-label-vertical-offset} -- The offset of the fret label from
348 the center of the fret in direction parallel to strings.
351 @code{label-dir} -- Side to which the fret label is attached.
352 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
353 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
355 @code{mute-string} -- Character string to be used to indicate muted
356 string. Default @code{\"x\"}.
358 @code{number-type} -- Type of numbers to use in fret label. Choices
359 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
360 @code{custom}. In the later case, the format string is supplied by
361 the @code{fret-label-custom-format} property.
362 Default @code{roman-lower}.
364 @code{open-string} -- Character string to be used to indicate open
365 string. Default @code{\"o\"}.
367 @code{orientation} -- Orientation of fret-diagram. Options include
368 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
369 Default @code{normal}.
371 @code{string-count} -- The number of strings. Default@tie{}6.
373 @code{string-label-font-mag} -- The magnification of the font used to
374 label fingerings at the string, rather than in the dot. Default value
375 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
376 @code{opposing-landscape}.
378 @code{string-thickness-factor} -- Factor for changing thickness of
379 each string in the fret diagram. Thickness of string @var{k} is given
381 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
384 @code{top-fret-thickness} -- The thickness of the top fret line, as a
385 multiple of the standard thickness. Default value@tie{}3.
387 @code{xo-font-magnification} -- Magnification used for mute and open
388 string indicators. Default value@tie{}0.5.
390 @code{xo-padding} -- Padding for open and mute indicators from top
391 fret. Default value 0.25.
393 ;; ugh: double, change.
394 (full-length-padding ,number? "How much padding to use at the
395 right side of a full-length tuplet bracket.")
396 (full-length-to-extent ,boolean? "Run to the extent of the column
397 for a full-length tuplet bracket.")
398 (full-measure-extra-space ,number? "Extra space that is allocated
399 at the beginning of a measure with only one note. This property is
400 read from the NonMusicalPaperColumn that begins the measure.")
401 (full-size-change ,boolean? "Don't make a change clef smaller.")
407 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
408 (gap-count ,integer? "Number of gapped beams for tremolo.")
409 (glyph ,string? "A string determining what @q{style} of glyph is
410 typeset. Valid choices depend on the function that is reading this
412 (glyph-name ,string? "The glyph name within the font.")
413 (glyph-name-alist ,list? "An alist of key-string pairs.")
414 (graphical ,boolean? "Display in graphical (vs. text) form.")
415 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
421 (hair-thickness ,number? "Thickness of the thin line in a bar
423 (harp-pedal-details ,list? "An alist of detailed grob properties
424 for harp pedal diagrams. Each alist entry consists of a
425 @code{(@var{property} . @var{value})} pair. The properties which can
426 be included in harp-pedal-details include the following:
430 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
431 boxes above/below the horizontal line. Default value@tie{}0.8.
433 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
435 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
437 @code{space-before-divider} -- Space between boxes before the first
438 divider (so that the diagram can be made symmetric). Default
441 @code{space-after-divider} -- Space between boxes after the first
442 divider. Default value@tie{}0.8.
444 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
445 of the ellipse around circled pedals. Default value@tie{}0.5.
447 @code{circle-x-padding} -- Padding in X direction of the ellipse
448 around circled pedals. Default value 0.15.
450 @code{circle-y-padding} -- Padding in Y direction of the ellipse
451 around circled pedals. Default value@tie{}0.2.
453 (head-direction ,ly:dir? "Are the note heads left or right in a
455 (height ,ly:dimension? "Height of an object in @code{staff-space}
457 (height-limit ,ly:dimension? "Maximum slur height: The longer the
458 slur, the closer it is to this height.")
459 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
460 that appears on a tied note after a line break will not be displayed.")
461 (horizontal-shift ,integer? "An integer that identifies ranking
462 of @code{NoteColumn}s for horizontal shifting. This is used by
463 @rinternals{note-collision-interface}.")
464 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
465 left and one to the right of this grob.")
471 (ignore-collision ,boolean? "If set, don't do note collision
472 resolution on this @code{NoteColumn}.")
473 (implicit ,boolean? "Is this an implicit bass figure?")
474 (inspect-index ,integer? "If debugging is set, set beam and slur
475 configuration to this index, and print the respective scores.")
476 (inspect-quants ,number-pair? "If debugging is set, set beam and
477 slur quants to this position, and print the respective scores.")
483 (keep-inside-line ,boolean? "If set, this column cannot have
484 objects sticking into the margin.")
485 (kern ,ly:dimension? "Amount of extra white space to add. For
486 bar lines, this is the amount of space after a thick line.")
487 (knee ,boolean? "Is this beam kneed?")
488 (knee-spacing-correction ,number? "Factor for the optical
489 correction amount for kneed beams. Set between @code{0} for no
490 correction and @code{1} for full correction.")
496 (labels ,list? "List of labels (symbols) placed on a column.")
497 (layer ,integer? "An integer which determines the order of printing
498 objects. Objects with the lowest value of layer are drawn first, then
499 objects with progressively higher values are drawn, so objects with
500 higher values overwrite objects with lower values. By default most
501 objects are assigned a layer value of 1.")
502 (ledger-line-thickness ,number-pair? "The thickness of ledger
503 lines. It is the sum of 2@tie{}numbers: The first is the factor for
504 line thickness, and the second for staff space. Both contributions
506 (left-bound-info ,list? "An alist of properties for determining
507 attachments of spanners to edges.")
508 (left-padding ,ly:dimension? "The amount of space that is put
509 left to an object (e.g., a lyric extender).")
510 (length ,ly:dimension? "User override for the stem length of
512 (length-fraction ,number? "Multiplier for lengths. Used for
513 determining ledger lines and stem lengths.")
514 (line-break-penalty ,number? "Penalty for a line break at this
515 column. This affects the choices of the line breaker; it avoids a
516 line break at a column with a positive penalty and prefers a line
517 break at a column with a negative penalty.")
518 (line-break-permission ,symbol? "Instructs the line breaker on
519 whether to put a line break at this column. Can be @code{force} or
521 (line-break-system-details ,list? "An alist of properties to use
522 if this column is the start of a system.")
523 (line-count ,integer? "The number of staff lines.")
524 (line-positions ,list? "Vertical positions of staff lines.")
525 (line-thickness ,number? "The thickness of the tie or slur
527 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
533 (max-beam-connect ,integer? "Maximum number of beams to connect
534 to beams from this stem. Further beams are typeset as beamlets.")
535 (max-stretch ,number? "The maximum amount that this
536 @code{VerticalAxisGroup} can be vertically stretched (for example, in
537 order to better fill a page).")
538 (measure-count ,integer? "The number of measures for a
539 multi-measure rest.")
540 (measure-length ,ly:moment? "Length of a measure. Used in some
541 spacing situations.")
542 (merge-differently-dotted ,boolean? "Merge note heads in
543 collisions, even if they have a different number of dots. This is
544 normal notation for some types of polyphonic music.
546 @code{merge-differently-dotted} only applies to opposing stem
547 directions (i.e., voice 1 &@tie{}2).")
548 (merge-differently-headed ,boolean? "Merge note heads in
549 collisions, even if they have different note heads. The smaller of
550 the two heads is rendered invisible. This is used in polyphonic
551 guitar notation. The value of this setting is used by
552 @rinternals{note-collision-interface}.
554 @code{merge-differently-headed} only applies to opposing stem
555 directions (i.e., voice 1 &@tie{}2).")
556 (minimum-distance ,ly:dimension? "Minimum distance between rest
558 (minimum-length ,ly:dimension? "Try to make a spanner at least
559 this long, normally in the horizontal direction. This requires an
560 appropriate callback for the @code{springs-and-rods} property. If
561 added to a @code{Tie}, this sets the minimum distance between
563 (minimum-length-fraction ,number? "Minimum length of ledger line
564 as fraction of note head size.")
565 (minimum-space ,ly:dimension? "Minimum distance that the victim
566 should move (after padding).")
567 (minimum-X-extent ,number-pair? "Minimum size of an object in
568 X@tie{}dimension, measured in @code{staff-space} units.")
569 (minimum-Y-extent ,number-pair? "Minimum size of an object in
570 Y@tie{}dimension, measured in @code{staff-space} units.")
576 (neutral-direction ,ly:dir? "Which direction to take in the
577 center of the staff.")
578 (neutral-position ,number? "Position (in half staff spaces) where
579 to flip the direction of custos stem.")
580 (next ,ly:grob? "Object that is next relation (e.g., the lyric
581 syllable following an extender).")
582 (no-alignment ,boolean? "If set, don't place this grob in a
583 @code{VerticalAlignment}; rather, place it using its own
584 @code{Y-offset} callback.")
585 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
587 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
588 get stems extending to the middle staff line.")
589 (non-break-align-symbols ,list? "A list of symbols that determine
590 which NON-break-aligned interfaces to align this to.")
591 (non-default ,boolean? "Set for manually specified clefs.")
592 (non-musical ,boolean? "True if the grob belongs to a
593 @code{NonMusicalPaperColumn}.")
594 (nonstaff-nonstaff-spacing ,list? "The spacing alist
595 controlling the distance between the current non-staff line and
596 the next non-staff line in the direction of @code{staff-affinity},
597 if both are on the same side of the related staff, and
598 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
599 @code{staff-staff-spacing} for a description of the alist
601 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
602 controlling the distance between the current non-staff line and
603 the nearest staff in the direction of @code{staff-affinity}, if
604 there are no non-staff lines between the two, and
605 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
606 @code{staff-affinity} is @code{CENTER}, then
607 @code{nonstaff-relatedstaff-spacing} is used for the nearest
608 staves on @emph{both} sides, even if other non-staff lines appear
609 between the current one and either of the staves. See
610 @code{staff-staff-spacing} for a description of the alist
612 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
613 controlling the distance between the current non-staff line and
614 the nearest staff in the opposite direction from
615 @code{staff-affinity}, if there are no other non-staff lines
616 between the two, and @code{staff-affinity} is either @code{UP} or
617 @code{DOWN}. See @code{staff-staff-spacing} for a description of
618 the alist structure.")
619 (normalized-endpoints ,pair? "Represents left and right placement
620 over the total spanner, where the width of the spanner is normalized
622 (note-names ,vector? "Vector of strings containing names for
623 easy-notation note heads.")
629 (outside-staff-horizontal-padding ,number? "By default, an
630 outside-staff-object can be placed so that is it very close to another
631 grob horizontally. If this property is set, the outside-staff-object
632 is raised so that it is not so close to its neighbor.")
633 (outside-staff-padding ,number? "The padding to place between
634 this grob and the staff when spacing according to
635 @code{outside-staff-priority}.")
636 (outside-staff-priority ,number? "If set, the grob is positioned
637 outside the staff in such a way as to avoid all collisions. In case
638 of a potential collision, the grob with the smaller
639 @code{outside-staff-priority} is closer to the staff.")
645 (packed-spacing ,boolean? "If set, the notes are spaced as
646 tightly as possible.")
647 (padding ,ly:dimension? "Add this much extra space between
648 objects that are next to each other.")
649 (padding-pairs ,list? "An alist mapping @code{(@var{name}
650 . @var{name})} to distances.")
651 (page-break-penalty ,number? "Penalty for page break at this
652 column. This affects the choices of the page breaker; it avoids a
653 page break at a column with a positive penalty and prefers a page
654 break at a column with a negative penalty.")
655 (page-break-permission ,symbol? "Instructs the page breaker on
656 whether to put a page break at this column. Can be @code{force} or
658 (page-turn-penalty ,number? "Penalty for a page turn at this
659 column. This affects the choices of the page breaker; it avoids a
660 page turn at a column with a positive penalty and prefers a page turn
661 at a column with a negative penalty.")
662 (page-turn-permission ,symbol? "Instructs the page breaker on
663 whether to put a page turn at this column. Can be @code{force} or
665 (parenthesized ,boolean? "Parenthesize this grob.")
666 (positions ,number-pair? "Pair of staff coordinates
667 @code{(@var{left} . @var{right})}, where both @var{left} and
668 @var{right} are in @code{staff-space} units of the current staff. For
669 slurs, this value selects which slur candidate to use; if extreme
670 positions are requested, the closest one is taken.")
671 (prefer-dotted-right ,boolean? "For note collisions, prefer to
672 shift dotted up-note to the right, rather than shifting just the
679 (ratio ,number? "Parameter for slur shape. The higher this
680 number, the quicker the slur attains its @code{height-limit}.")
681 (remove-empty ,boolean? "If set, remove group if it contains no
683 (remove-first ,boolean? "Remove the first staff of an orchestral
685 (restore-first ,boolean? "Print a natural before the
687 (rhythmic-location ,rhythmic-location? "Where (bar number,
688 measure position) in the score.")
689 (right-bound-info ,list? "An alist of properties for determining
690 attachments of spanners to edges.")
691 (right-padding ,ly:dimension? "Space to insert on the right side
692 of an object (e.g., between note and its accidentals).")
693 (rotation ,list? "Number of degrees to rotate this object, and
694 what point to rotate around. For example, @code{#'(45 0 0)} rotates
695 by 45 degrees around the center of this object.")
701 (same-direction-correction ,number? "Optical correction amount
702 for stems that are placed in tight configurations. This amount is
703 used for stems with the same direction to compensate for note head to
705 (script-priority ,number? "A sorting key that determines in what
706 order a script is within a stack of scripts.")
707 (self-alignment-X ,number? "Specify alignment of an object. The
708 value @code{-1} means left aligned, @code{0}@tie{}centered, and
709 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
710 values may also be specified.")
711 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
713 (shorten-pair ,number-pair? "The lengths to shorten a
714 text-spanner on both sides, for example a pedal bracket. Positive
715 values shorten the text-spanner, while negative values lengthen it.")
716 (shortest-duration-space ,ly:dimension? "Start with this much
717 space for the shortest duration. This is expressed in
718 @code{spacing-increment} as unit. See also
719 @rinternals{spacing-spanner-interface}.")
720 (shortest-playing-duration ,ly:moment? "The duration of the
721 shortest note playing here.")
722 (shortest-starter-duration ,ly:moment? "The duration of the
723 shortest note that starts here.")
724 (side-axis ,number? "If the value is @code{#X} (or
725 equivalently@tie{}@code{0}), the object is placed horizontally next to
726 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
728 (side-relative-direction ,ly:dir? "Multiply direction of
729 @code{direction-source} with this to get the direction of this
731 (size ,number? "Size of object, relative to standard size.")
732 (skyline-horizontal-padding ,number? "For determining the
733 vertical distance between two staves, it is possible to have a
734 configuration which would result in a tight interleaving of grobs from
735 the top staff and the bottom staff. The larger this parameter is, the
736 farther apart the staves are placed in such a configuration.")
737 (skyline-vertical-padding ,number? "The amount by which the left
738 and right skylines of a column are padded vertically, beyond the
739 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
740 grobs in the column. Increase this to prevent interleaving of grobs
741 from adjacent columns.")
742 (slash-negative-kern ,number? "The space to remove between
743 slashes in percent repeat glyphs. Larger values bring the two
744 elements closer together.")
745 (slope ,number? "The slope of this object.")
746 (slur-padding ,number? "Extra distance between slur and script.")
747 (space-alist ,list? "A table that specifies distances between
748 prefatory items, like clef and time-signature. The format is an alist
749 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
750 . @var{distance})}, where @var{type} can be the symbols
751 @code{minimum-space} or @code{extra-space}.")
752 (space-to-barline ,boolean? "If set, the distance between a note
753 and the following non-musical column will be measured to the bar line
754 instead of to the beginning of the non-musical column. If there is a
755 clef change followed by a bar line, for example, this means that we
756 will try to space the non-musical column as though the clef is not
758 (spacing-increment ,number? "Add this much space for a doubled
759 duration. Typically, the width of a note head. See also
760 @rinternals{spacing-spanner-interface}.")
761 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
762 spacing relative to its left and right @code{BreakAlignment}s.
764 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
765 bounds (i.e., clefs, key signatures and time signatures) using the following
769 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
771 (springs-and-rods ,boolean? "Dummy variable for triggering
773 (stacking-dir ,ly:dir? "Stack objects in which direction?")
774 (staff-affinity ,ly:dir? "The direction of the staff to use
775 for spacing the current non-staff line. Choices are @code{UP},
776 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
777 line will be placed equidistant between the two nearest staves on
778 either side, unless collisions or other spacing constraints
779 prevent this. Setting @code{staff-affinity} for a staff causes it
780 to be treated as a non-staff line. Setting @code{staff-affinity}
781 to @code{#f} causes a non-staff line to be treated as a staff.")
782 (staff-padding ,ly:dimension? "Maintain this much space between
783 reference points and the staff. Its effect is to align objects of
784 differing sizes (like the dynamics @b{p} and @b{f}) on their
786 (staff-position ,number? "Vertical position, measured in half
787 staff spaces, counted from the middle line.")
788 (staff-space ,ly:dimension? "Amount of space between staff lines,
789 expressed in global @code{staff-space}.")
790 (staff-staff-spacing ,list? "When applied to a staff-group's
791 @code{StaffGrouper} grob, this spacing alist controls the distance
792 between consecutive staves within the staff-group. When applied
793 to a staff's @code{VerticalAxisGroup} grob, it controls the
794 distance between the staff and the nearest staff below it in the
795 same system, replacing any settings inherited from the
796 @code{StaffGrouper} grob of the containing staff-group, if there
797 is one. This property remains in effect even when non-staff lines
798 appear between staves. The alist can contain the following keys:
803 @code{basic-distance} -- the vertical distance, measured in
804 staff-spaces, between the reference points of the two items when
805 no collisions would result, and no stretching or compressing is in
809 @code{minimum-distance} -- the smallest allowable vertical
810 distance, measured in staff-spaces, between the reference points
811 of the two items, when compressing is in effect.
814 @code{padding} -- the minimum required amount of unobstructed
815 vertical whitespace between the bounding boxes (or skylines) of
816 the two items, measured in staff-spaces.
819 @code{stretchability} -- a unitless measure of the dimension's
820 relative propensity to stretch. If zero, the distance will not
821 stretch (unless collisions would result).
824 (staffgroup-staff-spacing ,list? "The spacing alist
825 controlling the distance between the last staff of the current
826 staff-group and the staff just below it in the same system, even
827 if one or more non-staff lines exist between the two staves. If
828 the @code{staff-staff-spacing} property of the staff's
829 @code{VerticalAxisGroup} grob is set, that is used instead. See
830 @code{staff-staff-spacing} for a description of the alist
832 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
833 pair where the stem attaches to the notehead.")
834 (stem-end-position ,number? "Where does the stem end (the end is
835 opposite to the support-head)?")
837 (stem-spacing-correction ,number? "Optical correction amount for
838 stems that are placed in tight configurations. For opposite
839 directions, this amount is the correction for two normal sized stems
840 that overlap completely.")
841 (stemlet-length ,number? "How long should be a stem over a
843 (stencil ,ly:stencil? "The symbol to print.")
844 (stencils ,list? "Multiple stencils, used as intermediate
846 (strict-grace-spacing ,boolean? "If set, main notes are spaced
847 normally, then grace notes are put left of the musical columns for the
849 (strict-note-spacing ,boolean? "If set, unbroken columns with
850 non-musical material (clefs, bar lines, etc.) are not spaced
851 separately, but put before musical columns.")
852 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
854 (style ,symbol? "This setting determines in what style a grob is
855 typeset. Valid choices depend on the @code{stencil} callback reading
862 (text ,markup? "Text markup. See @ruser{Formatting text}.")
863 ;;FIXME -- Should both be the same?
864 (text-direction ,ly:dir? "This controls the ordering of the
865 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
866 should use @code{LEFT}.")
867 (thick-thickness ,number? "Bar line thickness, measured in
868 @code{line-thickness}.")
869 (thickness ,number? "Line thickness, generally measured in
870 @code{line-thickness}.")
871 (thin-kern ,number? "The space after a hair-line in a bar line.")
872 (tie-configuration ,list? "List of @code{(@var{position} .
873 @var{dir})} pairs, indicating the desired tie configuration, where
874 @var{position} is the offset from the center of the staff in staff
875 space and @var{dir} indicates the direction of the tie
876 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
877 in the list causes the corresponding tie to be formatted
879 (to-barline ,boolean? "If true, the spanner will stop at the bar
880 line just before it would otherwise stop.")
881 (toward-stem-shift ,number? "Amount by which scripts are shifted
882 toward the stem if their direction coincides with the stem direction.
883 @code{0.0} means keep the default position (centered on the note
884 head), @code{1.0} means centered on the stem. Interpolated values are
886 (transparent ,boolean? "This makes the grob invisible.")
892 (uniform-stretching ,boolean? "If set, items stretch
893 proportionally to their durations. This looks better in complex
894 polyphonic patterns.")
895 (used ,boolean? "If set, this spacing column is kept in the
902 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
903 one below this grob.")
909 (when ,ly:moment? "Global time step associated with this column
911 (whiteout ,boolean? "If true, the grob is printed over a white
912 background to white-out underlying material, if the grob is visible.
913 Usually #f by default.")
914 (width ,ly:dimension? "The width of a grob measured in staff
916 (word-space ,ly:dimension? "Space to insert between words in
923 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
924 (X-offset ,number? "The horizontal amount that this object is
925 moved relative to its X-parent.")
931 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
932 (Y-offset ,number? "The vertical amount that this object is moved
933 relative to its Y-parent.")
938 (zigzag-length ,ly:dimension? "The length of the lines of a
939 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
940 gives 60-degree zigzags.")
941 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
942 This number is adjusted slightly so that the glissando line can be
943 constructed from a whole number of squiggles.")
951 (define (define-internal-grob-property symbol type? description)
952 (define-grob-property symbol type? description)
953 (set-object-property! symbol 'backend-internal #t)
958 (define-public all-internal-grob-properties
961 (apply define-internal-grob-property x))
965 ;; grobs & grob arrays. (alphabetical)
966 (accidental-grob ,ly:grob? "The accidental for this note.")
967 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
968 @var{groblist})} entries.")
969 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
971 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
972 function is to protect objects from being garbage collected.")
973 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
974 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
975 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
977 (bars ,ly:grob-array? "An array of bar line pointers.")
978 (beam ,ly:grob? "A pointer to the beam, if applicable.")
979 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
980 column as start/begin point. Only columns that have grobs or act as
982 (bracket ,ly:grob? "The bracket for a number.")
984 (columns ,ly:grob-array? "An array of grobs, typically containing
985 @code{PaperColumn} or @code{NoteColumn} objects.")
986 (conditional-elements ,ly:grob-array? "Internal use only.")
987 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
990 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
991 set, which grob to get the direction from.")
992 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
993 (dot ,ly:grob? "A reference to a @code{Dots} object.")
994 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
996 (elements ,ly:grob-array? "An array of grobs; the type is depending on
997 the grob where this is set in.")
998 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
999 in addition to notes and stems.")
1001 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1003 (grace-spacing ,ly:grob? "A run of grace notes.")
1005 (heads ,ly:grob-array? "An array of note heads.")
1007 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1008 empty in a particular staff, then that staff is erased.")
1010 (keep-alive-with ,ly:grob-array? "An array of other
1011 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1013 (left-items ,ly:grob-array? "DOCME")
1014 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1017 (normal-stems ,ly:grob-array? "An array of visible stems.")
1018 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1019 (note-head ,ly:grob? "A single note head.")
1020 (note-heads ,ly:grob-array? "An array of note head grobs.")
1021 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1023 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1024 that are relevant for finding the @code{pure-Y-extent}")
1025 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1026 relevant for finding the @code{pure-Y-extent}.")
1027 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1028 relevant for finding the @code{pure-Y-extent}.")
1029 (pure-Y-common ,ly:grob? "A cache of the
1030 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1032 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1033 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1034 (rests ,ly:grob-array? "An array of rest objects.")
1035 (right-items ,ly:grob-array? "DOCME")
1036 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1038 (side-support-elements ,ly:grob-array? "The side support, an array of
1040 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1041 (spacing ,ly:grob? "The spacing spanner governing this section.")
1042 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1044 (span-start ,boolean? "Is the note head at the start of a spanner?")
1045 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1046 LEFT is for the first spanner, and RIGHT is for the last. CENTER will
1047 place it on the broken spanner that falls closest to the center of the length
1048 of the entire spanner, although this behavior is unpredictable in situations
1049 with lots of rhythmic diversity. For predictable results, use LEFT and RIGHT.")
1050 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1051 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1052 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1053 (stems ,ly:grob-array? "An array of stem objects.")
1055 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1056 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1057 (tuplet-number ,ly:grob? "The number for a bracket.")
1058 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1059 (X-common ,ly:grob? "Common reference point for axis group.")
1060 (Y-common ,ly:grob? "See @code{X-common}.")
1064 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1065 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1068 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1069 This may differ from @code{Y-extent} because it does not include the dots in
1070 a repeat bar line.")
1071 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1072 @code{FretBoard} be visible only at beginning of line or at
1075 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1076 translator) that was the cause for this grob.")
1077 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1078 depend on inter-staff spacing.")
1080 (delta-position ,number? "The vertical position difference.")
1082 (font ,ly:font-metric? "A cached font metric object.")
1083 (forced ,boolean? "Manually forced accidental.")
1085 (head-width ,ly:dimension? "The width of this ligature head.")
1087 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1088 @var{strength}))} pairs.")
1089 (important-column-ranks ,vector? "A cache of columns that contain
1090 @code{items-worth-living} data.")
1091 (interfaces ,list? "A list of symbols indicating the interfaces
1092 supported by this object. It is initialized from the @code{meta} field.")
1094 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1096 (maybe-loose ,boolean? "Used to mark a breakable column that is
1097 loose if and only if it is in the middle of a line.")
1098 (meta ,list? "Provide meta information. It is an alist with the
1099 entries @code{name} and @code{interfaces}.")
1100 (minimum-distances ,list? "A list of rods that have the format
1101 @code{(@var{obj} . @var{dist})}.")
1103 (positioning-done ,boolean? "Used to signal that a positioning element
1104 did its job. This ensures that a positioning is only done once.")
1105 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1106 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1107 cyclic dependencies.")
1108 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1109 to be within staff spaces.")
1110 (quantized-positions ,number-pair? "The beam positions after
1113 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1114 acts as an index for looking up a @code{Stencil} object.")
1115 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1116 Internally used to distribute beam shortening over stems.")
1117 (stem-info ,pair? "A cache of stem parameters.")
1118 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1119 top-margin of the page) of the system to which this staff belongs.")
1121 (use-breve-rest ,boolean? "Use breve rests for measures longer
1122 than a whole rest.")
1128 ;; There are too many properties for ancient notation;
1129 ;; probably neume-types (a list of symbols) would also work.
1131 ;; However, such a list would consist of a couple of dozens of
1132 ;; entries, since head prefixes may be combined in many ways. If
1133 ;; the macros in `gregorian.ly' would directly set prefix-set,
1134 ;; all the head prefixes could be junked; however, such macros
1135 ;; would be quite numerous, I guess. --jr
1137 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1139 (add-join ,boolean? "Is this ligature head-joined with the next one
1140 by a vertical line?")
1141 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1142 an additional stem on the right side?")
1143 (ascendens ,boolean? "Is this neume of ascending type?")
1144 (auctum ,boolean? "Is this neume liquescentically augmented?")
1146 (cavum ,boolean? "Is this neume outlined?")
1147 (context-info ,integer? "Within a ligature, the final glyph or shape of
1148 a head may be affected by the left and/or right neighbour head.
1149 @code{context-info} holds for each head such information about the left and
1150 right neighbour, encoded as a bit mask.")
1152 (deminutum ,boolean? "Is this neume deminished?")
1153 (descendens ,boolean? "Is this neume of descendent type?")
1155 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1156 grob (in @code{staff-space} units).")
1157 (flexa-interval ,integer? "The interval spanned by the two notes of a
1158 flexa shape (1 is a second, 7 is an octave).")
1159 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1160 ligature grob in (in @code{staff-space} units).")
1161 (ligature-flexa ,boolean? "request joining note to the previous one
1164 (inclinatum ,boolean? "Is this neume an inclinatum?")
1167 (linea ,boolean? "Attach vertical lines to this neume?")
1169 (oriscus ,boolean? "Is this neume an oriscus?")
1171 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1173 (prefix-set ,number? "A bit mask that holds all Gregorian head
1174 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1175 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1176 similar to a note head that is part of a ligature.")
1178 (quilisma ,boolean? "Is this neume a quilisma?")
1180 (stropha ,boolean? "Is this neume a stropha?")
1182 (virga ,boolean? "Is this neume a virga?")
1184 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1188 (define-public all-backend-properties
1190 all-internal-grob-properties
1191 all-user-grob-properties))