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