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 (footnote-text ,markup? "A footnote for the grob.")
297 (force-hshift ,number? "This specifies a manual shift for notes
298 in collisions. The unit is the note head width of the first voice
299 note. This is used by @rinternals{note-collision-interface}.")
300 (fraction ,number-pair? "Numerator and denominator of a time
302 (french-beaming ,boolean? "Use French beaming style for this
303 stem. The stem stops at the innermost beams.")
304 (fret-diagram-details ,list? "An alist of detailed grob
305 properties for fret diagrams. Each alist entry consists of a
306 @code{(@var{property} . @var{value})} pair. The properties which can
307 be included in @code{fret-diagram-details} include the following:
311 @code{barre-type} -- Type of barre indication used. Choices include
312 @code{curved}, @code{straight}, and @code{none}. Default
315 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
316 fret-space. Default value@tie{}0.5.
318 @code{dot-color} -- Color of dots. Options include @code{black} and
319 @code{white}. Default @code{black}.
321 @code{dot-label-font-mag} -- Magnification for font used to label fret
322 dots. Default value@tie{}1.
324 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
325 dots without labels, 0.95-@code{dot-radius} for dots with labels.
327 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
328 value 0.425 for labeled dots, 0.25 for unlabeled dots.
330 @code{finger-code} -- Code for the type of fingering indication used.
331 Options include @code{none}, @code{in-dot}, and @code{below-string}.
332 Default @code{none} for markup fret diagrams, @code{below-string} for
333 @code{FretBoards} fret diagrams.
335 @code{fret-count} -- The number of frets. Default@tie{}4.
337 @code{fret-label-font-mag} -- The magnification of the font used to
338 label the lowest fret number. Default@tie{}0.5.
340 @code{fret-label-vertical-offset} -- The offset of the fret label from
341 the center of the fret in direction parallel to strings.
344 @code{label-dir} -- Side to which the fret label is attached.
345 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
346 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
348 @code{mute-string} -- Character string to be used to indicate muted
349 string. Default @code{\"x\"}.
351 @code{number-type} -- Type of numbers to use in fret label. Choices
352 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
353 Default @code{roman-lower}.
355 @code{open-string} -- Character string to be used to indicate open
356 string. Default @code{\"o\"}.
358 @code{orientation} -- Orientation of fret-diagram. Options include
359 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
360 Default @code{normal}.
362 @code{string-count} -- The number of strings. Default@tie{}6.
364 @code{string-label-font-mag} -- The magnification of the font used to
365 label fingerings at the string, rather than in the dot. Default value
366 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
367 @code{opposing-landscape}.
369 @code{string-thickness-factor} -- Factor for changing thickness of
370 each string in the fret diagram. Thickness of string @var{k} is given
372 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
375 @code{top-fret-thickness} -- The thickness of the top fret line, as a
376 multiple of the standard thickness. Default value@tie{}3.
378 @code{xo-font-magnification} -- Magnification used for mute and open
379 string indicators. Default value@tie{}0.5.
381 @code{xo-padding} -- Padding for open and mute indicators from top
382 fret. Default value 0.25.
384 ;; ugh: double, change.
385 (full-length-padding ,number? "How much padding to use at the
386 right side of a full-length tuplet bracket.")
387 (full-length-to-extent ,boolean? "Run to the extent of the column
388 for a full-length tuplet bracket.")
389 (full-measure-extra-space ,number? "Extra space that is allocated
390 at the beginning of a measure with only one note. This property is
391 read from the NonMusicalPaperColumn that begins the measure.")
392 (full-size-change ,boolean? "Don't make a change clef smaller.")
398 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
399 (gap-count ,integer? "Number of gapped beams for tremolo.")
400 (glyph ,string? "A string determining what @q{style} of glyph is
401 typeset. Valid choices depend on the function that is reading this
403 (glyph-name ,string? "The glyph name within the font.")
404 (glyph-name-alist ,list? "An alist of key-string pairs.")
405 (graphical ,boolean? "Display in graphical (vs. text) form.")
406 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
412 (hair-thickness ,number? "Thickness of the thin line in a bar
414 (harp-pedal-details ,list? "An alist of detailed grob properties
415 for harp pedal diagrams. Each alist entry consists of a
416 @code{(@var{property} . @var{value})} pair. The properties which can
417 be included in harp-pedal-details include the following:
421 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
422 boxes above/below the horizontal line. Default value@tie{}0.8.
424 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
426 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
428 @code{space-before-divider} -- Space between boxes before the first
429 divider (so that the diagram can be made symmetric). Default
432 @code{space-after-divider} -- Space between boxes after the first
433 divider. Default value@tie{}0.8.
435 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
436 of the ellipse around circled pedals. Default value@tie{}0.5.
438 @code{circle-x-padding} -- Padding in X direction of the ellipse
439 around circled pedals. Default value 0.15.
441 @code{circle-y-padding} -- Padding in Y direction of the ellipse
442 around circled pedals. Default value@tie{}0.2.
444 (head-direction ,ly:dir? "Are the note heads left or right in a
446 (height ,ly:dimension? "Height of an object in @code{staff-space}
448 (height-limit ,ly:dimension? "Maximum slur height: The longer the
449 slur, the closer it is to this height.")
450 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
451 that appears on a tied note after a line break will not be displayed.")
452 (horizontal-shift ,integer? "An integer that identifies ranking
453 of @code{NoteColumn}s for horizontal shifting. This is used by
454 @rinternals{note-collision-interface}.")
455 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
456 left and one to the right of this grob.")
462 (ignore-collision ,boolean? "If set, don't do note collision
463 resolution on this @code{NoteColumn}.")
464 (implicit ,boolean? "Is this an implicit bass figure?")
465 (inspect-index ,integer? "If debugging is set, set beam and slur
466 configuration to this index, and print the respective scores.")
467 (inspect-quants ,number-pair? "If debugging is set, set beam and
468 slur quants to this position, and print the respective scores.")
474 (keep-inside-line ,boolean? "If set, this column cannot have
475 objects sticking into the margin.")
476 (kern ,ly:dimension? "Amount of extra white space to add. For
477 bar lines, this is the amount of space after a thick line.")
478 (knee ,boolean? "Is this beam kneed?")
479 (knee-spacing-correction ,number? "Factor for the optical
480 correction amount for kneed beams. Set between @code{0} for no
481 correction and @code{1} for full correction.")
487 (labels ,list? "List of labels (symbols) placed on a column.")
488 (layer ,integer? "An integer which determines the order of printing
489 objects. Objects with the lowest value of layer are drawn first, then
490 objects with progressively higher values are drawn, so objects with
491 higher values overwrite objects with lower values. By default most
492 objects are assigned a layer value of 1.")
493 (ledger-line-thickness ,number-pair? "The thickness of ledger
494 lines. It is the sum of 2@tie{}numbers: The first is the factor for
495 line thickness, and the second for staff space. Both contributions
497 (left-bound-info ,list? "An alist of properties for determining
498 attachments of spanners to edges.")
499 (left-padding ,ly:dimension? "The amount of space that is put
500 left to an object (e.g., a lyric extender).")
501 (length ,ly:dimension? "User override for the stem length of
503 (length-fraction ,number? "Multiplier for lengths. Used for
504 determining ledger lines and stem lengths.")
505 (line-break-penalty ,number? "Penalty for a line break at this
506 column. This affects the choices of the line breaker; it avoids a
507 line break at a column with a positive penalty and prefers a line
508 break at a column with a negative penalty.")
509 (line-break-permission ,symbol? "Instructs the line breaker on
510 whether to put a line break at this column. Can be @code{force} or
512 (line-break-system-details ,list? "An alist of properties to use
513 if this column is the start of a system.")
514 (line-count ,integer? "The number of staff lines.")
515 (line-positions ,list? "Vertical positions of staff lines.")
516 (line-thickness ,number? "The thickness of the tie or slur
518 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
524 (max-beam-connect ,integer? "Maximum number of beams to connect
525 to beams from this stem. Further beams are typeset as beamlets.")
526 (max-stretch ,number? "The maximum amount that this
527 @code{VerticalAxisGroup} can be vertically stretched (for example, in
528 order to better fill a page).")
529 (measure-count ,integer? "The number of measures for a
530 multi-measure rest.")
531 (measure-length ,ly:moment? "Length of a measure. Used in some
532 spacing situations.")
533 (merge-differently-dotted ,boolean? "Merge note heads in
534 collisions, even if they have a different number of dots. This is
535 normal notation for some types of polyphonic music.
537 @code{merge-differently-dotted} only applies to opposing stem
538 directions (i.e., voice 1 &@tie{}2).")
539 (merge-differently-headed ,boolean? "Merge note heads in
540 collisions, even if they have different note heads. The smaller of
541 the two heads is rendered invisible. This is used in polyphonic
542 guitar notation. The value of this setting is used by
543 @rinternals{note-collision-interface}.
545 @code{merge-differently-headed} only applies to opposing stem
546 directions (i.e., voice 1 &@tie{}2).")
547 (minimum-distance ,ly:dimension? "Minimum distance between rest
549 (minimum-length ,ly:dimension? "Try to make a spanner at least
550 this long, normally in the horizontal direction. This requires an
551 appropriate callback for the @code{springs-and-rods} property. If
552 added to a @code{Tie}, this sets the minimum distance between
554 (minimum-length-fraction ,number? "Minimum length of ledger line
555 as fraction of note head size.")
556 (minimum-space ,ly:dimension? "Minimum distance that the victim
557 should move (after padding).")
558 (minimum-X-extent ,number-pair? "Minimum size of an object in
559 X@tie{}dimension, measured in @code{staff-space} units.")
560 (minimum-Y-extent ,number-pair? "Minimum size of an object in
561 Y@tie{}dimension, measured in @code{staff-space} units.")
567 (neutral-direction ,ly:dir? "Which direction to take in the
568 center of the staff.")
569 (neutral-position ,number? "Position (in half staff spaces) where
570 to flip the direction of custos stem.")
571 (next ,ly:grob? "Object that is next relation (e.g., the lyric
572 syllable following an extender).")
573 (no-alignment ,boolean? "If set, don't place this grob in a
574 @code{VerticalAlignment}; rather, place it using its own
575 @code{Y-offset} callback.")
576 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
578 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
579 get stems extending to the middle staff line.")
580 (non-break-align-symbols ,list? "A list of symbols that determine
581 which NON-break-aligned interfaces to align this to.")
582 (non-default ,boolean? "Set for manually specified clefs.")
583 (non-musical ,boolean? "True if the grob belongs to a
584 @code{NonMusicalPaperColumn}.")
585 (nonstaff-nonstaff-spacing ,list? "The spacing alist
586 controlling the distance between the current non-staff line and
587 the next non-staff line in the direction of @code{staff-affinity},
588 if both are on the same side of the related staff, and
589 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
590 @code{staff-staff-spacing} for a description of the alist
592 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
593 controlling the distance between the current non-staff line and
594 the nearest staff in the direction of @code{staff-affinity}, if
595 there are no non-staff lines between the two, and
596 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
597 @code{staff-affinity} is @code{CENTER}, then
598 @code{nonstaff-relatedstaff-spacing} is used for the nearest
599 staves on @emph{both} sides, even if other non-staff lines appear
600 between the current one and either of the staves. See
601 @code{staff-staff-spacing} for a description of the alist
603 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
604 controlling the distance between the current non-staff line and
605 the nearest staff in the opposite direction from
606 @code{staff-affinity}, if there are no other non-staff lines
607 between the two, and @code{staff-affinity} is either @code{UP} or
608 @code{DOWN}. See @code{staff-staff-spacing} for a description of
609 the alist structure.")
610 (note-names ,vector? "Vector of strings containing names for
611 easy-notation note heads.")
617 (outside-staff-horizontal-padding ,number? "By default, an
618 outside-staff-object can be placed so that is it very close to another
619 grob horizontally. If this property is set, the outside-staff-object
620 is raised so that it is not so close to its neighbor.")
621 (outside-staff-padding ,number? "The padding to place between
622 this grob and the staff when spacing according to
623 @code{outside-staff-priority}.")
624 (outside-staff-priority ,number? "If set, the grob is positioned
625 outside the staff in such a way as to avoid all collisions. In case
626 of a potential collision, the grob with the smaller
627 @code{outside-staff-priority} is closer to the staff.")
633 (packed-spacing ,boolean? "If set, the notes are spaced as
634 tightly as possible.")
635 (padding ,ly:dimension? "Add this much extra space between
636 objects that are next to each other.")
637 (padding-pairs ,list? "An alist mapping @code{(@var{name}
638 . @var{name})} to distances.")
639 (page-break-penalty ,number? "Penalty for page break at this
640 column. This affects the choices of the page breaker; it avoids a
641 page break at a column with a positive penalty and prefers a page
642 break at a column with a negative penalty.")
643 (page-break-permission ,symbol? "Instructs the page breaker on
644 whether to put a page break at this column. Can be @code{force} or
646 (page-turn-penalty ,number? "Penalty for a page turn at this
647 column. This affects the choices of the page breaker; it avoids a
648 page turn at a column with a positive penalty and prefers a page turn
649 at a column with a negative penalty.")
650 (page-turn-permission ,symbol? "Instructs the page breaker on
651 whether to put a page turn at this column. Can be @code{force} or
653 (parenthesized ,boolean? "Parenthesize this grob.")
654 (positions ,number-pair? "Pair of staff coordinates
655 @code{(@var{left} . @var{right})}, where both @var{left} and
656 @var{right} are in @code{staff-space} units of the current staff. For
657 slurs, this value selects which slur candidate to use; if extreme
658 positions are requested, the closest one is taken.")
659 (prefer-dotted-right ,boolean? "For note collisions, prefer to
660 shift dotted up-note to the right, rather than shifting just the
667 (ratio ,number? "Parameter for slur shape. The higher this
668 number, the quicker the slur attains its @code{height-limit}.")
669 (remove-empty ,boolean? "If set, remove group if it contains no
671 (remove-first ,boolean? "Remove the first staff of an orchestral
673 (restore-first ,boolean? "Print a natural before the
675 (rhythmic-location ,rhythmic-location? "Where (bar number,
676 measure position) in the score.")
677 (right-bound-info ,list? "An alist of properties for determining
678 attachments of spanners to edges.")
679 (right-padding ,ly:dimension? "Space to insert on the right side
680 of an object (e.g., between note and its accidentals).")
681 (rotation ,list? "Number of degrees to rotate this object, and
682 what point to rotate around. For example, @code{#'(45 0 0)} rotates
683 by 45 degrees around the center of this object.")
689 (same-direction-correction ,number? "Optical correction amount
690 for stems that are placed in tight configurations. This amount is
691 used for stems with the same direction to compensate for note head to
693 (script-priority ,number? "A sorting key that determines in what
694 order a script is within a stack of scripts.")
695 (self-alignment-X ,number? "Specify alignment of an object. The
696 value @code{-1} means left aligned, @code{0}@tie{}centered, and
697 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
698 values may also be specified.")
699 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
701 (shorten-pair ,number-pair? "The lengths to shorten a
702 text-spanner on both sides, for example a pedal bracket. Positive
703 values shorten the text-spanner, while negative values lengthen it.")
704 (shortest-duration-space ,ly:dimension? "Start with this much
705 space for the shortest duration. This is expressed in
706 @code{spacing-increment} as unit. See also
707 @rinternals{spacing-spanner-interface}.")
708 (shortest-playing-duration ,ly:moment? "The duration of the
709 shortest note playing here.")
710 (shortest-starter-duration ,ly:moment? "The duration of the
711 shortest note that starts here.")
712 (side-axis ,number? "If the value is @code{#X} (or
713 equivalently@tie{}@code{0}), the object is placed horizontally next to
714 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
716 (side-relative-direction ,ly:dir? "Multiply direction of
717 @code{direction-source} with this to get the direction of this
719 (size ,number? "Size of object, relative to standard size.")
720 (skyline-horizontal-padding ,number? "For determining the
721 vertical distance between two staves, it is possible to have a
722 configuration which would result in a tight interleaving of grobs from
723 the top staff and the bottom staff. The larger this parameter is, the
724 farther apart the staves are placed in such a configuration.")
725 (skyline-vertical-padding ,number? "The amount by which the left
726 and right skylines of a column are padded vertically, beyond the
727 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
728 grobs in the column. Increase this to prevent interleaving of grobs
729 from adjacent columns.")
730 (slash-negative-kern ,number? "The space to remove between
731 slashes in percent repeat glyphs. Larger values bring the two
732 elements closer together.")
733 (slope ,number? "The slope of this object.")
734 (slur-padding ,number? "Extra distance between slur and script.")
735 (space-alist ,list? "A table that specifies distances between
736 prefatory items, like clef and time-signature. The format is an alist
737 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
738 . @var{distance})}, where @var{type} can be the symbols
739 @code{minimum-space} or @code{extra-space}.")
740 (space-to-barline ,boolean? "If set, the distance between a note
741 and the following non-musical column will be measured to the bar line
742 instead of to the beginning of the non-musical column. If there is a
743 clef change followed by a bar line, for example, this means that we
744 will try to space the non-musical column as though the clef is not
746 (spacing-increment ,number? "Add this much space for a doubled
747 duration. Typically, the width of a note head. See also
748 @rinternals{spacing-spanner-interface}.")
749 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
750 spacing relative to its left and right @code{BreakAlignment}s.
752 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
753 bounds (i.e., clefs, key signatures and time signatures) using the following
757 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
759 (springs-and-rods ,boolean? "Dummy variable for triggering
761 (stacking-dir ,ly:dir? "Stack objects in which direction?")
762 (staff-affinity ,ly:dir? "The direction of the staff to use
763 for spacing the current non-staff line. Choices are @code{UP},
764 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
765 line will be placed equidistant between the two nearest staves on
766 either side, unless collisions or other spacing constraints
767 prevent this. Setting @code{staff-affinity} for a staff causes it
768 to be treated as a non-staff line. Setting @code{staff-affinity}
769 to @code{#f} causes a non-staff line to be treated as a staff.")
770 (staff-padding ,ly:dimension? "Maintain this much space between
771 reference points and the staff. Its effect is to align objects of
772 differing sizes (like the dynamics @b{p} and @b{f}) on their
774 (staff-position ,number? "Vertical position, measured in half
775 staff spaces, counted from the middle line.")
776 (staff-space ,ly:dimension? "Amount of space between staff lines,
777 expressed in global @code{staff-space}.")
778 (staff-staff-spacing ,list? "When applied to a staff-group's
779 @code{StaffGrouper} grob, this spacing alist controls the distance
780 between consecutive staves within the staff-group. When applied
781 to a staff's @code{VerticalAxisGroup} grob, it controls the
782 distance between the staff and the nearest staff below it in the
783 same system, replacing any settings inherited from the
784 @code{StaffGrouper} grob of the containing staff-group, if there
785 is one. This property remains in effect even when non-staff lines
786 appear between staves. The alist can contain the following keys:
791 @code{basic-distance} -- the vertical distance, measured in
792 staff-spaces, between the reference points of the two items when
793 no collisions would result, and no stretching or compressing is in
797 @code{minimum-distance} -- the smallest allowable vertical
798 distance, measured in staff-spaces, between the reference points
799 of the two items, when compressing is in effect.
802 @code{padding} -- the minimum required amount of unobstructed
803 vertical whitespace between the bounding boxes (or skylines) of
804 the two items, measured in staff-spaces.
807 @code{stretchability} -- a unitless measure of the dimension's
808 relative propensity to stretch. If zero, the distance will not
809 stretch (unless collisions would result).
812 (staffgroup-staff-spacing ,list? "The spacing alist
813 controlling the distance between the last staff of the current
814 staff-group and the staff just below it in the same system, even
815 if one or more non-staff lines exist between the two staves. If
816 the @code{staff-staff-spacing} property of the staff's
817 @code{VerticalAxisGroup} grob is set, that is used instead. See
818 @code{staff-staff-spacing} for a description of the alist
820 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
821 pair where the stem attaches to the notehead.")
822 (stem-end-position ,number? "Where does the stem end (the end is
823 opposite to the support-head)?")
825 (stem-spacing-correction ,number? "Optical correction amount for
826 stems that are placed in tight configurations. For opposite
827 directions, this amount is the correction for two normal sized stems
828 that overlap completely.")
829 (stemlet-length ,number? "How long should be a stem over a
831 (stencil ,ly:stencil? "The symbol to print.")
832 (stencils ,list? "Multiple stencils, used as intermediate
834 (strict-grace-spacing ,boolean? "If set, main notes are spaced
835 normally, then grace notes are put left of the musical columns for the
837 (strict-note-spacing ,boolean? "If set, unbroken columns with
838 non-musical material (clefs, bar lines, etc.) are not spaced
839 separately, but put before musical columns.")
840 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
842 (style ,symbol? "This setting determines in what style a grob is
843 typeset. Valid choices depend on the @code{stencil} callback reading
850 (text ,markup? "Text markup. See @ruser{Formatting text}.")
851 ;;FIXME -- Should both be the same?
852 (text-direction ,ly:dir? "This controls the ordering of the
853 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
854 should use @code{LEFT}.")
855 (thick-thickness ,number? "Bar line thickness, measured in
856 @code{line-thickness}.")
857 (thickness ,number? "Line thickness, generally measured in
858 @code{line-thickness}.")
859 (thin-kern ,number? "The space after a hair-line in a bar line.")
860 (tie-configuration ,list? "List of @code{(@var{position} .
861 @var{dir})} pairs, indicating the desired tie configuration, where
862 @var{position} is the offset from the center of the staff in staff
863 space and @var{dir} indicates the direction of the tie
864 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
865 in the list causes the corresponding tie to be formatted
867 (to-barline ,boolean? "If true, the spanner will stop at the bar
868 line just before it would otherwise stop.")
869 (toward-stem-shift ,number? "Amount by which scripts are shifted
870 toward the stem if their direction coincides with the stem direction.
871 @code{0.0} means keep the default position (centered on the note
872 head), @code{1.0} means centered on the stem. Interpolated values are
874 (transparent ,boolean? "This makes the grob invisible.")
880 (uniform-stretching ,boolean? "If set, items stretch
881 proportionally to their durations. This looks better in complex
882 polyphonic patterns.")
883 (used ,boolean? "If set, this spacing column is kept in the
890 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
891 one below this grob.")
897 (when ,ly:moment? "Global time step associated with this column
899 (whiteout ,boolean? "If true, the grob is printed over a white
900 background to white-out underlying material, if the grob is visible.
901 Usually #f by default.")
902 (width ,ly:dimension? "The width of a grob measured in staff
904 (word-space ,ly:dimension? "Space to insert between words in
911 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
912 (X-offset ,number? "The horizontal amount that this object is
913 moved relative to its X-parent.")
919 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
920 (Y-offset ,number? "The vertical amount that this object is moved
921 relative to its Y-parent.")
926 (zigzag-length ,ly:dimension? "The length of the lines of a
927 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
928 gives 60-degree zigzags.")
929 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
930 This number is adjusted slightly so that the glissando line can be
931 constructed from a whole number of squiggles.")
939 (define (define-internal-grob-property symbol type? description)
940 (define-grob-property symbol type? description)
941 (set-object-property! symbol 'backend-internal #t)
946 (define-public all-internal-grob-properties
949 (apply define-internal-grob-property x))
953 ;; grobs & grob arrays. (alphabetical)
954 (accidental-grob ,ly:grob? "The accidental for this note.")
955 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
956 @var{groblist})} entries.")
957 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
959 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
960 function is to protect objects from being garbage collected.")
961 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
962 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
963 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
965 (bars ,ly:grob-array? "An array of bar line pointers.")
966 (beam ,ly:grob? "A pointer to the beam, if applicable.")
967 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
968 column as start/begin point. Only columns that have grobs or act as
970 (bracket ,ly:grob? "The bracket for a number.")
972 (columns ,ly:grob-array? "An array of grobs, typically containing
973 @code{PaperColumn} or @code{NoteColumn} objects.")
974 (conditional-elements ,ly:grob-array? "Internal use only.")
975 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
978 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
979 set, which grob to get the direction from.")
980 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
981 (dot ,ly:grob? "A reference to a @code{Dots} object.")
982 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
984 (elements ,ly:grob-array? "An array of grobs; the type is depending on
985 the grob where this is set in.")
986 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
987 in addition to notes and stems.")
989 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
991 (grace-spacing ,ly:grob? "A run of grace notes.")
993 (heads ,ly:grob-array? "An array of note heads.")
995 (items-worth-living ,ly:grob-array? "An array of interesting items. If
996 empty in a particular staff, then that staff is erased.")
998 (keep-alive-with ,ly:grob-array? "An array of other
999 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1001 (left-items ,ly:grob-array? "DOCME")
1002 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1005 (normal-stems ,ly:grob-array? "An array of visible stems.")
1006 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1007 (note-head ,ly:grob? "A single note head.")
1008 (note-heads ,ly:grob-array? "An array of note head grobs.")
1009 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1011 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1012 that are relevant for finding the @code{pure-Y-extent}")
1013 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1014 relevant for finding the @code{pure-Y-extent}.")
1015 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1016 relevant for finding the @code{pure-Y-extent}.")
1017 (pure-Y-common ,ly:grob? "A cache of the
1018 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1020 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1021 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1022 (rests ,ly:grob-array? "An array of rest objects.")
1023 (right-items ,ly:grob-array? "DOCME")
1024 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1026 (side-support-elements ,ly:grob-array? "The side support, an array of
1028 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1029 (spacing ,ly:grob? "The spacing spanner governing this section.")
1030 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1032 (span-start ,boolean? "Is the note head at the start of a spanner?")
1033 (spanner-placement ,number? "The place of an annotation on a spanner.
1034 Note that this number must be between -1 and 1, with -1 representing the
1035 beginning of the spanner and 1 representing the end. The annotation will
1036 still be placed at the left or right extremity of the spanner, but this
1037 number ensures that when line breaking happens, the annotation is assigned
1038 to the correct broken piece and the footnote is put on the correct page.
1039 An important caveat is that this number applies to column ranks, not staff
1040 space. For example, 0 will place the annotation at the middle column of
1041 its parent's span, which may be to the right or left of the physical middle
1043 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1044 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1045 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1046 (stems ,ly:grob-array? "An array of stem objects.")
1048 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1049 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1050 (tuplet-number ,ly:grob? "The number for a bracket.")
1051 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1052 (X-common ,ly:grob? "Common reference point for axis group.")
1053 (Y-common ,ly:grob? "See @code{X-common}.")
1057 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1058 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1061 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1062 This may differ from @code{Y-extent} because it does not include the dots in
1063 a repeat bar line.")
1064 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1065 @code{FretBoard} be visible only at beginning of line or at
1068 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1069 translator) that was the cause for this grob.")
1070 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1071 depend on inter-staff spacing.")
1073 (delta-position ,number? "The vertical position difference.")
1075 (font ,ly:font-metric? "A cached font metric object.")
1076 (forced ,boolean? "Manually forced accidental.")
1078 (head-width ,ly:dimension? "The width of this ligature head.")
1080 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1081 @var{strength}))} pairs.")
1082 (important-column-ranks ,vector? "A cache of columns that contain
1083 @code{items-worth-living} data.")
1084 (interfaces ,list? "A list of symbols indicating the interfaces
1085 supported by this object. It is initialized from the @code{meta} field.")
1087 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1089 (maybe-loose ,boolean? "Used to mark a breakable column that is
1090 loose if and only if it is in the middle of a line.")
1091 (meta ,list? "Provide meta information. It is an alist with the
1092 entries @code{name} and @code{interfaces}.")
1093 (minimum-distances ,list? "A list of rods that have the format
1094 @code{(@var{obj} . @var{dist})}.")
1096 (positioning-done ,boolean? "Used to signal that a positioning element
1097 did its job. This ensures that a positioning is only done once.")
1098 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1099 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1100 cyclic dependencies.")
1101 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1102 to be within staff spaces.")
1103 (quantized-positions ,number-pair? "The beam positions after
1106 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1107 acts as an index for looking up a @code{Stencil} object.")
1108 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1109 Internally used to distribute beam shortening over stems.")
1110 (stem-info ,pair? "A cache of stem parameters.")
1111 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1112 top-margin of the page) of the system to which this staff belongs.")
1114 (use-breve-rest ,boolean? "Use breve rests for measures longer
1115 than a whole rest.")
1121 ;; There are too many properties for ancient notation;
1122 ;; probably neume-types (a list of symbols) would also work.
1124 ;; However, such a list would consist of a couple of dozens of
1125 ;; entries, since head prefixes may be combined in many ways. If
1126 ;; the macros in `gregorian.ly' would directly set prefix-set,
1127 ;; all the head prefixes could be junked; however, such macros
1128 ;; would be quite numerous, I guess. --jr
1130 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1132 (add-join ,boolean? "Is this ligature head-joined with the next one
1133 by a vertical line?")
1134 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1135 an additional stem on the right side?")
1136 (ascendens ,boolean? "Is this neume of ascending type?")
1137 (auctum ,boolean? "Is this neume liquescentically augmented?")
1139 (cavum ,boolean? "Is this neume outlined?")
1140 (context-info ,integer? "Within a ligature, the final glyph or shape of
1141 a head may be affected by the left and/or right neighbour head.
1142 @code{context-info} holds for each head such information about the left and
1143 right neighbour, encoded as a bit mask.")
1145 (deminutum ,boolean? "Is this neume deminished?")
1146 (descendens ,boolean? "Is this neume of descendent type?")
1148 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1149 grob (in @code{staff-space} units).")
1150 (flexa-interval ,integer? "The interval spanned by the two notes of a
1151 flexa shape (1 is a second, 7 is an octave).")
1152 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1153 ligature grob in (in @code{staff-space} units).")
1154 (ligature-flexa ,boolean? "request joining note to the previous one
1157 (inclinatum ,boolean? "Is this neume an inclinatum?")
1160 (linea ,boolean? "Attach vertical lines to this neume?")
1162 (oriscus ,boolean? "Is this neume an oriscus?")
1164 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1166 (prefix-set ,number? "A bit mask that holds all Gregorian head
1167 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1168 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1169 similar to a note head that is part of a ligature.")
1171 (quilisma ,boolean? "Is this neume a quilisma?")
1173 (stropha ,boolean? "Is this neume a stropha?")
1175 (virga ,boolean? "Is this neume a virga?")
1177 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1181 (define-public all-backend-properties
1183 all-internal-grob-properties
1184 all-user-grob-properties))