1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2011 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/>.
20 ;; The interfaces defined here generally have no code (e.g.,
21 ;; dynamic-interface), or have callbacks defined entirely in
22 ;; scheme. Others interfaces are defined in lily/*.cc with the
23 ;; ADD_INTERFACE function.
25 ;; should include default value?
29 'accidental-suggestion-interface
30 "An accidental, printed as a suggestion (typically: vertically over a
36 "The line between note heads for a pitch range."
37 '(gap note-heads thickness))
40 'bass-figure-interface
45 'bass-figure-alignment-interface
46 "Align a bass figure."
52 '(thickness delta-position))
56 "Any kind of loudness sign."
65 'dynamic-line-spanner-interface
66 "Dynamic line spanner."
70 'dynamic-text-interface
71 "An absolute text dynamic."
75 'dynamic-text-spanner-interface
76 "Dynamic text spanner."
86 "A fingering instruction."
95 'footnote-spanner-interface
96 "Make a footnote spanner."
97 '(footnote-text spanner-placement))
100 'fret-diagram-interface
102 '(align-dir fret-diagram-details size dot-placement-list
111 'grace-spacing-interface
112 "Keep track of durations in a run of grace notes."
113 '(columns common-shortest-duration))
116 'inline-accidental-interface
117 "An inlined accidental (i.e. normal accidentals, cautionary
122 'instrument-specific-markup-interface
123 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
124 '(fret-diagram-details graphical harp-pedal-details size thickness))
127 'key-cancellation-interface
128 "A key cancellation."
132 'ligature-head-interface
133 "A note head that can become part of a ligature."
137 'ligature-bracket-interface
138 "A bracket indicating a ligature in the original edition."
139 '(width thickness height))
148 "Any object that is related to lyrics."
152 'lyric-syllable-interface
153 "A single piece of lyrics."
162 'metronome-mark-interface
167 'multi-measure-interface
168 "Multi measure rest, and the text or number that is printed over it."
177 'only-prebreak-interface
178 "Kill this grob after the line breaking process."
182 'parentheses-interface
183 "Parentheses for other objects."
187 'percent-repeat-interface
188 "Beat, Double and single measure repeats."
189 '(dot-negative-kern slash-negative-kern slope thickness))
192 'piano-pedal-interface
193 "A piano pedal sign."
197 'piano-pedal-script-interface
198 "A piano pedal sign, fixed size."
202 'pitched-trill-interface
203 "A note head to indicate trill pitches."
207 'rhythmic-grob-interface
208 "Any object with a duration. Used to determine which grobs are
209 interesting enough to maintain a hara-kiri staff."
213 'spacing-options-interface
214 "Supports setting of spacing variables."
215 '(spacing-increment shortest-duration-space))
218 'stanza-number-interface
219 "A stanza number, to be put in from of a lyrics line."
223 'string-number-interface
224 "A string number instruction."
228 'stroke-finger-interface
229 "A right hand finger instruction."
233 'system-start-text-interface
234 "Text in front of the system."
235 '(long-text self-alignment-X self-alignment-Y text))
238 'tab-note-head-interface
239 "A note head in tablature."
240 '(details display-cautionary span-start))
243 'trill-spanner-interface
248 'trill-pitch-accidental-interface
249 "An accidental for trill pitch."
253 'unbreakable-spanner-interface
254 "A spanner that should not be broken across line breaks. Override
255 with @code{breakable=##t}."