1 ;;;; define-grob-interfaces.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ;; should include default value?
13 'accidental-suggestion-interface
14 "An accidental, printed as a suggestion (typically: vertically over a
20 "The line between note heads for a pitch range."
21 '(gap note-heads thickness))
24 'bass-figure-interface
29 'bass-figure-alignment-interface
30 "Align a bass figure."
36 '(thickness delta-position))
40 "Any kind of loudness sign."
44 'dynamic-line-spanner-interface
45 "Dynamic line spanner."
49 'dynamic-text-spanner-interface
50 "Dynamic text spanner."
55 "A fingering instruction."
59 'fret-diagram-interface
61 '(align-dir fret-diagram-details size dot-placement-list
65 'grace-spacing-interface
66 "Keep track of durations in a run of grace notes."
67 '(columns common-shortest-duration))
70 'instrument-specific-markup-interface
71 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
72 '(fret-diagram-details harp-pedal-details size thickness))
75 'key-cancellation-interface
80 'ligature-bracket-interface
81 "A bracket indicating a ligature in the original edition."
82 '(width thickness height))
91 "Any object that is related to lyrics."
95 'lyric-syllable-interface
96 "A single piece of lyrics."
105 'metronome-mark-interface
110 'multi-measure-interface
111 "Multi measure rest, and the text or number that is printed over it."
120 'only-prebreak-interface
121 "Kill this grob after the line breaking process."
125 'parentheses-interface
126 "Parentheses for other objects."
130 'percent-repeat-interface
131 "Beat, Double and single measure repeats."
132 '(dot-negative-kern slash-negative-kern slope thickness))
135 'piano-pedal-interface
136 "A piano pedal sign."
140 'piano-pedal-script-interface
141 "A piano pedal sign, fixed size."
145 'pitched-trill-interface
146 "A note head to indicate trill pitches."
150 'rhythmic-grob-interface
151 "Any object with a duration. Used to determine which grobs are
152 interesting enough to maintain a hara-kiri staff."
156 'spacing-options-interface
157 "Supports setting of spacing variables."
158 '(spacing-increment shortest-duration-space))
161 'stanza-number-interface
162 "A stanza number, to be put in from of a lyrics line."
166 'string-number-interface
167 "A string number instruction."
171 'stroke-finger-interface
172 "A right hand finger instruction."
176 'system-start-text-interface
177 "Text in front of the system."
178 '(long-text self-alignment-X self-alignment-Y text))
181 'tab-note-head-interface
182 "A note head in tablature."
186 'trill-spanner-interface
191 'trill-pitch-accidental-interface
192 "An accidental for trill pitch."
196 'unbreakable-spanner-interface
197 "A spanner that should not be broken across line breaks. Override
198 with @code{breakable=##t}."
202 'vertically-spaceable-interface
203 "Objects that should be kept at constant vertical distances. Typically:
204 @rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."