1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 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-symbol ,symbol? "This key is used for aligning and
97 spacing breakable items.")
98 (break-align-orders ,vector? "Defines the order in which
99 prefatory matter (clefs, key signatures) appears. The format is a
100 vector of length@tie{}3, where each element is one order for
101 end-of-line, middle of line, and start-of-line, respectively. An
102 order is a list of symbols.
104 For example, clefs are put after key signatures by setting
107 \\override Score.BreakAlignment #'break-align-orders =
108 #(make-vector 3 '(span-bar
115 (break-overshoot ,number-pair? "How much does a broken spanner
116 stick out of its bounds?")
117 (break-visibility ,vector? "A vector of 3@tie{}booleans,
118 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
119 @code{#t} means visible, @code{#f} means killed.")
120 (breakable ,boolean? "Allow breaks here.")
122 (c0-position ,integer? "An integer indicating the position of
124 (clip-edges ,boolean? "Allow outward pointing beamlets at the
126 (collapse-height ,ly:dimension? "Minimum height of system start
127 delimiter. If equal or smaller, the bracket is removed.")
128 (color ,color? "The color of this grob.")
129 (common-shortest-duration ,ly:moment? "The most common shortest
130 note length. This is used in spacing. Enlarging this sets the score
132 (concaveness ,number? "A beam is concave if its inner stems are
133 closer to the beam than the two outside stems. This number is a
134 measure of the closeness of the inner stems. It is used for damping
135 the slope of the beam.")
136 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
137 this grob looks as a continued break.")
138 (control-points ,list? "List of offsets (number pairs) that form
139 control points for the tie, slur, or bracket shape. For B@'eziers,
140 this should list the control points of a third-order B@'ezier curve.")
142 (damping ,number? "Amount of beam slope damping.")
143 (dash-fraction ,number? "Size of the dashes, relative to
144 @code{dash-period}. Should be between @code{0.0} (no line) and
145 @code{1.0} (continuous line).")
146 (dash-period ,number? "The length of one dash together with
147 whitespace. If negative, no line is drawn at all.")
148 (default-direction ,ly:dir? "Direction determined by note head
150 (digit-names ,vector "Names for string finger digits.")
151 (direction ,ly:dir? "If @code{side-axis} is @code{1} (or
152 @code{#X}), then this property determines whether the object is placed
153 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
154 other object. Otherwise, it determines whether the object is placed
155 @code{#UP}, @code{#CENTER} or #DOWN. Numerical values may also be
156 used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
157 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, @code{CENTER}=@code{0}
158 but also other numerical values are permitted.")
159 (dot-color ,symbol? "Color of dots. Options include
160 @code{black} and @code{white}.")
161 (dot-count ,integer? "The number of dots.")
162 (dot-radius ,number? "Radius of dots.")
163 (duration-log ,integer? "The 2-log of the note head duration,
164 i.e. @code{0} = whole note, @code{1} = half note, etc.")
166 (eccentricity ,number? "How asymmetrical to make a slur.
167 Positive means move the center to the right.")
168 (edge-height ,pair? "A pair of numbers specifying the heights of
169 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
170 (edge-text ,pair? "A pair specifying the texts to be set at the
171 edges: @code{(@var{left-text} . @var{right-text})}.")
172 (expand-limit ,integer? "Maximum number of measures expanded in
174 (extra-X-extent ,number-pair? "A grob is enlarged in
175 X@tie{}dimension by this much.")
176 (extra-Y-extent ,number-pair? "See @code{extra-X-extent}.")
178 (extra-dy ,number? "Slope glissandi this much extra.")
179 (extra-offset ,number-pair? "A pair representing an offset. This
180 offset is added just before outputting the symbol, so the typesetting
181 engine is completely oblivious to it.")
182 (extra-spacing-width ,number-pair? "In the horizontal spacing
183 problem, we pad each item by this amount (by adding the @q{car} on the
184 left side of the item and adding the @q{cdr} on the right side of the
185 item). In order to make a grob take up no horizontal space at all,
186 set this to @code{(+inf.0 . -inf.0)}.")
188 (finger-code ,symbol? "Code for the type of fingering indication
189 in a fret diagram. Options include @code{none}, @code{in-dot}, and
190 @code{below-string}.")
191 (flag-count ,number? "The number of tremolo beams.")
192 (flag-style ,symbol? "A string determining what style of flag
193 glyph is typeset on a @code{Stem}. Valid options include @code{()}
194 and @code{mensural}. Additionally, @code{no-flag} switches off the
196 (font-encoding ,symbol? "The font encoding is the broadest
197 category for selecting a font. Options include: @code{fetaMusic},
198 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math},
199 @code{fetaBraces}, @code{fetaDynamic}.")
200 (font-family ,symbol? "The font family is the broadest category
201 for selecting text fonts. Options include: @code{sans},
203 (font-name ,string? "Specifies a file name (without extension)
204 of the font to load. This setting overrides selection using
205 @code{font-family}, @code{font-series} and @code{font-shape}.")
206 (font-series ,symbol? "Select the series of a font. Choices
207 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
208 (font-shape ,symbol? "Select the shape of a font. Choices
209 include @code{upright}, @code{italic}, @code{caps}.")
210 (font-size ,number? "The font size, compared to the @q{normal}
211 size. @code{0}@tie{}is style-sheet's normal size, @code{-1} is
212 smaller, @code{+1} is bigger. Each step of@tie{}1 is approximately
213 12% larger, 6@tie{}steps are exactly a factor@tie{}2 larger.
214 Fractional values are allowed.")
215 (force-hshift ,number? "This specifies a manual shift for notes
216 in collisions. The unit is the note head width of the first voice
217 note. This is used by @internalsref{note-collision-interface}.")
218 (forced ,boolean? "Manually forced accidental.")
219 (fraction ,number-pair? "Numerator and denominator of a time
221 (french-beaming ,boolean? "Use French beaming style for this
222 stem. The stem stops at the innermost beams.")
223 (fret-count ,integer? "The number of frets in a fret diagram.")
224 ;; ugh: double, change.
225 (full-size-change ,boolean? "Don't make a change clef smaller.")
227 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
228 (gap-count ,integer? "Number of gapped beams for tremolo.")
229 (glyph ,string? "A string determining what @q{style} of glyph is
230 typeset. Valid choices depend on the function that is reading this
232 (glyph-name-alist ,list? "An alist of key-string pairs.")
233 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
235 (hair-thickness ,number? "Thickness of the thin line in a bar
237 (head-direction ,ly:dir? "Are the note heads left or right in a
239 (height ,ly:dimension? "Height of an object in
240 @code{staff-space} units.")
241 (height-limit ,ly:dimension? "Maximum slur height: The longer the
242 slur, the closer it is to this height.")
243 (horizontal-shift ,integer? "An integer that identifies ranking
244 of @code{NoteColumn}s for horizontal shifting. This is used by
245 @internalsref{note-collision-interface}.")
246 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
247 left and one to the right of this grob.")
249 (ignore-collision ,boolean? "If set, don't do note collision
250 resolution on this @code{NoteColumn}.")
251 (implicit ,boolean? "Is this an implicit bass figure?")
252 (infinite-spacing-height ,boolean? "If true, then for the
253 purposes of horizontal spacing, treat this item as though it were
254 infinitely tall. That is, no object from another column is allowed to
255 stick above or below this item.")
256 (inspect-index ,integer? "If debugging is set, set beam and slur
257 configuration to this index, and print the respective scores.")
258 (inspect-quants ,number-pair? "If debugging is set,
259 set beam and slur quants to this position, and print the respective
262 (keep-fixed-while-stretching ,boolean? "A grob with this property
263 set to true is fixed relative to the staff above it when systems are
265 (keep-inside-line ,boolean? "If set, this column cannot have
266 things sticking into the margin.")
267 (kern ,ly:dimension? "Amount of extra white space to add. For
268 bar lines, this is the amount of space after a thick line.")
269 (knee ,boolean? "Is this beam kneed?")
270 (knee-spacing-correction ,number? "Factor for the optical
271 correction amount for kneed beams. Set between @code{0} for no
272 correction and @code{1} for full correction.")
274 (label-dir ,ly:dir? "Side to which a label is attached.
275 @code{-1} for left, @code{1}@tie{}for right.")
276 (layer ,number? "The output layer (a value between 0 and@tie{}2:
277 Layers define the order of printing objects. Objects in lower layers
278 are overprinted by objects in higher layers.")
279 (ledger-line-thickness ,number-pair? "The thickness of ledger
280 lines. It is the sum of 2@tie{}numbers: The first is the factor for
281 line thickness, and the second for staff space. Both contributions
283 (left-bound-info ,list? "An alist of properties for determining
284 attachments of spanners to edges.")
285 (left-padding ,ly:dimension? "The amount of space that is put
286 left to an object (e.g., a group of accidentals).")
287 (length ,ly:dimension? "User override for the stem length of
289 (length-fraction ,number? "Multiplier for lengths. Used for
290 determining ledger lines and stem lengths.")
291 (line-break-penalty ,number? "Penalty for a line break at this
292 column. This affects the choices of the line breaker; it avoids a
293 line break at a column with a positive penalty and prefer a line break
294 at a column with a negative penalty.")
295 (line-break-permission ,symbol? "Instructs the line breaker on
296 whether to put a line break at this column. Can be @code{force} or
298 (line-break-system-details ,list? "An alist of properties to use
299 if this column is the start of a system.")
300 (line-count ,integer? "The number of staff lines.")
301 (line-positions ,list? "Vertical positions of staff lines.")
302 (line-thickness ,number? "The thickness of the tie or slur
304 (long-text ,markup? "Text markup. See @usermanref{Text
307 (max-beam-connect ,integer? "Maximum number of beams to connect
308 to beams from this stem. Further beams are typeset as beamlets.")
309 (max-stretch ,number? "The maximum amount that this
310 @code{VerticalAxisGroup} can be vertically stretched (for example, in
311 order to better fill a page).")
312 (measure-count ,integer? "The number of measures for a
313 multi-measure rest.")
314 (measure-length ,ly:moment? "Length of a measure. Used in some
315 spacing situations.")
316 (merge-differently-dotted ,boolean? "Merge note heads in
317 collisions, even if they have a different number of dots. This is
318 normal notation for some types of polyphonic music.
320 @code{merge-differently-dotted} only applies to opposing stem
321 directions (i.e. voice 1 &@tie{}2).")
322 (merge-differently-headed ,boolean? "Merge note heads in
323 collisions, even if they have different note heads. The
324 smaller of the two heads is rendered invisible. This is used in
325 polyphonic guitar notation. The value of this setting is used by
326 @internalsref{note-collision-interface}.
328 @code{merge-differently-headed} only applies to opposing stem
329 directions (i.e. voice 1 &@tie{}2).")
330 (minimum-X-extent ,number-pair? "Minimum size of an object in
331 X@tie{}dimension, measured in @code{staff-space} units.")
332 (minimum-Y-extent ,number-pair? "See @code{minimum-X-extent}.")
333 (minimum-distance ,ly:dimension? "Minimum distance between rest
335 (minimum-length ,ly:dimension? "Try to make a spanner at least
336 this long, normally in the horizontal direction. This requires an
337 appropriate callback for the @code{springs-and-rods} property. If
338 added to a @code{Tie}, this sets the minimum distance between
340 (minimum-length-fraction ,number? "Minimum length of ledger line
341 as fraction of note head size.")
342 (minimum-space ,ly:dimension? "Minimum distance that the victim
343 should move (after padding).")
345 (neutral-direction ,ly:dir? "Which direction to take in the
346 center of the staff.")
347 (neutral-position ,number? "Position (in half staff spaces) where
348 to flip the direction of custos stem.")
349 (next ,ly:grob? "Object that is next relation (e.g., the lyric
350 syllable following an extender.")
351 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
353 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
354 get stems extending to the middle staff line.")
355 (non-default ,boolean? "Set for manually specified clefs.")
356 (non-musical ,boolean? "True if the grob belongs to a
357 @code{NonMusicalPaperColumn}.")
358 (note-names ,vector? "Vector of strings containing names for
359 easy-notation note heads.")
360 (number-type ,symbol? "Type of numbers to use in label. Choices
361 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
363 (outside-staff-horizontal-padding ,number? "By default, an
364 outside-staff-object can be placed so that is it very close to another
365 grob horizontally. If this property is set, the outside-staff-object
366 is raised so that it is not so close to its neighbour.")
367 (outside-staff-padding ,number? "The padding to place between
368 this grob and the staff when spacing according to
369 @code{outside-staff-priority}.")
370 (outside-staff-priority ,number? "If set, the grob is positioned
371 outside the staff in such a way as to avoid all collisions.
372 In case of a potential collision, the grob with the smaller
373 @code{outside-staff-priority} is closer to the staff.")
375 (packed-spacing ,boolean? "If set, the notes are spaced as
376 tightly as possible.")
377 (padding ,ly:dimension? "Add this much extra space between
378 objects that are next to each other.")
379 (page-break-penalty ,number? "Penalty for page break at this
380 column. This affects the choices of the page breaker; it avoids a
381 page break at a column with a positive penalty and prefer a page break
382 at a column with a negative penalty.")
383 (page-break-permission ,symbol? "Instructs the page breaker on
384 whether to put a page break at this column. Can be @code{force} or
386 (page-turn-penalty ,number? "Penalty for a page turn at this
387 column. This affects the choices of the page breaker; it avoids a
388 page turn at a column with a positive penalty and prefer a page turn
389 at a column with a negative penalty.")
390 (page-turn-permission ,symbol? "Instructs the page breaker on
391 whether to put a page turn at this column. Can be @code{force} or
393 (parenthesized ,boolean? "Parenthesize this grob.")
394 (positions ,pair? "Pair of staff coordinates @code{(@var{left}
395 . @var{right})}, where both @var{left} and @var{right} are in
396 @code{staff-space} units of the current staff.")
398 (ratio ,number? "Parameter for slur shape. The higher this
399 number, the quicker the slur attains its @code{height-limit}.")
400 (remove-empty ,boolean? "If set, remove group if it contains no
402 (remove-first ,boolean? "Remove the first staff of a orchestral
404 (restore-first ,boolean? "Print a natural before the
406 (rhythmic-location ,rhythmic-location? "Where (bar number,
407 measure position) in the score.")
408 (right-bound-info ,list? "An alist of properties for determining
409 attachments of spanners to edges.")
410 (right-padding ,ly:dimension? "Space to insert on the right side
411 of an object (e.g., between note and its accidentals).")
412 (rotation ,list? "Number of degrees to rotate this object, and
413 what point to rotate around. For example, @code{#'(45 0 0)} rotates
414 by 45 degrees around the center of this object.")
416 (same-direction-correction ,number? "Optical correction amount
417 for stems that are placed in tight configurations. This amount is
418 used for stems with the same direction to compensate for note-head to
420 (script-priority ,number? "A sorting key that determines in what
421 order a script is within a stack of scripts.")
422 (self-alignment-X ,number? "Specify alignment of an object. The
423 value @code{-1} means left aligned, @code{0}@tie{}centered, and
424 @code{1}@tie{}right-aligned in X@tie{}direction. Values in-between
425 may also be specified.")
426 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
428 (shorten-pair ,number-pair? "The lengths to shorten a
429 text-spanner on both sides, for example a pedal bracket. Positive
430 values shorten the text-spanner, while negative values lengthen it.")
431 (shortest-duration-space ,ly:dimension? "Start with this much
432 space for the shortest duration. This is expressed in
433 @code{spacing-increment} as unit. See also
434 @internalsref{spacing-spanner-interface}.")
435 (shortest-playing-duration ,ly:moment? "The duration of the
436 shortest playing here.")
437 (shortest-starter-duration ,ly:moment? "The duration of the
438 shortest note that starts here.")
439 (side-axis ,number? "If the value is @code{#X} (or
440 equivalently@tie{}@code{1}), the object is placed horizontally next
441 to the other object. If the value is @code{#Y} or@tie{}@code{0}, it
442 is placed vertically.")
443 (side-relative-direction ,ly:dir? "Multiply direction of
444 @code{direction-source} with this to get the direction of this
446 (size ,number? "Size of object, relative to standard size.")
447 (slope ,number? "The slope of this object.")
448 (slur-padding ,number? "Extra distance between slur and script.")
449 (space-alist ,list? "A table that specifies distances between
450 prefatory items, like clef and time-signature. The format is an alist
451 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
452 . @var{distance})}, where @var{type} can be the symbols
453 @code{minimum-space} or @code{extra-space}.")
454 (spacing-increment ,number? "Add this much space for a doubled
455 duration. Typically, the width of a note head. See also
456 @internalsref{spacing-spanner-interface}.")
457 (springs-and-rods ,boolean? "Dummy variable for triggering
459 (stacking-dir ,ly:dir? "Stack objects in which direction?")
460 (staff-padding ,ly:dimension? "Maintain this much space between
461 reference points and the staff. Its effect is to align objects of
462 differing sizes (like the dynamic @b{p} and @b{f}) on their
464 (staff-position ,number? "Vertical position, measured in half
465 staff spaces, counted from the middle line.")
466 (staff-space ,ly:dimension? "Amount of space between staff lines,
467 expressed in global @code{staff-space}.")
468 (stem-attachment ,number-pair? "A @code{(@var{x} . @var{y})} pair
469 where the stem attaches to the notehead.")
470 (stem-end-position ,number? "Where does the stem end (the end is
471 opposite to the support-head)?")
473 (stem-spacing-correction ,number? "Optical correction amount for
474 stems that are placed in tight configurations. For opposite
475 directions, this amount is the correction for two normal sized stems
476 that overlap completely.")
477 (stemlet-length ,number? "How long should a stem over a rest
479 (stencil ,ly:stencil? "The symbol to print.")
480 (stencils ,list? "Multiple stencils, used as intermediate
482 (strict-grace-spacing ,boolean? "If set, grace notes
483 are not spaced separately, but put before musical columns.")
484 (strict-note-spacing ,boolean? "If set, unbroken columns
485 with non-musical material (clefs, barlines, etc.) are not spaced
486 separately, but put before musical columns.")
487 (string-count ,integer? "The number of strings in a fret
489 (string-fret-finger-combinations ,list? "List consisting of
490 @code{(@var{string-number} @var{fret-number} @var{finger-number})}
492 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
494 (style ,symbol? "This setting determines in what style a grob is
495 typeset. Valid choices depend on the @code{stencil} callback reading
498 (text ,markup? "Text markup. See @usermanref{Text markup}.")
499 ;;FIXME -- Should both be the same?
500 (text-direction ,ly:dir? "This controls the ordering of the
501 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
502 should use @code{LEFT}.")
503 (thick-thickness ,number? "Bar line thickness, measured in
504 @code{line-thickness}.")
505 (thickness ,number? "Line thickness, generally measured in
506 @code{line-thickness}.")
507 (thin-kern ,number? "The space after a hair-line in a bar line.")
508 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
509 @var{min} and @var{max} are dimensions in staff space.")
510 (tie-configuration ,list? "List of @code{(@var{position} .
511 @var{dir})} pairs, indicating the desired tie configuration, where
512 @var{position} is the offset from the center of the staff in staff
513 space and @var{dir} indicates the direction of the tie
514 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
515 in the list causes the corresponding tie to be formatted
517 (transparent ,boolean? "This makes the grob invisible.")
519 (uniform-stretching ,boolean? "If set, items stretch
520 proportionally to their durations. This looks better in complex
521 polyphonic patterns.")
522 (used ,boolean? "If set, this spacing column is kept in the
525 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
526 one below this grob.")
528 (when ,ly:moment? "Global time step associated with this column
530 (width ,ly:dimension? "The width of a grob measured in staff
532 (word-space ,ly:dimension? "Space to insert between words in
535 (zigzag-length ,ly:dimension? "The length of the lines of a
536 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
537 gives 60-degree zigzags.")
538 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
539 This number is adjusted slightly so that the glissando line can
540 be constructed from a whole number of squiggles.")
548 (define (define-internal-grob-property symbol type? description)
549 (define-grob-property symbol type? description)
550 (set-object-property! symbol 'backend-internal #t)
555 (define-public all-internal-grob-properties
558 (apply define-internal-grob-property x))
562 ;; grobs & grob arrays. (alphabetical)
563 (X-common ,ly:grob? "Common refpoint for axis group.")
564 (Y-common ,ly:grob? "See @code{X-common}.")
565 (cached-pure-extents ,vector? "Used by a VerticalAxisGroup to cache the Y-extents of different column ranges.")
566 (axis-group-parent-X ,ly:grob? "Containing X axis group")
567 (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
568 (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
569 (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")
570 (all-elements ,ly:grob-array? "list of all grobs in this line. Its
571 function is to protect objects from being garbage collected.")
572 (arpeggio ,ly:grob? "pointer to arpeggio object.")
573 (beam ,ly:grob? "pointer to the beam, if applicable.")
574 (bracket ,ly:grob? "the bracket for a number.")
575 (cross-staff ,boolean? "for a beam or a stem, true if we depend on inter-staff spacing")
576 (direction-source ,ly:grob? "in case side-relative-direction is
577 set, which grob to get the direction from .")
578 (dot ,ly:grob? "reference to Dots object.")
579 (dots ,ly:grob-array? "multiple Dots objects.")
580 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
581 (important-column-ranks ,vector? "Cache of columns that contain items-worth-living.")
582 (items-worth-living ,ly:grob-array? "A list of interesting items. If
583 empty in a particular staff, then that staff is erased.")
585 (glyph-name ,string? "a name of character within font.")
586 (left-neighbors ,ly:grob-array? " List of
587 spacing-wish grobs that are close to the current column.
589 The closest spacing-wishes determine the actual distances between the
592 (left-items ,ly:grob-array? "")
593 (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
595 (pure-Y-common ,ly:grob? "Caches the common_refpoint_of_array of the elements grob-set")
596 (pure-relevant-elements ,ly:grob-array? "The subset of elements that are relevant for finding the pure-Y-extent.")
597 (stem ,ly:grob? "pointer to Stem object.")
598 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
600 (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
601 (rest ,ly:grob? "the staff symbol grob that we're in.")
602 (rests ,ly:grob-array? "A list of rest objects.")
603 (rest-collision ,ly:grob? "rest collision that a rest is in.")
604 (accidental-grob ,ly:grob? "Accidental for this note.")
605 (bars ,ly:grob-array? "list of bar line pointers.")
606 (bounded-by-me ,ly:grob-array? "list of spanners that have this
607 column as start/begin point. Only columns that have grobs or act as
610 (columns ,ly:grob-array? "list of grobs, typically containing
611 paper-columns or note-column objects.")
612 (conditional-elements ,ly:grob-array? "Internal use only")
613 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
614 in addition to notes and stems.")
615 (elements ,ly:grob-array? "list of grobs, type depending on the Grob
616 where this is set in.")
617 (grace-spacing ,ly:grob? "a run of grace notes.")
618 (heads ,ly:grob-array? "List of note heads.")
620 (note-columns ,pair? "list of NoteColumn grobs.")
622 (normal-stems ,ly:grob-array? "Array of visible stems.")
623 (note-heads ,ly:grob-array? "List of note head grobs")
624 (note-head ,ly:grob? "A single note head")
625 (right-items ,ly:grob-array? "")
626 (right-neighbors ,ly:grob-array? "see left-neighbors")
627 (separation-item ,ly:grob? "A separation item.")
628 (slur ,ly:grob? "A pointer to a slur object")
629 (spacing ,ly:grob? "the spacing spanner governing this section.")
630 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")
631 (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
632 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
633 (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
634 (tuplets ,ly:grob-array? "list of smaller tuplet brackets")
635 (tuplet-number ,ly:grob? "the number for a bracket.")
641 (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
642 (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob. ")
643 (circled-tip ,boolean? "Put a circle at start/end of hairpins (al/del niente)")
644 (delta-position ,number? "vertical position difference")
645 (details ,list? "alist of parameters for detailed grob behavior.
647 more information on the allowed parameters can be found by inspecting
648 lily/slur-scoring.cc, lily/beam-quanting.cc, and
649 lily/tie-formatting-problem.cc. Setting @code{debug-tie-scoring},
650 @code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
655 (font ,ly:font-metric? "Cached font metric object")
656 (head-width ,ly:dimension? "width of this ligature head")
658 (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
659 (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
660 (least-squares-dy ,number?
661 "ideal beam slope, without damping.")
663 (meta ,list? "Contains meta information. It is an alist with the
664 entries @code{name} and @code{interfaces}.")
665 (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
667 (positioning-done ,boolean?
668 "Used to signal that a positioning element
669 did its job. This ensures that a positioning is only done once.")
670 (pure-Y-extent ,number-pair? "The estimated height of a system")
672 (quantized-positions ,number-pair? "Beam positions after quanting.")
673 (quantize-position ,boolean? "If set, a vertical alignment is aligned to be within staff spaces.")
674 (quant-score ,string? "Beam quanting score -- can be stored for
677 (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
678 acts as an index for looking up a Stencil object.")
680 (stem-info ,pair? "caching of stem parameters")
681 (shorten ,ly:dimension? "The amount of space that a
682 stem. Internally used to distribute beam shortening over stems. ")
683 (skyline-distance ,number? "The distance between this staff and the next one, as determined by a skyline algorithm.")
684 (skyline-horizontal-padding ,number? "For determining the vertical distance between 2 staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration.")
686 (use-breve-rest ,boolean? "Use breve rests for measures longer
692 (join-right-amount ,number? "")
693 (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
697 ;; there are too many properties for ancient notation
698 ;; probably neume-types (a list of symbols) would also work.
700 ;; However, such this list would consist of a couple of dozens of
701 ;; entries, since head prefixes may be combined in many ways. If
702 ;; the macros in gregorian-init.ly would directly set prefix-set,
703 ;; all the head prefixes could be junked; however, such macros
704 ;; would be quite numerous, I guess. --jr
706 (auctum ,boolean? "is this neume liquescentically augmented?")
707 (ascendens ,boolean? "is this neume of an ascending type?")
708 (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
709 (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
710 (cavum ,boolean? "is this neume outlined?")
711 (descendens ,boolean? "is this neume of a descendent type?")
712 (deminutum ,boolean? "is this neume deminished?")
713 (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
714 (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
715 (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
716 (linea ,boolean? "attach vertical lines to this neume?")
717 (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
718 (context-info ,integer? "Within a ligature, the final glyph or shape of a head may be affected by the left and/or right neighbour head. context-info holds for each head such information about the left and right neighbour, encoded as a bit mask.")
719 (inclinatum ,boolean? "is this neume an inclinatum?")
720 (oriscus ,boolean? "is this neume an oriscus?")
721 (quilisma ,boolean? "is this neume a quilisma?")
722 (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
723 (prefix-set ,number? "a bit mask that holds all Gregorian head prefixes, such as @code{\\virga} or @code{\\quilisma}")
724 (stropha ,boolean? "Is this neume a stropha?")
725 (virga ,boolean? "Is this neume a virga?")
726 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
728 ;; end ancient notation
732 (define-public all-backend-properties
734 all-internal-grob-properties
735 all-user-grob-properties))