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."
60 'dynamic-line-spanner-interface
61 "Dynamic line spanner."
65 'dynamic-text-interface
66 "An absolute text dynamic."
70 'dynamic-text-spanner-interface
71 "Dynamic text spanner."
81 "A fingering instruction."
85 'fret-diagram-interface
87 '(align-dir fret-diagram-details size dot-placement-list
96 'grace-spacing-interface
97 "Keep track of durations in a run of grace notes."
98 '(columns common-shortest-duration))
101 'instrument-specific-markup-interface
102 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
103 '(fret-diagram-details graphical harp-pedal-details size thickness))
106 'key-cancellation-interface
107 "A key cancellation."
111 'ligature-bracket-interface
112 "A bracket indicating a ligature in the original edition."
113 '(width thickness height))
122 "Any object that is related to lyrics."
126 'lyric-syllable-interface
127 "A single piece of lyrics."
136 'metronome-mark-interface
141 'multi-measure-interface
142 "Multi measure rest, and the text or number that is printed over it."
151 'only-prebreak-interface
152 "Kill this grob after the line breaking process."
156 'parentheses-interface
157 "Parentheses for other objects."
161 'percent-repeat-interface
162 "Beat, Double and single measure repeats."
163 '(dot-negative-kern slash-negative-kern slope thickness))
166 'piano-pedal-interface
167 "A piano pedal sign."
171 'piano-pedal-script-interface
172 "A piano pedal sign, fixed size."
176 'pitched-trill-interface
177 "A note head to indicate trill pitches."
181 'rhythmic-grob-interface
182 "Any object with a duration. Used to determine which grobs are
183 interesting enough to maintain a hara-kiri staff."
187 'spacing-options-interface
188 "Supports setting of spacing variables."
189 '(spacing-increment shortest-duration-space))
192 'stanza-number-interface
193 "A stanza number, to be put in from of a lyrics line."
197 'string-number-interface
198 "A string number instruction."
202 'stroke-finger-interface
203 "A right hand finger instruction."
207 'system-start-text-interface
208 "Text in front of the system."
209 '(long-text self-alignment-X self-alignment-Y text))
212 'tab-note-head-interface
213 "A note head in tablature."
214 '(details display-cautionary span-start))
217 'trill-spanner-interface
222 'trill-pitch-accidental-interface
223 "An accidental for trill pitch."
227 'unbreakable-spanner-interface
228 "A spanner that should not be broken across line breaks. Override
229 with @code{breakable=##t}."