1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2014 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-scripts ,boolean? "If set, a tuplet bracket avoids the
68 scripts associated with the note heads it encompasses.")
69 (avoid-slur ,symbol? "Method of handling slur collisions.
70 Choices are @code{inside}, @code{outside}, @code{around}, and
71 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
72 grob inside the slur. @code{outside} moves the grob vertically to the
73 outside of the slur. @code{around} moves the grob vertically to the
74 outside of the slur only if there is a collision. @code{ignore} does
75 not move either. In grobs whose notational significance depends on
76 vertical position (such as accidentals, clefs, etc.), @code{outside}
77 and @code{around} behave like @code{ignore}.")
78 (axes ,list? "List of axis numbers. In the case of alignment
79 grobs, this should contain only one number.")
85 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
86 This may differ from @code{Y-extent} because it does not include the
87 dots in a repeat bar line.")
88 (base-shortest-duration ,ly:moment? "Spacing is based on the
89 shortest notes in a piece. Normally, pieces are spaced as if notes at
90 least as short as this are present.")
91 (baseline-skip ,ly:dimension? "Distance between base lines of
92 multiple lines of text.")
93 (beam-thickness ,ly:dimension? "Beam thickness, measured in
94 @code{staff-space} units.")
95 (beam-width ,ly:dimension? "Width of the tremolo sign.")
96 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
97 when their direction is forced. It is a list, since the value is
98 different depending on the number of flags and beams.")
99 (beaming ,pair? "Pair of number lists. Each number list
100 specifies which beams to make. @code{0}@tie{}is the central beam,
101 @code{1}@tie{}is the next beam toward the note, etc. This information
102 is used to determine how to connect the beaming patterns from stem to
103 stem inside a beam.")
104 (beamlet-default-length ,pair? "A pair of numbers. The first
105 number specifies the default length of a beamlet that sticks out of
106 the left hand side of this stem; the second number specifies the
107 default length of the beamlet to the right. The actual length of a
108 beamlet is determined by taking either the default length or the
109 length specified by @code{beamlet-max-length-proportion}, whichever is
111 (beamlet-max-length-proportion ,pair? "The maximum length of a
112 beamlet, as a proportion of the distance between two adjacent stems.")
113 (before-line-breaking ,boolean? "Dummy property, used to trigger
114 a callback function.")
115 (between-cols ,pair? "Where to attach a loose column to.")
116 (bound-details ,list? "An alist of properties for determining
117 attachments of spanners to edges.")
118 (bound-padding ,number? "The amount of padding to insert around
120 (bracket-flare ,number-pair? "A pair of numbers specifying how
121 much edges of brackets should slant outward. Value @code{0.0} means
123 (bracket-visibility ,boolean-or-symbol? "This controls the
124 visibility of the tuplet bracket. Setting it to false prevents
125 printing of the bracket. Setting the property to @code{if-no-beam}
126 makes it print only if there is no beam associated with this tuplet
128 (break-align-anchor ,number? "Grobs aligned to this breakable
129 item will have their X-offsets shifted by this number. In bar lines,
130 for example, this is used to position grobs relative to the (visual)
131 center of the bar line.")
132 (break-align-anchor-alignment ,number? "Read by
133 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
134 aligning an anchor to a grob's extent.")
135 (break-align-orders ,vector? "This is a vector of 3@tie{}lists:
136 @w{@code{#(@var{end-of-line} @var{unbroken} @var{start-of-line}}}).
137 Each list contains @w{@emph{break-align symbols}} that specify an
138 order of breakable items (see @rinternals{break-alignment-interface}).
140 For example, this places time signatures before clefs:
143 \\override Score.BreakAlignment.break-align-orders =
144 #(make-vector 3 '(left-edge
156 (break-align-symbol ,symbol? "This key is used for aligning,
157 ordering, and spacing breakable items. See
158 @rinternals{break-alignment-interface}.")
159 (break-align-symbols ,list? "A list of
160 @w{@emph{break-align symbols}} that determines which breakable
161 items to align this to. If the grob selected by the first symbol
162 in the list is invisible due to @w{@code{break-visibility}}, we
163 will align to the next grob (and so on). Choices are listed in
164 @rinternals{break-alignment-interface}.")
165 (break-overshoot ,number-pair? "How much does a broken spanner
166 stick out of its bounds?")
167 (break-visibility ,vector? "A vector of 3@tie{}booleans,
168 @w{@code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}}.
169 @code{#t} means visible, @code{#f} means killed.")
170 (breakable ,boolean? "Allow breaks here.")
171 (broken-bound-padding ,number? "The amount of padding to insert
172 when a spanner is broken at a line break.")
177 (chord-dots-limit ,integer? "Limits the column of dots
178 on each chord to the height of the chord plus
179 @code{chord-dots-limit} staff-positions.")
180 (circled-tip ,boolean? "Put a circle at start/@/end of
181 hairpins (al/@/del niente).")
182 (clip-edges ,boolean? "Allow outward pointing beamlets at the
184 (collapse-height ,ly:dimension? "Minimum height of system start
185 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
186 (collision-interfaces ,list? "A list of interfaces for which
187 automatic beam-collision resolution is run.")
188 (collision-voice-only ,boolean? "Does automatic beam collsion apply
189 only to the voice in which the beam was created?")
190 (color ,color? "The color of this grob.")
191 (common-shortest-duration ,ly:moment? "The most common shortest
192 note length. This is used in spacing. Enlarging this sets the score
194 (concaveness ,number? "A beam is concave if its inner stems are
195 closer to the beam than the two outside stems. This number is a
196 measure of the closeness of the inner stems. It is used for damping
197 the slope of the beam.")
198 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
199 this grob looks as a continued break.")
200 (control-points ,list? "List of offsets (number pairs) that form
201 control points for the tie, slur, or bracket shape. For B@'eziers,
202 this should list the control points of a third-order B@'ezier curve.")
203 (count-from ,integer? "The first measure in a measure count
204 receives this number. The following measures are numbered in
205 increments from this initial value.")
210 (damping ,number? "Amount of beam slope damping.")
211 (dash-definition ,pair? "List of @code{dash-elements} defining the
212 dash structure. Each @code{dash-element} has a starting t value,
213 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
214 (dash-fraction ,number? "Size of the dashes, relative to
215 @code{dash-period}. Should be between @code{0.0} (no line) and
216 @code{1.0} (continuous line).")
217 (dash-period ,number? "The length of one dash together with
218 whitespace. If negative, no line is drawn at all.")
219 (default-direction ,ly:dir? "Direction determined by note head
221 (default-staff-staff-spacing ,list? "The settings to use for
222 @code{staff-staff-spacing} when it is unset, for ungrouped staves
223 and for grouped staves that do not have the relevant
224 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
225 @code{staffgroup-staff-spacing}).")
226 (details ,list? "Alist of parameters for detailed grob behavior.
227 More information on the allowed parameters for a grob can be found by
228 looking at the top of the Internals Reference page for each interface
229 having a @code{details} property.")
230 (digit-names ,vector? "Names for string finger digits.")
231 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
232 @code{X}), then this property determines whether the object is placed
233 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
234 other object. Otherwise, it determines whether the object is placed
235 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
236 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
237 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
238 @code{CENTER}=@code{0}.")
239 (dot-count ,integer? "The number of dots.")
240 (dot-negative-kern ,number? "The space to remove between a dot
241 and a slash in percent repeat glyphs. Larger values bring the two
242 elements closer together.")
243 (dot-placement-list ,list? "List consisting of
244 @code{(@var{description} @var{string-number} @var{fret-number}
245 @var{finger-number})} entries used to define fret diagrams.")
246 (double-stem-separation ,number? "The distance between the two
247 stems of a half note in tablature when using @code{\\tabFullNotation},
248 not counting the width of the stems themselves, expressed as a multiple
249 of the default height of a staff-space in the traditional five-line
251 (duration-log ,integer? "The 2-log of the note head duration,
252 i.e., @code{0} = whole note, @code{1} = half note, etc.")
258 (eccentricity ,number? "How asymmetrical to make a slur.
259 Positive means move the center to the right.")
260 (edge-height ,pair? "A pair of numbers specifying the heights of
261 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
262 (edge-text ,pair? "A pair specifying the texts to be set at the
263 edges: @code{(@var{left-text} . @var{right-text})}.")
264 (round-up-exceptions ,list? "A list of pairs where car is the numerator
265 and cdr the denominator of a moment. Each pair in this list means that
266 the multi-measure rests of the corresponding length will be rounded up to
267 the longer rest. See @var{round-up-to-longer-rest}.")
268 (expand-limit ,integer? "Maximum number of measures expanded in
271 (extra-dy ,number? "Slope glissandi this much extra.")
272 (extra-offset ,number-pair? "A pair representing an offset. This
273 offset is added just before outputting the symbol, so the typesetting
274 engine is completely oblivious to it. The values are measured in
275 @code{staff-space} units of the staff's @code{StaffSymbol}.")
276 (extra-spacing-height ,number-pair? "In the horizontal spacing
277 problem, we increase the height of each item by this amount (by adding
278 the @q{car} to the bottom of the item and adding the @q{cdr} to the
279 top of the item). In order to make a grob infinitely high (to prevent
280 the horizontal spacing problem from placing any other grobs above or
281 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
282 (extra-spacing-width ,number-pair? "In the horizontal spacing
283 problem, we pad each item by this amount (by adding the @q{car} on the
284 left side of the item and adding the @q{cdr} on the right side of the
285 item). In order to make a grob take up no horizontal space at all,
286 set this to @code{(+inf.0 . -inf.0)}.")
292 (flag-count ,number? "The number of tremolo beams.")
293 (flag-style ,symbol? "The style of the flag to be used with
294 @code{MetronomeMark}. Available are @code{'modern-straight-flag},
295 @code{'old-straight-flag}, @code{flat-flag}, @code{mensural} and
297 (flat-positions ,list? "Flats in key signatures are placed
298 within the specified ranges of staff-positions. The general form
299 is a list of pairs, with one pair for each type of clef, in order
300 of the staff-position at which each clef places C:
301 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
302 If the list contains a single element it applies for all clefs.
303 A single number in place of a pair sets accidentals within the octave
304 ending at that staff-position.")
305 (font-encoding ,symbol? "The font encoding is the broadest
306 category for selecting a font. Currently, only lilypond's system
307 fonts (Emmentaler) are using this property. Available
308 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
309 @code{fetaText} (Emmentaler).")
310 (font-family ,symbol? "The font family is the broadest category
311 for selecting text fonts. Options include: @code{sans},
313 (font-name ,string? "Specifies a file name (without extension) of
314 the font to load. This setting overrides selection using
315 @code{font-family}, @code{font-series} and @code{font-shape}.")
316 (font-series ,symbol? "Select the series of a font. Choices
317 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
318 (font-shape ,symbol? "Select the shape of a font. Choices
319 include @code{upright}, @code{italic}, @code{caps}.")
320 (font-size ,number? "The font size, compared to the
321 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
322 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
323 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
324 larger. If the context property @code{fontSize} is set, its value is
325 added to this before the glyph is printed. Fractional values are
327 (footnote ,boolean? "Should this be a footnote or in-note?")
328 (footnote-music ,ly:music? "Music creating a footnote.")
329 (footnote-text ,markup? "A footnote for the grob.")
330 (force-hshift ,number? "This specifies a manual shift for notes
331 in collisions. The unit is the note head width of the first voice
332 note. This is used by @rinternals{note-collision-interface}.")
333 (forced-spacing ,number? "Spacing forced between grobs, used in
334 various ligature engravers.")
335 (fraction ,fraction? "Numerator and denominator of a time
337 (french-beaming ,boolean? "Use French beaming style for this
338 stem. The stem stops at the innermost beams.")
339 (fret-diagram-details ,list? "An alist of detailed grob
340 properties for fret diagrams. Each alist entry consists of a
341 @code{(@var{property} . @var{value})} pair. The properties which can
342 be included in @code{fret-diagram-details} include the following:
346 @code{barre-type} -- Type of barre indication used. Choices include
347 @code{curved}, @code{straight}, and @code{none}. Default
350 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
351 fret-space. Default value@tie{}0.5.
353 @code{dot-color} -- Color of dots. Options include @code{black} and
354 @code{white}. Default @code{black}.
356 @code{dot-label-font-mag} -- Magnification for font used to label fret
357 dots. Default value@tie{}1.
359 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
360 dots without labels, 0.95-@code{dot-radius} for dots with labels.
362 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
363 value 0.425 for labeled dots, 0.25 for unlabeled dots.
365 @code{finger-code} -- Code for the type of fingering indication used.
366 Options include @code{none}, @code{in-dot}, and @code{below-string}.
367 Default @code{none} for markup fret diagrams, @code{below-string} for
368 @code{FretBoards} fret diagrams.
370 @code{fret-count} -- The number of frets. Default@tie{}4.
372 @code{fret-label-custom-format} -- The format string to be used label
373 the lowest fret number, when @code{number-type} equals to
374 @code{custom}. Default@tie{}\"~a\".
376 @code{fret-label-font-mag} -- The magnification of the font used to
377 label the lowest fret number. Default@tie{}0.5.
379 @code{fret-label-vertical-offset} -- The offset of the fret label from
380 the center of the fret in direction parallel to strings.
383 @code{fret-label-horizontal-offset} -- The offset of the fret label from
384 the center of the fret in direction orthogonal to strings.
387 @code{paren-padding} -- The padding for the parenthesis.
390 @code{label-dir} -- Side to which the fret label is attached.
391 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
392 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
394 @code{mute-string} -- Character string to be used to indicate muted
395 string. Default @code{\"x\"}.
397 @code{number-type} -- Type of numbers to use in fret label. Choices
398 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
399 @code{custom}. In the later case, the format string is supplied by
400 the @code{fret-label-custom-format} property.
401 Default @code{roman-lower}.
403 @code{open-string} -- Character string to be used to indicate open
404 string. Default @code{\"o\"}.
406 @code{orientation} -- Orientation of fret-diagram. Options include
407 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
408 Default @code{normal}.
410 @code{string-count} -- The number of strings. Default@tie{}6.
412 @code{string-label-font-mag} -- The magnification of the font used to
413 label fingerings at the string, rather than in the dot. Default value
414 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
415 @code{opposing-landscape}.
417 @code{string-thickness-factor} -- Factor for changing thickness of
418 each string in the fret diagram. Thickness of string @var{k} is given
420 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
423 @code{top-fret-thickness} -- The thickness of the top fret line, as a
424 multiple of the standard thickness. Default value@tie{}3.
426 @code{xo-font-magnification} -- Magnification used for mute and open
427 string indicators. Default value@tie{}0.5.
429 @code{xo-padding} -- Padding for open and mute indicators from top
430 fret. Default value 0.25.
432 ;; ugh: double, change.
433 (full-length-padding ,number? "How much padding to use at the
434 right side of a full-length tuplet bracket.")
435 (full-length-to-extent ,boolean? "Run to the extent of the column
436 for a full-length tuplet bracket.")
437 (full-measure-extra-space ,number? "Extra space that is allocated
438 at the beginning of a measure with only one note. This property is
439 read from the NonMusicalPaperColumn that begins the measure.")
440 (full-size-change ,boolean? "Don't make a change clef smaller.")
446 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
447 (gap-count ,integer? "Number of gapped beams for tremolo.")
448 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
450 (glyph ,string? "A string determining what @q{style} of glyph is
451 typeset. Valid choices depend on the function that is reading this
454 In combination with (span) bar lines, it is a string resembling the
455 bar line appearance in ASCII form.")
456 (glyph-name ,string? "The glyph name within the font.
458 In the context of (span) bar lines, @var{glyph-name} represents
459 a processed form of @code{glyph}, where decisions about line breaking
460 etc. are already taken.")
461 (glyph-name-alist ,list? "An alist of key-string pairs.")
462 (graphical ,boolean? "Display in graphical (vs. text) form.")
463 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
469 (hair-thickness ,number? "Thickness of the thin line in a bar
470 line, expressed as a multiple of the default staff-line thickness
471 (i.e. the visual output is @emph{not} influenced by changes to
472 @code{@var{Staff}.StaffSymbol.thickness}).")
473 (harp-pedal-details ,list? "An alist of detailed grob properties
474 for harp pedal diagrams. Each alist entry consists of a
475 @code{(@var{property} . @var{value})} pair. The properties which can
476 be included in harp-pedal-details include the following:
480 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
481 boxes above/@/below the horizontal line. Default value@tie{}0.8.
483 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
485 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
487 @code{space-before-divider} -- Space between boxes before the first
488 divider (so that the diagram can be made symmetric). Default
491 @code{space-after-divider} -- Space between boxes after the first
492 divider. Default value@tie{}0.8.
494 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
495 of the ellipse around circled pedals. Default value@tie{}0.5.
497 @code{circle-x-padding} -- Padding in X direction of the ellipse
498 around circled pedals. Default value 0.15.
500 @code{circle-y-padding} -- Padding in Y direction of the ellipse
501 around circled pedals. Default value@tie{}0.2.
503 (head-direction ,ly:dir? "Are the note heads left or right in a
505 (height ,ly:dimension? "Height of an object in @code{staff-space}
507 (height-limit ,ly:dimension? "Maximum slur height: The longer the
508 slur, the closer it is to this height.")
509 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
510 that appears on a tied note after a line break will not be displayed.")
511 (horizon-padding ,number? "The amount to pad the axis
512 along which a @code{Skyline} is built for the
513 @code{side-position-interface}.")
514 (horizontal-shift ,integer? "An integer that identifies ranking
515 of @code{NoteColumn}s for horizontal shifting. This is used by
516 @rinternals{note-collision-interface}.")
517 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
518 left and one to the right of this grob.")
524 (id ,string? "An id string for the grob. Depending on the typestting
525 backend being used, this id will be assigned to a group containing all of
526 the stencils that comprise a given grob. For example, in the svg backend,
527 the string will be assigned to the @code{id} attribute of a group (<g>)
528 that encloses the stencils that comprise the grob. In the Postscript
529 backend, as there is no way to group items, the setting of the id property
530 will have no effect.")
531 (ignore-collision ,boolean? "If set, don't do note collision
532 resolution on this @code{NoteColumn}.")
533 (implicit ,boolean? "Is this an implicit bass figure?")
534 (inspect-index ,integer? "If debugging is set, set beam and slur
535 configuration to this index, and print the respective scores.")
536 (inspect-quants ,number-pair? "If debugging is set, set beam and
537 slur quants to this position, and print the respective scores.")
543 (keep-inside-line ,boolean? "If set, this column cannot have
544 objects sticking into the margin.")
545 (kern ,ly:dimension? "The space between individual elements
546 in any compound bar line, expressed as a multiple of the default
547 staff-line thickness (i.e. the visual output is @emph{not}
548 influenced by changes to
549 @code{@var{Staff}.StaffSymbol.thickness}).")
550 (knee ,boolean? "Is this beam kneed?")
551 (knee-spacing-correction ,number? "Factor for the optical
552 correction amount for kneed beams. Set between @code{0} for no
553 correction and @code{1} for full correction.")
554 (knee-to-beam ,boolean? "Determines whether a tuplet number
555 will be positioned next to a kneed beam.")
561 (labels ,list? "List of labels (symbols) placed on a column.")
562 (layer ,integer? "An integer which determines the order of printing
563 objects. Objects with the lowest value of layer are drawn first, then
564 objects with progressively higher values are drawn, so objects with
565 higher values overwrite objects with lower values. By default most
566 objects are assigned a layer value of 1.")
567 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
569 (ledger-line-thickness ,number-pair? "The thickness of ledger
570 lines. It is the sum of 2@tie{}numbers: The first is the factor for
571 line thickness, and the second for staff space. Both contributions
573 (ledger-positions ,list? "Repeating pattern for the vertical positions
574 of ledger lines. Bracketed groups are always shown together.")
575 (left-bound-info ,list? "An alist of properties for determining
576 attachments of spanners to edges.")
577 (left-padding ,ly:dimension? "The amount of space that is put
578 left to an object (e.g., a lyric extender).")
579 (length ,ly:dimension? "User override for the stem length of
581 (length-fraction ,number? "Multiplier for lengths. Used for
582 determining ledger lines and stem lengths.")
583 (line-break-penalty ,number? "Penalty for a line break at this
584 column. This affects the choices of the line breaker; it avoids a
585 line break at a column with a positive penalty and prefers a line
586 break at a column with a negative penalty.")
587 (line-break-permission ,symbol? "Instructs the line breaker on
588 whether to put a line break at this column. Can be @code{force} or
590 (line-break-system-details ,list? "An alist of properties to use
591 if this column is the start of a system.")
592 (line-count ,integer? "The number of staff lines.")
593 (line-positions ,list? "Vertical positions of staff lines.")
594 (line-thickness ,number? "For slurs and ties, this is the
595 diameter of the virtual @qq{pen} that draws the two arcs of the
596 curve's outline, which intersect at the endpoints. This property
597 is expressed as a multiple of the current staff-line thickness
598 (i.e. the visual output is influenced by changes to
599 @code{@var{Staff}.StaffSymbol.thickness}).")
600 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
606 (max-beam-connect ,integer? "Maximum number of beams to connect
607 to beams from this stem. Further beams are typeset as beamlets.")
608 (max-stretch ,number? "The maximum amount that this
609 @code{VerticalAxisGroup} can be vertically stretched (for example, in
610 order to better fill a page).")
611 (maximum-gap ,number? "Maximum value allowed for @code{gap}
613 (measure-count ,integer? "The number of measures for a
614 multi-measure rest.")
615 (measure-length ,ly:moment? "Length of a measure. Used in some
616 spacing situations.")
617 (merge-differently-dotted ,boolean? "Merge note heads in
618 collisions, even if they have a different number of dots. This is
619 normal notation for some types of polyphonic music.
621 @code{merge-differently-dotted} only applies to opposing stem
622 directions (i.e., voice 1 &@tie{}2).")
623 (merge-differently-headed ,boolean? "Merge note heads in
624 collisions, even if they have different note heads. The smaller of
625 the two heads is rendered invisible. This is used in polyphonic
626 guitar notation. The value of this setting is used by
627 @rinternals{note-collision-interface}.
629 @code{merge-differently-headed} only applies to opposing stem
630 directions (i.e., voice 1 &@tie{}2).")
631 (minimum-distance ,ly:dimension? "Minimum distance between rest
633 (minimum-length ,ly:dimension? "Try to make a spanner at least
634 this long, normally in the horizontal direction. This requires an
635 appropriate callback for the @code{springs-and-rods} property. If
636 added to a @code{Tie}, this sets the minimum distance between
638 (minimum-length-fraction ,number? "Minimum length of ledger line
639 as fraction of note head size.")
640 (minimum-space ,ly:dimension? "Minimum distance that the victim
641 should move (after padding).")
642 (minimum-X-extent ,number-pair? "Minimum size of an object in
643 X@tie{}dimension, measured in @code{staff-space} units.")
644 (minimum-Y-extent ,number-pair? "Minimum size of an object in
645 Y@tie{}dimension, measured in @code{staff-space} units.")
651 (neutral-direction ,ly:dir? "Which direction to take in the
652 center of the staff.")
653 (neutral-position ,number? "Position (in half staff spaces) where
654 to flip the direction of custos stem.")
655 (next ,ly:grob? "Object that is next relation (e.g., the lyric
656 syllable following an extender).")
657 (no-alignment ,boolean? "If set, don't place this grob in a
658 @code{VerticalAlignment}; rather, place it using its own
659 @code{Y-offset} callback.")
660 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
662 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
663 get stems extending to the middle staff line.")
664 (non-break-align-symbols ,list? "A list of symbols that determine
665 which NON-break-aligned interfaces to align this to.")
666 (non-default ,boolean? "Set for manually specified clefs.")
667 (non-musical ,boolean? "True if the grob belongs to a
668 @code{NonMusicalPaperColumn}.")
669 (nonstaff-nonstaff-spacing ,list? "The spacing alist
670 controlling the distance between the current non-staff line and
671 the next non-staff line in the direction of @code{staff-affinity},
672 if both are on the same side of the related staff, and
673 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
674 @code{staff-staff-spacing} for a description of the alist
676 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
677 controlling the distance between the current non-staff line and
678 the nearest staff in the direction of @code{staff-affinity}, if
679 there are no non-staff lines between the two, and
680 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
681 @code{staff-affinity} is @code{CENTER}, then
682 @code{nonstaff-relatedstaff-spacing} is used for the nearest
683 staves on @emph{both} sides, even if other non-staff lines appear
684 between the current one and either of the staves. See
685 @code{staff-staff-spacing} for a description of the alist
687 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
688 controlling the distance between the current non-staff line and
689 the nearest staff in the opposite direction from
690 @code{staff-affinity}, if there are no other non-staff lines
691 between the two, and @code{staff-affinity} is either @code{UP} or
692 @code{DOWN}. See @code{staff-staff-spacing} for a description of
693 the alist structure.")
694 (normalized-endpoints ,pair? "Represents left and right placement
695 over the total spanner, where the width of the spanner is normalized
697 (note-names ,vector? "Vector of strings containing names for
698 easy-notation note heads.")
704 (outside-staff-horizontal-padding ,number? "By default, an
705 outside-staff-object can be placed so that is it very close to another
706 grob horizontally. If this property is set, the outside-staff-object
707 is raised so that it is not so close to its neighbor.")
708 (outside-staff-padding ,number? "The padding to place between
709 grobs when spacing according to @code{outside-staff-priority}.
710 Two grobs with different @code{outside-staff-padding} values have
711 the larger value of padding between them.")
712 (outside-staff-placement-directive ,symbol? "One of four directives
713 telling how outside staff objects should be placed.
716 @code{left-to-right-greedy} -- Place each successive grob from left to
719 @code{left-to-right-polite} -- Place a grob from left to right only if
720 it does not potentially overlap with another grob that has been placed
721 on a pass through a grob array. If there is overlap, do another pass to
724 @code{right-to-left-greedy} -- Same as @code{left-to-right-greedy}, but
727 @code{right-to-left-polite} -- Same as @code{left-to-right-polite}, but
730 (outside-staff-priority ,number? "If set, the grob is positioned
731 outside the staff in such a way as to avoid all collisions. In case
732 of a potential collision, the grob with the smaller
733 @code{outside-staff-priority} is closer to the staff.")
739 (packed-spacing ,boolean? "If set, the notes are spaced as
740 tightly as possible.")
741 (padding ,ly:dimension? "Add this much extra space between
742 objects that are next to each other.")
743 (padding-pairs ,list? "An alist mapping @code{(@var{name}
744 . @var{name})} to distances.")
745 (page-break-penalty ,number? "Penalty for page break at this
746 column. This affects the choices of the page breaker; it avoids a
747 page break at a column with a positive penalty and prefers a page
748 break at a column with a negative penalty.")
749 (page-break-permission ,symbol? "Instructs the page breaker on
750 whether to put a page break at this column. Can be @code{force} or
752 (page-turn-penalty ,number? "Penalty for a page turn at this
753 column. This affects the choices of the page breaker; it avoids a
754 page turn at a column with a positive penalty and prefers a page turn
755 at a column with a negative penalty.")
756 (page-turn-permission ,symbol? "Instructs the page breaker on
757 whether to put a page turn at this column. Can be @code{force} or
759 (parent-alignment-X ,number? "Specify on which point
760 of the parent the object is aligned. The value @w{@code{-1}} means
761 aligned on parent's left edge, @code{0}@tie{}on@tie{}center, and
762 @code{1}@tie{}right edge, in X@tie{}direction. Other numerical
763 values may also be specified - the unit is half the parent's width.
764 If unset, the value from @code{self-alignment-X} property will be
766 (parent-alignment-Y ,number? "Like @code{parent-alignment-X}
767 but for the Y@tie{}axis.")
768 (parenthesized ,boolean? "Parenthesize this grob.")
769 (positions ,number-pair? "Pair of staff coordinates
770 @code{(@var{left} . @var{right})}, where both @var{left} and
771 @var{right} are in @code{staff-space} units of the current staff. For
772 slurs, this value selects which slur candidate to use; if extreme
773 positions are requested, the closest one is taken.")
774 (prefer-dotted-right ,boolean? "For note collisions, prefer to
775 shift dotted up-note to the right, rather than shifting just the
777 (protrusion ,number? "In an arpeggio bracket, the length of the
783 (ratio ,number? "Parameter for slur shape. The higher this
784 number, the quicker the slur attains its @code{height-limit}.")
785 (remove-empty ,boolean? "If set, remove group if it contains no
787 (remove-first ,boolean? "Remove the first staff of an orchestral
789 (replacement-alist ,list? "Alist of strings.
790 The key is a string of the pattern to be replaced. The value is a
791 string of what should be displayed. Useful for ligatures.")
792 (restore-first ,boolean? "Print a natural before the
794 (rhythmic-location ,rhythmic-location? "Where (bar number,
795 measure position) in the score.")
796 (right-bound-info ,list? "An alist of properties for determining
797 attachments of spanners to edges.")
798 (right-padding ,ly:dimension? "Space to insert on the right side
799 of an object (e.g., between note and its accidentals).")
800 (rotation ,list? "Number of degrees to rotate this object, and
801 what point to rotate around. For example, @code{'(45 0 0)} rotates
802 by 45 degrees around the center of this object.")
803 (rounded ,boolean? "Decide whether lines should be drawn rounded or not.")
804 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
805 rest when the length of a measure is between two values of
806 @code{usable-duration-logs}. For example, displays a breve instead of a whole
813 (same-direction-correction ,number? "Optical correction amount
814 for stems that are placed in tight configurations. This amount is
815 used for stems with the same direction to compensate for note head to
817 (script-priority ,number? "A key for determining the order of
818 scripts in a stack, by being added to the position of the script in
819 the user input, the sum being the overall priority. Smaller means
820 closer to the head.")
821 (segno-kern ,number? "The space between the two thin lines
822 of the segno bar line symbol, expressed as a multiple of the
823 default staff-line thickness (i.e. the visual output is @emph{not}
824 influenced by changes to
825 @code{@var{Staff}.StaffSymbol.thickness}).")
826 (self-alignment-X ,number? "Specify alignment of an object. The
827 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
828 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
829 values may also be specified - the unit is half the object width.")
830 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
832 (sharp-positions ,list? "Sharps in key signatures are placed
833 within the specified ranges of staff-positions. The general form
834 is a list of pairs, with one pair for each type of clef, in order
835 of the staff-position at which each clef places C:
836 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
837 If the list contains a single element it applies for all clefs.
838 A single number in place of a pair sets accidentals within the octave
839 ending at that staff-position.")
840 (shorten-pair ,number-pair? "The lengths to shorten a
841 text-spanner on both sides, for example a pedal bracket. Positive
842 values shorten the text-spanner, while negative values lengthen it.")
843 (shortest-duration-space ,number? "Start with this multiple of
844 @code{spacing-increment} space for the shortest duration. See also
845 @rinternals{spacing-spanner-interface}.")
846 (shortest-playing-duration ,ly:moment? "The duration of the
847 shortest note playing here.")
848 (shortest-starter-duration ,ly:moment? "The duration of the
849 shortest note that starts here.")
850 (side-axis ,number? "If the value is @code{X} (or
851 equivalently@tie{}@code{0}), the object is placed horizontally next to
852 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
854 (side-relative-direction ,ly:dir? "Multiply direction of
855 @code{direction-source} with this to get the direction of this
857 (simple-Y ,boolean? "Should the Y placement of a spanner
858 disregard changes in system heights?")
859 (size ,number? "Size of object, relative to standard size.")
860 (skip-quanting ,boolean? "Should beam quanting be skipped?")
861 (skyline-horizontal-padding ,number? "For determining the
862 vertical distance between two staves, it is possible to have a
863 configuration which would result in a tight interleaving of grobs from
864 the top staff and the bottom staff. The larger this parameter is, the
865 farther apart the staves are placed in such a configuration.")
866 (skyline-vertical-padding ,number? "The amount by which the left
867 and right skylines of a column are padded vertically, beyond the
868 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
869 grobs in the column. Increase this to prevent interleaving of grobs
870 from adjacent columns.")
871 (slash-negative-kern ,number? "The space to remove between
872 slashes in percent repeat glyphs. Larger values bring the two
873 elements closer together.")
874 (slope ,number? "The slope of this object.")
875 (slur-padding ,number? "Extra distance between slur and script.")
876 (snap-radius ,number? "The maximum distance between two objects that
877 will cause them to snap to alignment along an axis.")
878 (space-alist ,list? "An alist that specifies distances from this
879 grob to other breakable items, using the format:
882 '((@var{break-align-symbol} . (@var{spacing-style} . @var{space}))
883 (@var{break-align-symbol} . (@var{spacing-style} . @var{space}))
887 Standard choices for @w{@code{@var{break-align-symbol}}} are listed in
888 @rinternals{break-alignment-interface}. Additionally, three special
889 @w{break-align} symbols available to @w{@code{space-alist}} are:
894 used when the grob is just left of the first note on a line
897 used when the grob is just left of any other note
900 used when the grob is the last item on the line (only compatible with
901 the @w{@code{extra-space}} spacing style)
905 Choices for @code{@var{spacing-style}} are:
910 Put this much space between the two grobs. The space is stretchable
911 when paired with @w{@code{first-note}} or @w{@code{next-note}};
912 otherwise it is fixed.
915 Put at least this much space between the left sides of both grobs,
916 without allowing them to collide. The space is stretchable when paired
917 with @w{@code{first-note}} or @w{@code{next-note}}; otherwise it
918 is fixed. Not compatible with @w{@code{right-edge}}.
921 Only compatible with @w{@code{first-note}} and
922 @w{@code{next-note}}. Put this much fixed space between the grob
925 @item minimum-fixed-space
926 Only compatible with @w{@code{first-note}} and
927 @w{@code{next-note}}. Put at least this much fixed space between
928 the left side of the grob and the left side of the note, without
929 allowing them to collide.
931 @item semi-fixed-space
932 Only compatible with @w{@code{first-note}} and
933 @w{@code{next-note}}. Put this much space between the grob and
934 the note, such that half of the space is fixed and half is
939 Rules for this spacing are much more complicated than this.
940 See [Wanske] page 126--134, [Ross] page 143--147.")
941 (space-to-barline ,boolean? "If set, the distance between a note
942 and the following non-musical column will be measured to the bar line
943 instead of to the beginning of the non-musical column. If there is a
944 clef change followed by a bar line, for example, this means that we
945 will try to space the non-musical column as though the clef is not
947 (spacing-increment ,ly:dimension? "The unit of length for
948 note-spacing. Typically, the width of a note head. See also
949 @rinternals{spacing-spanner-interface}.")
950 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
951 spacing relative to its left and right @code{BreakAlignment}s.
953 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
954 bounds (i.e., clefs, key signatures and time signatures) using the following
958 \\override MultiMeasureRest
959 #'spacing-pair = #'(staff-bar . staff-bar)
961 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
962 (springs-and-rods ,boolean? "Dummy variable for triggering
964 (stacking-dir ,ly:dir? "Stack objects in which direction?")
965 (staff-affinity ,ly:dir? "The direction of the staff to use
966 for spacing the current non-staff line. Choices are @code{UP},
967 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
968 line will be placed equidistant between the two nearest staves on
969 either side, unless collisions or other spacing constraints
970 prevent this. Setting @code{staff-affinity} for a staff causes it
971 to be treated as a non-staff line. Setting @code{staff-affinity}
972 to @code{#f} causes a non-staff line to be treated as a staff.")
973 (staff-padding ,ly:dimension? "Maintain this much space between
974 reference points and the staff. Its effect is to align objects of
975 differing sizes (like the dynamics @b{p} and @b{f}) on their
977 (staff-position ,number? "Vertical position, measured in half
978 staff spaces, counted from the middle line.")
979 (staff-space ,ly:dimension? "Amount of space between staff lines,
980 expressed in global @code{staff-space}.")
981 (staff-staff-spacing ,list? "When applied to a staff-group's
982 @code{StaffGrouper} grob, this spacing alist controls the distance
983 between consecutive staves within the staff-group. When applied
984 to a staff's @code{VerticalAxisGroup} grob, it controls the
985 distance between the staff and the nearest staff below it in the
986 same system, replacing any settings inherited from the
987 @code{StaffGrouper} grob of the containing staff-group, if there
988 is one. This property remains in effect even when non-staff lines
989 appear between staves. The alist can contain the following keys:
994 @code{basic-distance} -- the vertical distance, measured in
995 staff-spaces, between the reference points of the two items when
996 no collisions would result, and no stretching or compressing is in
1000 @code{minimum-distance} -- the smallest allowable vertical
1001 distance, measured in staff-spaces, between the reference points
1002 of the two items, when compressing is in effect.
1005 @code{padding} -- the minimum required amount of unobstructed
1006 vertical whitespace between the bounding boxes (or skylines) of
1007 the two items, measured in staff-spaces.
1010 @code{stretchability} -- a unitless measure of the dimension's
1011 relative propensity to stretch. If zero, the distance will not
1012 stretch (unless collisions would result).
1015 (staffgroup-staff-spacing ,list? "The spacing alist
1016 controlling the distance between the last staff of the current
1017 staff-group and the staff just below it in the same system, even
1018 if one or more non-staff lines exist between the two staves. If
1019 the @code{staff-staff-spacing} property of the staff's
1020 @code{VerticalAxisGroup} grob is set, that is used instead. See
1021 @code{staff-staff-spacing} for a description of the alist
1023 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
1024 pair where the stem attaches to the notehead.")
1025 (stem-begin-position ,number? "User override for the
1026 begin position of a stem.")
1028 (stem-spacing-correction ,number? "Optical correction amount for
1029 stems that are placed in tight configurations. For opposite
1030 directions, this amount is the correction for two normal sized stems
1031 that overlap completely.")
1032 (stemlet-length ,number? "How long should be a stem over a
1034 (stencil ,ly:stencil? "The symbol to print.")
1035 (stencils ,list? "Multiple stencils, used as intermediate
1037 (strict-grace-spacing ,boolean? "If set, main notes are spaced
1038 normally, then grace notes are put left of the musical columns for the
1040 (strict-note-spacing ,boolean? "If set, unbroken columns with
1041 non-musical material (clefs, bar lines, etc.) are not spaced
1042 separately, but put before musical columns.")
1043 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
1045 (style ,symbol? "This setting determines in what style a grob is
1046 typeset. Valid choices depend on the @code{stencil} callback reading
1053 (text ,markup? "Text markup. See @ruser{Formatting text}.")
1054 ;;FIXME -- Should both be the same?
1055 (text-direction ,ly:dir? "This controls the ordering of the
1056 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
1057 should use @code{LEFT}.")
1058 (thick-thickness ,number? "Thickness of the thick line in a
1059 bar line, expressed as a multiple of the default staff-line
1060 thickness (i.e. the visual output is @emph{not} influenced by
1061 changes to @code{@var{Staff}.StaffSymbol.thickness}).")
1062 (thickness ,number? "For grobs made up of lines, this is the
1063 thickness of the line. For slurs and ties, this is the distance
1064 between the two arcs of the curve's outline at its thickest point,
1065 not counting the diameter of the virtual @qq{pen} that draws the
1066 arcs. This property is expressed as a multiple of the current
1067 staff-line thickness (i.e. the visual output is influenced by
1068 changes to @code{@var{Staff}.StaffSymbol.thickness}).")
1069 (tie-configuration ,list? "List of @code{(@var{position} .
1070 @var{dir})} pairs, indicating the desired tie configuration, where
1071 @var{position} is the offset from the center of the staff in staff
1072 space and @var{dir} indicates the direction of the tie (@code{1}=>up,
1073 @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
1074 in the list causes the corresponding tie to be formatted
1076 (to-barline ,boolean? "If true, the spanner will stop at the bar
1077 line just before it would otherwise stop.")
1078 (toward-stem-shift ,number? "Amount by which scripts are shifted
1079 toward the stem if their direction coincides with the stem direction.
1080 @code{0.0} means keep the default position (centered on the note
1081 head), @code{1.0} means centered on the stem. Interpolated values are
1083 (transparent ,boolean? "This makes the grob invisible.")
1089 (uniform-stretching ,boolean? "If set, items stretch
1090 proportionally to their natural separation based on durations.
1091 This looks better in complex polyphonic patterns.")
1092 (used ,boolean? "If set, this spacing column is kept in the
1094 (usable-duration-logs ,list? "List of @code{duration-log}s that
1095 can be used in typesetting the grob.")
1096 (use-skylines ,boolean? "Should skylines be used for side
1102 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
1103 one below this grob.")
1108 (when ,ly:moment? "Global time step associated with this column
1110 (whiteout ,boolean? "If true, the grob is printed over a white
1111 background to white-out underlying material, if the grob is visible.
1112 Usually #f by default.")
1113 (width ,ly:dimension? "The width of a grob measured in staff
1115 (word-space ,ly:dimension? "Space to insert between words in
1122 (X-align-on-main-noteheads ,boolean? "If true, this grob will
1123 ignore suspended noteheads when aligning itself on NoteColumn.")
1124 (X-extent ,number-pair? "Extent (size) in the X@tie{}direction,
1125 measured in staff-space units, relative to object's reference point.")
1126 (X-offset ,number? "The horizontal amount that this object is
1127 moved relative to its X-parent.")
1128 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
1129 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
1130 @var{right} are in @code{staff-space} units of the current staff.")
1136 (Y-extent ,number-pair? "Extent (size) in the Y@tie{}direction,
1137 measured in staff-space units, relative to object's reference point.")
1138 (Y-offset ,number? "The vertical amount that this object is moved
1139 relative to its Y-parent.")
1144 (zigzag-length ,ly:dimension? "The length of the lines of a
1145 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
1146 gives 60-degree zigzags.")
1147 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
1148 This number is adjusted slightly so that the glissando line can be
1149 constructed from a whole number of squiggles.")
1157 (define (define-internal-grob-property symbol type? description)
1158 (define-grob-property symbol type? description)
1159 (set-object-property! symbol 'backend-internal #t)
1164 (define-public all-internal-grob-properties
1167 (apply define-internal-grob-property x))
1171 ;; grobs & grob arrays. (alphabetical)
1172 (accidental-grob ,ly:grob? "The accidental for this note.")
1173 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
1174 @var{groblist})} entries.")
1175 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
1177 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
1178 function is to protect objects from being garbage collected.")
1179 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1180 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1182 (bars ,ly:grob-array? "An array of bar line pointers.")
1183 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1184 (beam-segments ,list? "Internal representation of beam segments.")
1185 (bound-alignment-interfaces ,list "Interfaces to be used
1186 for positioning elements that align with a column.")
1187 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1188 column as start/@/begin point. Only columns that have grobs or act as
1189 bounds are spaced.")
1190 (bracket ,ly:grob? "The bracket for a number.")
1192 (c0-position ,integer? "An integer indicating the position of
1194 (columns ,ly:grob-array? "An array of grobs, typically containing
1195 @code{PaperColumn} or @code{NoteColumn} objects.")
1196 (concurrent-hairpins ,ly:grob-array? "All concurrent hairpins.")
1197 (conditional-elements ,ly:grob-array? "Internal use only.")
1198 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1201 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1202 set, which grob to get the direction from.")
1203 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1204 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1205 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1207 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1208 the grob where this is set in.")
1209 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1210 in addition to notes and stems.")
1212 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1213 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1214 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1215 (footnotes-before-line-breaking ,ly:grob-array? "Footnote grobs of
1217 (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of
1220 (glissando-index ,integer? "The index of a glissando in its note
1222 (grace-spacing ,ly:grob? "A run of grace notes.")
1224 (has-span-bar ,pair? "A pair of grobs containing the span bars to
1225 be drawn below and above the staff. If no span bar is in a position,
1226 the respective element is set to @code{#f}.")
1227 (heads ,ly:grob-array? "An array of note heads.")
1229 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1230 empty in a particular staff, then that staff is erased.")
1231 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1232 (in-note-padding ,number? "Padding between in-notes.")
1233 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1235 (keep-alive-with ,ly:grob-array? "An array of other
1236 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1238 (left-items ,ly:grob-array? "DOCME")
1239 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1242 (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.")
1243 (minimum-translations-alist ,list? "An list of translations for a given
1244 start and end point.")
1246 (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the
1247 pure-from-neighbor-interface to determine various grob heights.")
1249 (normal-stems ,ly:grob-array? "An array of visible stems.")
1250 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1251 (note-head ,ly:grob? "A single note head.")
1252 (note-heads ,ly:grob-array? "An array of note head grobs.")
1253 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1255 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1256 that are relevant for finding the @code{pure-Y-extent}")
1257 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1258 relevant for finding the @code{pure-Y-extent}.")
1259 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1260 relevant for finding the @code{pure-Y-extent}.")
1261 (pure-Y-common ,ly:grob? "A cache of the
1262 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1264 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1265 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1266 (rests ,ly:grob-array? "An array of rest objects.")
1267 (right-items ,ly:grob-array? "DOCME")
1268 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1270 (side-support-elements ,ly:grob-array? "The side support, an array of
1272 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1273 (spacing ,ly:grob? "The spacing spanner governing this section.")
1274 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1276 (span-start ,boolean? "Is the note head at the start of a spanner?")
1277 (spanner-broken ,boolean? "Indicates whether spanner
1278 alignment should be broken after the current spanner.")
1279 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1280 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1281 @code{CENTER} will place it on the broken spanner that falls closest to the
1282 center of the length of the entire spanner, although this behavior is
1283 unpredictable in situations with lots of rhythmic diversity. For predictable
1284 results, use @code{LEFT} and @code{RIGHT}.")
1285 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1286 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1287 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1288 (stems ,ly:grob-array? "An array of stem objects.")
1290 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1291 (ties ,ly:grob-array? "A grob array of @code{Tie} objects.")
1292 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1293 (tuplet-number ,ly:grob? "The number for a bracket.")
1294 (tuplet-start ,boolean? "Is stem at the start of a tuplet?")
1295 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1297 (vertical-alignment ,ly:grob? "The VerticalAlignment in a System.")
1298 (vertical-skyline-elements ,ly:grob-array? "An array of grobs
1299 used to create vertical skylines.")
1301 (X-common ,ly:grob? "Common reference point for axis group.")
1302 (Y-common ,ly:grob? "See @code{X-common}.")
1306 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1307 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1310 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1311 @code{FretBoard} be visible only at beginning of line or at
1314 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1315 translator) that was the cause for this grob.")
1316 (cross-staff ,boolean? "True for grobs whose @code{Y-extent} depends on
1317 inter-staff spacing. The extent is measured relative to the grobs's parent
1318 staff (more generally, its @code{VerticalAxisGroup}) so this boolean flags
1319 grobs that are not rigidly fixed to their parent staff.
1320 Beams that join notes from two staves are @code{cross-staff}.
1321 Grobs that are positioned around such beams are also @code{cross-staff}.
1322 Grobs that are grouping objects, however, like @code{VerticalAxisGroups}
1323 will not in general be marked @code{cross-staff} when some of the members
1324 of the group are @code{cross-staff}.")
1326 (delta-position ,number? "The vertical position difference.")
1328 (font ,ly:font-metric? "A cached font metric object.")
1329 (forced ,boolean? "Manually forced accidental.")
1331 (head-width ,ly:dimension? "The width of this ligature head.")
1333 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1334 @var{strength}))} pairs.")
1335 (important-column-ranks ,vector? "A cache of columns that contain
1336 @code{items-worth-living} data.")
1337 (interfaces ,list? "A list of symbols indicating the interfaces
1338 supported by this object. It is initialized from the @code{meta} field.")
1340 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1342 (maybe-loose ,boolean? "Used to mark a breakable column that is
1343 loose if and only if it is in the middle of a line.")
1344 (meta ,list? "Provide meta information. It is an alist with the
1345 entries @code{name} and @code{interfaces}.")
1346 (minimum-distances ,list? "A list of rods that have the format
1347 @code{(@var{obj} . @var{dist})}.")
1349 (note-collision ,ly:grob? "The @code{NoteCollision} object of a
1351 (numbering-assertion-function ,scheme? "The function used to assert
1352 that footnotes are receiving correct automatic numbers.")
1354 (positioning-done ,boolean? "Used to signal that a positioning element
1355 did its job. This ensures that a positioning is only done once.")
1356 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1357 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1358 cyclic dependencies.")
1359 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1360 to be within staff spaces.")
1361 (quantized-positions ,number-pair? "The beam positions after
1365 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1366 acts as an index for looking up a @code{Stencil} object.")
1367 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1368 Internally used to distribute beam shortening over stems.")
1369 (stem-info ,pair? "A cache of stem parameters.")
1370 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1371 top-margin of the page) of the system to which this staff belongs.")
1378 ;; There are too many properties for ancient notation;
1379 ;; probably neume-types (a list of symbols) would also work.
1381 ;; However, such a list would consist of a couple of dozens of
1382 ;; entries, since head prefixes may be combined in many ways. If
1383 ;; the macros in `gregorian.ly' would directly set prefix-set,
1384 ;; all the head prefixes could be junked; however, such macros
1385 ;; would be quite numerous, I guess. --jr
1387 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1389 (add-join ,boolean? "Is this ligature head-joined with the next one
1390 by a vertical line?")
1391 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1392 an additional stem on the right side?")
1393 (ascendens ,boolean? "Is this neume of ascending type?")
1394 (auctum ,boolean? "Is this neume liquescentically augmented?")
1396 (cavum ,boolean? "Is this neume outlined?")
1397 (context-info ,integer? "Within a ligature, the final glyph or shape of
1398 a head may be affected by the left and/@/or right neighbour head.
1399 @code{context-info} holds for each head such information about the left and
1400 right neighbour, encoded as a bit mask.")
1402 (deminutum ,boolean? "Is this neume deminished?")
1403 (descendens ,boolean? "Is this neume of descendent type?")
1405 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1406 grob (in @code{staff-space} units).")
1407 (flexa-interval ,integer? "The interval spanned by the two notes of a
1408 flexa shape (1 is a second, 7 is an octave).")
1409 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1410 ligature grob in (in @code{staff-space} units).")
1411 (ligature-flexa ,boolean? "request joining note to the previous one
1414 (inclinatum ,boolean? "Is this neume an inclinatum?")
1417 (linea ,boolean? "Attach vertical lines to this neume?")
1419 (oriscus ,boolean? "Is this neume an oriscus?")
1421 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1423 (prefix-set ,number? "A bit mask that holds all Gregorian head
1424 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1425 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1426 similar to a note head that is part of a ligature.")
1428 (quilisma ,boolean? "Is this neume a quilisma?")
1430 (stropha ,boolean? "Is this neume a stropha?")
1432 (virga ,boolean? "Is this neume a virga?")
1434 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1438 (define-public all-backend-properties
1440 all-internal-grob-properties
1441 all-user-grob-properties))