1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 (define (define-grob-property symbol type? description)
9 (if (not (equal? (object-property symbol 'backend-doc) #f))
10 (ly:error (_ "symbol ~S redefined") symbol))
12 (set-object-property! symbol 'backend-type? type?)
13 (set-object-property! symbol 'backend-doc description)
16 ;; put this in an alist?
18 all-user-grob-properties
22 (apply define-grob-property x))
25 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
26 (X-offset ,number? "The horizontal amount that this object is
27 moved relative to its X-parent.")
28 (Y-extent ,number-pair? "See @code{X-extent}.")
29 (Y-offset ,number? "The vertical amount that this object is moved
30 relative to its Y-parent.")
32 (add-stem-support ,boolean? "If set, the @code{Stem} object is
33 included in this script's support.")
34 (after-line-breaking ,boolean? "Dummy property, used to trigger
35 callback for @code{after-line-breaking}.")
36 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
37 @code{0}: around center of width, @code{1}: right side.")
38 (allow-loose-spacing ,boolean? "If set, column can be detached
40 (alteration ,number? "Alteration numbers for accidental.")
41 (alteration-alist ,list? "List of @code{(@var{pitch}
42 . @var{accidental})} pairs for key signature.")
43 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
44 arpeggio squiggly line.")
45 (arrow-length ,number? "Arrow length.")
46 (arrow-width ,number? "Arrow width.")
47 (auto-knee-gap ,ly:dimension? "If a gap is found between note
48 heads where a horizontal beam fits that is larger than this number,
50 (average-spacing-wishes ,boolean? "If set, the spacing wishes
51 are averaged over staves.")
52 (avoid-note-head ,boolean? "If set, the stem of a chord does not
53 pass through all note heads, but starts at the last note head.")
54 (avoid-slur ,symbol? "Method of handling slur collisions.
55 Choices are @code{around}, @code{inside}, @code{outside}. If unset,
56 scripts and slurs ignore each other. @code{around} only moves the
57 script if there is a collision; @code{outside} always moves the
59 (axes ,list? "List of axis numbers. In the case of alignment
60 grobs, this should contain only one number.")
62 (bar-size ,ly:dimension? "The size of a bar line.")
63 (barre-type ,symbol? "Type of barre indication used in a fret
64 diagram. Choices include @code{curved} and @code{straight}.")
65 (base-shortest-duration ,ly:moment? "Spacing is based on the
66 shortest notes in a piece. Normally, pieces are spaced as if notes
67 at least as short as this are present.")
68 (baseline-skip ,ly:dimension? "Distance between base lines of
69 multiple lines of text.")
70 (beam-thickness ,ly:dimension? "Beam thickness, measured in
71 @code{staff-space} units.")
72 (beam-width ,ly:dimension? "Width of the tremolo sign.")
73 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
74 when their direction is forced. It is a list, since the value is
75 different depending on the number of flags and beams.")
76 (beaming ,pair? "Pair of number lists. Each number list
77 specifies which beams to make. @code{0}@tie{}is the central beam,
78 @code{1}@tie{}is the next beam toward the note, etc. This
79 information is used to determine how to connect the beaming patterns
80 from stem to stem inside a beam.")
81 (before-line-breaking ,boolean? "Dummy property, used to trigger
82 a callback function.")
83 (between-cols ,pair? "Where to attach a loose column to.")
84 (bound-padding ,number? "The amount of padding to insert around
86 (bound-details ,list? "An alist of properties for determining
87 attachments of spanners to edges.")
88 (bracket-flare ,number-pair? "A pair of numbers specifying how
89 much edges of brackets should slant outward. Value @code{0.0} means
91 (bracket-visibility ,boolean-or-symbol? "This controls the
92 visibility of the tuplet bracket. Setting it to false prevents
93 printing of the bracket. Setting the property to @code{if-no-beam}
94 makes it print only if there is no beam associated with this tuplet
96 (break-align-anchor ,number? "Grobs aligned to this break-align
97 grob will have their X-offsets shifted by this number. In barlines,
98 for example, this is used to position grobs relative to the (visual)
99 center of the barline.")
100 (break-align-anchor-alignment ,number? "Read by
101 ly:break-aligned-interface::calc-extent-aligned-anchor for aligning
102 an anchor to a grobs extent")
103 (break-align-symbol ,symbol? "This key is used for aligning and
104 spacing breakable items.")
105 (break-align-symbols ,list? "A list of symbols that determine
106 which break-aligned grobs to align this to. If the grob selected by
107 the first symbol in the list is invisible due to break-visibility,
108 we will align to the next grob (and so on).")
109 (break-align-orders ,vector? "Defines the order in which
110 prefatory matter (clefs, key signatures) appears. The format is a
111 vector of length@tie{}3, where each element is one order for
112 end-of-line, middle of line, and start-of-line, respectively. An
113 order is a list of symbols.
115 For example, clefs are put after key signatures by setting
118 \\override Score.BreakAlignment #'break-align-orders =
119 #(make-vector 3 '(span-bar
126 (break-overshoot ,number-pair? "How much does a broken spanner
127 stick out of its bounds?")
128 (break-visibility ,vector? "A vector of 3@tie{}booleans,
129 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
130 @code{#t} means visible, @code{#f} means killed.")
131 (breakable ,boolean? "Allow breaks here.")
133 (c0-position ,integer? "An integer indicating the position of
135 (clip-edges ,boolean? "Allow outward pointing beamlets at the
137 (collapse-height ,ly:dimension? "Minimum height of system start
138 delimiter. If equal or smaller, the bracket is removed.")
139 (color ,color? "The color of this grob.")
140 (common-shortest-duration ,ly:moment? "The most common shortest
141 note length. This is used in spacing. Enlarging this sets the score
143 (concaveness ,number? "A beam is concave if its inner stems are
144 closer to the beam than the two outside stems. This number is a
145 measure of the closeness of the inner stems. It is used for damping
146 the slope of the beam.")
147 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
148 this grob looks as a continued break.")
149 (control-points ,list? "List of offsets (number pairs) that form
150 control points for the tie, slur, or bracket shape. For B@'eziers,
151 this should list the control points of a third-order B@'ezier curve.")
153 (damping ,number? "Amount of beam slope damping.")
154 (dash-fraction ,number? "Size of the dashes, relative to
155 @code{dash-period}. Should be between @code{0.0} (no line) and
156 @code{1.0} (continuous line).")
157 (dash-period ,number? "The length of one dash together with
158 whitespace. If negative, no line is drawn at all.")
159 (default-direction ,ly:dir? "Direction determined by note head
161 (digit-names ,vector "Names for string finger digits.")
162 (direction ,ly:dir? "If @code{side-axis} is @code{1} (or
163 @code{#X}), then this property determines whether the object is placed
164 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
165 other object. Otherwise, it determines whether the object is placed
166 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
167 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
168 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, @code{CENTER}=@code{0}
169 but also other numerical values are permitted.")
170 (dot-color ,symbol? "Color of dots. Options include
171 @code{black} and @code{white}.")
172 (dot-count ,integer? "The number of dots.")
173 (dot-radius ,number? "Radius of dots.")
174 (duration-log ,integer? "The 2-log of the note head duration,
175 i.e., @code{0} = whole note, @code{1} = half note, etc.")
177 (eccentricity ,number? "How asymmetrical to make a slur.
178 Positive means move the center to the right.")
179 (edge-height ,pair? "A pair of numbers specifying the heights of
180 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
181 (edge-text ,pair? "A pair specifying the texts to be set at the
182 edges: @code{(@var{left-text} . @var{right-text})}.")
183 (expand-limit ,integer? "Maximum number of measures expanded in
185 (extra-X-extent ,number-pair? "A grob is enlarged in
186 X@tie{}dimension by this much.")
187 (extra-Y-extent ,number-pair? "See @code{extra-X-extent}.")
189 (extra-dy ,number? "Slope glissandi this much extra.")
190 (extra-offset ,number-pair? "A pair representing an offset. This
191 offset is added just before outputting the symbol, so the typesetting
192 engine is completely oblivious to it. The values are measured in
193 @code{staff-space} units of the staff's @code{StaffSymbol}.")
194 (extra-spacing-width ,number-pair? "In the horizontal spacing
195 problem, we pad each item by this amount (by adding the @q{car} on the
196 left side of the item and adding the @q{cdr} on the right side of the
197 item). In order to make a grob take up no horizontal space at all,
198 set this to @code{(+inf.0 . -inf.0)}.")
200 (finger-code ,symbol? "Code for the type of fingering indication
201 in a fret diagram. Options include @code{none}, @code{in-dot}, and
202 @code{below-string}.")
203 (flag-count ,number? "The number of tremolo beams.")
204 (flag-style ,symbol? "A string determining what style of flag
205 glyph is typeset on a @code{Stem}. Valid options include @code{()}
206 and @code{mensural}. Additionally, @code{no-flag} switches off the
208 (font-encoding ,symbol? "The font encoding is the broadest
209 category for selecting a font. Options include: @code{fetaMusic},
210 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math},
211 @code{fetaBraces}, @code{fetaDynamic}.")
212 (font-family ,symbol? "The font family is the broadest category
213 for selecting text fonts. Options include: @code{sans},
215 (font-name ,string? "Specifies a file name (without extension)
216 of the font to load. This setting overrides selection using
217 @code{font-family}, @code{font-series} and @code{font-shape}.")
218 (font-series ,symbol? "Select the series of a font. Choices
219 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
220 (font-shape ,symbol? "Select the shape of a font. Choices
221 include @code{upright}, @code{italic}, @code{caps}.")
222 (font-size ,number? "The font size, compared to the @q{normal}
223 size. @code{0}@tie{}is style-sheet's normal size, @code{-1} is
224 smaller, @code{+1} is bigger. Each step of@tie{}1 is approximately
225 12% larger, 6@tie{}steps are exactly a factor@tie{}2 larger.
226 Fractional values are allowed.")
227 (force-hshift ,number? "This specifies a manual shift for notes
228 in collisions. The unit is the note head width of the first voice
229 note. This is used by @internalsref{note-collision-interface}.")
230 (forced ,boolean? "Manually forced accidental.")
231 (fraction ,number-pair? "Numerator and denominator of a time
233 (french-beaming ,boolean? "Use French beaming style for this
234 stem. The stem stops at the innermost beams.")
235 (fret-count ,integer? "The number of frets in a fret diagram.")
236 ;; ugh: double, change.
237 (full-size-change ,boolean? "Don't make a change clef smaller.")
239 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
240 (gap-count ,integer? "Number of gapped beams for tremolo.")
241 (glyph ,string? "A string determining what @q{style} of glyph is
242 typeset. Valid choices depend on the function that is reading this
244 (glyph-name-alist ,list? "An alist of key-string pairs.")
245 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
247 (hair-thickness ,number? "Thickness of the thin line in a bar
249 (head-direction ,ly:dir? "Are the note heads left or right in a
251 (height ,ly:dimension? "Height of an object in
252 @code{staff-space} units.")
253 (height-limit ,ly:dimension? "Maximum slur height: The longer the
254 slur, the closer it is to this height.")
255 (horizontal-shift ,integer? "An integer that identifies ranking
256 of @code{NoteColumn}s for horizontal shifting. This is used by
257 @internalsref{note-collision-interface}.")
258 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
259 left and one to the right of this grob.")
261 (ignore-collision ,boolean? "If set, don't do note collision
262 resolution on this @code{NoteColumn}.")
263 (implicit ,boolean? "Is this an implicit bass figure?")
264 (infinite-spacing-height ,boolean? "If true, then for the
265 purposes of horizontal spacing, treat this item as though it were
266 infinitely tall. That is, no object from another column is allowed to
267 stick above or below this item.")
268 (inspect-index ,integer? "If debugging is set, set beam and slur
269 configuration to this index, and print the respective scores.")
270 (inspect-quants ,number-pair? "If debugging is set,
271 set beam and slur quants to this position, and print the respective
274 (keep-fixed-while-stretching ,boolean? "A grob with this property
275 set to true is fixed relative to the staff above it when systems are
277 (keep-inside-line ,boolean? "If set, this column cannot have
278 things sticking into the margin.")
279 (kern ,ly:dimension? "Amount of extra white space to add. For
280 bar lines, this is the amount of space after a thick line.")
281 (knee ,boolean? "Is this beam kneed?")
282 (knee-spacing-correction ,number? "Factor for the optical
283 correction amount for kneed beams. Set between @code{0} for no
284 correction and @code{1} for full correction.")
286 (labels ,list? "List of labels (symbols) placed on a column")
287 (label-dir ,ly:dir? "Side to which a label is attached.
288 @code{-1} for left, @code{1}@tie{}for right.")
289 (layer ,number? "The output layer (a value between 0 and@tie{}2:
290 Layers define the order of printing objects. Objects in lower layers
291 are overprinted by objects in higher layers.")
292 (ledger-line-thickness ,number-pair? "The thickness of ledger
293 lines. It is the sum of 2@tie{}numbers: The first is the factor for
294 line thickness, and the second for staff space. Both contributions
296 (left-bound-info ,list? "An alist of properties for determining
297 attachments of spanners to edges.")
298 (left-padding ,ly:dimension? "The amount of space that is put
299 left to an object (e.g., a group of accidentals).")
300 (length ,ly:dimension? "User override for the stem length of
302 (length-fraction ,number? "Multiplier for lengths. Used for
303 determining ledger lines and stem lengths.")
304 (line-break-penalty ,number? "Penalty for a line break at this
305 column. This affects the choices of the line breaker; it avoids a
306 line break at a column with a positive penalty and prefer a line break
307 at a column with a negative penalty.")
308 (line-break-permission ,symbol? "Instructs the line breaker on
309 whether to put a line break at this column. Can be @code{force} or
311 (line-break-system-details ,list? "An alist of properties to use
312 if this column is the start of a system.")
313 (line-count ,integer? "The number of staff lines.")
314 (line-positions ,list? "Vertical positions of staff lines.")
315 (line-thickness ,number? "The thickness of the tie or slur
317 (long-text ,markup? "Text markup. See @usermanref{Text
320 (max-beam-connect ,integer? "Maximum number of beams to connect
321 to beams from this stem. Further beams are typeset as beamlets.")
322 (max-stretch ,number? "The maximum amount that this
323 @code{VerticalAxisGroup} can be vertically stretched (for example, in
324 order to better fill a page).")
325 (measure-count ,integer? "The number of measures for a
326 multi-measure rest.")
327 (measure-length ,ly:moment? "Length of a measure. Used in some
328 spacing situations.")
329 (merge-differently-dotted ,boolean? "Merge note heads in
330 collisions, even if they have a different number of dots. This is
331 normal notation for some types of polyphonic music.
333 @code{merge-differently-dotted} only applies to opposing stem
334 directions (i.e., voice 1 &@tie{}2).")
335 (merge-differently-headed ,boolean? "Merge note heads in
336 collisions, even if they have different note heads. The
337 smaller of the two heads is rendered invisible. This is used in
338 polyphonic guitar notation. The value of this setting is used by
339 @internalsref{note-collision-interface}.
341 @code{merge-differently-headed} only applies to opposing stem
342 directions (i.e., voice 1 &@tie{}2).")
343 (minimum-X-extent ,number-pair? "Minimum size of an object in
344 X@tie{}dimension, measured in @code{staff-space} units.")
345 (minimum-Y-extent ,number-pair? "See @code{minimum-X-extent}.")
346 (minimum-distance ,ly:dimension? "Minimum distance between rest
348 (minimum-length ,ly:dimension? "Try to make a spanner at least
349 this long, normally in the horizontal direction. This requires an
350 appropriate callback for the @code{springs-and-rods} property. If
351 added to a @code{Tie}, this sets the minimum distance between
353 (minimum-length-fraction ,number? "Minimum length of ledger line
354 as fraction of note head size.")
355 (minimum-space ,ly:dimension? "Minimum distance that the victim
356 should move (after padding).")
358 (neutral-direction ,ly:dir? "Which direction to take in the
359 center of the staff.")
360 (neutral-position ,number? "Position (in half staff spaces) where
361 to flip the direction of custos stem.")
362 (next ,ly:grob? "Object that is next relation (e.g., the lyric
363 syllable following an extender.")
364 (no-alignment ,boolean? "If set, don't place this grob in a
365 VerticalAlignment; rather, place it using its own Y-offset callback")
366 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
368 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
369 get stems extending to the middle staff line.")
370 (non-default ,boolean? "Set for manually specified clefs.")
371 (non-musical ,boolean? "True if the grob belongs to a
372 @code{NonMusicalPaperColumn}.")
373 (note-names ,vector? "Vector of strings containing names for
374 easy-notation note heads.")
375 (number-type ,symbol? "Type of numbers to use in label. Choices
376 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
378 (outside-staff-horizontal-padding ,number? "By default, an
379 outside-staff-object can be placed so that is it very close to another
380 grob horizontally. If this property is set, the outside-staff-object
381 is raised so that it is not so close to its neighbour.")
382 (outside-staff-padding ,number? "The padding to place between
383 this grob and the staff when spacing according to
384 @code{outside-staff-priority}.")
385 (outside-staff-priority ,number? "If set, the grob is positioned
386 outside the staff in such a way as to avoid all collisions.
387 In case of a potential collision, the grob with the smaller
388 @code{outside-staff-priority} is closer to the staff.")
390 (packed-spacing ,boolean? "If set, the notes are spaced as
391 tightly as possible.")
392 (padding ,ly:dimension? "Add this much extra space between
393 objects that are next to each other.")
394 (page-break-penalty ,number? "Penalty for page break at this
395 column. This affects the choices of the page breaker; it avoids a
396 page break at a column with a positive penalty and prefer a page break
397 at a column with a negative penalty.")
398 (page-break-permission ,symbol? "Instructs the page breaker on
399 whether to put a page break at this column. Can be @code{force} or
401 (page-turn-penalty ,number? "Penalty for a page turn at this
402 column. This affects the choices of the page breaker; it avoids a
403 page turn at a column with a positive penalty and prefer a page turn
404 at a column with a negative penalty.")
405 (page-turn-permission ,symbol? "Instructs the page breaker on
406 whether to put a page turn at this column. Can be @code{force} or
408 (parenthesized ,boolean? "Parenthesize this grob.")
409 (positions ,number-pair? "Pair of staff coordinates @code{(@var{left}
410 . @var{right})}, where both @var{left} and @var{right} are in
411 @code{staff-space} units of the current staff.
413 For slurs, this value selects which slur candidate
414 to use; if extreme positions are requested, the closest one is taken.")
416 (ratio ,number? "Parameter for slur shape. The higher this
417 number, the quicker the slur attains its @code{height-limit}.")
418 (remove-empty ,boolean? "If set, remove group if it contains no
420 (remove-first ,boolean? "Remove the first staff of a orchestral
422 (restore-first ,boolean? "Print a natural before the
424 (rhythmic-location ,rhythmic-location? "Where (bar number,
425 measure position) in the score.")
426 (right-bound-info ,list? "An alist of properties for determining
427 attachments of spanners to edges.")
428 (right-padding ,ly:dimension? "Space to insert on the right side
429 of an object (e.g., between note and its accidentals).")
430 (rotation ,list? "Number of degrees to rotate this object, and
431 what point to rotate around. For example, @code{#'(45 0 0)} rotates
432 by 45 degrees around the center of this object.")
434 (same-direction-correction ,number? "Optical correction amount
435 for stems that are placed in tight configurations. This amount is
436 used for stems with the same direction to compensate for note-head to
438 (script-priority ,number? "A sorting key that determines in what
439 order a script is within a stack of scripts.")
440 (self-alignment-X ,number? "Specify alignment of an object. The
441 value @code{-1} means left aligned, @code{0}@tie{}centered, and
442 @code{1}@tie{}right-aligned in X@tie{}direction. Values in-between
443 may also be specified.")
444 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
446 (shorten-pair ,number-pair? "The lengths to shorten a
447 text-spanner on both sides, for example a pedal bracket. Positive
448 values shorten the text-spanner, while negative values lengthen it.")
449 (shortest-duration-space ,ly:dimension? "Start with this much
450 space for the shortest duration. This is expressed in
451 @code{spacing-increment} as unit. See also
452 @internalsref{spacing-spanner-interface}.")
453 (shortest-playing-duration ,ly:moment? "The duration of the
454 shortest playing here.")
455 (shortest-starter-duration ,ly:moment? "The duration of the
456 shortest note that starts here.")
457 (side-axis ,number? "If the value is @code{#X} (or
458 equivalently@tie{}@code{1}), the object is placed horizontally next
459 to the other object. If the value is @code{#Y} or@tie{}@code{0}, it
460 is placed vertically.")
461 (side-relative-direction ,ly:dir? "Multiply direction of
462 @code{direction-source} with this to get the direction of this
464 (size ,number? "Size of object, relative to standard size.")
465 (slope ,number? "The slope of this object.")
466 (slur-padding ,number? "Extra distance between slur and script.")
467 (space-alist ,list? "A table that specifies distances between
468 prefatory items, like clef and time-signature. The format is an alist
469 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
470 . @var{distance})}, where @var{type} can be the symbols
471 @code{minimum-space} or @code{extra-space}.")
472 (space-to-barline ,boolean? "If set, the distance between a note
473 and the following non-musical column will be measured to the barline
474 instead of to the beginning of the non-musical column. If there is a
475 clef change followed by a barline, for example, this means that we will
476 try to space the non-musical column as though the clef is not there.")
477 (spacing-increment ,number? "Add this much space for a doubled
478 duration. Typically, the width of a note head. See also
479 @internalsref{spacing-spanner-interface}.")
480 (springs-and-rods ,boolean? "Dummy variable for triggering
482 (stacking-dir ,ly:dir? "Stack objects in which direction?")
483 (staff-padding ,ly:dimension? "Maintain this much space between
484 reference points and the staff. Its effect is to align objects of
485 differing sizes (like the dynamic @b{p} and @b{f}) on their
487 (staff-position ,number? "Vertical position, measured in half
488 staff spaces, counted from the middle line.")
489 (staff-space ,ly:dimension? "Amount of space between staff lines,
490 expressed in global @code{staff-space}.")
491 (stem-attachment ,number-pair? "A @code{(@var{x} . @var{y})} pair
492 where the stem attaches to the notehead.")
493 (stem-end-position ,number? "Where does the stem end (the end is
494 opposite to the support-head)?")
496 (stem-spacing-correction ,number? "Optical correction amount for
497 stems that are placed in tight configurations. For opposite
498 directions, this amount is the correction for two normal sized stems
499 that overlap completely.")
500 (stemlet-length ,number? "How long should a stem over a rest
502 (stencil ,ly:stencil? "The symbol to print.")
503 (stencils ,list? "Multiple stencils, used as intermediate
505 (strict-grace-spacing ,boolean? "If set, grace notes
506 are not spaced separately, but put before musical columns.")
507 (strict-note-spacing ,boolean? "If set, unbroken columns
508 with non-musical material (clefs, barlines, etc.) are not spaced
509 separately, but put before musical columns.")
510 (string-count ,integer? "The number of strings in a fret
512 (string-fret-finger-combinations ,list? "List consisting of
513 @code{(@var{string-number} @var{fret-number} @var{finger-number})}
515 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
517 (style ,symbol? "This setting determines in what style a grob is
518 typeset. Valid choices depend on the @code{stencil} callback reading
521 (text ,markup? "Text markup. See @usermanref{Text markup}.")
522 ;;FIXME -- Should both be the same?
523 (text-direction ,ly:dir? "This controls the ordering of the
524 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
525 should use @code{LEFT}.")
526 (thick-thickness ,number? "Bar line thickness, measured in
527 @code{line-thickness}.")
528 (thickness ,number? "Line thickness, generally measured in
529 @code{line-thickness}.")
530 (thin-kern ,number? "The space after a hair-line in a bar line.")
531 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
532 @var{min} and @var{max} are dimensions in staff space.")
533 (to-barline ,boolean? "If true, the spanner will stop at that barline
534 just before it would otherwise stop.")
535 (tie-configuration ,list? "List of @code{(@var{position} .
536 @var{dir})} pairs, indicating the desired tie configuration, where
537 @var{position} is the offset from the center of the staff in staff
538 space and @var{dir} indicates the direction of the tie
539 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
540 in the list causes the corresponding tie to be formatted
542 (transparent ,boolean? "This makes the grob invisible.")
544 (uniform-stretching ,boolean? "If set, items stretch
545 proportionally to their durations. This looks better in complex
546 polyphonic patterns.")
547 (used ,boolean? "If set, this spacing column is kept in the
550 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
551 one below this grob.")
553 (when ,ly:moment? "Global time step associated with this column
555 (width ,ly:dimension? "The width of a grob measured in staff
557 (word-space ,ly:dimension? "Space to insert between words in
560 (zigzag-length ,ly:dimension? "The length of the lines of a
561 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
562 gives 60-degree zigzags.")
563 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
564 This number is adjusted slightly so that the glissando line can
565 be constructed from a whole number of squiggles.")
573 (define (define-internal-grob-property symbol type? description)
574 (define-grob-property symbol type? description)
575 (set-object-property! symbol 'backend-internal #t)
580 (define-public all-internal-grob-properties
583 (apply define-internal-grob-property x))
587 ;; grobs & grob arrays. (alphabetical)
588 (X-common ,ly:grob? "Common reference point for axis group.")
590 (Y-common ,ly:grob? "See @code{X-common}.")
592 (accidental-grob ,ly:grob? "The accidental for this note.")
593 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
594 @var{groblist})} entries.")
595 (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
596 cache the @code{Y-extent}s of different column ranges.")
597 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
599 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
600 function is to protect objects from being garbage collected.")
601 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
602 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
603 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
605 (bars ,ly:grob-array? "A list of bar line pointers.")
606 (beam ,ly:grob? "A pointer to the beam, if applicable.")
607 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
608 column as start/begin point. Only columns that have grobs or act as
610 (bracket ,ly:grob? "The bracket for a number.")
612 (columns ,ly:grob-array? "A list of grobs, typically containing
613 @code{PaperColumn} or @code{NoteColumn} objects.")
614 (conditional-elements ,ly:grob-array? "Internal use only.")
615 (cross-staff ,boolean? "For a beam or a stem, this is true if we
616 depend on inter-staff spacing.")
618 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
619 set, which grob to get the direction from.")
620 (dot ,ly:grob? "A reference to a @code{Dots} object.")
621 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
623 (elements ,ly:grob-array? "A list of grobs; the type is depending on
624 the grob where this is set in.")
625 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
626 in addition to notes and stems.")
628 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
630 (glyph-name ,string? "The glyph name within the font.")
631 (grace-spacing ,ly:grob? "A run of grace notes.")
633 (heads ,ly:grob-array? "A list of note heads.")
635 (important-column-ranks ,vector? "A cache of columns that contain
636 @code{items-worth-living} data.")
637 (items-worth-living ,ly:grob-array? "A list of interesting items. If
638 empty in a particular staff, then that staff is erased.")
640 (left-items ,ly:grob-array? "DOCME")
641 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
642 that are close to the current column.
644 The closest @code{spacing-wishes} determine the actual distances between the
647 (normal-stems ,ly:grob-array? "An array of visible stems.")
648 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
649 (note-head ,ly:grob? "A single note head.")
650 (note-heads ,ly:grob-array? "A list of note head grobs.")
652 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
654 (pure-Y-common ,ly:grob? "A cache of the
655 @code{common_refpoint_of_array} of the @code{elements} grob set.")
656 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
657 cyclic dependencies.")
658 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
659 relevant for finding the @code{pure-Y-extent}.")
660 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
661 relevant for finding the @code{pure-Y-extent}.")
663 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
664 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
665 (rests ,ly:grob-array? "A list of rest objects.")
666 (right-items ,ly:grob-array? "DOCME")
667 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
669 (separation-item ,ly:grob? "A separation item.")
670 (side-support-elements ,ly:grob-array? "The side support, a list of
672 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
673 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
675 (spacing ,ly:grob? "The spacing spanner governing this section.")
676 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
678 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
679 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
680 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
681 notes that the arpeggio has to be before.")
683 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
684 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
685 (tuplet-number ,ly:grob? "The number for a bracket.")
686 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
690 (begin-of-line-visible ,boolean? "Used for marking @code{ChordNames}
691 that should only show changes.")
693 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
694 translator) that was the cause for this grob.")
695 (circled-tip ,boolean? "Put a circle at start/end of hairpins (al/del
698 (delta-position ,number? "The vertical position difference.")
699 (details ,list? "Alist of parameters for detailed grob behavior.
701 More information on the allowed parameters can be found by inspecting
702 @file{lily/slur-scoring.cc}, @file{lily/beam-quanting.cc}, and
703 @file{lily/tie-formatting-problem.cc}. Setting @code{debug-tie-scoring},
704 @code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
707 (font ,ly:font-metric? "A cached font metric object.")
709 (head-width ,ly:dimension? "The width of this ligature head.")
711 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
712 @var{strength}))} pairs.")
713 (interfaces ,list? "A list of symbols indicating the interfaces
714 supported by this object. It is initialized from the @code{meta} field.")
716 (least-squares-dy ,number? "The ideal beam slope, without damping.")
718 (meta ,list? "Provide meta information. It is an alist with the
719 entries @code{name} and @code{interfaces}.")
720 (minimum-distances ,list? "A list of rods that have the format
721 @code{(@var{obj} . @var{dist})}.")
723 (positioning-done ,boolean? "Used to signal that a positioning element
724 did its job. This ensures that a positioning is only done once.")
725 (pure-Y-extent ,number-pair? "The estimated height of a system.")
727 (quant-score ,string? "The Beam quanting score -- can be stored for
729 (quantize-position ,boolean? "If set, a vertical alignment is aligned
730 to be within staff spaces.")
731 (quantized-positions ,number-pair? "The beam positions after
734 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
735 acts as an index for looking up a @code{Stencil} object.")
736 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
737 Internally used to distribute beam shortening over stems.")
738 (skyline-distance ,number? "The distance between this staff and the
739 next one, as determined by a skyline algorithm.")
740 (skyline-horizontal-padding ,number? "For determining the vertical
741 distance between two staves, it is possible to have a configuration which
742 would result in a tight interleaving of grobs from the top staff and the
743 bottom staff. The larger this parameter is, the farther apart the staves
744 are placed in such a configuration.")
745 (stem-info ,pair? "A cache of stem parameters.")
747 (use-breve-rest ,boolean? "Use breve rests for measures longer
754 ;; There are too many properties for ancient notation;
755 ;; probably neume-types (a list of symbols) would also work.
757 ;; However, such a list would consist of a couple of dozens of
758 ;; entries, since head prefixes may be combined in many ways. If
759 ;; the macros in `gregorian-init.ly' would directly set prefix-set,
760 ;; all the head prefixes could be junked; however, such macros
761 ;; would be quite numerous, I guess. --jr
763 (add-cauda ,boolean? "Does this flexa require an additional cauda on
765 (add-join ,boolean? "Is this ligature head-joined with the next one
766 by a vertical line?")
767 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
768 an additional stem on the right side?")
769 (ascendens ,boolean? "Is this neume of ascending type?")
770 (auctum ,boolean? "Is this neume liquescentically augmented?")
772 (cavum ,boolean? "Is this neume outlined?")
773 (context-info ,integer? "Within a ligature, the final glyph or shape of
774 a head may be affected by the left and/or right neighbour head.
775 @code{context-info} holds for each head such information about the left and
776 right neighbour, encoded as a bit mask.")
778 (descendens ,boolean? "Is this neume of descendent type?")
779 (deminutum ,boolean? "Is this neume deminished?")
781 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
782 grob (in @code{staff-space} units).")
783 (flexa-width ,ly:dimension? "The width of a flexa shape in a
784 ligature grob in (in @code{staff-space} units).")
786 (inclinatum ,boolean? "Is this neume an inclinatum?")
788 (join-heads ,boolean? "Whether to join the note heads of an ambitus
789 grob with a vertical line.")
790 (join-right-amount ,number? "DOCME")
792 (linea ,boolean? "Attach vertical lines to this neume?")
794 (oriscus ,boolean? "Is this neume an oriscus?")
796 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
798 (prefix-set ,number? "A bit mask that holds all Gregorian head
799 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
800 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
801 similar to a note head that is part of a ligature.")
803 (quilisma ,boolean? "Is this neume a quilisma?")
805 (stropha ,boolean? "Is this neume a stropha?")
807 (virga ,boolean? "Is this neume a virga?")
809 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
812 ;; fret-diagrams extra properties
813 (mute-string ,string? "String to be used to indicate a muted string in
815 (open-string ,string? "A string to be used to indicate an open string
817 (orientation ,symbol? "The orientation of a fret-diagram. Options
818 include @code{normal} and @code{landscape}.")
819 (xo-font-magnification ,number? "Magnification used for mute and open
820 string indicators in fret diagrams.")
824 (define-public all-backend-properties
826 all-internal-grob-properties
827 all-user-grob-properties))