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 (automatically-numbered ,boolean? "Should a footnote be automatically
63 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
64 averaged over staves.")
65 (avoid-note-head ,boolean? "If set, the stem of a chord does not
66 pass through all note heads, but starts at the last note head.")
67 (avoid-slur ,symbol? "Method of handling slur collisions.
68 Choices are @code{inside}, @code{outside}, @code{around}, and
69 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
70 grob inside the slur. @code{outside} moves the grob vertically to the
71 outside of the slur. @code{around} moves the grob vertically to the
72 outside of the slur only if there is a collision. @code{ignore} does
73 not move either. In grobs whose notational significance depends on
74 vertical position (such as accidentals, clefs, etc.), @code{outside}
75 and @code{around} behave like @code{ignore}.")
76 (axes ,list? "List of axis numbers. In the case of alignment
77 grobs, this should contain only one number.")
83 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
84 This may differ from @code{Y-extent} because it does not include the
85 dots in a repeat bar line.")
86 (base-shortest-duration ,ly:moment? "Spacing is based on the
87 shortest notes in a piece. Normally, pieces are spaced as if notes at
88 least as short as this are present.")
89 (baseline-skip ,ly:dimension? "Distance between base lines of
90 multiple lines of text.")
91 (beam-thickness ,ly:dimension? "Beam thickness, measured in
92 @code{staff-space} units.")
93 (beam-width ,ly:dimension? "Width of the tremolo sign.")
94 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
95 when their direction is forced. It is a list, since the value is
96 different depending on the number of flags and beams.")
97 (beaming ,pair? "Pair of number lists. Each number list
98 specifies which beams to make. @code{0}@tie{}is the central beam,
99 @code{1}@tie{}is the next beam toward the note, etc. This information
100 is used to determine how to connect the beaming patterns from stem to
101 stem inside a beam.")
102 (beamlet-default-length ,pair? "A pair of numbers. The first
103 number specifies the default length of a beamlet that sticks out of
104 the left hand side of this stem; the second number specifies the
105 default length of the beamlet to the right. The actual length of a
106 beamlet is determined by taking either the default length or the
107 length specified by @code{beamlet-max-length-proportion}, whichever is
109 (beamlet-max-length-proportion ,pair? "The maximum length of a
110 beamlet, as a proportion of the distance between two adjacent stems.")
111 (before-line-breaking ,boolean? "Dummy property, used to trigger
112 a callback function.")
113 (between-cols ,pair? "Where to attach a loose column to.")
114 (bound-details ,list? "An alist of properties for determining
115 attachments of spanners to edges.")
116 (bound-padding ,number? "The amount of padding to insert around
118 (bracket-flare ,number-pair? "A pair of numbers specifying how
119 much edges of brackets should slant outward. Value @code{0.0} means
121 (bracket-visibility ,boolean-or-symbol? "This controls the
122 visibility of the tuplet bracket. Setting it to false prevents
123 printing of the bracket. Setting the property to @code{if-no-beam}
124 makes it print only if there is no beam associated with this tuplet
126 (break-align-anchor ,number? "Grobs aligned to this break-align
127 grob will have their X-offsets shifted by this number. In bar lines,
128 for example, this is used to position grobs relative to the (visual)
129 center of the bar line.")
130 (break-align-anchor-alignment ,number? "Read by
131 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
132 aligning an anchor to a grob's extent.")
133 (break-align-orders ,vector? "Defines the order in which
134 prefatory matter (clefs, key signatures) appears. The format is a
135 vector of length@tie{}3, where each element is one order for
136 end-of-line, middle of line, and start-of-line, respectively. An
137 order is a list of symbols.
139 For example, clefs are put after key signatures by setting
142 \\override Score.BreakAlignment #'break-align-orders =
143 #(make-vector 3 '(span-bar
150 (break-align-symbol ,symbol? "This key is used for aligning and
151 spacing breakable items.")
152 (break-align-symbols ,list? "A list of symbols that determine
153 which break-aligned grobs to align this to. If the grob selected by
154 the first symbol in the list is invisible due to break-visibility, we
155 will align to the next grob (and so on). Choices are @code{left-edge},
156 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
157 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
159 (break-overshoot ,number-pair? "How much does a broken spanner
160 stick out of its bounds?")
161 (break-visibility ,vector? "A vector of 3@tie{}booleans,
162 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
163 @code{#t} means visible, @code{#f} means killed.")
164 (breakable ,boolean? "Allow breaks here.")
169 (c0-position ,integer? "An integer indicating the position of
171 (circled-tip ,boolean? "Put a circle at start/@/end of
172 hairpins (al/@/del niente).")
173 (clip-edges ,boolean? "Allow outward pointing beamlets at the
175 (collapse-height ,ly:dimension? "Minimum height of system start
176 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
177 (collision-bias ,number? "Number determining how much to favor the
178 left (negative) or right (positive). Larger absolute values in either
179 direction will push a collision in this direction.")
180 (collision-interfaces ,list? "A list of interfaces for which
181 automatic beam-collision resolution is run.")
182 (collision-padding ,number? "Amount of padding to apply after
183 a collision is detected via the self-alignment-interface.")
184 (collision-voice-only ,boolean? "Does automatic beam collsion apply
185 only to the voice in which the beam was created?")
186 (color ,color? "The color of this grob.")
187 (common-shortest-duration ,ly:moment? "The most common shortest
188 note length. This is used in spacing. Enlarging this sets the score
190 (concaveness ,number? "A beam is concave if its inner stems are
191 closer to the beam than the two outside stems. This number is a
192 measure of the closeness of the inner stems. It is used for damping
193 the slope of the beam.")
194 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
195 this grob looks as a continued break.")
196 (control-points ,list? "List of offsets (number pairs) that form
197 control points for the tie, slur, or bracket shape. For B@'eziers,
198 this should list the control points of a third-order B@'ezier curve.")
203 (damping ,number? "Amount of beam slope damping.")
204 (dash-definition ,pair? "List of @code{dash-elements} defining the
205 dash structure. Each @code{dash-element} has a starting t value,
206 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
207 (dash-fraction ,number? "Size of the dashes, relative to
208 @code{dash-period}. Should be between @code{0.0} (no line) and
209 @code{1.0} (continuous line).")
210 (dash-period ,number? "The length of one dash together with
211 whitespace. If negative, no line is drawn at all.")
212 (default-direction ,ly:dir? "Direction determined by note head
214 (default-staff-staff-spacing ,list? "The settings to use for
215 @code{staff-staff-spacing} when it is unset, for ungrouped staves
216 and for grouped staves that do not have the relevant
217 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
218 @code{staffgroup-staff-spacing}).")
219 (details ,list? "Alist of parameters for detailed grob behavior.
220 More information on the allowed parameters for a grob can be found by
221 looking at the top of the Internals Reference page for each interface
222 having a @code{details} property.")
223 (digit-names ,vector? "Names for string finger digits.")
224 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
225 @code{X}), then this property determines whether the object is placed
226 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
227 other object. Otherwise, it determines whether the object is placed
228 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
229 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
230 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
231 @code{CENTER}=@code{0}.")
232 (dot-count ,integer? "The number of dots.")
233 (dot-negative-kern ,number? "The space to remove between a dot
234 and a slash in percent repeat glyphs. Larger values bring the two
235 elements closer together.")
236 (dot-placement-list ,list? "List consisting of
237 @code{(@var{description} @var{string-number} @var{fret-number}
238 @var{finger-number})} entries used to define fret diagrams.")
239 (duration-log ,integer? "The 2-log of the note head duration,
240 i.e., @code{0} = whole note, @code{1} = half note, etc.")
246 (eccentricity ,number? "How asymmetrical to make a slur.
247 Positive means move the center to the right.")
248 (edge-height ,pair? "A pair of numbers specifying the heights of
249 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
250 (edge-text ,pair? "A pair specifying the texts to be set at the
251 edges: @code{(@var{left-text} . @var{right-text})}.")
252 (round-up-exceptions ,list? "A list of pairs where car is the numerator
253 and cdr the denominator of a moment. Each pair in this list means that
254 the multi-measure rests of the corresponding length will be rounded up to
255 the longer rest. See @var{round-up-to-longer-rest}.")
256 (expand-limit ,integer? "Maximum number of measures expanded in
259 (extra-dy ,number? "Slope glissandi this much extra.")
260 (extra-offset ,number-pair? "A pair representing an offset. This
261 offset is added just before outputting the symbol, so the typesetting
262 engine is completely oblivious to it. The values are measured in
263 @code{staff-space} units of the staff's @code{StaffSymbol}.")
264 (extra-spacing-height ,number-pair? "In the horizontal spacing
265 problem, we increase the height of each item by this amount (by adding
266 the @q{car} to the bottom of the item and adding the @q{cdr} to the
267 top of the item). In order to make a grob infinitely high (to prevent
268 the horizontal spacing problem from placing any other grobs above or
269 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
270 (extra-spacing-width ,number-pair? "In the horizontal spacing
271 problem, we pad each item by this amount (by adding the @q{car} on the
272 left side of the item and adding the @q{cdr} on the right side of the
273 item). In order to make a grob take up no horizontal space at all,
274 set this to @code{(+inf.0 . -inf.0)}.")
275 (extra-X-extent ,number-pair? "A grob is enlarged in
276 X@tie{}dimension by this much.")
277 (extra-Y-extent ,number-pair? "A grob is enlarged in
278 Y@tie{}dimension by this much.")
284 (flag-count ,number? "The number of tremolo beams.")
285 (font-encoding ,symbol? "The font encoding is the broadest
286 category for selecting a font. Currently, only lilypond's system
287 fonts (Emmentaler) are using this property. Available
288 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
289 @code{fetaText} (Emmentaler).")
290 (font-family ,symbol? "The font family is the broadest category
291 for selecting text fonts. Options include: @code{sans},
293 (font-name ,string? "Specifies a file name (without extension) of
294 the font to load. This setting overrides selection using
295 @code{font-family}, @code{font-series} and @code{font-shape}.")
296 (font-series ,symbol? "Select the series of a font. Choices
297 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
298 (font-shape ,symbol? "Select the shape of a font. Choices
299 include @code{upright}, @code{italic}, @code{caps}.")
300 (font-size ,number? "The font size, compared to the
301 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
302 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
303 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
304 larger. Fractional values are allowed.")
305 (footnote ,boolean? "Should this be a footnote or in-note?")
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 (forced-spacing ,number? "Spacing forced between grobs, used in
311 various ligature engravers.")
312 (fraction ,fraction? "Numerator and denominator of a time
314 (french-beaming ,boolean? "Use French beaming style for this
315 stem. The stem stops at the innermost beams.")
316 (fret-diagram-details ,list? "An alist of detailed grob
317 properties for fret diagrams. Each alist entry consists of a
318 @code{(@var{property} . @var{value})} pair. The properties which can
319 be included in @code{fret-diagram-details} include the following:
323 @code{barre-type} -- Type of barre indication used. Choices include
324 @code{curved}, @code{straight}, and @code{none}. Default
327 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
328 fret-space. Default value@tie{}0.5.
330 @code{dot-color} -- Color of dots. Options include @code{black} and
331 @code{white}. Default @code{black}.
333 @code{dot-label-font-mag} -- Magnification for font used to label fret
334 dots. Default value@tie{}1.
336 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
337 dots without labels, 0.95-@code{dot-radius} for dots with labels.
339 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
340 value 0.425 for labeled dots, 0.25 for unlabeled dots.
342 @code{finger-code} -- Code for the type of fingering indication used.
343 Options include @code{none}, @code{in-dot}, and @code{below-string}.
344 Default @code{none} for markup fret diagrams, @code{below-string} for
345 @code{FretBoards} fret diagrams.
347 @code{fret-count} -- The number of frets. Default@tie{}4.
349 @code{fret-label-custom-format} -- The format string to be used label
350 the lowest fret number, when @code{number-type} equals to
351 @code{custom}. Default@tie{}\"~a\".
353 @code{fret-label-font-mag} -- The magnification of the font used to
354 label the lowest fret number. Default@tie{}0.5.
356 @code{fret-label-vertical-offset} -- The offset of the fret label from
357 the center of the fret in direction parallel to strings.
360 @code{label-dir} -- Side to which the fret label is attached.
361 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
362 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
364 @code{mute-string} -- Character string to be used to indicate muted
365 string. Default @code{\"x\"}.
367 @code{number-type} -- Type of numbers to use in fret label. Choices
368 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
369 @code{custom}. In the later case, the format string is supplied by
370 the @code{fret-label-custom-format} property.
371 Default @code{roman-lower}.
373 @code{open-string} -- Character string to be used to indicate open
374 string. Default @code{\"o\"}.
376 @code{orientation} -- Orientation of fret-diagram. Options include
377 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
378 Default @code{normal}.
380 @code{string-count} -- The number of strings. Default@tie{}6.
382 @code{string-label-font-mag} -- The magnification of the font used to
383 label fingerings at the string, rather than in the dot. Default value
384 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
385 @code{opposing-landscape}.
387 @code{string-thickness-factor} -- Factor for changing thickness of
388 each string in the fret diagram. Thickness of string @var{k} is given
390 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
393 @code{top-fret-thickness} -- The thickness of the top fret line, as a
394 multiple of the standard thickness. Default value@tie{}3.
396 @code{xo-font-magnification} -- Magnification used for mute and open
397 string indicators. Default value@tie{}0.5.
399 @code{xo-padding} -- Padding for open and mute indicators from top
400 fret. Default value 0.25.
402 ;; ugh: double, change.
403 (full-length-padding ,number? "How much padding to use at the
404 right side of a full-length tuplet bracket.")
405 (full-length-to-extent ,boolean? "Run to the extent of the column
406 for a full-length tuplet bracket.")
407 (full-measure-extra-space ,number? "Extra space that is allocated
408 at the beginning of a measure with only one note. This property is
409 read from the NonMusicalPaperColumn that begins the measure.")
410 (full-size-change ,boolean? "Don't make a change clef smaller.")
416 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
417 (gap-count ,integer? "Number of gapped beams for tremolo.")
418 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
420 (glyph ,string? "A string determining what @q{style} of glyph is
421 typeset. Valid choices depend on the function that is reading this
423 (glyph-name ,string? "The glyph name within the font.")
424 (glyph-name-alist ,list? "An alist of key-string pairs.")
425 (graphical ,boolean? "Display in graphical (vs. text) form.")
426 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
432 (hair-thickness ,number? "Thickness of the thin line in a bar
434 (harp-pedal-details ,list? "An alist of detailed grob properties
435 for harp pedal diagrams. Each alist entry consists of a
436 @code{(@var{property} . @var{value})} pair. The properties which can
437 be included in harp-pedal-details include the following:
441 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
442 boxes above/@/below the horizontal line. Default value@tie{}0.8.
444 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
446 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
448 @code{space-before-divider} -- Space between boxes before the first
449 divider (so that the diagram can be made symmetric). Default
452 @code{space-after-divider} -- Space between boxes after the first
453 divider. Default value@tie{}0.8.
455 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
456 of the ellipse around circled pedals. Default value@tie{}0.5.
458 @code{circle-x-padding} -- Padding in X direction of the ellipse
459 around circled pedals. Default value 0.15.
461 @code{circle-y-padding} -- Padding in Y direction of the ellipse
462 around circled pedals. Default value@tie{}0.2.
464 (head-direction ,ly:dir? "Are the note heads left or right in a
466 (height ,ly:dimension? "Height of an object in @code{staff-space}
468 (height-limit ,ly:dimension? "Maximum slur height: The longer the
469 slur, the closer it is to this height.")
470 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
471 that appears on a tied note after a line break will not be displayed.")
472 (horizontal-shift ,integer? "An integer that identifies ranking
473 of @code{NoteColumn}s for horizontal shifting. This is used by
474 @rinternals{note-collision-interface}.")
475 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
476 left and one to the right of this grob.")
482 (ignore-collision ,boolean? "If set, don't do note collision
483 resolution on this @code{NoteColumn}.")
484 (implicit ,boolean? "Is this an implicit bass figure?")
485 (inspect-index ,integer? "If debugging is set, set beam and slur
486 configuration to this index, and print the respective scores.")
487 (inspect-quants ,number-pair? "If debugging is set, set beam and
488 slur quants to this position, and print the respective scores.")
494 (keep-inside-line ,boolean? "If set, this column cannot have
495 objects sticking into the margin.")
496 (kern ,ly:dimension? "Amount of extra white space to add. For
497 bar lines, this is the amount of space after a thick line.")
498 (knee ,boolean? "Is this beam kneed?")
499 (knee-spacing-correction ,number? "Factor for the optical
500 correction amount for kneed beams. Set between @code{0} for no
501 correction and @code{1} for full correction.")
507 (labels ,list? "List of labels (symbols) placed on a column.")
508 (layer ,integer? "An integer which determines the order of printing
509 objects. Objects with the lowest value of layer are drawn first, then
510 objects with progressively higher values are drawn, so objects with
511 higher values overwrite objects with lower values. By default most
512 objects are assigned a layer value of 1.")
513 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
515 (ledger-line-thickness ,number-pair? "The thickness of ledger
516 lines. It is the sum of 2@tie{}numbers: The first is the factor for
517 line thickness, and the second for staff space. Both contributions
519 (ledger-positions ,list? "Repeating pattern for the vertical positions
520 of ledger lines. Bracketed groups are always shown together.")
521 (left-bound-info ,list? "An alist of properties for determining
522 attachments of spanners to edges.")
523 (left-padding ,ly:dimension? "The amount of space that is put
524 left to an object (e.g., a lyric extender).")
525 (length ,ly:dimension? "User override for the stem length of
527 (length-fraction ,number? "Multiplier for lengths. Used for
528 determining ledger lines and stem lengths.")
529 (line-break-penalty ,number? "Penalty for a line break at this
530 column. This affects the choices of the line breaker; it avoids a
531 line break at a column with a positive penalty and prefers a line
532 break at a column with a negative penalty.")
533 (line-break-permission ,symbol? "Instructs the line breaker on
534 whether to put a line break at this column. Can be @code{force} or
536 (line-break-system-details ,list? "An alist of properties to use
537 if this column is the start of a system.")
538 (line-count ,integer? "The number of staff lines.")
539 (line-positions ,list? "Vertical positions of staff lines.")
540 (line-thickness ,number? "The thickness of the tie or slur
542 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
548 (max-beam-connect ,integer? "Maximum number of beams to connect
549 to beams from this stem. Further beams are typeset as beamlets.")
550 (max-stretch ,number? "The maximum amount that this
551 @code{VerticalAxisGroup} can be vertically stretched (for example, in
552 order to better fill a page).")
553 (measure-count ,integer? "The number of measures for a
554 multi-measure rest.")
555 (measure-length ,ly:moment? "Length of a measure. Used in some
556 spacing situations.")
557 (merge-differently-dotted ,boolean? "Merge note heads in
558 collisions, even if they have a different number of dots. This is
559 normal notation for some types of polyphonic music.
561 @code{merge-differently-dotted} only applies to opposing stem
562 directions (i.e., voice 1 &@tie{}2).")
563 (merge-differently-headed ,boolean? "Merge note heads in
564 collisions, even if they have different note heads. The smaller of
565 the two heads is rendered invisible. This is used in polyphonic
566 guitar notation. The value of this setting is used by
567 @rinternals{note-collision-interface}.
569 @code{merge-differently-headed} only applies to opposing stem
570 directions (i.e., voice 1 &@tie{}2).")
571 (minimum-distance ,ly:dimension? "Minimum distance between rest
573 (minimum-length ,ly:dimension? "Try to make a spanner at least
574 this long, normally in the horizontal direction. This requires an
575 appropriate callback for the @code{springs-and-rods} property. If
576 added to a @code{Tie}, this sets the minimum distance between
578 (minimum-length-fraction ,number? "Minimum length of ledger line
579 as fraction of note head size.")
580 (minimum-space ,ly:dimension? "Minimum distance that the victim
581 should move (after padding).")
582 (minimum-X-extent ,number-pair? "Minimum size of an object in
583 X@tie{}dimension, measured in @code{staff-space} units.")
584 (minimum-Y-extent ,number-pair? "Minimum size of an object in
585 Y@tie{}dimension, measured in @code{staff-space} units.")
591 (neutral-direction ,ly:dir? "Which direction to take in the
592 center of the staff.")
593 (neutral-position ,number? "Position (in half staff spaces) where
594 to flip the direction of custos stem.")
595 (next ,ly:grob? "Object that is next relation (e.g., the lyric
596 syllable following an extender).")
597 (no-alignment ,boolean? "If set, don't place this grob in a
598 @code{VerticalAlignment}; rather, place it using its own
599 @code{Y-offset} callback.")
600 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
602 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
603 get stems extending to the middle staff line.")
604 (non-break-align-symbols ,list? "A list of symbols that determine
605 which NON-break-aligned interfaces to align this to.")
606 (non-default ,boolean? "Set for manually specified clefs.")
607 (non-musical ,boolean? "True if the grob belongs to a
608 @code{NonMusicalPaperColumn}.")
609 (nonstaff-nonstaff-spacing ,list? "The spacing alist
610 controlling the distance between the current non-staff line and
611 the next non-staff line in the direction of @code{staff-affinity},
612 if both are on the same side of the related staff, and
613 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
614 @code{staff-staff-spacing} for a description of the alist
616 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
617 controlling the distance between the current non-staff line and
618 the nearest staff in the direction of @code{staff-affinity}, if
619 there are no non-staff lines between the two, and
620 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
621 @code{staff-affinity} is @code{CENTER}, then
622 @code{nonstaff-relatedstaff-spacing} is used for the nearest
623 staves on @emph{both} sides, even if other non-staff lines appear
624 between the current one and either of the staves. See
625 @code{staff-staff-spacing} for a description of the alist
627 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
628 controlling the distance between the current non-staff line and
629 the nearest staff in the opposite direction from
630 @code{staff-affinity}, if there are no other non-staff lines
631 between the two, and @code{staff-affinity} is either @code{UP} or
632 @code{DOWN}. See @code{staff-staff-spacing} for a description of
633 the alist structure.")
634 (normalized-endpoints ,pair? "Represents left and right placement
635 over the total spanner, where the width of the spanner is normalized
637 (note-names ,vector? "Vector of strings containing names for
638 easy-notation note heads.")
644 (outside-staff-horizontal-padding ,number? "By default, an
645 outside-staff-object can be placed so that is it very close to another
646 grob horizontally. If this property is set, the outside-staff-object
647 is raised so that it is not so close to its neighbor.")
648 (outside-staff-padding ,number? "The padding to place between
649 this grob and the staff when spacing according to
650 @code{outside-staff-priority}.")
651 (outside-staff-priority ,number? "If set, the grob is positioned
652 outside the staff in such a way as to avoid all collisions. In case
653 of a potential collision, the grob with the smaller
654 @code{outside-staff-priority} is closer to the staff.")
660 (packed-spacing ,boolean? "If set, the notes are spaced as
661 tightly as possible.")
662 (padding ,ly:dimension? "Add this much extra space between
663 objects that are next to each other.")
664 (padding-pairs ,list? "An alist mapping @code{(@var{name}
665 . @var{name})} to distances.")
666 (page-break-penalty ,number? "Penalty for page break at this
667 column. This affects the choices of the page breaker; it avoids a
668 page break at a column with a positive penalty and prefers a page
669 break at a column with a negative penalty.")
670 (page-break-permission ,symbol? "Instructs the page breaker on
671 whether to put a page break at this column. Can be @code{force} or
673 (page-turn-penalty ,number? "Penalty for a page turn at this
674 column. This affects the choices of the page breaker; it avoids a
675 page turn at a column with a positive penalty and prefers a page turn
676 at a column with a negative penalty.")
677 (page-turn-permission ,symbol? "Instructs the page breaker on
678 whether to put a page turn at this column. Can be @code{force} or
680 (parenthesized ,boolean? "Parenthesize this grob.")
681 (positions ,number-pair? "Pair of staff coordinates
682 @code{(@var{left} . @var{right})}, where both @var{left} and
683 @var{right} are in @code{staff-space} units of the current staff. For
684 slurs, this value selects which slur candidate to use; if extreme
685 positions are requested, the closest one is taken.")
686 (prefer-dotted-right ,boolean? "For note collisions, prefer to
687 shift dotted up-note to the right, rather than shifting just the
693 (ratio ,number? "Parameter for slur shape. The higher this
694 number, the quicker the slur attains its @code{height-limit}.")
695 (remove-empty ,boolean? "If set, remove group if it contains no
697 (remove-first ,boolean? "Remove the first staff of an orchestral
699 (replacement-alist ,list? "Alist of strings.
700 The key is a string of the pattern to be replaced. The value is a
701 string of what should be displayed. Useful for ligatures.")
702 (restore-first ,boolean? "Print a natural before the
704 (rhythmic-location ,rhythmic-location? "Where (bar number,
705 measure position) in the score.")
706 (right-bound-info ,list? "An alist of properties for determining
707 attachments of spanners to edges.")
708 (right-padding ,ly:dimension? "Space to insert on the right side
709 of an object (e.g., between note and its accidentals).")
710 (rotation ,list? "Number of degrees to rotate this object, and
711 what point to rotate around. For example, @code{'(45 0 0)} rotates
712 by 45 degrees around the center of this object.")
713 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
714 rest when the length of a measure is between two values of
715 @code{usable-duration-logs}. For example, displays a breve instead of a whole
722 (same-direction-correction ,number? "Optical correction amount
723 for stems that are placed in tight configurations. This amount is
724 used for stems with the same direction to compensate for note head to
726 (script-priority ,number? "A sorting key that determines in what
727 order a script is within a stack of scripts.")
728 (self-alignment-X ,number? "Specify alignment of an object. The
729 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
730 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
731 values may also be specified.")
732 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
734 (shorten-pair ,number-pair? "The lengths to shorten a
735 text-spanner on both sides, for example a pedal bracket. Positive
736 values shorten the text-spanner, while negative values lengthen it.")
737 (shortest-duration-space ,ly:dimension? "Start with this much
738 space for the shortest duration. This is expressed in
739 @code{spacing-increment} as unit. See also
740 @rinternals{spacing-spanner-interface}.")
741 (shortest-playing-duration ,ly:moment? "The duration of the
742 shortest note playing here.")
743 (shortest-starter-duration ,ly:moment? "The duration of the
744 shortest note that starts here.")
745 (side-axis ,number? "If the value is @code{X} (or
746 equivalently@tie{}@code{0}), the object is placed horizontally next to
747 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
749 (side-relative-direction ,ly:dir? "Multiply direction of
750 @code{direction-source} with this to get the direction of this
752 (simple-Y ,boolean? "Should the Y placement of a spanner
753 disregard changes in system heights?")
754 (size ,number? "Size of object, relative to standard size.")
755 (skip-quanting ,boolean? "Should beam quanting be skipped?")
756 (skyline-horizontal-padding ,number? "For determining the
757 vertical distance between two staves, it is possible to have a
758 configuration which would result in a tight interleaving of grobs from
759 the top staff and the bottom staff. The larger this parameter is, the
760 farther apart the staves are placed in such a configuration.")
761 (skyline-vertical-padding ,number? "The amount by which the left
762 and right skylines of a column are padded vertically, beyond the
763 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
764 grobs in the column. Increase this to prevent interleaving of grobs
765 from adjacent columns.")
766 (slash-negative-kern ,number? "The space to remove between
767 slashes in percent repeat glyphs. Larger values bring the two
768 elements closer together.")
769 (slope ,number? "The slope of this object.")
770 (slur-padding ,number? "Extra distance between slur and script.")
771 (space-alist ,list? "A table that specifies distances between
772 prefatory items, like clef and time-signature. The format is an alist
773 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
774 . @var{distance})}, where @var{type} can be the symbols
775 @code{minimum-space} or @code{extra-space}.")
776 (space-to-barline ,boolean? "If set, the distance between a note
777 and the following non-musical column will be measured to the bar line
778 instead of to the beginning of the non-musical column. If there is a
779 clef change followed by a bar line, for example, this means that we
780 will try to space the non-musical column as though the clef is not
782 (spacing-increment ,number? "Add this much space for a doubled
783 duration. Typically, the width of a note head. See also
784 @rinternals{spacing-spanner-interface}.")
785 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
786 spacing relative to its left and right @code{BreakAlignment}s.
788 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
789 bounds (i.e., clefs, key signatures and time signatures) using the following
793 \\override MultiMeasureRest
794 #'spacing-pair = #'(staff-bar . staff-bar)
796 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
797 (springs-and-rods ,boolean? "Dummy variable for triggering
799 (stacking-dir ,ly:dir? "Stack objects in which direction?")
800 (staff-affinity ,ly:dir? "The direction of the staff to use
801 for spacing the current non-staff line. Choices are @code{UP},
802 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
803 line will be placed equidistant between the two nearest staves on
804 either side, unless collisions or other spacing constraints
805 prevent this. Setting @code{staff-affinity} for a staff causes it
806 to be treated as a non-staff line. Setting @code{staff-affinity}
807 to @code{#f} causes a non-staff line to be treated as a staff.")
808 (staff-padding ,ly:dimension? "Maintain this much space between
809 reference points and the staff. Its effect is to align objects of
810 differing sizes (like the dynamics @b{p} and @b{f}) on their
812 (staff-position ,number? "Vertical position, measured in half
813 staff spaces, counted from the middle line.")
814 (staff-space ,ly:dimension? "Amount of space between staff lines,
815 expressed in global @code{staff-space}.")
816 (staff-staff-spacing ,list? "When applied to a staff-group's
817 @code{StaffGrouper} grob, this spacing alist controls the distance
818 between consecutive staves within the staff-group. When applied
819 to a staff's @code{VerticalAxisGroup} grob, it controls the
820 distance between the staff and the nearest staff below it in the
821 same system, replacing any settings inherited from the
822 @code{StaffGrouper} grob of the containing staff-group, if there
823 is one. This property remains in effect even when non-staff lines
824 appear between staves. The alist can contain the following keys:
829 @code{basic-distance} -- the vertical distance, measured in
830 staff-spaces, between the reference points of the two items when
831 no collisions would result, and no stretching or compressing is in
835 @code{minimum-distance} -- the smallest allowable vertical
836 distance, measured in staff-spaces, between the reference points
837 of the two items, when compressing is in effect.
840 @code{padding} -- the minimum required amount of unobstructed
841 vertical whitespace between the bounding boxes (or skylines) of
842 the two items, measured in staff-spaces.
845 @code{stretchability} -- a unitless measure of the dimension's
846 relative propensity to stretch. If zero, the distance will not
847 stretch (unless collisions would result).
850 (staffgroup-staff-spacing ,list? "The spacing alist
851 controlling the distance between the last staff of the current
852 staff-group and the staff just below it in the same system, even
853 if one or more non-staff lines exist between the two staves. If
854 the @code{staff-staff-spacing} property of the staff's
855 @code{VerticalAxisGroup} grob is set, that is used instead. See
856 @code{staff-staff-spacing} for a description of the alist
858 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
859 pair where the stem attaches to the notehead.")
860 (stem-begin-position ,number? "User override for the
861 begin position of a stem.")
863 (stem-spacing-correction ,number? "Optical correction amount for
864 stems that are placed in tight configurations. For opposite
865 directions, this amount is the correction for two normal sized stems
866 that overlap completely.")
867 (stemlet-length ,number? "How long should be a stem over a
869 (stencil ,ly:stencil? "The symbol to print.")
870 (stencils ,list? "Multiple stencils, used as intermediate
872 (strict-grace-spacing ,boolean? "If set, main notes are spaced
873 normally, then grace notes are put left of the musical columns for the
875 (strict-note-spacing ,boolean? "If set, unbroken columns with
876 non-musical material (clefs, bar lines, etc.) are not spaced
877 separately, but put before musical columns.")
878 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
880 (style ,symbol? "This setting determines in what style a grob is
881 typeset. Valid choices depend on the @code{stencil} callback reading
888 (text ,markup? "Text markup. See @ruser{Formatting text}.")
889 ;;FIXME -- Should both be the same?
890 (text-direction ,ly:dir? "This controls the ordering of the
891 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
892 should use @code{LEFT}.")
893 (thick-thickness ,number? "Bar line thickness, measured in
894 @code{line-thickness}.")
895 (thickness ,number? "Line thickness, generally measured in
896 @code{line-thickness}.")
897 (thin-kern ,number? "The space after a hair-line in a bar line.")
898 (tie-configuration ,list? "List of @code{(@var{position} .
899 @var{dir})} pairs, indicating the desired tie configuration, where
900 @var{position} is the offset from the center of the staff in staff
901 space and @var{dir} indicates the direction of the tie
902 (@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
903 in the list causes the corresponding tie to be formatted
905 (to-barline ,boolean? "If true, the spanner will stop at the bar
906 line just before it would otherwise stop.")
907 (toward-stem-shift ,number? "Amount by which scripts are shifted
908 toward the stem if their direction coincides with the stem direction.
909 @code{0.0} means keep the default position (centered on the note
910 head), @code{1.0} means centered on the stem. Interpolated values are
912 (transparent ,boolean? "This makes the grob invisible.")
918 (uniform-stretching ,boolean? "If set, items stretch
919 proportionally to their durations. This looks better in complex
920 polyphonic patterns.")
921 (used ,boolean? "If set, this spacing column is kept in the
923 (usable-duration-logs ,list? "List of @code{duration-log}s that
924 can be used in typesetting the grob.")
925 (use-skylines ,boolean? "Should skylines be used for side
931 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
932 one below this grob.")
938 (when ,ly:moment? "Global time step associated with this column
940 (whiteout ,boolean? "If true, the grob is printed over a white
941 background to white-out underlying material, if the grob is visible.
942 Usually #f by default.")
943 (width ,ly:dimension? "The width of a grob measured in staff
945 (word-space ,ly:dimension? "Space to insert between words in
952 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
953 (X-offset ,number? "The horizontal amount that this object is
954 moved relative to its X-parent.")
955 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
956 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
957 @var{right} are in @code{staff-space} units of the current staff.")
963 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
964 (Y-offset ,number? "The vertical amount that this object is moved
965 relative to its Y-parent.")
970 (zigzag-length ,ly:dimension? "The length of the lines of a
971 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
972 gives 60-degree zigzags.")
973 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
974 This number is adjusted slightly so that the glissando line can be
975 constructed from a whole number of squiggles.")
983 (define (define-internal-grob-property symbol type? description)
984 (define-grob-property symbol type? description)
985 (set-object-property! symbol 'backend-internal #t)
990 (define-public all-internal-grob-properties
993 (apply define-internal-grob-property x))
997 ;; grobs & grob arrays. (alphabetical)
998 (accidental-grob ,ly:grob? "The accidental for this note.")
999 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
1000 @var{groblist})} entries.")
1001 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
1003 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
1004 function is to protect objects from being garbage collected.")
1005 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
1006 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1007 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1009 (bars ,ly:grob-array? "An array of bar line pointers.")
1010 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1011 (beam-segments ,list? "Internal representation of beam segments.")
1012 (bound-alignment-interfaces ,list "Interfaces to be used
1013 for positioning elements that align with a column.")
1014 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1015 column as start/@/begin point. Only columns that have grobs or act as
1016 bounds are spaced.")
1017 (bracket ,ly:grob? "The bracket for a number.")
1019 (columns ,ly:grob-array? "An array of grobs, typically containing
1020 @code{PaperColumn} or @code{NoteColumn} objects.")
1021 (conditional-elements ,ly:grob-array? "Internal use only.")
1022 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1025 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1026 set, which grob to get the direction from.")
1027 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1028 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1029 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1031 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1032 the grob where this is set in.")
1033 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1034 in addition to notes and stems.")
1036 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1037 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1038 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1039 (footnotes-before-line-breaking ,ly:grob-array? "Footnote grobs of
1041 (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of
1043 (full-score-pure-minimum-translations ,list? "A list of translations
1044 for a full score's worth of grobs.")
1046 (glissando-index ,integer? "The index of a glissando in its note
1048 (grace-spacing ,ly:grob? "A run of grace notes.")
1050 (has-span-bar ,pair? "A pair of booleans indicating whether a a span bar
1051 is drawn above, or respectively below, this staff.")
1052 (heads ,ly:grob-array? "An array of note heads.")
1054 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1055 empty in a particular staff, then that staff is erased.")
1056 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1057 (in-note-padding ,number? "Padding between in-notes.")
1058 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1060 (keep-alive-with ,ly:grob-array? "An array of other
1061 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1063 (left-items ,ly:grob-array? "DOCME")
1064 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1067 (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.")
1069 (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the
1070 pure-from-neighbor-interface to determine various grob heights.")
1072 (normal-stems ,ly:grob-array? "An array of visible stems.")
1073 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1074 (note-head ,ly:grob? "A single note head.")
1075 (note-heads ,ly:grob-array? "An array of note head grobs.")
1076 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1078 (potential-X-colliding-grobs ,ly:grob-array? "Grobs that can potentially
1079 collide with a self-aligned grob on the X-axis.")
1080 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1081 that are relevant for finding the @code{pure-Y-extent}")
1082 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1083 relevant for finding the @code{pure-Y-extent}.")
1084 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1085 relevant for finding the @code{pure-Y-extent}.")
1086 (pure-Y-common ,ly:grob? "A cache of the
1087 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1089 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1090 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1091 (rests ,ly:grob-array? "An array of rest objects.")
1092 (right-items ,ly:grob-array? "DOCME")
1093 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1095 (side-support-elements ,ly:grob-array? "The side support, an array of
1097 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1098 (spacing ,ly:grob? "The spacing spanner governing this section.")
1099 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1101 (span-start ,boolean? "Is the note head at the start of a spanner?")
1102 (spanner-broken ,boolean? "Indicates whether spanner
1103 alignment should be broken after the current spanner.")
1104 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1105 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1106 @code{CENTER} will place it on the broken spanner that falls closest to the
1107 center of the length of the entire spanner, although this behavior is
1108 unpredictable in situations with lots of rhythmic diversity. For predictable
1109 results, use @code{LEFT} and @code{RIGHT}.")
1110 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1111 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1112 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1113 (stems ,ly:grob-array? "An array of stem objects.")
1115 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1116 (ties ,ly:grob-array? "A grob array of @code{Tie} objects.")
1117 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1118 (tuplet-number ,ly:grob? "The number for a bracket.")
1119 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1120 (X-colliding-grobs ,ly:grob-array? "Grobs that can collide
1121 with a self-aligned grob on the X-axis.")
1122 (Y-colliding-grobs ,ly:grob-array? "Grobs that can collide
1123 with a self-aligned grob on the Y-axis.")
1124 (X-common ,ly:grob? "Common reference point for axis group.")
1125 (Y-common ,ly:grob? "See @code{X-common}.")
1129 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1130 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1133 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1134 @code{FretBoard} be visible only at beginning of line or at
1137 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1138 translator) that was the cause for this grob.")
1139 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1140 depend on inter-staff spacing.")
1142 (delta-position ,number? "The vertical position difference.")
1144 (font ,ly:font-metric? "A cached font metric object.")
1145 (forced ,boolean? "Manually forced accidental.")
1147 (head-width ,ly:dimension? "The width of this ligature head.")
1149 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1150 @var{strength}))} pairs.")
1151 (important-column-ranks ,vector? "A cache of columns that contain
1152 @code{items-worth-living} data.")
1153 (interfaces ,list? "A list of symbols indicating the interfaces
1154 supported by this object. It is initialized from the @code{meta} field.")
1156 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1158 (maybe-loose ,boolean? "Used to mark a breakable column that is
1159 loose if and only if it is in the middle of a line.")
1160 (meta ,list? "Provide meta information. It is an alist with the
1161 entries @code{name} and @code{interfaces}.")
1162 (minimum-distances ,list? "A list of rods that have the format
1163 @code{(@var{obj} . @var{dist})}.")
1165 (note-collision ,ly:grob? "The @code{NoteCollision} object of a
1167 (numbering-assertion-function ,scheme? "The function used to assert
1168 that footnotes are receiving correct automatic numbers.")
1170 (positioning-done ,boolean? "Used to signal that a positioning element
1171 did its job. This ensures that a positioning is only done once.")
1172 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1173 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1174 cyclic dependencies.")
1175 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1176 to be within staff spaces.")
1177 (quantized-positions ,number-pair? "The beam positions after
1180 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1181 acts as an index for looking up a @code{Stencil} object.")
1182 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1183 Internally used to distribute beam shortening over stems.")
1184 (stem-info ,pair? "A cache of stem parameters.")
1185 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1186 top-margin of the page) of the system to which this staff belongs.")
1193 ;; There are too many properties for ancient notation;
1194 ;; probably neume-types (a list of symbols) would also work.
1196 ;; However, such a list would consist of a couple of dozens of
1197 ;; entries, since head prefixes may be combined in many ways. If
1198 ;; the macros in `gregorian.ly' would directly set prefix-set,
1199 ;; all the head prefixes could be junked; however, such macros
1200 ;; would be quite numerous, I guess. --jr
1202 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1204 (add-join ,boolean? "Is this ligature head-joined with the next one
1205 by a vertical line?")
1206 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1207 an additional stem on the right side?")
1208 (ascendens ,boolean? "Is this neume of ascending type?")
1209 (auctum ,boolean? "Is this neume liquescentically augmented?")
1211 (cavum ,boolean? "Is this neume outlined?")
1212 (context-info ,integer? "Within a ligature, the final glyph or shape of
1213 a head may be affected by the left and/@/or right neighbour head.
1214 @code{context-info} holds for each head such information about the left and
1215 right neighbour, encoded as a bit mask.")
1217 (deminutum ,boolean? "Is this neume deminished?")
1218 (descendens ,boolean? "Is this neume of descendent type?")
1220 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1221 grob (in @code{staff-space} units).")
1222 (flexa-interval ,integer? "The interval spanned by the two notes of a
1223 flexa shape (1 is a second, 7 is an octave).")
1224 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1225 ligature grob in (in @code{staff-space} units).")
1226 (ligature-flexa ,boolean? "request joining note to the previous one
1229 (inclinatum ,boolean? "Is this neume an inclinatum?")
1232 (linea ,boolean? "Attach vertical lines to this neume?")
1234 (oriscus ,boolean? "Is this neume an oriscus?")
1236 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1238 (prefix-set ,number? "A bit mask that holds all Gregorian head
1239 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1240 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1241 similar to a note head that is part of a ligature.")
1243 (quilisma ,boolean? "Is this neume a quilisma?")
1245 (stropha ,boolean? "Is this neume a stropha?")
1247 (virga ,boolean? "Is this neume a virga?")
1249 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1253 (define-public all-backend-properties
1255 all-internal-grob-properties
1256 all-user-grob-properties))