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-font-mag} -- The magnification of the font used to
341 label the lowest fret number. Default@tie{}0.5.
343 @code{fret-label-vertical-offset} -- The offset of the fret label from
344 the center of the fret in direction parallel to strings.
347 @code{label-dir} -- Side to which the fret label is attached.
348 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
349 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
351 @code{mute-string} -- Character string to be used to indicate muted
352 string. Default @code{\"x\"}.
354 @code{number-type} -- Type of numbers to use in fret label. Choices
355 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
356 Default @code{roman-lower}.
358 @code{open-string} -- Character string to be used to indicate open
359 string. Default @code{\"o\"}.
361 @code{orientation} -- Orientation of fret-diagram. Options include
362 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
363 Default @code{normal}.
365 @code{string-count} -- The number of strings. Default@tie{}6.
367 @code{string-label-font-mag} -- The magnification of the font used to
368 label fingerings at the string, rather than in the dot. Default value
369 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
370 @code{opposing-landscape}.
372 @code{string-thickness-factor} -- Factor for changing thickness of
373 each string in the fret diagram. Thickness of string @var{k} is given
375 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
378 @code{top-fret-thickness} -- The thickness of the top fret line, as a
379 multiple of the standard thickness. Default value@tie{}3.
381 @code{xo-font-magnification} -- Magnification used for mute and open
382 string indicators. Default value@tie{}0.5.
384 @code{xo-padding} -- Padding for open and mute indicators from top
385 fret. Default value 0.25.
387 ;; ugh: double, change.
388 (full-length-padding ,number? "How much padding to use at the
389 right side of a full-length tuplet bracket.")
390 (full-length-to-extent ,boolean? "Run to the extent of the column
391 for a full-length tuplet bracket.")
392 (full-measure-extra-space ,number? "Extra space that is allocated
393 at the beginning of a measure with only one note. This property is
394 read from the NonMusicalPaperColumn that begins the measure.")
395 (full-size-change ,boolean? "Don't make a change clef smaller.")
401 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
402 (gap-count ,integer? "Number of gapped beams for tremolo.")
403 (glyph ,string? "A string determining what @q{style} of glyph is
404 typeset. Valid choices depend on the function that is reading this
406 (glyph-name ,string? "The glyph name within the font.")
407 (glyph-name-alist ,list? "An alist of key-string pairs.")
408 (graphical ,boolean? "Display in graphical (vs. text) form.")
409 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
415 (hair-thickness ,number? "Thickness of the thin line in a bar
417 (harp-pedal-details ,list? "An alist of detailed grob properties
418 for harp pedal diagrams. Each alist entry consists of a
419 @code{(@var{property} . @var{value})} pair. The properties which can
420 be included in harp-pedal-details include the following:
424 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
425 boxes above/below the horizontal line. Default value@tie{}0.8.
427 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
429 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
431 @code{space-before-divider} -- Space between boxes before the first
432 divider (so that the diagram can be made symmetric). Default
435 @code{space-after-divider} -- Space between boxes after the first
436 divider. Default value@tie{}0.8.
438 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
439 of the ellipse around circled pedals. Default value@tie{}0.5.
441 @code{circle-x-padding} -- Padding in X direction of the ellipse
442 around circled pedals. Default value 0.15.
444 @code{circle-y-padding} -- Padding in Y direction of the ellipse
445 around circled pedals. Default value@tie{}0.2.
447 (head-direction ,ly:dir? "Are the note heads left or right in a
449 (height ,ly:dimension? "Height of an object in @code{staff-space}
451 (height-limit ,ly:dimension? "Maximum slur height: The longer the
452 slur, the closer it is to this height.")
453 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
454 that appears on a tied note after a line break will not be displayed.")
455 (horizontal-shift ,integer? "An integer that identifies ranking
456 of @code{NoteColumn}s for horizontal shifting. This is used by
457 @rinternals{note-collision-interface}.")
458 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
459 left and one to the right of this grob.")
465 (ignore-collision ,boolean? "If set, don't do note collision
466 resolution on this @code{NoteColumn}.")
467 (implicit ,boolean? "Is this an implicit bass figure?")
468 (inspect-index ,integer? "If debugging is set, set beam and slur
469 configuration to this index, and print the respective scores.")
470 (inspect-quants ,number-pair? "If debugging is set, set beam and
471 slur quants to this position, and print the respective scores.")
477 (keep-inside-line ,boolean? "If set, this column cannot have
478 objects sticking into the margin.")
479 (kern ,ly:dimension? "Amount of extra white space to add. For
480 bar lines, this is the amount of space after a thick line.")
481 (knee ,boolean? "Is this beam kneed?")
482 (knee-spacing-correction ,number? "Factor for the optical
483 correction amount for kneed beams. Set between @code{0} for no
484 correction and @code{1} for full correction.")
490 (labels ,list? "List of labels (symbols) placed on a column.")
491 (layer ,integer? "An integer which determines the order of printing
492 objects. Objects with the lowest value of layer are drawn first, then
493 objects with progressively higher values are drawn, so objects with
494 higher values overwrite objects with lower values. By default most
495 objects are assigned a layer value of 1.")
496 (ledger-line-thickness ,number-pair? "The thickness of ledger
497 lines. It is the sum of 2@tie{}numbers: The first is the factor for
498 line thickness, and the second for staff space. Both contributions
500 (left-bound-info ,list? "An alist of properties for determining
501 attachments of spanners to edges.")
502 (left-padding ,ly:dimension? "The amount of space that is put
503 left to an object (e.g., a lyric extender).")
504 (length ,ly:dimension? "User override for the stem length of
506 (length-fraction ,number? "Multiplier for lengths. Used for
507 determining ledger lines and stem lengths.")
508 (line-break-penalty ,number? "Penalty for a line break at this
509 column. This affects the choices of the line breaker; it avoids a
510 line break at a column with a positive penalty and prefers a line
511 break at a column with a negative penalty.")
512 (line-break-permission ,symbol? "Instructs the line breaker on
513 whether to put a line break at this column. Can be @code{force} or
515 (line-break-system-details ,list? "An alist of properties to use
516 if this column is the start of a system.")
517 (line-count ,integer? "The number of staff lines.")
518 (line-positions ,list? "Vertical positions of staff lines.")
519 (line-thickness ,number? "The thickness of the tie or slur
521 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
527 (max-beam-connect ,integer? "Maximum number of beams to connect
528 to beams from this stem. Further beams are typeset as beamlets.")
529 (max-stretch ,number? "The maximum amount that this
530 @code{VerticalAxisGroup} can be vertically stretched (for example, in
531 order to better fill a page).")
532 (measure-count ,integer? "The number of measures for a
533 multi-measure rest.")
534 (measure-length ,ly:moment? "Length of a measure. Used in some
535 spacing situations.")
536 (merge-differently-dotted ,boolean? "Merge note heads in
537 collisions, even if they have a different number of dots. This is
538 normal notation for some types of polyphonic music.
540 @code{merge-differently-dotted} only applies to opposing stem
541 directions (i.e., voice 1 &@tie{}2).")
542 (merge-differently-headed ,boolean? "Merge note heads in
543 collisions, even if they have different note heads. The smaller of
544 the two heads is rendered invisible. This is used in polyphonic
545 guitar notation. The value of this setting is used by
546 @rinternals{note-collision-interface}.
548 @code{merge-differently-headed} only applies to opposing stem
549 directions (i.e., voice 1 &@tie{}2).")
550 (minimum-distance ,ly:dimension? "Minimum distance between rest
552 (minimum-length ,ly:dimension? "Try to make a spanner at least
553 this long, normally in the horizontal direction. This requires an
554 appropriate callback for the @code{springs-and-rods} property. If
555 added to a @code{Tie}, this sets the minimum distance between
557 (minimum-length-fraction ,number? "Minimum length of ledger line
558 as fraction of note head size.")
559 (minimum-space ,ly:dimension? "Minimum distance that the victim
560 should move (after padding).")
561 (minimum-X-extent ,number-pair? "Minimum size of an object in
562 X@tie{}dimension, measured in @code{staff-space} units.")
563 (minimum-Y-extent ,number-pair? "Minimum size of an object in
564 Y@tie{}dimension, measured in @code{staff-space} units.")
570 (neutral-direction ,ly:dir? "Which direction to take in the
571 center of the staff.")
572 (neutral-position ,number? "Position (in half staff spaces) where
573 to flip the direction of custos stem.")
574 (next ,ly:grob? "Object that is next relation (e.g., the lyric
575 syllable following an extender).")
576 (no-alignment ,boolean? "If set, don't place this grob in a
577 @code{VerticalAlignment}; rather, place it using its own
578 @code{Y-offset} callback.")
579 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
581 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
582 get stems extending to the middle staff line.")
583 (non-break-align-symbols ,list? "A list of symbols that determine
584 which NON-break-aligned interfaces to align this to.")
585 (non-default ,boolean? "Set for manually specified clefs.")
586 (non-musical ,boolean? "True if the grob belongs to a
587 @code{NonMusicalPaperColumn}.")
588 (nonstaff-nonstaff-spacing ,list? "The spacing alist
589 controlling the distance between the current non-staff line and
590 the next non-staff line in the direction of @code{staff-affinity},
591 if both are on the same side of the related staff, and
592 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
593 @code{staff-staff-spacing} for a description of the alist
595 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
596 controlling the distance between the current non-staff line and
597 the nearest staff in the direction of @code{staff-affinity}, if
598 there are no non-staff lines between the two, and
599 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
600 @code{staff-affinity} is @code{CENTER}, then
601 @code{nonstaff-relatedstaff-spacing} is used for the nearest
602 staves on @emph{both} sides, even if other non-staff lines appear
603 between the current one and either of the staves. See
604 @code{staff-staff-spacing} for a description of the alist
606 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
607 controlling the distance between the current non-staff line and
608 the nearest staff in the opposite direction from
609 @code{staff-affinity}, if there are no other non-staff lines
610 between the two, and @code{staff-affinity} is either @code{UP} or
611 @code{DOWN}. See @code{staff-staff-spacing} for a description of
612 the alist structure.")
613 (note-names ,vector? "Vector of strings containing names for
614 easy-notation note heads.")
620 (outside-staff-horizontal-padding ,number? "By default, an
621 outside-staff-object can be placed so that is it very close to another
622 grob horizontally. If this property is set, the outside-staff-object
623 is raised so that it is not so close to its neighbor.")
624 (outside-staff-padding ,number? "The padding to place between
625 this grob and the staff when spacing according to
626 @code{outside-staff-priority}.")
627 (outside-staff-priority ,number? "If set, the grob is positioned
628 outside the staff in such a way as to avoid all collisions. In case
629 of a potential collision, the grob with the smaller
630 @code{outside-staff-priority} is closer to the staff.")
636 (packed-spacing ,boolean? "If set, the notes are spaced as
637 tightly as possible.")
638 (padding ,ly:dimension? "Add this much extra space between
639 objects that are next to each other.")
640 (padding-pairs ,list? "An alist mapping @code{(@var{name}
641 . @var{name})} to distances.")
642 (page-break-penalty ,number? "Penalty for page break at this
643 column. This affects the choices of the page breaker; it avoids a
644 page break at a column with a positive penalty and prefers a page
645 break at a column with a negative penalty.")
646 (page-break-permission ,symbol? "Instructs the page breaker on
647 whether to put a page break at this column. Can be @code{force} or
649 (page-turn-penalty ,number? "Penalty for a page turn at this
650 column. This affects the choices of the page breaker; it avoids a
651 page turn at a column with a positive penalty and prefers a page turn
652 at a column with a negative penalty.")
653 (page-turn-permission ,symbol? "Instructs the page breaker on
654 whether to put a page turn at this column. Can be @code{force} or
656 (parenthesized ,boolean? "Parenthesize this grob.")
657 (positions ,number-pair? "Pair of staff coordinates
658 @code{(@var{left} . @var{right})}, where both @var{left} and
659 @var{right} are in @code{staff-space} units of the current staff. For
660 slurs, this value selects which slur candidate to use; if extreme
661 positions are requested, the closest one is taken.")
662 (prefer-dotted-right ,boolean? "For note collisions, prefer to
663 shift dotted up-note to the right, rather than shifting just the
670 (ratio ,number? "Parameter for slur shape. The higher this
671 number, the quicker the slur attains its @code{height-limit}.")
672 (remove-empty ,boolean? "If set, remove group if it contains no
674 (remove-first ,boolean? "Remove the first staff of an orchestral
676 (restore-first ,boolean? "Print a natural before the
678 (rhythmic-location ,rhythmic-location? "Where (bar number,
679 measure position) in the score.")
680 (right-bound-info ,list? "An alist of properties for determining
681 attachments of spanners to edges.")
682 (right-padding ,ly:dimension? "Space to insert on the right side
683 of an object (e.g., between note and its accidentals).")
684 (rotation ,list? "Number of degrees to rotate this object, and
685 what point to rotate around. For example, @code{#'(45 0 0)} rotates
686 by 45 degrees around the center of this object.")
692 (same-direction-correction ,number? "Optical correction amount
693 for stems that are placed in tight configurations. This amount is
694 used for stems with the same direction to compensate for note head to
696 (script-priority ,number? "A sorting key that determines in what
697 order a script is within a stack of scripts.")
698 (self-alignment-X ,number? "Specify alignment of an object. The
699 value @code{-1} means left aligned, @code{0}@tie{}centered, and
700 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
701 values may also be specified.")
702 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
704 (shorten-pair ,number-pair? "The lengths to shorten a
705 text-spanner on both sides, for example a pedal bracket. Positive
706 values shorten the text-spanner, while negative values lengthen it.")
707 (shortest-duration-space ,ly:dimension? "Start with this much
708 space for the shortest duration. This is expressed in
709 @code{spacing-increment} as unit. See also
710 @rinternals{spacing-spanner-interface}.")
711 (shortest-playing-duration ,ly:moment? "The duration of the
712 shortest note playing here.")
713 (shortest-starter-duration ,ly:moment? "The duration of the
714 shortest note that starts here.")
715 (side-axis ,number? "If the value is @code{#X} (or
716 equivalently@tie{}@code{0}), the object is placed horizontally next to
717 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
719 (side-relative-direction ,ly:dir? "Multiply direction of
720 @code{direction-source} with this to get the direction of this
722 (size ,number? "Size of object, relative to standard size.")
723 (skyline-horizontal-padding ,number? "For determining the
724 vertical distance between two staves, it is possible to have a
725 configuration which would result in a tight interleaving of grobs from
726 the top staff and the bottom staff. The larger this parameter is, the
727 farther apart the staves are placed in such a configuration.")
728 (skyline-vertical-padding ,number? "The amount by which the left
729 and right skylines of a column are padded vertically, beyond the
730 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
731 grobs in the column. Increase this to prevent interleaving of grobs
732 from adjacent columns.")
733 (slash-negative-kern ,number? "The space to remove between
734 slashes in percent repeat glyphs. Larger values bring the two
735 elements closer together.")
736 (slope ,number? "The slope of this object.")
737 (slur-padding ,number? "Extra distance between slur and script.")
738 (space-alist ,list? "A table that specifies distances between
739 prefatory items, like clef and time-signature. The format is an alist
740 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
741 . @var{distance})}, where @var{type} can be the symbols
742 @code{minimum-space} or @code{extra-space}.")
743 (space-to-barline ,boolean? "If set, the distance between a note
744 and the following non-musical column will be measured to the bar line
745 instead of to the beginning of the non-musical column. If there is a
746 clef change followed by a bar line, for example, this means that we
747 will try to space the non-musical column as though the clef is not
749 (spacing-increment ,number? "Add this much space for a doubled
750 duration. Typically, the width of a note head. See also
751 @rinternals{spacing-spanner-interface}.")
752 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
753 spacing relative to its left and right @code{BreakAlignment}s.
755 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
756 bounds (i.e., clefs, key signatures and time signatures) using the following
760 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
762 (springs-and-rods ,boolean? "Dummy variable for triggering
764 (stacking-dir ,ly:dir? "Stack objects in which direction?")
765 (staff-affinity ,ly:dir? "The direction of the staff to use
766 for spacing the current non-staff line. Choices are @code{UP},
767 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
768 line will be placed equidistant between the two nearest staves on
769 either side, unless collisions or other spacing constraints
770 prevent this. Setting @code{staff-affinity} for a staff causes it
771 to be treated as a non-staff line. Setting @code{staff-affinity}
772 to @code{#f} causes a non-staff line to be treated as a staff.")
773 (staff-padding ,ly:dimension? "Maintain this much space between
774 reference points and the staff. Its effect is to align objects of
775 differing sizes (like the dynamics @b{p} and @b{f}) on their
777 (staff-position ,number? "Vertical position, measured in half
778 staff spaces, counted from the middle line.")
779 (staff-space ,ly:dimension? "Amount of space between staff lines,
780 expressed in global @code{staff-space}.")
781 (staff-staff-spacing ,list? "When applied to a staff-group's
782 @code{StaffGrouper} grob, this spacing alist controls the distance
783 between consecutive staves within the staff-group. When applied
784 to a staff's @code{VerticalAxisGroup} grob, it controls the
785 distance between the staff and the nearest staff below it in the
786 same system, replacing any settings inherited from the
787 @code{StaffGrouper} grob of the containing staff-group, if there
788 is one. This property remains in effect even when non-staff lines
789 appear between staves. The alist can contain the following keys:
794 @code{basic-distance} -- the vertical distance, measured in
795 staff-spaces, between the reference points of the two items when
796 no collisions would result, and no stretching or compressing is in
800 @code{minimum-distance} -- the smallest allowable vertical
801 distance, measured in staff-spaces, between the reference points
802 of the two items, when compressing is in effect.
805 @code{padding} -- the minimum required amount of unobstructed
806 vertical whitespace between the bounding boxes (or skylines) of
807 the two items, measured in staff-spaces.
810 @code{stretchability} -- a unitless measure of the dimension's
811 relative propensity to stretch. If zero, the distance will not
812 stretch (unless collisions would result).
815 (staffgroup-staff-spacing ,list? "The spacing alist
816 controlling the distance between the last staff of the current
817 staff-group and the staff just below it in the same system, even
818 if one or more non-staff lines exist between the two staves. If
819 the @code{staff-staff-spacing} property of the staff's
820 @code{VerticalAxisGroup} grob is set, that is used instead. See
821 @code{staff-staff-spacing} for a description of the alist
823 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
824 pair where the stem attaches to the notehead.")
825 (stem-end-position ,number? "Where does the stem end (the end is
826 opposite to the support-head)?")
828 (stem-spacing-correction ,number? "Optical correction amount for
829 stems that are placed in tight configurations. For opposite
830 directions, this amount is the correction for two normal sized stems
831 that overlap completely.")
832 (stemlet-length ,number? "How long should be a stem over a
834 (stencil ,ly:stencil? "The symbol to print.")
835 (stencils ,list? "Multiple stencils, used as intermediate
837 (strict-grace-spacing ,boolean? "If set, main notes are spaced
838 normally, then grace notes are put left of the musical columns for the
840 (strict-note-spacing ,boolean? "If set, unbroken columns with
841 non-musical material (clefs, bar lines, etc.) are not spaced
842 separately, but put before musical columns.")
843 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
845 (style ,symbol? "This setting determines in what style a grob is
846 typeset. Valid choices depend on the @code{stencil} callback reading
853 (text ,markup? "Text markup. See @ruser{Formatting text}.")
854 ;;FIXME -- Should both be the same?
855 (text-direction ,ly:dir? "This controls the ordering of the
856 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
857 should use @code{LEFT}.")
858 (thick-thickness ,number? "Bar line thickness, measured in
859 @code{line-thickness}.")
860 (thickness ,number? "Line thickness, generally measured in
861 @code{line-thickness}.")
862 (thin-kern ,number? "The space after a hair-line in a bar line.")
863 (tie-configuration ,list? "List of @code{(@var{position} .
864 @var{dir})} pairs, indicating the desired tie configuration, where
865 @var{position} is the offset from the center of the staff in staff
866 space and @var{dir} indicates the direction of the tie
867 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
868 in the list causes the corresponding tie to be formatted
870 (to-barline ,boolean? "If true, the spanner will stop at the bar
871 line just before it would otherwise stop.")
872 (toward-stem-shift ,number? "Amount by which scripts are shifted
873 toward the stem if their direction coincides with the stem direction.
874 @code{0.0} means keep the default position (centered on the note
875 head), @code{1.0} means centered on the stem. Interpolated values are
877 (transparent ,boolean? "This makes the grob invisible.")
883 (uniform-stretching ,boolean? "If set, items stretch
884 proportionally to their durations. This looks better in complex
885 polyphonic patterns.")
886 (used ,boolean? "If set, this spacing column is kept in the
893 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
894 one below this grob.")
900 (when ,ly:moment? "Global time step associated with this column
902 (whiteout ,boolean? "If true, the grob is printed over a white
903 background to white-out underlying material, if the grob is visible.
904 Usually #f by default.")
905 (width ,ly:dimension? "The width of a grob measured in staff
907 (word-space ,ly:dimension? "Space to insert between words in
914 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
915 (X-offset ,number? "The horizontal amount that this object is
916 moved relative to its X-parent.")
922 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
923 (Y-offset ,number? "The vertical amount that this object is moved
924 relative to its Y-parent.")
929 (zigzag-length ,ly:dimension? "The length of the lines of a
930 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
931 gives 60-degree zigzags.")
932 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
933 This number is adjusted slightly so that the glissando line can be
934 constructed from a whole number of squiggles.")
942 (define (define-internal-grob-property symbol type? description)
943 (define-grob-property symbol type? description)
944 (set-object-property! symbol 'backend-internal #t)
949 (define-public all-internal-grob-properties
952 (apply define-internal-grob-property x))
956 ;; grobs & grob arrays. (alphabetical)
957 (accidental-grob ,ly:grob? "The accidental for this note.")
958 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
959 @var{groblist})} entries.")
960 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
962 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
963 function is to protect objects from being garbage collected.")
964 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
965 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
966 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
968 (bars ,ly:grob-array? "An array of bar line pointers.")
969 (beam ,ly:grob? "A pointer to the beam, if applicable.")
970 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
971 column as start/begin point. Only columns that have grobs or act as
973 (bracket ,ly:grob? "The bracket for a number.")
975 (columns ,ly:grob-array? "An array of grobs, typically containing
976 @code{PaperColumn} or @code{NoteColumn} objects.")
977 (conditional-elements ,ly:grob-array? "Internal use only.")
978 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
981 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
982 set, which grob to get the direction from.")
983 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
984 (dot ,ly:grob? "A reference to a @code{Dots} object.")
985 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
987 (elements ,ly:grob-array? "An array of grobs; the type is depending on
988 the grob where this is set in.")
989 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
990 in addition to notes and stems.")
992 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
994 (grace-spacing ,ly:grob? "A run of grace notes.")
996 (heads ,ly:grob-array? "An array of note heads.")
998 (items-worth-living ,ly:grob-array? "An array of interesting items. If
999 empty in a particular staff, then that staff is erased.")
1001 (keep-alive-with ,ly:grob-array? "An array of other
1002 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1004 (left-items ,ly:grob-array? "DOCME")
1005 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1008 (normal-stems ,ly:grob-array? "An array of visible stems.")
1009 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1010 (note-head ,ly:grob? "A single note head.")
1011 (note-heads ,ly:grob-array? "An array of note head grobs.")
1012 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1014 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1015 that are relevant for finding the @code{pure-Y-extent}")
1016 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1017 relevant for finding the @code{pure-Y-extent}.")
1018 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1019 relevant for finding the @code{pure-Y-extent}.")
1020 (pure-Y-common ,ly:grob? "A cache of the
1021 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1023 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1024 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1025 (rests ,ly:grob-array? "An array of rest objects.")
1026 (right-items ,ly:grob-array? "DOCME")
1027 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1029 (side-support-elements ,ly:grob-array? "The side support, an array of
1031 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1032 (spacing ,ly:grob? "The spacing spanner governing this section.")
1033 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1035 (span-start ,boolean? "Is the note head at the start of a spanner?")
1036 (spanner-placement ,number? "The place of an annotation on a spanner.
1037 Note that this number must be between -1 and 1, with -1 representing the
1038 beginning of the spanner and 1 representing the end. The annotation will
1039 still be placed at the left or right extremity of the spanner, but this
1040 number ensures that when line breaking happens, the annotation is assigned
1041 to the correct broken piece and the footnote is put on the correct page.
1042 An important caveat is that this number applies to column ranks, not staff
1043 space. For example, 0 will place the annotation at the middle column of
1044 its parent's span, which may be to the right or left of the physical middle
1046 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1047 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1048 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1049 (stems ,ly:grob-array? "An array of stem objects.")
1051 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1052 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1053 (tuplet-number ,ly:grob? "The number for a bracket.")
1054 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1055 (X-common ,ly:grob? "Common reference point for axis group.")
1056 (Y-common ,ly:grob? "See @code{X-common}.")
1060 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1061 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1064 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1065 This may differ from @code{Y-extent} because it does not include the dots in
1066 a repeat bar line.")
1067 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1068 @code{FretBoard} be visible only at beginning of line or at
1071 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1072 translator) that was the cause for this grob.")
1073 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1074 depend on inter-staff spacing.")
1076 (delta-position ,number? "The vertical position difference.")
1078 (font ,ly:font-metric? "A cached font metric object.")
1079 (forced ,boolean? "Manually forced accidental.")
1081 (head-width ,ly:dimension? "The width of this ligature head.")
1083 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1084 @var{strength}))} pairs.")
1085 (important-column-ranks ,vector? "A cache of columns that contain
1086 @code{items-worth-living} data.")
1087 (interfaces ,list? "A list of symbols indicating the interfaces
1088 supported by this object. It is initialized from the @code{meta} field.")
1090 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1092 (maybe-loose ,boolean? "Used to mark a breakable column that is
1093 loose if and only if it is in the middle of a line.")
1094 (meta ,list? "Provide meta information. It is an alist with the
1095 entries @code{name} and @code{interfaces}.")
1096 (minimum-distances ,list? "A list of rods that have the format
1097 @code{(@var{obj} . @var{dist})}.")
1099 (positioning-done ,boolean? "Used to signal that a positioning element
1100 did its job. This ensures that a positioning is only done once.")
1101 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1102 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1103 cyclic dependencies.")
1104 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1105 to be within staff spaces.")
1106 (quantized-positions ,number-pair? "The beam positions after
1109 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1110 acts as an index for looking up a @code{Stencil} object.")
1111 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1112 Internally used to distribute beam shortening over stems.")
1113 (stem-info ,pair? "A cache of stem parameters.")
1114 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1115 top-margin of the page) of the system to which this staff belongs.")
1117 (use-breve-rest ,boolean? "Use breve rests for measures longer
1118 than a whole rest.")
1124 ;; There are too many properties for ancient notation;
1125 ;; probably neume-types (a list of symbols) would also work.
1127 ;; However, such a list would consist of a couple of dozens of
1128 ;; entries, since head prefixes may be combined in many ways. If
1129 ;; the macros in `gregorian.ly' would directly set prefix-set,
1130 ;; all the head prefixes could be junked; however, such macros
1131 ;; would be quite numerous, I guess. --jr
1133 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1135 (add-join ,boolean? "Is this ligature head-joined with the next one
1136 by a vertical line?")
1137 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1138 an additional stem on the right side?")
1139 (ascendens ,boolean? "Is this neume of ascending type?")
1140 (auctum ,boolean? "Is this neume liquescentically augmented?")
1142 (cavum ,boolean? "Is this neume outlined?")
1143 (context-info ,integer? "Within a ligature, the final glyph or shape of
1144 a head may be affected by the left and/or right neighbour head.
1145 @code{context-info} holds for each head such information about the left and
1146 right neighbour, encoded as a bit mask.")
1148 (deminutum ,boolean? "Is this neume deminished?")
1149 (descendens ,boolean? "Is this neume of descendent type?")
1151 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1152 grob (in @code{staff-space} units).")
1153 (flexa-interval ,integer? "The interval spanned by the two notes of a
1154 flexa shape (1 is a second, 7 is an octave).")
1155 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1156 ligature grob in (in @code{staff-space} units).")
1157 (ligature-flexa ,boolean? "request joining note to the previous one
1160 (inclinatum ,boolean? "Is this neume an inclinatum?")
1163 (linea ,boolean? "Attach vertical lines to this neume?")
1165 (oriscus ,boolean? "Is this neume an oriscus?")
1167 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1169 (prefix-set ,number? "A bit mask that holds all Gregorian head
1170 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1171 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1172 similar to a note head that is part of a ligature.")
1174 (quilisma ,boolean? "Is this neume a quilisma?")
1176 (stropha ,boolean? "Is this neume a stropha?")
1178 (virga ,boolean? "Is this neume a virga?")
1180 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1184 (define-public all-backend-properties
1186 all-internal-grob-properties
1187 all-user-grob-properties))