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."
45 "Print a special bar symbol. It replaces the regular bar
46 symbol with a special symbol. The argument @var{bartype}
47 is a string which specifies the kind of bar line to print.
49 The list of allowed glyphs and predefined bar lines can be
50 found in @file{scm/bar-line.scm}.
52 @code{gap} is used for the gaps in dashed bar lines."
66 'bass-figure-interface
71 'bass-figure-alignment-interface
72 "Align a bass figure."
82 'clef-modifier-interface
83 "The number describing transposition of the clef, placed below
84 or above clef sign. Usually this is 8 (octave transposition)
85 or 15 (two octaves), but LilyPond allows any integer here."
90 "Any kind of loudness sign."
94 'dynamic-line-spanner-interface
95 "Dynamic line spanner."
99 'dynamic-text-interface
100 "An absolute text dynamic."
104 'dynamic-text-spanner-interface
105 "Dynamic text spanner."
115 "A fingering instruction."
121 '(automatically-numbered
124 numbering-assertion-function))
127 'footnote-spanner-interface
128 "Make a footnote spanner."
133 'fret-diagram-interface
147 'grace-spacing-interface
148 "Keep track of durations in a run of grace notes."
150 common-shortest-duration))
153 'inline-accidental-interface
154 "An inlined accidental (i.e. normal accidentals, cautionary
159 'instrument-specific-markup-interface
160 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
161 '(fret-diagram-details graphical harp-pedal-details size thickness))
164 'key-cancellation-interface
165 "A key cancellation."
169 'ligature-head-interface
170 "A note head that can become part of a ligature."
174 'ligature-bracket-interface
175 "A bracket indicating a ligature in the original edition."
176 '(width thickness height))
185 "Any object that is related to lyrics."
189 'lyric-syllable-interface
190 "A single piece of lyrics."
199 'measure-counter-interface
200 "A counter for numbering measures."
205 'metronome-mark-interface
210 'multi-measure-interface
211 "Multi measure rest, and the text or number that is printed over it."
220 'only-prebreak-interface
221 "Kill this grob after the line breaking process."
225 'parentheses-interface
226 "Parentheses for other objects."
231 'percent-repeat-interface
232 "Beat, Double and single measure repeats."
239 'piano-pedal-interface
240 "A piano pedal sign."
244 'piano-pedal-script-interface
245 "A piano pedal sign, fixed size."
249 'pitched-trill-interface
250 "A note head to indicate trill pitches."
254 'rhythmic-grob-interface
255 "Any object with a duration. Used to determine which grobs are
256 interesting enough to maintain a hara-kiri staff."
260 'spacing-options-interface
261 "Supports setting of spacing variables."
263 shortest-duration-space))
267 "A bar line that is spanned between other barlines.
268 This interface is used for bar lines that connect different
275 pure-relevant-spanners))
278 'stanza-number-interface
279 "A stanza number, to be put in from of a lyrics line."
283 'string-number-interface
284 "A string number instruction."
288 'stroke-finger-interface
289 "A right hand finger instruction."
293 'system-start-text-interface
294 "Text in front of the system."
301 'tab-note-head-interface
302 "A note head in tablature."
303 '(details display-cautionary span-start))
306 'trill-spanner-interface
311 'trill-pitch-accidental-interface
312 "An accidental for trill pitch."
316 'unbreakable-spanner-interface
317 "A spanner that should not be broken across line breaks. Override
318 with @code{breakable=##t}."