1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 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))
41 "Print a special bar symbol. It replaces the regular bar
42 symbol with a special symbol. The argument @var{bartype}
43 is a string which specifies the kind of bar line to print.
45 The list of allowed glyphs and predefined bar lines can be
46 found in @file{scm/bar-line.scm}.
48 @code{gap} is used for the gaps in dashed bar lines."
49 '(allow-span-bar bar-extent gap glyph glyph-name has-span-bar
50 hair-thickness kern rounded thin-kern thick-thickness))
53 'bass-figure-interface
58 'bass-figure-alignment-interface
59 "Align a bass figure."
65 '(thickness delta-position))
69 "Any kind of loudness sign."
73 'dynamic-line-spanner-interface
74 "Dynamic line spanner."
78 'dynamic-text-interface
79 "An absolute text dynamic."
83 'dynamic-text-spanner-interface
84 "Dynamic text spanner."
94 "A fingering instruction."
100 '(automatically-numbered
103 numbering-assertion-function))
106 'footnote-spanner-interface
107 "Make a footnote spanner."
108 '(footnote-text spanner-placement))
111 'fret-diagram-interface
113 '(align-dir fret-diagram-details size dot-placement-list
122 'grace-spacing-interface
123 "Keep track of durations in a run of grace notes."
124 '(columns common-shortest-duration))
127 'inline-accidental-interface
128 "An inlined accidental (i.e. normal accidentals, cautionary
133 'instrument-specific-markup-interface
134 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
135 '(fret-diagram-details graphical harp-pedal-details size thickness))
138 'key-cancellation-interface
139 "A key cancellation."
143 'ligature-head-interface
144 "A note head that can become part of a ligature."
148 'ligature-bracket-interface
149 "A bracket indicating a ligature in the original edition."
150 '(width thickness height))
159 "Any object that is related to lyrics."
163 'lyric-syllable-interface
164 "A single piece of lyrics."
173 'measure-counter-interface
174 "A counter for numbering measures."
175 '(columns count-from))
178 'metronome-mark-interface
183 'multi-measure-interface
184 "Multi measure rest, and the text or number that is printed over it."
193 'octavate-eight-interface
194 "Interface that permits the nominal identification of the octavian
195 annotation that multiplies by two the freqency of the pitches present
196 in a given staff were they played on a clef that lacked said octavian
201 'only-prebreak-interface
202 "Kill this grob after the line breaking process."
206 'parentheses-interface
207 "Parentheses for other objects."
211 'percent-repeat-interface
212 "Beat, Double and single measure repeats."
213 '(dot-negative-kern slash-negative-kern slope thickness))
216 'piano-pedal-interface
217 "A piano pedal sign."
221 'piano-pedal-script-interface
222 "A piano pedal sign, fixed size."
226 'pitched-trill-interface
227 "A note head to indicate trill pitches."
231 'rhythmic-grob-interface
232 "Any object with a duration. Used to determine which grobs are
233 interesting enough to maintain a hara-kiri staff."
237 'spacing-options-interface
238 "Supports setting of spacing variables."
239 '(spacing-increment shortest-duration-space))
243 "A bar line that is spanned between other barlines.
244 This interface is used for bar lines that connect different
246 '(glyph-name elements pure-Y-common pure-relevant-grobs
247 pure-relevant-items pure-relevant-spanners))
250 'stanza-number-interface
251 "A stanza number, to be put in from of a lyrics line."
255 'string-number-interface
256 "A string number instruction."
260 'stroke-finger-interface
261 "A right hand finger instruction."
265 'system-start-text-interface
266 "Text in front of the system."
267 '(long-text self-alignment-X self-alignment-Y text))
270 'tab-note-head-interface
271 "A note head in tablature."
272 '(details display-cautionary span-start))
275 'trill-spanner-interface
280 'trill-pitch-accidental-interface
281 "An accidental for trill pitch."
285 'unbreakable-spanner-interface
286 "A spanner that should not be broken across line breaks. Override
287 with @code{breakable=##t}."