;;;; interface-description.scm -- part of generated backend documentation
;;;;
;;;;  source file of the GNU LilyPond music typesetter
;;;;
;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>


;; should include default value?


(ly:add-interface
 'accidental-suggestion-interface
   "An accidental, printed as a suggestion (typically: vertically over a note)"
   '())

(ly:add-interface
 'dynamic-interface
   "Any kind of loudness sign"
   '())

(ly:add-interface
 'dynamic-line-spanner-interface
   "Dynamic line spanner"
   '(avoid-slur))

(ly:add-interface
 'finger-interface
 "A fingering instruction"
 '())

(ly:add-interface
 'string-number-interface
 "A string number instruction"
 '())

(ly:add-interface
 'fret-diagram-interface
 "A fret diagram"
 '(align-dir barre-type dot-color dot-radius finger-code fret-count
  label-dir number-type size string-count thickness))

(ly:add-interface
 'ligature-interface
 "A ligature"
 '())

(ly:add-interface
 'ligature-bracket-interface
 "A bracket indicating a ligature in the original edition"
 '(width thickness height))


(ly:add-interface
 'lyric-syllable-interface
 "a single piece of lyrics"
 '())

(ly:add-interface
 'lyric-interface
 "Any object that is related to lyrics."
 '())

(ly:add-interface
 'mark-interface
 "a rehearsal mark"
 '())

(ly:add-interface
 'metronome-mark-interface
 "a rehearsal mark"
 '())

(ly:add-interface
 'multi-measure-interface
 "Multi measure rest, and the text or number that is printed over it."
 '())

(ly:add-interface
'note-name-interface
 "Note name"
 '(style))

(ly:add-interface
 'only-prebreak-interface
 "Kill this grob after the line breaking process."
 '())

(ly:add-interface
 'piano-pedal-interface
 "A piano pedal sign"
 '())

(ly:add-interface
 'pitched-trill-interface
   "A note head to indicate trill pitches"
   '(accidental-grob))

(ly:add-interface
 'rhythmic-grob-interface
 "Any object with a rhythmic basis. Used to determine which grobs
are interesting enough to maintain a hara-kiri staff."
 '())

(ly:add-interface
 'stanza-number-interface
 "A stanza number, to be put in from of a lyrics line"
 '())

(ly:add-interface
 'bass-figure-interface
 "A bass figure text"
 '(implicit))

;;; todo: this is not typesetting info. Move to interpretation.
(ly:add-interface
 'tablature-interface
 "An interface for any notes set in a tablature staff"
 '())

(ly:add-interface
 'vertically-spaceable-interface
 "Objects that should be kept at constant vertical distances. Typically:
@internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."
 '())
