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 (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 break-align
129 grob 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? "Defines the order in which
136 prefatory matter (clefs, key signatures) appears. The format is a
137 vector of length@tie{}3, where each element is one order for
138 end-of-line, middle of line, and start-of-line, respectively. An
139 order is a list of symbols.
141 For example, clefs are put after key signatures by setting
144 \\override Score.BreakAlignment #'break-align-orders =
145 #(make-vector 3 '(span-bar
152 (break-align-symbol ,symbol? "This key is used for aligning and
153 spacing breakable items.")
154 (break-align-symbols ,list? "A list of symbols that determine
155 which break-aligned grobs to align this to. If the grob selected by
156 the first symbol in the list is invisible due to break-visibility, we
157 will align to the next grob (and so on). Choices are @code{left-edge},
158 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
159 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
161 (break-overshoot ,number-pair? "How much does a broken spanner
162 stick out of its bounds?")
163 (break-visibility ,vector? "A vector of 3@tie{}booleans,
164 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
165 @code{#t} means visible, @code{#f} means killed.")
166 (breakable ,boolean? "Allow breaks here.")
167 (broken-bound-padding ,number? "The amount of padding to insert
168 when a spanner is broken at a line break.")
173 (c0-position ,integer? "An integer indicating the position of
175 (circled-tip ,boolean? "Put a circle at start/@/end of
176 hairpins (al/@/del niente).")
177 (clip-edges ,boolean? "Allow outward pointing beamlets at the
179 (collapse-height ,ly:dimension? "Minimum height of system start
180 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
181 (collision-bias ,number? "Number determining how much to favor the
182 left (negative) or right (positive). Larger absolute values in either
183 direction will push a collision in this direction.")
184 (collision-interfaces ,list? "A list of interfaces for which
185 automatic beam-collision resolution is run.")
186 (collision-padding ,number? "Amount of padding to apply after
187 a collision is detected via the self-alignment-interface.")
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.")
207 (damping ,number? "Amount of beam slope damping.")
208 (dash-definition ,pair? "List of @code{dash-elements} defining the
209 dash structure. Each @code{dash-element} has a starting t value,
210 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
211 (dash-fraction ,number? "Size of the dashes, relative to
212 @code{dash-period}. Should be between @code{0.0} (no line) and
213 @code{1.0} (continuous line).")
214 (dash-period ,number? "The length of one dash together with
215 whitespace. If negative, no line is drawn at all.")
216 (default-direction ,ly:dir? "Direction determined by note head
218 (default-staff-staff-spacing ,list? "The settings to use for
219 @code{staff-staff-spacing} when it is unset, for ungrouped staves
220 and for grouped staves that do not have the relevant
221 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
222 @code{staffgroup-staff-spacing}).")
223 (details ,list? "Alist of parameters for detailed grob behavior.
224 More information on the allowed parameters for a grob can be found by
225 looking at the top of the Internals Reference page for each interface
226 having a @code{details} property.")
227 (digit-names ,vector? "Names for string finger digits.")
228 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
229 @code{X}), then this property determines whether the object is placed
230 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
231 other object. Otherwise, it determines whether the object is placed
232 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
233 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
234 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
235 @code{CENTER}=@code{0}.")
236 (dot-count ,integer? "The number of dots.")
237 (dot-negative-kern ,number? "The space to remove between a dot
238 and a slash in percent repeat glyphs. Larger values bring the two
239 elements closer together.")
240 (dot-placement-list ,list? "List consisting of
241 @code{(@var{description} @var{string-number} @var{fret-number}
242 @var{finger-number})} entries used to define fret diagrams.")
243 (duration-log ,integer? "The 2-log of the note head duration,
244 i.e., @code{0} = whole note, @code{1} = half note, etc.")
250 (eccentricity ,number? "How asymmetrical to make a slur.
251 Positive means move the center to the right.")
252 (edge-height ,pair? "A pair of numbers specifying the heights of
253 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
254 (edge-text ,pair? "A pair specifying the texts to be set at the
255 edges: @code{(@var{left-text} . @var{right-text})}.")
256 (round-up-exceptions ,list? "A list of pairs where car is the numerator
257 and cdr the denominator of a moment. Each pair in this list means that
258 the multi-measure rests of the corresponding length will be rounded up to
259 the longer rest. See @var{round-up-to-longer-rest}.")
260 (expand-limit ,integer? "Maximum number of measures expanded in
263 (extra-dy ,number? "Slope glissandi this much extra.")
264 (extra-offset ,number-pair? "A pair representing an offset. This
265 offset is added just before outputting the symbol, so the typesetting
266 engine is completely oblivious to it. The values are measured in
267 @code{staff-space} units of the staff's @code{StaffSymbol}.")
268 (extra-spacing-height ,number-pair? "In the horizontal spacing
269 problem, we increase the height of each item by this amount (by adding
270 the @q{car} to the bottom of the item and adding the @q{cdr} to the
271 top of the item). In order to make a grob infinitely high (to prevent
272 the horizontal spacing problem from placing any other grobs above or
273 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
274 (extra-spacing-width ,number-pair? "In the horizontal spacing
275 problem, we pad each item by this amount (by adding the @q{car} on the
276 left side of the item and adding the @q{cdr} on the right side of the
277 item). In order to make a grob take up no horizontal space at all,
278 set this to @code{(+inf.0 . -inf.0)}.")
279 (extra-X-extent ,number-pair? "A grob is enlarged in
280 X@tie{}dimension by this much.")
281 (extra-Y-extent ,number-pair? "A grob is enlarged in
282 Y@tie{}dimension by this much.")
288 (flag-count ,number? "The number of tremolo beams.")
289 (flat-positions ,list? "Flats in key signatures are placed
290 within the specified ranges of staff-positions. The general form
291 is a list of pairs, with one pair for each type of clef, in order
292 of the staff-position at which each clef places C:
293 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
294 If the list contains a single element it applies for all clefs.
295 A single number in place of a pair sets accidentals within the octave
296 ending at that staff-position.")
297 (font-encoding ,symbol? "The font encoding is the broadest
298 category for selecting a font. Currently, only lilypond's system
299 fonts (Emmentaler) are using this property. Available
300 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
301 @code{fetaText} (Emmentaler).")
302 (font-family ,symbol? "The font family is the broadest category
303 for selecting text fonts. Options include: @code{sans},
305 (font-name ,string? "Specifies a file name (without extension) of
306 the font to load. This setting overrides selection using
307 @code{font-family}, @code{font-series} and @code{font-shape}.")
308 (font-series ,symbol? "Select the series of a font. Choices
309 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
310 (font-shape ,symbol? "Select the shape of a font. Choices
311 include @code{upright}, @code{italic}, @code{caps}.")
312 (font-size ,number? "The font size, compared to the
313 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
314 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
315 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
316 larger. Fractional values are allowed.")
317 (footnote ,boolean? "Should this be a footnote or in-note?")
318 (footnote-music ,ly:music? "Music creating a footnote.")
319 (footnote-text ,markup? "A footnote for the grob.")
320 (force-hshift ,number? "This specifies a manual shift for notes
321 in collisions. The unit is the note head width of the first voice
322 note. This is used by @rinternals{note-collision-interface}.")
323 (forced-spacing ,number? "Spacing forced between grobs, used in
324 various ligature engravers.")
325 (fraction ,fraction? "Numerator and denominator of a time
327 (french-beaming ,boolean? "Use French beaming style for this
328 stem. The stem stops at the innermost beams.")
329 (fret-diagram-details ,list? "An alist of detailed grob
330 properties for fret diagrams. Each alist entry consists of a
331 @code{(@var{property} . @var{value})} pair. The properties which can
332 be included in @code{fret-diagram-details} include the following:
336 @code{barre-type} -- Type of barre indication used. Choices include
337 @code{curved}, @code{straight}, and @code{none}. Default
340 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
341 fret-space. Default value@tie{}0.5.
343 @code{dot-color} -- Color of dots. Options include @code{black} and
344 @code{white}. Default @code{black}.
346 @code{dot-label-font-mag} -- Magnification for font used to label fret
347 dots. Default value@tie{}1.
349 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
350 dots without labels, 0.95-@code{dot-radius} for dots with labels.
352 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
353 value 0.425 for labeled dots, 0.25 for unlabeled dots.
355 @code{finger-code} -- Code for the type of fingering indication used.
356 Options include @code{none}, @code{in-dot}, and @code{below-string}.
357 Default @code{none} for markup fret diagrams, @code{below-string} for
358 @code{FretBoards} fret diagrams.
360 @code{fret-count} -- The number of frets. Default@tie{}4.
362 @code{fret-label-custom-format} -- The format string to be used label
363 the lowest fret number, when @code{number-type} equals to
364 @code{custom}. Default@tie{}\"~a\".
366 @code{fret-label-font-mag} -- The magnification of the font used to
367 label the lowest fret number. Default@tie{}0.5.
369 @code{fret-label-vertical-offset} -- The offset of the fret label from
370 the center of the fret in direction parallel to strings.
373 @code{label-dir} -- Side to which the fret label is attached.
374 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
375 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
377 @code{mute-string} -- Character string to be used to indicate muted
378 string. Default @code{\"x\"}.
380 @code{number-type} -- Type of numbers to use in fret label. Choices
381 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
382 @code{custom}. In the later case, the format string is supplied by
383 the @code{fret-label-custom-format} property.
384 Default @code{roman-lower}.
386 @code{open-string} -- Character string to be used to indicate open
387 string. Default @code{\"o\"}.
389 @code{orientation} -- Orientation of fret-diagram. Options include
390 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
391 Default @code{normal}.
393 @code{string-count} -- The number of strings. Default@tie{}6.
395 @code{string-label-font-mag} -- The magnification of the font used to
396 label fingerings at the string, rather than in the dot. Default value
397 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
398 @code{opposing-landscape}.
400 @code{string-thickness-factor} -- Factor for changing thickness of
401 each string in the fret diagram. Thickness of string @var{k} is given
403 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
406 @code{top-fret-thickness} -- The thickness of the top fret line, as a
407 multiple of the standard thickness. Default value@tie{}3.
409 @code{xo-font-magnification} -- Magnification used for mute and open
410 string indicators. Default value@tie{}0.5.
412 @code{xo-padding} -- Padding for open and mute indicators from top
413 fret. Default value 0.25.
415 ;; ugh: double, change.
416 (full-length-padding ,number? "How much padding to use at the
417 right side of a full-length tuplet bracket.")
418 (full-length-to-extent ,boolean? "Run to the extent of the column
419 for a full-length tuplet bracket.")
420 (full-measure-extra-space ,number? "Extra space that is allocated
421 at the beginning of a measure with only one note. This property is
422 read from the NonMusicalPaperColumn that begins the measure.")
423 (full-size-change ,boolean? "Don't make a change clef smaller.")
429 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
430 (gap-count ,integer? "Number of gapped beams for tremolo.")
431 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
433 (glyph ,string? "A string determining what @q{style} of glyph is
434 typeset. Valid choices depend on the function that is reading this
436 (glyph-name ,string? "The glyph name within the font.")
437 (glyph-name-alist ,list? "An alist of key-string pairs.")
438 (graphical ,boolean? "Display in graphical (vs. text) form.")
439 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
445 (hair-thickness ,number? "Thickness of the thin line in a bar
447 (harp-pedal-details ,list? "An alist of detailed grob properties
448 for harp pedal diagrams. Each alist entry consists of a
449 @code{(@var{property} . @var{value})} pair. The properties which can
450 be included in harp-pedal-details include the following:
454 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
455 boxes above/@/below the horizontal line. Default value@tie{}0.8.
457 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
459 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
461 @code{space-before-divider} -- Space between boxes before the first
462 divider (so that the diagram can be made symmetric). Default
465 @code{space-after-divider} -- Space between boxes after the first
466 divider. Default value@tie{}0.8.
468 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
469 of the ellipse around circled pedals. Default value@tie{}0.5.
471 @code{circle-x-padding} -- Padding in X direction of the ellipse
472 around circled pedals. Default value 0.15.
474 @code{circle-y-padding} -- Padding in Y direction of the ellipse
475 around circled pedals. Default value@tie{}0.2.
477 (head-direction ,ly:dir? "Are the note heads left or right in a
479 (height ,ly:dimension? "Height of an object in @code{staff-space}
481 (height-limit ,ly:dimension? "Maximum slur height: The longer the
482 slur, the closer it is to this height.")
483 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
484 that appears on a tied note after a line break will not be displayed.")
485 (horizontal-shift ,integer? "An integer that identifies ranking
486 of @code{NoteColumn}s for horizontal shifting. This is used by
487 @rinternals{note-collision-interface}.")
488 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
489 left and one to the right of this grob.")
495 (id ,string? "An id string for the grob. Depending on the typestting
496 backend being used, this id will be assigned to a group containing all of
497 the stencils that comprise a given grob. For example, in the svg backend,
498 the string will be assigned to the @code{id} attribute of a group (<g>)
499 that encloses the stencils that comprise the grob. In the Postscript
500 backend, as there is no way to group items, the setting of the id property
501 will have no effect.")
502 (ignore-collision ,boolean? "If set, don't do note collision
503 resolution on this @code{NoteColumn}.")
504 (implicit ,boolean? "Is this an implicit bass figure?")
505 (inspect-index ,integer? "If debugging is set, set beam and slur
506 configuration to this index, and print the respective scores.")
507 (inspect-quants ,number-pair? "If debugging is set, set beam and
508 slur quants to this position, and print the respective scores.")
514 (keep-inside-line ,boolean? "If set, this column cannot have
515 objects sticking into the margin.")
516 (kern ,ly:dimension? "Amount of extra white space to add. For
517 bar lines, this is the amount of space after a thick line.")
518 (knee ,boolean? "Is this beam kneed?")
519 (knee-spacing-correction ,number? "Factor for the optical
520 correction amount for kneed beams. Set between @code{0} for no
521 correction and @code{1} for full correction.")
527 (labels ,list? "List of labels (symbols) placed on a column.")
528 (layer ,integer? "An integer which determines the order of printing
529 objects. Objects with the lowest value of layer are drawn first, then
530 objects with progressively higher values are drawn, so objects with
531 higher values overwrite objects with lower values. By default most
532 objects are assigned a layer value of 1.")
533 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
535 (ledger-line-thickness ,number-pair? "The thickness of ledger
536 lines. It is the sum of 2@tie{}numbers: The first is the factor for
537 line thickness, and the second for staff space. Both contributions
539 (ledger-positions ,list? "Repeating pattern for the vertical positions
540 of ledger lines. Bracketed groups are always shown together.")
541 (left-bound-info ,list? "An alist of properties for determining
542 attachments of spanners to edges.")
543 (left-padding ,ly:dimension? "The amount of space that is put
544 left to an object (e.g., a lyric extender).")
545 (length ,ly:dimension? "User override for the stem length of
547 (length-fraction ,number? "Multiplier for lengths. Used for
548 determining ledger lines and stem lengths.")
549 (line-break-penalty ,number? "Penalty for a line break at this
550 column. This affects the choices of the line breaker; it avoids a
551 line break at a column with a positive penalty and prefers a line
552 break at a column with a negative penalty.")
553 (line-break-permission ,symbol? "Instructs the line breaker on
554 whether to put a line break at this column. Can be @code{force} or
556 (line-break-system-details ,list? "An alist of properties to use
557 if this column is the start of a system.")
558 (line-count ,integer? "The number of staff lines.")
559 (line-positions ,list? "Vertical positions of staff lines.")
560 (line-thickness ,number? "The thickness of the tie or slur
562 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
568 (max-beam-connect ,integer? "Maximum number of beams to connect
569 to beams from this stem. Further beams are typeset as beamlets.")
570 (max-stretch ,number? "The maximum amount that this
571 @code{VerticalAxisGroup} can be vertically stretched (for example, in
572 order to better fill a page).")
573 (measure-count ,integer? "The number of measures for a
574 multi-measure rest.")
575 (measure-length ,ly:moment? "Length of a measure. Used in some
576 spacing situations.")
577 (merge-differently-dotted ,boolean? "Merge note heads in
578 collisions, even if they have a different number of dots. This is
579 normal notation for some types of polyphonic music.
581 @code{merge-differently-dotted} only applies to opposing stem
582 directions (i.e., voice 1 &@tie{}2).")
583 (merge-differently-headed ,boolean? "Merge note heads in
584 collisions, even if they have different note heads. The smaller of
585 the two heads is rendered invisible. This is used in polyphonic
586 guitar notation. The value of this setting is used by
587 @rinternals{note-collision-interface}.
589 @code{merge-differently-headed} only applies to opposing stem
590 directions (i.e., voice 1 &@tie{}2).")
591 (minimum-distance ,ly:dimension? "Minimum distance between rest
593 (minimum-length ,ly:dimension? "Try to make a spanner at least
594 this long, normally in the horizontal direction. This requires an
595 appropriate callback for the @code{springs-and-rods} property. If
596 added to a @code{Tie}, this sets the minimum distance between
598 (minimum-length-fraction ,number? "Minimum length of ledger line
599 as fraction of note head size.")
600 (minimum-space ,ly:dimension? "Minimum distance that the victim
601 should move (after padding).")
602 (minimum-X-extent ,number-pair? "Minimum size of an object in
603 X@tie{}dimension, measured in @code{staff-space} units.")
604 (minimum-Y-extent ,number-pair? "Minimum size of an object in
605 Y@tie{}dimension, measured in @code{staff-space} units.")
611 (neutral-direction ,ly:dir? "Which direction to take in the
612 center of the staff.")
613 (neutral-position ,number? "Position (in half staff spaces) where
614 to flip the direction of custos stem.")
615 (next ,ly:grob? "Object that is next relation (e.g., the lyric
616 syllable following an extender).")
617 (no-alignment ,boolean? "If set, don't place this grob in a
618 @code{VerticalAlignment}; rather, place it using its own
619 @code{Y-offset} callback.")
620 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
622 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
623 get stems extending to the middle staff line.")
624 (non-break-align-symbols ,list? "A list of symbols that determine
625 which NON-break-aligned interfaces to align this to.")
626 (non-default ,boolean? "Set for manually specified clefs.")
627 (non-musical ,boolean? "True if the grob belongs to a
628 @code{NonMusicalPaperColumn}.")
629 (nonstaff-nonstaff-spacing ,list? "The spacing alist
630 controlling the distance between the current non-staff line and
631 the next non-staff line in the direction of @code{staff-affinity},
632 if both are on the same side of the related staff, and
633 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
634 @code{staff-staff-spacing} for a description of the alist
636 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
637 controlling the distance between the current non-staff line and
638 the nearest staff in the direction of @code{staff-affinity}, if
639 there are no non-staff lines between the two, and
640 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
641 @code{staff-affinity} is @code{CENTER}, then
642 @code{nonstaff-relatedstaff-spacing} is used for the nearest
643 staves on @emph{both} sides, even if other non-staff lines appear
644 between the current one and either of the staves. See
645 @code{staff-staff-spacing} for a description of the alist
647 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
648 controlling the distance between the current non-staff line and
649 the nearest staff in the opposite direction from
650 @code{staff-affinity}, if there are no other non-staff lines
651 between the two, and @code{staff-affinity} is either @code{UP} or
652 @code{DOWN}. See @code{staff-staff-spacing} for a description of
653 the alist structure.")
654 (normalized-endpoints ,pair? "Represents left and right placement
655 over the total spanner, where the width of the spanner is normalized
657 (note-names ,vector? "Vector of strings containing names for
658 easy-notation note heads.")
664 (outside-staff-horizontal-padding ,number? "By default, an
665 outside-staff-object can be placed so that is it very close to another
666 grob horizontally. If this property is set, the outside-staff-object
667 is raised so that it is not so close to its neighbor.")
668 (outside-staff-padding ,number? "The padding to place between
669 this grob and the staff when spacing according to
670 @code{outside-staff-priority}.")
671 (outside-staff-placement-directive ,symbol? "One of four directives
672 telling how outside staff objects should be placed.
675 @code{left-to-right-greedy} -- Place each successive grob from left to
678 @code{left-to-right-polite} -- Place a grob from left to right only if
679 it does not potentially overlap with another grob that has been placed
680 on a pass through a grob array. If there is overlap, do another pass to
683 @code{right-to-left-greedy} -- Same as @code{left-to-right-greedy}, but
686 @code{right-to-left-polite} -- Same as @code{left-to-right-polite}, but
689 (outside-staff-priority ,number? "If set, the grob is positioned
690 outside the staff in such a way as to avoid all collisions. In case
691 of a potential collision, the grob with the smaller
692 @code{outside-staff-priority} is closer to the staff.")
698 (packed-spacing ,boolean? "If set, the notes are spaced as
699 tightly as possible.")
700 (padding ,ly:dimension? "Add this much extra space between
701 objects that are next to each other.")
702 (padding-pairs ,list? "An alist mapping @code{(@var{name}
703 . @var{name})} to distances.")
704 (page-break-penalty ,number? "Penalty for page break at this
705 column. This affects the choices of the page breaker; it avoids a
706 page break at a column with a positive penalty and prefers a page
707 break at a column with a negative penalty.")
708 (page-break-permission ,symbol? "Instructs the page breaker on
709 whether to put a page break at this column. Can be @code{force} or
711 (page-turn-penalty ,number? "Penalty for a page turn at this
712 column. This affects the choices of the page breaker; it avoids a
713 page turn at a column with a positive penalty and prefers a page turn
714 at a column with a negative penalty.")
715 (page-turn-permission ,symbol? "Instructs the page breaker on
716 whether to put a page turn at this column. Can be @code{force} or
718 (parenthesized ,boolean? "Parenthesize this grob.")
719 (positions ,number-pair? "Pair of staff coordinates
720 @code{(@var{left} . @var{right})}, where both @var{left} and
721 @var{right} are in @code{staff-space} units of the current staff. For
722 slurs, this value selects which slur candidate to use; if extreme
723 positions are requested, the closest one is taken.")
724 (prefer-dotted-right ,boolean? "For note collisions, prefer to
725 shift dotted up-note to the right, rather than shifting just the
731 (ratio ,number? "Parameter for slur shape. The higher this
732 number, the quicker the slur attains its @code{height-limit}.")
733 (remove-empty ,boolean? "If set, remove group if it contains no
735 (remove-first ,boolean? "Remove the first staff of an orchestral
737 (replacement-alist ,list? "Alist of strings.
738 The key is a string of the pattern to be replaced. The value is a
739 string of what should be displayed. Useful for ligatures.")
740 (restore-first ,boolean? "Print a natural before the
742 (rhythmic-location ,rhythmic-location? "Where (bar number,
743 measure position) in the score.")
744 (right-bound-info ,list? "An alist of properties for determining
745 attachments of spanners to edges.")
746 (right-padding ,ly:dimension? "Space to insert on the right side
747 of an object (e.g., between note and its accidentals).")
748 (rotation ,list? "Number of degrees to rotate this object, and
749 what point to rotate around. For example, @code{'(45 0 0)} rotates
750 by 45 degrees around the center of this object.")
751 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
752 rest when the length of a measure is between two values of
753 @code{usable-duration-logs}. For example, displays a breve instead of a whole
760 (same-direction-correction ,number? "Optical correction amount
761 for stems that are placed in tight configurations. This amount is
762 used for stems with the same direction to compensate for note head to
764 (script-priority ,number? "A sorting key that determines in what
765 order a script is within a stack of scripts.")
766 (self-alignment-X ,number? "Specify alignment of an object. The
767 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
768 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
769 values may also be specified.")
770 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
772 (sharp-positions ,list? "Sharps in key signatures are placed
773 within the specified ranges of staff-positions. The general form
774 is a list of pairs, with one pair for each type of clef, in order
775 of the staff-position at which each clef places C:
776 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
777 If the list contains a single element it applies for all clefs.
778 A single number in place of a pair sets accidentals within the octave
779 ending at that staff-position.")
780 (shorten-pair ,number-pair? "The lengths to shorten a
781 text-spanner on both sides, for example a pedal bracket. Positive
782 values shorten the text-spanner, while negative values lengthen it.")
783 (shortest-duration-space ,ly:dimension? "Start with this much
784 space for the shortest duration. This is expressed in
785 @code{spacing-increment} as unit. See also
786 @rinternals{spacing-spanner-interface}.")
787 (shortest-playing-duration ,ly:moment? "The duration of the
788 shortest note playing here.")
789 (shortest-starter-duration ,ly:moment? "The duration of the
790 shortest note that starts here.")
791 (side-axis ,number? "If the value is @code{X} (or
792 equivalently@tie{}@code{0}), the object is placed horizontally next to
793 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
795 (side-relative-direction ,ly:dir? "Multiply direction of
796 @code{direction-source} with this to get the direction of this
798 (simple-Y ,boolean? "Should the Y placement of a spanner
799 disregard changes in system heights?")
800 (size ,number? "Size of object, relative to standard size.")
801 (skip-quanting ,boolean? "Should beam quanting be skipped?")
802 (skyline-horizontal-padding ,number? "For determining the
803 vertical distance between two staves, it is possible to have a
804 configuration which would result in a tight interleaving of grobs from
805 the top staff and the bottom staff. The larger this parameter is, the
806 farther apart the staves are placed in such a configuration.")
807 (skyline-vertical-padding ,number? "The amount by which the left
808 and right skylines of a column are padded vertically, beyond the
809 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
810 grobs in the column. Increase this to prevent interleaving of grobs
811 from adjacent columns.")
812 (slash-negative-kern ,number? "The space to remove between
813 slashes in percent repeat glyphs. Larger values bring the two
814 elements closer together.")
815 (slope ,number? "The slope of this object.")
816 (slur-padding ,number? "Extra distance between slur and script.")
817 (space-alist ,list? "A table that specifies distances between
818 prefatory items, like clef and time-signature. The format is an alist
819 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
820 . @var{distance})}, where @var{type} can be the symbols
821 @code{minimum-space} or @code{extra-space}.")
822 (space-to-barline ,boolean? "If set, the distance between a note
823 and the following non-musical column will be measured to the bar line
824 instead of to the beginning of the non-musical column. If there is a
825 clef change followed by a bar line, for example, this means that we
826 will try to space the non-musical column as though the clef is not
828 (spacing-increment ,number? "Add this much space for a doubled
829 duration. Typically, the width of a note head. See also
830 @rinternals{spacing-spanner-interface}.")
831 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
832 spacing relative to its left and right @code{BreakAlignment}s.
834 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
835 bounds (i.e., clefs, key signatures and time signatures) using the following
839 \\override MultiMeasureRest
840 #'spacing-pair = #'(staff-bar . staff-bar)
842 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
843 (springs-and-rods ,boolean? "Dummy variable for triggering
845 (stacking-dir ,ly:dir? "Stack objects in which direction?")
846 (staff-affinity ,ly:dir? "The direction of the staff to use
847 for spacing the current non-staff line. Choices are @code{UP},
848 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
849 line will be placed equidistant between the two nearest staves on
850 either side, unless collisions or other spacing constraints
851 prevent this. Setting @code{staff-affinity} for a staff causes it
852 to be treated as a non-staff line. Setting @code{staff-affinity}
853 to @code{#f} causes a non-staff line to be treated as a staff.")
854 (staff-padding ,ly:dimension? "Maintain this much space between
855 reference points and the staff. Its effect is to align objects of
856 differing sizes (like the dynamics @b{p} and @b{f}) on their
858 (staff-position ,number? "Vertical position, measured in half
859 staff spaces, counted from the middle line.")
860 (staff-space ,ly:dimension? "Amount of space between staff lines,
861 expressed in global @code{staff-space}.")
862 (staff-staff-spacing ,list? "When applied to a staff-group's
863 @code{StaffGrouper} grob, this spacing alist controls the distance
864 between consecutive staves within the staff-group. When applied
865 to a staff's @code{VerticalAxisGroup} grob, it controls the
866 distance between the staff and the nearest staff below it in the
867 same system, replacing any settings inherited from the
868 @code{StaffGrouper} grob of the containing staff-group, if there
869 is one. This property remains in effect even when non-staff lines
870 appear between staves. The alist can contain the following keys:
875 @code{basic-distance} -- the vertical distance, measured in
876 staff-spaces, between the reference points of the two items when
877 no collisions would result, and no stretching or compressing is in
881 @code{minimum-distance} -- the smallest allowable vertical
882 distance, measured in staff-spaces, between the reference points
883 of the two items, when compressing is in effect.
886 @code{padding} -- the minimum required amount of unobstructed
887 vertical whitespace between the bounding boxes (or skylines) of
888 the two items, measured in staff-spaces.
891 @code{stretchability} -- a unitless measure of the dimension's
892 relative propensity to stretch. If zero, the distance will not
893 stretch (unless collisions would result).
896 (staffgroup-staff-spacing ,list? "The spacing alist
897 controlling the distance between the last staff of the current
898 staff-group and the staff just below it in the same system, even
899 if one or more non-staff lines exist between the two staves. If
900 the @code{staff-staff-spacing} property of the staff's
901 @code{VerticalAxisGroup} grob is set, that is used instead. See
902 @code{staff-staff-spacing} for a description of the alist
904 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
905 pair where the stem attaches to the notehead.")
906 (stem-begin-position ,number? "User override for the
907 begin position of a stem.")
909 (stem-spacing-correction ,number? "Optical correction amount for
910 stems that are placed in tight configurations. For opposite
911 directions, this amount is the correction for two normal sized stems
912 that overlap completely.")
913 (stemlet-length ,number? "How long should be a stem over a
915 (stencil ,ly:stencil? "The symbol to print.")
916 (stencils ,list? "Multiple stencils, used as intermediate
918 (strict-grace-spacing ,boolean? "If set, main notes are spaced
919 normally, then grace notes are put left of the musical columns for the
921 (strict-note-spacing ,boolean? "If set, unbroken columns with
922 non-musical material (clefs, bar lines, etc.) are not spaced
923 separately, but put before musical columns.")
924 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
926 (style ,symbol? "This setting determines in what style a grob is
927 typeset. Valid choices depend on the @code{stencil} callback reading
934 (text ,markup? "Text markup. See @ruser{Formatting text}.")
935 ;;FIXME -- Should both be the same?
936 (text-direction ,ly:dir? "This controls the ordering of the
937 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
938 should use @code{LEFT}.")
939 (thick-thickness ,number? "Bar line thickness, measured in
940 @code{line-thickness}.")
941 (thickness ,number? "Line thickness, generally measured in
942 @code{line-thickness}.")
943 (thin-kern ,number? "The space after a hair-line in a bar line.")
944 (tie-configuration ,list? "List of @code{(@var{position} .
945 @var{dir})} pairs, indicating the desired tie configuration, where
946 @var{position} is the offset from the center of the staff in staff
947 space and @var{dir} indicates the direction of the tie
948 (@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
949 in the list causes the corresponding tie to be formatted
951 (to-barline ,boolean? "If true, the spanner will stop at the bar
952 line just before it would otherwise stop.")
953 (toward-stem-shift ,number? "Amount by which scripts are shifted
954 toward the stem if their direction coincides with the stem direction.
955 @code{0.0} means keep the default position (centered on the note
956 head), @code{1.0} means centered on the stem. Interpolated values are
958 (transparent ,boolean? "This makes the grob invisible.")
964 (uniform-stretching ,boolean? "If set, items stretch
965 proportionally to their durations. This looks better in complex
966 polyphonic patterns.")
967 (used ,boolean? "If set, this spacing column is kept in the
969 (usable-duration-logs ,list? "List of @code{duration-log}s that
970 can be used in typesetting the grob.")
971 (use-skylines ,boolean? "Should skylines be used for side
977 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
978 one below this grob.")
983 (when ,ly:moment? "Global time step associated with this column
985 (whiteout ,boolean? "If true, the grob is printed over a white
986 background to white-out underlying material, if the grob is visible.
987 Usually #f by default.")
988 (width ,ly:dimension? "The width of a grob measured in staff
990 (word-space ,ly:dimension? "Space to insert between words in
997 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
998 (X-offset ,number? "The horizontal amount that this object is
999 moved relative to its X-parent.")
1000 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
1001 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
1002 @var{right} are in @code{staff-space} units of the current staff.")
1008 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
1009 (Y-offset ,number? "The vertical amount that this object is moved
1010 relative to its Y-parent.")
1015 (zigzag-length ,ly:dimension? "The length of the lines of a
1016 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
1017 gives 60-degree zigzags.")
1018 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
1019 This number is adjusted slightly so that the glissando line can be
1020 constructed from a whole number of squiggles.")
1028 (define (define-internal-grob-property symbol type? description)
1029 (define-grob-property symbol type? description)
1030 (set-object-property! symbol 'backend-internal #t)
1035 (define-public all-internal-grob-properties
1038 (apply define-internal-grob-property x))
1042 ;; grobs & grob arrays. (alphabetical)
1043 (accidental-grob ,ly:grob? "The accidental for this note.")
1044 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
1045 @var{groblist})} entries.")
1046 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
1048 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
1049 function is to protect objects from being garbage collected.")
1050 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
1051 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1052 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1054 (bars ,ly:grob-array? "An array of bar line pointers.")
1055 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1056 (beam-segments ,list? "Internal representation of beam segments.")
1057 (bound-alignment-interfaces ,list "Interfaces to be used
1058 for positioning elements that align with a column.")
1059 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1060 column as start/@/begin point. Only columns that have grobs or act as
1061 bounds are spaced.")
1062 (bracket ,ly:grob? "The bracket for a number.")
1064 (columns ,ly:grob-array? "An array of grobs, typically containing
1065 @code{PaperColumn} or @code{NoteColumn} objects.")
1066 (concurrent-hairpins ,ly:grob-array? "All concurrent hairpins.")
1067 (conditional-elements ,ly:grob-array? "Internal use only.")
1068 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1071 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1072 set, which grob to get the direction from.")
1073 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1074 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1075 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1077 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1078 the grob where this is set in.")
1079 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1080 in addition to notes and stems.")
1082 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1083 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1084 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1085 (footnotes-before-line-breaking ,ly:grob-array? "Footnote grobs of
1087 (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of
1089 (full-score-pure-minimum-translations ,list? "A list of translations
1090 for a full score's worth of grobs.")
1092 (glissando-index ,integer? "The index of a glissando in its note
1094 (grace-spacing ,ly:grob? "A run of grace notes.")
1096 (has-span-bar ,pair? "A pair of grobs containing the span bars to
1097 be drawn below and above the staff. If no span bar is in a position,
1098 the respective element is set to @code{#f}.")
1099 (heads ,ly:grob-array? "An array of note heads.")
1101 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1102 empty in a particular staff, then that staff is erased.")
1103 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1104 (in-note-padding ,number? "Padding between in-notes.")
1105 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1107 (keep-alive-with ,ly:grob-array? "An array of other
1108 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1110 (left-items ,ly:grob-array? "DOCME")
1111 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1114 (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.")
1116 (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the
1117 pure-from-neighbor-interface to determine various grob heights.")
1119 (normal-stems ,ly:grob-array? "An array of visible stems.")
1120 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1121 (note-head ,ly:grob? "A single note head.")
1122 (note-heads ,ly:grob-array? "An array of note head grobs.")
1123 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1125 (potential-X-colliding-grobs ,ly:grob-array? "Grobs that can potentially
1126 collide with a self-aligned grob on the X-axis.")
1127 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1128 that are relevant for finding the @code{pure-Y-extent}")
1129 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1130 relevant for finding the @code{pure-Y-extent}.")
1131 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1132 relevant for finding the @code{pure-Y-extent}.")
1133 (pure-Y-common ,ly:grob? "A cache of the
1134 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1136 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1137 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1138 (rests ,ly:grob-array? "An array of rest objects.")
1139 (right-items ,ly:grob-array? "DOCME")
1140 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1142 (side-support-elements ,ly:grob-array? "The side support, an array of
1144 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1145 (spacing ,ly:grob? "The spacing spanner governing this section.")
1146 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1148 (span-start ,boolean? "Is the note head at the start of a spanner?")
1149 (spanner-broken ,boolean? "Indicates whether spanner
1150 alignment should be broken after the current spanner.")
1151 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1152 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1153 @code{CENTER} will place it on the broken spanner that falls closest to the
1154 center of the length of the entire spanner, although this behavior is
1155 unpredictable in situations with lots of rhythmic diversity. For predictable
1156 results, use @code{LEFT} and @code{RIGHT}.")
1157 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1158 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1159 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1160 (stems ,ly:grob-array? "An array of stem objects.")
1162 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1163 (ties ,ly:grob-array? "A grob array of @code{Tie} objects.")
1164 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1165 (tuplet-number ,ly:grob? "The number for a bracket.")
1166 (tuplet-start ,boolean? "Is stem at the start of a tuplet?")
1167 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1169 (vertical-alignment ,ly:grob? "The VerticalAlignment in a System.")
1170 (vertical-skyline-elements ,ly:grob-array? "An array of grobs
1171 used to create vertical skylines.")
1173 (X-colliding-grobs ,ly:grob-array? "Grobs that can collide
1174 with a self-aligned grob on the X-axis.")
1175 (Y-colliding-grobs ,ly:grob-array? "Grobs that can collide
1176 with a self-aligned grob on the Y-axis.")
1177 (X-common ,ly:grob? "Common reference point for axis group.")
1178 (Y-common ,ly:grob? "See @code{X-common}.")
1182 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1183 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1186 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1187 @code{FretBoard} be visible only at beginning of line or at
1190 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1191 translator) that was the cause for this grob.")
1192 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1193 depend on inter-staff spacing.")
1195 (delta-position ,number? "The vertical position difference.")
1197 (font ,ly:font-metric? "A cached font metric object.")
1198 (forced ,boolean? "Manually forced accidental.")
1200 (head-width ,ly:dimension? "The width of this ligature head.")
1202 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1203 @var{strength}))} pairs.")
1204 (important-column-ranks ,vector? "A cache of columns that contain
1205 @code{items-worth-living} data.")
1206 (interfaces ,list? "A list of symbols indicating the interfaces
1207 supported by this object. It is initialized from the @code{meta} field.")
1209 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1211 (maybe-loose ,boolean? "Used to mark a breakable column that is
1212 loose if and only if it is in the middle of a line.")
1213 (meta ,list? "Provide meta information. It is an alist with the
1214 entries @code{name} and @code{interfaces}.")
1215 (minimum-distances ,list? "A list of rods that have the format
1216 @code{(@var{obj} . @var{dist})}.")
1218 (note-collision ,ly:grob? "The @code{NoteCollision} object of a
1220 (numbering-assertion-function ,scheme? "The function used to assert
1221 that footnotes are receiving correct automatic numbers.")
1223 (positioning-done ,boolean? "Used to signal that a positioning element
1224 did its job. This ensures that a positioning is only done once.")
1225 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1226 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1227 cyclic dependencies.")
1228 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1229 to be within staff spaces.")
1230 (quantized-positions ,number-pair? "The beam positions after
1234 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1235 acts as an index for looking up a @code{Stencil} object.")
1236 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1237 Internally used to distribute beam shortening over stems.")
1238 (stem-info ,pair? "A cache of stem parameters.")
1239 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1240 top-margin of the page) of the system to which this staff belongs.")
1247 ;; There are too many properties for ancient notation;
1248 ;; probably neume-types (a list of symbols) would also work.
1250 ;; However, such a list would consist of a couple of dozens of
1251 ;; entries, since head prefixes may be combined in many ways. If
1252 ;; the macros in `gregorian.ly' would directly set prefix-set,
1253 ;; all the head prefixes could be junked; however, such macros
1254 ;; would be quite numerous, I guess. --jr
1256 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1258 (add-join ,boolean? "Is this ligature head-joined with the next one
1259 by a vertical line?")
1260 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1261 an additional stem on the right side?")
1262 (ascendens ,boolean? "Is this neume of ascending type?")
1263 (auctum ,boolean? "Is this neume liquescentically augmented?")
1265 (cavum ,boolean? "Is this neume outlined?")
1266 (context-info ,integer? "Within a ligature, the final glyph or shape of
1267 a head may be affected by the left and/@/or right neighbour head.
1268 @code{context-info} holds for each head such information about the left and
1269 right neighbour, encoded as a bit mask.")
1271 (deminutum ,boolean? "Is this neume deminished?")
1272 (descendens ,boolean? "Is this neume of descendent type?")
1274 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1275 grob (in @code{staff-space} units).")
1276 (flexa-interval ,integer? "The interval spanned by the two notes of a
1277 flexa shape (1 is a second, 7 is an octave).")
1278 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1279 ligature grob in (in @code{staff-space} units).")
1280 (ligature-flexa ,boolean? "request joining note to the previous one
1283 (inclinatum ,boolean? "Is this neume an inclinatum?")
1286 (linea ,boolean? "Attach vertical lines to this neume?")
1288 (oriscus ,boolean? "Is this neume an oriscus?")
1290 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1292 (prefix-set ,number? "A bit mask that holds all Gregorian head
1293 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1294 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1295 similar to a note head that is part of a ligature.")
1297 (quilisma ,boolean? "Is this neume a quilisma?")
1299 (stropha ,boolean? "Is this neume a stropha?")
1301 (virga ,boolean? "Is this neume a virga?")
1303 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1307 (define-public all-backend-properties
1309 all-internal-grob-properties
1310 all-user-grob-properties))