1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2015 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 'horizontal-bracket-text-interface
154 "Label for an analysis bracket."
158 'inline-accidental-interface
159 "An inlined accidental (i.e. normal accidentals, cautionary
164 'instrument-specific-markup-interface
165 "Instrument-specific markup (like fret boards or harp pedal diagrams)."
166 '(fret-diagram-details graphical harp-pedal-details size thickness))
169 'key-cancellation-interface
170 "A key cancellation."
174 'ligature-head-interface
175 "A note head that can become part of a ligature."
179 'ligature-bracket-interface
180 "A bracket indicating a ligature in the original edition."
181 '(width thickness height))
190 "Any object that is related to lyrics."
194 'lyric-syllable-interface
195 "A single piece of lyrics."
204 'measure-counter-interface
205 "A counter for numbering measures."
211 'metronome-mark-interface
216 'multi-measure-interface
217 "Multi measure rest, and the text or number that is printed over it."
231 'only-prebreak-interface
232 "Kill this grob after the line breaking process."
236 'outside-staff-axis-group-interface
237 "A vertical axis group on which outside-staff skyline calculations are done."
238 '(outside-staff-placement-directive vertical-skyline-elements))
241 'outside-staff-interface
242 "A grob that could be placed outside staff."
243 '(outside-staff-horizontal-padding outside-staff-padding outside-staff-priority))
246 'parentheses-interface
247 "Parentheses for other objects."
252 'percent-repeat-interface
253 "Beat, Double and single measure repeats."
260 'piano-pedal-interface
261 "A piano pedal sign."
265 'piano-pedal-script-interface
266 "A piano pedal sign, fixed size."
270 'pitched-trill-interface
271 "A note head to indicate trill pitches."
275 'rhythmic-grob-interface
276 "Any object with a duration. Used to determine which grobs are
277 interesting enough to maintain a hara-kiri staff."
281 'spacing-options-interface
282 "Supports setting of spacing variables."
284 shortest-duration-space))
288 "A bar line that is spanned between other barlines.
289 This interface is used for bar lines that connect different
296 pure-relevant-spanners))
299 'stanza-number-interface
300 "A stanza number, to be put in from of a lyrics line."
304 'string-number-interface
305 "A string number instruction."
309 'stroke-finger-interface
310 "A right hand finger instruction."
314 'system-start-text-interface
315 "Text in front of the system."
322 'tab-note-head-interface
323 "A note head in tablature."
324 '(details display-cautionary span-start))
327 'time-signature-interface
328 "A time signature, in different styles. The following values for @code{style} are are recognized:
332 4/4 and 2/2 are typeset as C and struck C, respectively. All other time signatures are written with two digits. The value @code{default} is equivalent to @code{C}.
334 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are typeset with neo-mensural style mensuration marks. All other time signatures are written with two digits.
336 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are typeset with mensural style mensuration marks. All other time signatures are written with two digits.
338 All time signatures are typeset with a single digit, e.g., 3/2 is written as 3.
340 All time signatures are typeset with two digits.
345 'trill-spanner-interface
350 'trill-pitch-accidental-interface
351 "An accidental for trill pitch."
355 'unbreakable-spanner-interface
356 "A spanner that should not be broken across line breaks. Override
357 with @code{breakable=##t}."