1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 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 (beam-gap ,number-pair? "Size of a gap in a @code{Beam}.")
112 (beamlet-max-length-proportion ,pair? "The maximum length of a
113 beamlet, as a proportion of the distance between two adjacent stems.")
114 (before-line-breaking ,boolean? "Dummy property, used to trigger
115 a callback function.")
116 (between-cols ,pair? "Where to attach a loose column to.")
117 (bound-details ,list? "An alist of properties for determining
118 attachments of spanners to edges.")
119 (bound-padding ,number? "The amount of padding to insert around
121 (bracket-flare ,number-pair? "A pair of numbers specifying how
122 much edges of brackets should slant outward. Value @code{0.0} means
124 (bracket-visibility ,boolean-or-symbol? "This controls the
125 visibility of the tuplet bracket. Setting it to false prevents
126 printing of the bracket. Setting the property to @code{if-no-beam}
127 makes it print only if there is no beam associated with this tuplet
129 (break-align-anchor ,number? "Grobs aligned to this break-align
130 grob will have their X-offsets shifted by this number. In bar lines,
131 for example, this is used to position grobs relative to the (visual)
132 center of the bar line.")
133 (break-align-anchor-alignment ,number? "Read by
134 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
135 aligning an anchor to a grob's extent.")
136 (break-align-orders ,vector? "Defines the order in which
137 prefatory matter (clefs, key signatures) appears. The format is a
138 vector of length@tie{}3, where each element is one order for
139 end-of-line, middle of line, and start-of-line, respectively. An
140 order is a list of symbols.
142 For example, clefs are put after key signatures by setting
145 \\override Score.BreakAlignment #'break-align-orders =
146 #(make-vector 3 '(span-bar
153 (break-align-symbol ,symbol? "This key is used for aligning and
154 spacing breakable items.")
155 (break-align-symbols ,list? "A list of symbols that determine
156 which break-aligned grobs to align this to. If the grob selected by
157 the first symbol in the list is invisible due to break-visibility, we
158 will align to the next grob (and so on). Choices are @code{left-edge},
159 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
160 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
162 (break-overshoot ,number-pair? "How much does a broken spanner
163 stick out of its bounds?")
164 (break-visibility ,vector? "A vector of 3@tie{}booleans,
165 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
166 @code{#t} means visible, @code{#f} means killed.")
167 (breakable ,boolean? "Allow breaks here.")
168 (broken-bound-padding ,number? "The amount of padding to insert
169 when a spanner is broken at a line break.")
174 (circled-tip ,boolean? "Put a circle at start/@/end of
175 hairpins (al/@/del niente).")
176 (clip-edges ,boolean? "Allow outward pointing beamlets at the
178 (collapse-height ,ly:dimension? "Minimum height of system start
179 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
180 (collision-bias ,number? "Number determining how much to favor the
181 left (negative) or right (positive). Larger absolute values in either
182 direction will push a collision in this direction.")
183 (collision-interfaces ,list? "A list of interfaces for which
184 automatic beam-collision resolution is run.")
185 (collision-padding ,number? "Amount of padding to apply after
186 a collision is detected via the self-alignment-interface.")
187 (collision-voice-only ,boolean? "Does automatic beam collsion apply
188 only to the voice in which the beam was created?")
189 (color ,color? "The color of this grob.")
190 (common-shortest-duration ,ly:moment? "The most common shortest
191 note length. This is used in spacing. Enlarging this sets the score
193 (concaveness ,number? "A beam is concave if its inner stems are
194 closer to the beam than the two outside stems. This number is a
195 measure of the closeness of the inner stems. It is used for damping
196 the slope of the beam.")
197 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
198 this grob looks as a continued break.")
199 (control-points ,list? "List of offsets (number pairs) that form
200 control points for the tie, slur, or bracket shape. For B@'eziers,
201 this should list the control points of a third-order B@'ezier curve.")
202 (count-from ,integer? "The first measure in a measure count
203 receives this number. The following measures are numbered in
204 increments from this initial value.")
209 (damping ,number? "Amount of beam slope damping.")
210 (dash-definition ,pair? "List of @code{dash-elements} defining the
211 dash structure. Each @code{dash-element} has a starting t value,
212 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
213 (dash-fraction ,number? "Size of the dashes, relative to
214 @code{dash-period}. Should be between @code{0.0} (no line) and
215 @code{1.0} (continuous line).")
216 (dash-period ,number? "The length of one dash together with
217 whitespace. If negative, no line is drawn at all.")
218 (default-direction ,ly:dir? "Direction determined by note head
220 (default-staff-staff-spacing ,list? "The settings to use for
221 @code{staff-staff-spacing} when it is unset, for ungrouped staves
222 and for grouped staves that do not have the relevant
223 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
224 @code{staffgroup-staff-spacing}).")
225 (details ,list? "Alist of parameters for detailed grob behavior.
226 More information on the allowed parameters for a grob can be found by
227 looking at the top of the Internals Reference page for each interface
228 having a @code{details} property.")
229 (digit-names ,vector? "Names for string finger digits.")
230 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
231 @code{X}), then this property determines whether the object is placed
232 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
233 other object. Otherwise, it determines whether the object is placed
234 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
235 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
236 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
237 @code{CENTER}=@code{0}.")
238 (dot-count ,integer? "The number of dots.")
239 (dot-negative-kern ,number? "The space to remove between a dot
240 and a slash in percent repeat glyphs. Larger values bring the two
241 elements closer together.")
242 (dot-placement-list ,list? "List consisting of
243 @code{(@var{description} @var{string-number} @var{fret-number}
244 @var{finger-number})} entries used to define fret diagrams.")
245 (duration-log ,integer? "The 2-log of the note head duration,
246 i.e., @code{0} = whole note, @code{1} = half note, etc.")
252 (eccentricity ,number? "How asymmetrical to make a slur.
253 Positive means move the center to the right.")
254 (edge-height ,pair? "A pair of numbers specifying the heights of
255 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
256 (edge-text ,pair? "A pair specifying the texts to be set at the
257 edges: @code{(@var{left-text} . @var{right-text})}.")
258 (round-up-exceptions ,list? "A list of pairs where car is the numerator
259 and cdr the denominator of a moment. Each pair in this list means that
260 the multi-measure rests of the corresponding length will be rounded up to
261 the longer rest. See @var{round-up-to-longer-rest}.")
262 (expand-limit ,integer? "Maximum number of measures expanded in
265 (extra-dy ,number? "Slope glissandi this much extra.")
266 (extra-offset ,number-pair? "A pair representing an offset. This
267 offset is added just before outputting the symbol, so the typesetting
268 engine is completely oblivious to it. The values are measured in
269 @code{staff-space} units of the staff's @code{StaffSymbol}.")
270 (extra-spacing-height ,number-pair? "In the horizontal spacing
271 problem, we increase the height of each item by this amount (by adding
272 the @q{car} to the bottom of the item and adding the @q{cdr} to the
273 top of the item). In order to make a grob infinitely high (to prevent
274 the horizontal spacing problem from placing any other grobs above or
275 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
276 (extra-spacing-width ,number-pair? "In the horizontal spacing
277 problem, we pad each item by this amount (by adding the @q{car} on the
278 left side of the item and adding the @q{cdr} on the right side of the
279 item). In order to make a grob take up no horizontal space at all,
280 set this to @code{(+inf.0 . -inf.0)}.")
286 (flag-count ,number? "The number of tremolo beams.")
287 (flat-positions ,list? "Flats in key signatures are placed
288 within the specified ranges of staff-positions. The general form
289 is a list of pairs, with one pair for each type of clef, in order
290 of the staff-position at which each clef places C:
291 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
292 If the list contains a single element it applies for all clefs.
293 A single number in place of a pair sets accidentals within the octave
294 ending at that staff-position.")
295 (font-encoding ,symbol? "The font encoding is the broadest
296 category for selecting a font. Currently, only lilypond's system
297 fonts (Emmentaler) are using this property. Available
298 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
299 @code{fetaText} (Emmentaler).")
300 (font-family ,symbol? "The font family is the broadest category
301 for selecting text fonts. Options include: @code{sans},
303 (font-name ,string? "Specifies a file name (without extension) of
304 the font to load. This setting overrides selection using
305 @code{font-family}, @code{font-series} and @code{font-shape}.")
306 (font-series ,symbol? "Select the series of a font. Choices
307 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
308 (font-shape ,symbol? "Select the shape of a font. Choices
309 include @code{upright}, @code{italic}, @code{caps}.")
310 (font-size ,number? "The font size, compared to the
311 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
312 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
313 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
314 larger. Fractional values are allowed.")
315 (footnote ,boolean? "Should this be a footnote or in-note?")
316 (footnote-music ,ly:music? "Music creating a footnote.")
317 (footnote-text ,markup? "A footnote for the grob.")
318 (force-hshift ,number? "This specifies a manual shift for notes
319 in collisions. The unit is the note head width of the first voice
320 note. This is used by @rinternals{note-collision-interface}.")
321 (forced-spacing ,number? "Spacing forced between grobs, used in
322 various ligature engravers.")
323 (fraction ,fraction? "Numerator and denominator of a time
325 (french-beaming ,boolean? "Use French beaming style for this
326 stem. The stem stops at the innermost beams.")
327 (fret-diagram-details ,list? "An alist of detailed grob
328 properties for fret diagrams. Each alist entry consists of a
329 @code{(@var{property} . @var{value})} pair. The properties which can
330 be included in @code{fret-diagram-details} include the following:
334 @code{barre-type} -- Type of barre indication used. Choices include
335 @code{curved}, @code{straight}, and @code{none}. Default
338 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
339 fret-space. Default value@tie{}0.5.
341 @code{dot-color} -- Color of dots. Options include @code{black} and
342 @code{white}. Default @code{black}.
344 @code{dot-label-font-mag} -- Magnification for font used to label fret
345 dots. Default value@tie{}1.
347 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
348 dots without labels, 0.95-@code{dot-radius} for dots with labels.
350 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
351 value 0.425 for labeled dots, 0.25 for unlabeled dots.
353 @code{finger-code} -- Code for the type of fingering indication used.
354 Options include @code{none}, @code{in-dot}, and @code{below-string}.
355 Default @code{none} for markup fret diagrams, @code{below-string} for
356 @code{FretBoards} fret diagrams.
358 @code{fret-count} -- The number of frets. Default@tie{}4.
360 @code{fret-label-custom-format} -- The format string to be used label
361 the lowest fret number, when @code{number-type} equals to
362 @code{custom}. Default@tie{}\"~a\".
364 @code{fret-label-font-mag} -- The magnification of the font used to
365 label the lowest fret number. Default@tie{}0.5.
367 @code{fret-label-vertical-offset} -- The offset of the fret label from
368 the center of the fret in direction parallel to strings.
371 @code{label-dir} -- Side to which the fret label is attached.
372 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
373 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
375 @code{mute-string} -- Character string to be used to indicate muted
376 string. Default @code{\"x\"}.
378 @code{number-type} -- Type of numbers to use in fret label. Choices
379 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
380 @code{custom}. In the later case, the format string is supplied by
381 the @code{fret-label-custom-format} property.
382 Default @code{roman-lower}.
384 @code{open-string} -- Character string to be used to indicate open
385 string. Default @code{\"o\"}.
387 @code{orientation} -- Orientation of fret-diagram. Options include
388 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
389 Default @code{normal}.
391 @code{string-count} -- The number of strings. Default@tie{}6.
393 @code{string-label-font-mag} -- The magnification of the font used to
394 label fingerings at the string, rather than in the dot. Default value
395 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
396 @code{opposing-landscape}.
398 @code{string-thickness-factor} -- Factor for changing thickness of
399 each string in the fret diagram. Thickness of string @var{k} is given
401 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
404 @code{top-fret-thickness} -- The thickness of the top fret line, as a
405 multiple of the standard thickness. Default value@tie{}3.
407 @code{xo-font-magnification} -- Magnification used for mute and open
408 string indicators. Default value@tie{}0.5.
410 @code{xo-padding} -- Padding for open and mute indicators from top
411 fret. Default value 0.25.
413 ;; ugh: double, change.
414 (full-length-padding ,number? "How much padding to use at the
415 right side of a full-length tuplet bracket.")
416 (full-length-to-extent ,boolean? "Run to the extent of the column
417 for a full-length tuplet bracket.")
418 (full-measure-extra-space ,number? "Extra space that is allocated
419 at the beginning of a measure with only one note. This property is
420 read from the NonMusicalPaperColumn that begins the measure.")
421 (full-size-change ,boolean? "Don't make a change clef smaller.")
427 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
428 (gap-count ,integer? "Number of gapped beams for tremolo.")
429 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
431 (glyph ,string? "A string determining what @q{style} of glyph is
432 typeset. Valid choices depend on the function that is reading this
435 In combination with (span) bar lines, it is a string resembling the
436 bar line appearance in ASCII form.")
437 (glyph-name ,string? "The glyph name within the font.
439 In the context of (span) bar lines, @var{glyph-name} represents
440 a processed form of @code{glyph}, where decisions about line breaking
441 etc. are already taken.")
442 (glyph-name-alist ,list? "An alist of key-string pairs.")
443 (graphical ,boolean? "Display in graphical (vs. text) form.")
444 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
450 (hair-thickness ,number? "Thickness of the thin line in a bar
452 (harp-pedal-details ,list? "An alist of detailed grob properties
453 for harp pedal diagrams. Each alist entry consists of a
454 @code{(@var{property} . @var{value})} pair. The properties which can
455 be included in harp-pedal-details include the following:
459 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
460 boxes above/@/below the horizontal line. Default value@tie{}0.8.
462 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
464 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
466 @code{space-before-divider} -- Space between boxes before the first
467 divider (so that the diagram can be made symmetric). Default
470 @code{space-after-divider} -- Space between boxes after the first
471 divider. Default value@tie{}0.8.
473 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
474 of the ellipse around circled pedals. Default value@tie{}0.5.
476 @code{circle-x-padding} -- Padding in X direction of the ellipse
477 around circled pedals. Default value 0.15.
479 @code{circle-y-padding} -- Padding in Y direction of the ellipse
480 around circled pedals. Default value@tie{}0.2.
482 (head-direction ,ly:dir? "Are the note heads left or right in a
484 (height ,ly:dimension? "Height of an object in @code{staff-space}
486 (height-limit ,ly:dimension? "Maximum slur height: The longer the
487 slur, the closer it is to this height.")
488 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
489 that appears on a tied note after a line break will not be displayed.")
490 (horizon-padding ,number? "The amount to pad the axis
491 along which a @code{Skyline} is built for the
492 @code{side-position-interface}.")
493 (horizontal-shift ,integer? "An integer that identifies ranking
494 of @code{NoteColumn}s for horizontal shifting. This is used by
495 @rinternals{note-collision-interface}.")
496 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
497 left and one to the right of this grob.")
503 (id ,string? "An id string for the grob. Depending on the typestting
504 backend being used, this id will be assigned to a group containing all of
505 the stencils that comprise a given grob. For example, in the svg backend,
506 the string will be assigned to the @code{id} attribute of a group (<g>)
507 that encloses the stencils that comprise the grob. In the Postscript
508 backend, as there is no way to group items, the setting of the id property
509 will have no effect.")
510 (ignore-collision ,boolean? "If set, don't do note collision
511 resolution on this @code{NoteColumn}.")
512 (implicit ,boolean? "Is this an implicit bass figure?")
513 (inspect-index ,integer? "If debugging is set, set beam and slur
514 configuration to this index, and print the respective scores.")
515 (inspect-quants ,number-pair? "If debugging is set, set beam and
516 slur quants to this position, and print the respective scores.")
522 (keep-inside-line ,boolean? "If set, this column cannot have
523 objects sticking into the margin.")
524 (kern ,ly:dimension? "Amount of extra white space to add. For
525 bar lines, this is the amount of space after a thick line.")
526 (knee ,boolean? "Is this beam kneed?")
527 (knee-spacing-correction ,number? "Factor for the optical
528 correction amount for kneed beams. Set between @code{0} for no
529 correction and @code{1} for full correction.")
535 (labels ,list? "List of labels (symbols) placed on a column.")
536 (layer ,integer? "An integer which determines the order of printing
537 objects. Objects with the lowest value of layer are drawn first, then
538 objects with progressively higher values are drawn, so objects with
539 higher values overwrite objects with lower values. By default most
540 objects are assigned a layer value of 1.")
541 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
543 (ledger-line-thickness ,number-pair? "The thickness of ledger
544 lines. It is the sum of 2@tie{}numbers: The first is the factor for
545 line thickness, and the second for staff space. Both contributions
547 (ledger-positions ,list? "Repeating pattern for the vertical positions
548 of ledger lines. Bracketed groups are always shown together.")
549 (left-bound-info ,list? "An alist of properties for determining
550 attachments of spanners to edges.")
551 (left-padding ,ly:dimension? "The amount of space that is put
552 left to an object (e.g., a lyric extender).")
553 (length ,ly:dimension? "User override for the stem length of
555 (length-fraction ,number? "Multiplier for lengths. Used for
556 determining ledger lines and stem lengths.")
557 (line-break-penalty ,number? "Penalty for a line break at this
558 column. This affects the choices of the line breaker; it avoids a
559 line break at a column with a positive penalty and prefers a line
560 break at a column with a negative penalty.")
561 (line-break-permission ,symbol? "Instructs the line breaker on
562 whether to put a line break at this column. Can be @code{force} or
564 (line-break-system-details ,list? "An alist of properties to use
565 if this column is the start of a system.")
566 (line-count ,integer? "The number of staff lines.")
567 (line-positions ,list? "Vertical positions of staff lines.")
568 (line-thickness ,number? "The thickness of the tie or slur
570 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
576 (max-beam-connect ,integer? "Maximum number of beams to connect
577 to beams from this stem. Further beams are typeset as beamlets.")
578 (max-stretch ,number? "The maximum amount that this
579 @code{VerticalAxisGroup} can be vertically stretched (for example, in
580 order to better fill a page).")
581 (maximum-gap ,number? "Maximum value allowed for @code{gap}
583 (measure-count ,integer? "The number of measures for a
584 multi-measure rest.")
585 (measure-length ,ly:moment? "Length of a measure. Used in some
586 spacing situations.")
587 (merge-differently-dotted ,boolean? "Merge note heads in
588 collisions, even if they have a different number of dots. This is
589 normal notation for some types of polyphonic music.
591 @code{merge-differently-dotted} only applies to opposing stem
592 directions (i.e., voice 1 &@tie{}2).")
593 (merge-differently-headed ,boolean? "Merge note heads in
594 collisions, even if they have different note heads. The smaller of
595 the two heads is rendered invisible. This is used in polyphonic
596 guitar notation. The value of this setting is used by
597 @rinternals{note-collision-interface}.
599 @code{merge-differently-headed} only applies to opposing stem
600 directions (i.e., voice 1 &@tie{}2).")
601 (minimum-distance ,ly:dimension? "Minimum distance between rest
603 (minimum-length ,ly:dimension? "Try to make a spanner at least
604 this long, normally in the horizontal direction. This requires an
605 appropriate callback for the @code{springs-and-rods} property. If
606 added to a @code{Tie}, this sets the minimum distance between
608 (minimum-length-fraction ,number? "Minimum length of ledger line
609 as fraction of note head size.")
610 (minimum-space ,ly:dimension? "Minimum distance that the victim
611 should move (after padding).")
612 (minimum-X-extent ,number-pair? "Minimum size of an object in
613 X@tie{}dimension, measured in @code{staff-space} units.")
614 (minimum-Y-extent ,number-pair? "Minimum size of an object in
615 Y@tie{}dimension, measured in @code{staff-space} units.")
621 (neutral-direction ,ly:dir? "Which direction to take in the
622 center of the staff.")
623 (neutral-position ,number? "Position (in half staff spaces) where
624 to flip the direction of custos stem.")
625 (next ,ly:grob? "Object that is next relation (e.g., the lyric
626 syllable following an extender).")
627 (no-alignment ,boolean? "If set, don't place this grob in a
628 @code{VerticalAlignment}; rather, place it using its own
629 @code{Y-offset} callback.")
630 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
632 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
633 get stems extending to the middle staff line.")
634 (non-break-align-symbols ,list? "A list of symbols that determine
635 which NON-break-aligned interfaces to align this to.")
636 (non-default ,boolean? "Set for manually specified clefs.")
637 (non-musical ,boolean? "True if the grob belongs to a
638 @code{NonMusicalPaperColumn}.")
639 (nonstaff-nonstaff-spacing ,list? "The spacing alist
640 controlling the distance between the current non-staff line and
641 the next non-staff line in the direction of @code{staff-affinity},
642 if both are on the same side of the related staff, and
643 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
644 @code{staff-staff-spacing} for a description of the alist
646 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
647 controlling the distance between the current non-staff line and
648 the nearest staff in the direction of @code{staff-affinity}, if
649 there are no non-staff lines between the two, and
650 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
651 @code{staff-affinity} is @code{CENTER}, then
652 @code{nonstaff-relatedstaff-spacing} is used for the nearest
653 staves on @emph{both} sides, even if other non-staff lines appear
654 between the current one and either of the staves. See
655 @code{staff-staff-spacing} for a description of the alist
657 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
658 controlling the distance between the current non-staff line and
659 the nearest staff in the opposite direction from
660 @code{staff-affinity}, if there are no other non-staff lines
661 between the two, and @code{staff-affinity} is either @code{UP} or
662 @code{DOWN}. See @code{staff-staff-spacing} for a description of
663 the alist structure.")
664 (normalized-endpoints ,pair? "Represents left and right placement
665 over the total spanner, where the width of the spanner is normalized
667 (note-names ,vector? "Vector of strings containing names for
668 easy-notation note heads.")
674 (outside-staff-horizontal-padding ,number? "By default, an
675 outside-staff-object can be placed so that is it very close to another
676 grob horizontally. If this property is set, the outside-staff-object
677 is raised so that it is not so close to its neighbor.")
678 (outside-staff-padding ,number? "The padding to place between
679 grobs when spacing according to @code{outside-staff-priority}.
680 Two grobs with different @code{outside-staff-padding} values have
681 the larger value of padding between them.")
682 (outside-staff-placement-directive ,symbol? "One of four directives
683 telling how outside staff objects should be placed.
686 @code{left-to-right-greedy} -- Place each successive grob from left to
689 @code{left-to-right-polite} -- Place a grob from left to right only if
690 it does not potentially overlap with another grob that has been placed
691 on a pass through a grob array. If there is overlap, do another pass to
694 @code{right-to-left-greedy} -- Same as @code{left-to-right-greedy}, but
697 @code{right-to-left-polite} -- Same as @code{left-to-right-polite}, but
700 (outside-staff-priority ,number? "If set, the grob is positioned
701 outside the staff in such a way as to avoid all collisions. In case
702 of a potential collision, the grob with the smaller
703 @code{outside-staff-priority} is closer to the staff.")
709 (packed-spacing ,boolean? "If set, the notes are spaced as
710 tightly as possible.")
711 (padding ,ly:dimension? "Add this much extra space between
712 objects that are next to each other.")
713 (padding-pairs ,list? "An alist mapping @code{(@var{name}
714 . @var{name})} to distances.")
715 (page-break-penalty ,number? "Penalty for page break at this
716 column. This affects the choices of the page breaker; it avoids a
717 page break at a column with a positive penalty and prefers a page
718 break at a column with a negative penalty.")
719 (page-break-permission ,symbol? "Instructs the page breaker on
720 whether to put a page break at this column. Can be @code{force} or
722 (page-turn-penalty ,number? "Penalty for a page turn at this
723 column. This affects the choices of the page breaker; it avoids a
724 page turn at a column with a positive penalty and prefers a page turn
725 at a column with a negative penalty.")
726 (page-turn-permission ,symbol? "Instructs the page breaker on
727 whether to put a page turn at this column. Can be @code{force} or
729 (parenthesized ,boolean? "Parenthesize this grob.")
730 (positions ,number-pair? "Pair of staff coordinates
731 @code{(@var{left} . @var{right})}, where both @var{left} and
732 @var{right} are in @code{staff-space} units of the current staff. For
733 slurs, this value selects which slur candidate to use; if extreme
734 positions are requested, the closest one is taken.")
735 (prefer-dotted-right ,boolean? "For note collisions, prefer to
736 shift dotted up-note to the right, rather than shifting just the
738 (protrusion ,number? "In an arpeggio bracket, the length of the
744 (ratio ,number? "Parameter for slur shape. The higher this
745 number, the quicker the slur attains its @code{height-limit}.")
746 (remove-empty ,boolean? "If set, remove group if it contains no
748 (remove-first ,boolean? "Remove the first staff of an orchestral
750 (replacement-alist ,list? "Alist of strings.
751 The key is a string of the pattern to be replaced. The value is a
752 string of what should be displayed. Useful for ligatures.")
753 (restore-first ,boolean? "Print a natural before the
755 (rhythmic-location ,rhythmic-location? "Where (bar number,
756 measure position) in the score.")
757 (right-bound-info ,list? "An alist of properties for determining
758 attachments of spanners to edges.")
759 (right-padding ,ly:dimension? "Space to insert on the right side
760 of an object (e.g., between note and its accidentals).")
761 (rotation ,list? "Number of degrees to rotate this object, and
762 what point to rotate around. For example, @code{'(45 0 0)} rotates
763 by 45 degrees around the center of this object.")
764 (rounded ,boolean? "Decide whether lines should be drawn rounded or not.")
765 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
766 rest when the length of a measure is between two values of
767 @code{usable-duration-logs}. For example, displays a breve instead of a whole
774 (same-direction-correction ,number? "Optical correction amount
775 for stems that are placed in tight configurations. This amount is
776 used for stems with the same direction to compensate for note head to
778 (script-priority ,number? "A key for determining the order of
779 scripts in a stack, by being added to the position of the script in
780 the user input, the sum being the overall priority. Smaller means
781 closer to the head.")
782 (self-alignment-X ,number? "Specify alignment of an object. The
783 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
784 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
785 values may also be specified.")
786 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
788 (sharp-positions ,list? "Sharps in key signatures are placed
789 within the specified ranges of staff-positions. The general form
790 is a list of pairs, with one pair for each type of clef, in order
791 of the staff-position at which each clef places C:
792 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
793 If the list contains a single element it applies for all clefs.
794 A single number in place of a pair sets accidentals within the octave
795 ending at that staff-position.")
796 (shorten-pair ,number-pair? "The lengths to shorten a
797 text-spanner on both sides, for example a pedal bracket. Positive
798 values shorten the text-spanner, while negative values lengthen it.")
799 (shortest-duration-space ,ly:dimension? "Start with this much
800 space for the shortest duration. This is expressed in
801 @code{spacing-increment} as unit. See also
802 @rinternals{spacing-spanner-interface}.")
803 (shortest-playing-duration ,ly:moment? "The duration of the
804 shortest note playing here.")
805 (shortest-starter-duration ,ly:moment? "The duration of the
806 shortest note that starts here.")
807 (side-axis ,number? "If the value is @code{X} (or
808 equivalently@tie{}@code{0}), the object is placed horizontally next to
809 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
811 (side-relative-direction ,ly:dir? "Multiply direction of
812 @code{direction-source} with this to get the direction of this
814 (simple-Y ,boolean? "Should the Y placement of a spanner
815 disregard changes in system heights?")
816 (size ,number? "Size of object, relative to standard size.")
817 (skip-quanting ,boolean? "Should beam quanting be skipped?")
818 (skyline-horizontal-padding ,number? "For determining the
819 vertical distance between two staves, it is possible to have a
820 configuration which would result in a tight interleaving of grobs from
821 the top staff and the bottom staff. The larger this parameter is, the
822 farther apart the staves are placed in such a configuration.")
823 (skyline-vertical-padding ,number? "The amount by which the left
824 and right skylines of a column are padded vertically, beyond the
825 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
826 grobs in the column. Increase this to prevent interleaving of grobs
827 from adjacent columns.")
828 (slash-negative-kern ,number? "The space to remove between
829 slashes in percent repeat glyphs. Larger values bring the two
830 elements closer together.")
831 (slope ,number? "The slope of this object.")
832 (slur-padding ,number? "Extra distance between slur and script.")
833 (snap-radius ,number? "The maximum distance between two objects that
834 will cause them to snap to alignment along an axis.")
835 (space-alist ,list? "A table that specifies distances between
836 prefatory items, like clef and time-signature. The format is an alist
837 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
838 . @var{distance})}, where @var{type} can be the symbols
839 @code{minimum-space} or @code{extra-space}.")
840 (space-to-barline ,boolean? "If set, the distance between a note
841 and the following non-musical column will be measured to the bar line
842 instead of to the beginning of the non-musical column. If there is a
843 clef change followed by a bar line, for example, this means that we
844 will try to space the non-musical column as though the clef is not
846 (spacing-increment ,number? "Add this much space for a doubled
847 duration. Typically, the width of a note head. See also
848 @rinternals{spacing-spanner-interface}.")
849 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
850 spacing relative to its left and right @code{BreakAlignment}s.
852 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
853 bounds (i.e., clefs, key signatures and time signatures) using the following
857 \\override MultiMeasureRest
858 #'spacing-pair = #'(staff-bar . staff-bar)
860 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
861 (springs-and-rods ,boolean? "Dummy variable for triggering
863 (stacking-dir ,ly:dir? "Stack objects in which direction?")
864 (staff-affinity ,ly:dir? "The direction of the staff to use
865 for spacing the current non-staff line. Choices are @code{UP},
866 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
867 line will be placed equidistant between the two nearest staves on
868 either side, unless collisions or other spacing constraints
869 prevent this. Setting @code{staff-affinity} for a staff causes it
870 to be treated as a non-staff line. Setting @code{staff-affinity}
871 to @code{#f} causes a non-staff line to be treated as a staff.")
872 (staff-padding ,ly:dimension? "Maintain this much space between
873 reference points and the staff. Its effect is to align objects of
874 differing sizes (like the dynamics @b{p} and @b{f}) on their
876 (staff-position ,number? "Vertical position, measured in half
877 staff spaces, counted from the middle line.")
878 (staff-space ,ly:dimension? "Amount of space between staff lines,
879 expressed in global @code{staff-space}.")
880 (staff-staff-spacing ,list? "When applied to a staff-group's
881 @code{StaffGrouper} grob, this spacing alist controls the distance
882 between consecutive staves within the staff-group. When applied
883 to a staff's @code{VerticalAxisGroup} grob, it controls the
884 distance between the staff and the nearest staff below it in the
885 same system, replacing any settings inherited from the
886 @code{StaffGrouper} grob of the containing staff-group, if there
887 is one. This property remains in effect even when non-staff lines
888 appear between staves. The alist can contain the following keys:
893 @code{basic-distance} -- the vertical distance, measured in
894 staff-spaces, between the reference points of the two items when
895 no collisions would result, and no stretching or compressing is in
899 @code{minimum-distance} -- the smallest allowable vertical
900 distance, measured in staff-spaces, between the reference points
901 of the two items, when compressing is in effect.
904 @code{padding} -- the minimum required amount of unobstructed
905 vertical whitespace between the bounding boxes (or skylines) of
906 the two items, measured in staff-spaces.
909 @code{stretchability} -- a unitless measure of the dimension's
910 relative propensity to stretch. If zero, the distance will not
911 stretch (unless collisions would result).
914 (staffgroup-staff-spacing ,list? "The spacing alist
915 controlling the distance between the last staff of the current
916 staff-group and the staff just below it in the same system, even
917 if one or more non-staff lines exist between the two staves. If
918 the @code{staff-staff-spacing} property of the staff's
919 @code{VerticalAxisGroup} grob is set, that is used instead. See
920 @code{staff-staff-spacing} for a description of the alist
922 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
923 pair where the stem attaches to the notehead.")
924 (stem-begin-position ,number? "User override for the
925 begin position of a stem.")
927 (stem-spacing-correction ,number? "Optical correction amount for
928 stems that are placed in tight configurations. For opposite
929 directions, this amount is the correction for two normal sized stems
930 that overlap completely.")
931 (stemlet-length ,number? "How long should be a stem over a
933 (stencil ,ly:stencil? "The symbol to print.")
934 (stencils ,list? "Multiple stencils, used as intermediate
936 (strict-grace-spacing ,boolean? "If set, main notes are spaced
937 normally, then grace notes are put left of the musical columns for the
939 (strict-note-spacing ,boolean? "If set, unbroken columns with
940 non-musical material (clefs, bar lines, etc.) are not spaced
941 separately, but put before musical columns.")
942 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
944 (style ,symbol? "This setting determines in what style a grob is
945 typeset. Valid choices depend on the @code{stencil} callback reading
952 (text ,markup? "Text markup. See @ruser{Formatting text}.")
953 ;;FIXME -- Should both be the same?
954 (text-direction ,ly:dir? "This controls the ordering of the
955 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
956 should use @code{LEFT}.")
957 (thick-thickness ,number? "Bar line thickness, measured in
958 @code{line-thickness}.")
959 (thickness ,number? "Line thickness, generally measured in
960 @code{line-thickness}.")
961 (thin-kern ,number? "The space after a hair-line in a bar line.")
962 (tie-configuration ,list? "List of @code{(@var{position} .
963 @var{dir})} pairs, indicating the desired tie configuration, where
964 @var{position} is the offset from the center of the staff in staff
965 space and @var{dir} indicates the direction of the tie (@code{1}=>up,
966 @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
967 in the list causes the corresponding tie to be formatted
969 (to-barline ,boolean? "If true, the spanner will stop at the bar
970 line just before it would otherwise stop.")
971 (toward-stem-shift ,number? "Amount by which scripts are shifted
972 toward the stem if their direction coincides with the stem direction.
973 @code{0.0} means keep the default position (centered on the note
974 head), @code{1.0} means centered on the stem. Interpolated values are
976 (transparent ,boolean? "This makes the grob invisible.")
982 (uniform-stretching ,boolean? "If set, items stretch
983 proportionally to their durations. This looks better in complex
984 polyphonic patterns.")
985 (used ,boolean? "If set, this spacing column is kept in the
987 (usable-duration-logs ,list? "List of @code{duration-log}s that
988 can be used in typesetting the grob.")
989 (use-skylines ,boolean? "Should skylines be used for side
995 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
996 one below this grob.")
1001 (when ,ly:moment? "Global time step associated with this column
1003 (whiteout ,boolean? "If true, the grob is printed over a white
1004 background to white-out underlying material, if the grob is visible.
1005 Usually #f by default.")
1006 (width ,ly:dimension? "The width of a grob measured in staff
1008 (word-space ,ly:dimension? "Space to insert between words in
1015 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
1016 (X-offset ,number? "The horizontal amount that this object is
1017 moved relative to its X-parent.")
1018 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
1019 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
1020 @var{right} are in @code{staff-space} units of the current staff.")
1026 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
1027 (Y-offset ,number? "The vertical amount that this object is moved
1028 relative to its Y-parent.")
1033 (zigzag-length ,ly:dimension? "The length of the lines of a
1034 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
1035 gives 60-degree zigzags.")
1036 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
1037 This number is adjusted slightly so that the glissando line can be
1038 constructed from a whole number of squiggles.")
1046 (define (define-internal-grob-property symbol type? description)
1047 (define-grob-property symbol type? description)
1048 (set-object-property! symbol 'backend-internal #t)
1053 (define-public all-internal-grob-properties
1056 (apply define-internal-grob-property x))
1060 ;; grobs & grob arrays. (alphabetical)
1061 (accidental-grob ,ly:grob? "The accidental for this note.")
1062 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
1063 @var{groblist})} entries.")
1064 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
1066 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
1067 function is to protect objects from being garbage collected.")
1068 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1069 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1071 (bars ,ly:grob-array? "An array of bar line pointers.")
1072 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1073 (beam-segments ,list? "Internal representation of beam segments.")
1074 (bound-alignment-interfaces ,list "Interfaces to be used
1075 for positioning elements that align with a column.")
1076 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1077 column as start/@/begin point. Only columns that have grobs or act as
1078 bounds are spaced.")
1079 (bracket ,ly:grob? "The bracket for a number.")
1081 (c0-position ,integer? "An integer indicating the position of
1083 (columns ,ly:grob-array? "An array of grobs, typically containing
1084 @code{PaperColumn} or @code{NoteColumn} objects.")
1085 (concurrent-hairpins ,ly:grob-array? "All concurrent hairpins.")
1086 (conditional-elements ,ly:grob-array? "Internal use only.")
1087 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1090 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1091 set, which grob to get the direction from.")
1092 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1093 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1094 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1096 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1097 the grob where this is set in.")
1098 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1099 in addition to notes and stems.")
1101 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1102 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1103 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1104 (footnotes-before-line-breaking ,ly:grob-array? "Footnote grobs of
1106 (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of
1109 (glissando-index ,integer? "The index of a glissando in its note
1111 (grace-spacing ,ly:grob? "A run of grace notes.")
1113 (has-span-bar ,pair? "A pair of grobs containing the span bars to
1114 be drawn below and above the staff. If no span bar is in a position,
1115 the respective element is set to @code{#f}.")
1116 (heads ,ly:grob-array? "An array of note heads.")
1118 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1119 empty in a particular staff, then that staff is erased.")
1120 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1121 (in-note-padding ,number? "Padding between in-notes.")
1122 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1124 (keep-alive-with ,ly:grob-array? "An array of other
1125 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1127 (left-items ,ly:grob-array? "DOCME")
1128 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1131 (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.")
1132 (minimum-translations-alist ,list? "An list of translations for a given
1133 start and end point.")
1135 (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the
1136 pure-from-neighbor-interface to determine various grob heights.")
1138 (normal-stems ,ly:grob-array? "An array of visible stems.")
1139 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1140 (note-head ,ly:grob? "A single note head.")
1141 (note-heads ,ly:grob-array? "An array of note head grobs.")
1142 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1144 (potential-X-colliding-grobs ,ly:grob-array? "Grobs that can potentially
1145 collide with a self-aligned grob on the X-axis.")
1146 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1147 that are relevant for finding the @code{pure-Y-extent}")
1148 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1149 relevant for finding the @code{pure-Y-extent}.")
1150 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1151 relevant for finding the @code{pure-Y-extent}.")
1152 (pure-Y-common ,ly:grob? "A cache of the
1153 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1155 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1156 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1157 (rests ,ly:grob-array? "An array of rest objects.")
1158 (right-items ,ly:grob-array? "DOCME")
1159 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1161 (side-support-elements ,ly:grob-array? "The side support, an array of
1163 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1164 (spacing ,ly:grob? "The spacing spanner governing this section.")
1165 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1167 (span-start ,boolean? "Is the note head at the start of a spanner?")
1168 (spanner-broken ,boolean? "Indicates whether spanner
1169 alignment should be broken after the current spanner.")
1170 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1171 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1172 @code{CENTER} will place it on the broken spanner that falls closest to the
1173 center of the length of the entire spanner, although this behavior is
1174 unpredictable in situations with lots of rhythmic diversity. For predictable
1175 results, use @code{LEFT} and @code{RIGHT}.")
1176 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1177 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1178 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1179 (stems ,ly:grob-array? "An array of stem objects.")
1181 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1182 (ties ,ly:grob-array? "A grob array of @code{Tie} objects.")
1183 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1184 (tuplet-number ,ly:grob? "The number for a bracket.")
1185 (tuplet-start ,boolean? "Is stem at the start of a tuplet?")
1186 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1188 (vertical-alignment ,ly:grob? "The VerticalAlignment in a System.")
1189 (vertical-skyline-elements ,ly:grob-array? "An array of grobs
1190 used to create vertical skylines.")
1192 (X-colliding-grobs ,ly:grob-array? "Grobs that can collide
1193 with a self-aligned grob on the X-axis.")
1194 (Y-colliding-grobs ,ly:grob-array? "Grobs that can collide
1195 with a self-aligned grob on the Y-axis.")
1196 (X-common ,ly:grob? "Common reference point for axis group.")
1197 (Y-common ,ly:grob? "See @code{X-common}.")
1201 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1202 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1205 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1206 @code{FretBoard} be visible only at beginning of line or at
1209 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1210 translator) that was the cause for this grob.")
1211 (cross-staff ,boolean? "True for grobs whose @code{Y-extent} depends on
1212 inter-staff spacing. The extent is measured relative to the grobs's parent
1213 staff (more generally, its @code{VerticalAxisGroup}) so this boolean flags
1214 grobs that are not rigidly fixed to their parent staff.
1215 Beams that join notes from two staves are @code{cross-staff}.
1216 Grobs that are positioned around such beams are also @code{cross-staff}.
1217 Grobs that are grouping objects, however, like @code{VerticalAxisGroups}
1218 will not in general be marked @code{cross-staff} when some of the members
1219 of the group are @code{cross-staff}.")
1221 (delta-position ,number? "The vertical position difference.")
1223 (font ,ly:font-metric? "A cached font metric object.")
1224 (forced ,boolean? "Manually forced accidental.")
1226 (head-width ,ly:dimension? "The width of this ligature head.")
1228 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1229 @var{strength}))} pairs.")
1230 (important-column-ranks ,vector? "A cache of columns that contain
1231 @code{items-worth-living} data.")
1232 (interfaces ,list? "A list of symbols indicating the interfaces
1233 supported by this object. It is initialized from the @code{meta} field.")
1235 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1237 (maybe-loose ,boolean? "Used to mark a breakable column that is
1238 loose if and only if it is in the middle of a line.")
1239 (meta ,list? "Provide meta information. It is an alist with the
1240 entries @code{name} and @code{interfaces}.")
1241 (minimum-distances ,list? "A list of rods that have the format
1242 @code{(@var{obj} . @var{dist})}.")
1244 (note-collision ,ly:grob? "The @code{NoteCollision} object of a
1246 (numbering-assertion-function ,scheme? "The function used to assert
1247 that footnotes are receiving correct automatic numbers.")
1249 (positioning-done ,boolean? "Used to signal that a positioning element
1250 did its job. This ensures that a positioning is only done once.")
1251 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1252 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1253 cyclic dependencies.")
1254 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1255 to be within staff spaces.")
1256 (quantized-positions ,number-pair? "The beam positions after
1260 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1261 acts as an index for looking up a @code{Stencil} object.")
1262 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1263 Internally used to distribute beam shortening over stems.")
1264 (stem-info ,pair? "A cache of stem parameters.")
1265 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1266 top-margin of the page) of the system to which this staff belongs.")
1273 ;; There are too many properties for ancient notation;
1274 ;; probably neume-types (a list of symbols) would also work.
1276 ;; However, such a list would consist of a couple of dozens of
1277 ;; entries, since head prefixes may be combined in many ways. If
1278 ;; the macros in `gregorian.ly' would directly set prefix-set,
1279 ;; all the head prefixes could be junked; however, such macros
1280 ;; would be quite numerous, I guess. --jr
1282 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1284 (add-join ,boolean? "Is this ligature head-joined with the next one
1285 by a vertical line?")
1286 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1287 an additional stem on the right side?")
1288 (ascendens ,boolean? "Is this neume of ascending type?")
1289 (auctum ,boolean? "Is this neume liquescentically augmented?")
1291 (cavum ,boolean? "Is this neume outlined?")
1292 (context-info ,integer? "Within a ligature, the final glyph or shape of
1293 a head may be affected by the left and/@/or right neighbour head.
1294 @code{context-info} holds for each head such information about the left and
1295 right neighbour, encoded as a bit mask.")
1297 (deminutum ,boolean? "Is this neume deminished?")
1298 (descendens ,boolean? "Is this neume of descendent type?")
1300 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1301 grob (in @code{staff-space} units).")
1302 (flexa-interval ,integer? "The interval spanned by the two notes of a
1303 flexa shape (1 is a second, 7 is an octave).")
1304 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1305 ligature grob in (in @code{staff-space} units).")
1306 (ligature-flexa ,boolean? "request joining note to the previous one
1309 (inclinatum ,boolean? "Is this neume an inclinatum?")
1312 (linea ,boolean? "Attach vertical lines to this neume?")
1314 (oriscus ,boolean? "Is this neume an oriscus?")
1316 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1318 (prefix-set ,number? "A bit mask that holds all Gregorian head
1319 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1320 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1321 similar to a note head that is part of a ligature.")
1323 (quilisma ,boolean? "Is this neume a quilisma?")
1325 (stropha ,boolean? "Is this neume a stropha?")
1327 (virga ,boolean? "Is this neume a virga?")
1329 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1333 (define-public all-backend-properties
1335 all-internal-grob-properties
1336 all-user-grob-properties))