scm/define-grob-interfaces.scm

   1 ;;;; interface-description.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  1998--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 ; should include default value?
  10
  11
  12
  13 (ly:add-interface
  14  'dynamic-interface
  15    "Any kind of loudness sign"
  16    '()
  17     )
  18
  19 (ly:add-interface
  20  'finger-interface
  21  "A fingering instruction"
  22  '()
  23  )
  24
  25 (ly:add-interface
  26  'ligature-interface
  27  "A ligature"
  28  '()
  29  )
  30
  31 (ly:add-interface
  32  'ligature-bracket-interface
  33  "A bracket indicating a ligature in the original edition"
  34  '(width thickness height ligature-primitive-callback))
  35
  36 (ly:add-interface
  37  'lyric-syllable-interface
  38  "a single piece of lyrics"
  39  '())
  40
  41 (ly:add-interface
  42  'lyric-interface
  43  "Any object that is related to lyrics."
  44  '())
  45
  46 (ly:add-interface
  47  'mark-interface
  48  "a rehearsal mark"
  49  '())
  50
  51 (ly:add-interface
  52  'metronome-mark-interface
  53  "a rehearsal mark"
  54  '(
  55    ))
  56
  57
  58 (ly:add-interface
  59  'multi-measure-interface
  60  "Multi measure rest, and the text or number that is printed over it."
  61  '())
  62
  63
  64 (ly:add-interface
  65 'note-name-interface
  66  "Note name"
  67  '(style))
  68
  69 (ly:add-interface
  70  'only-prebreak-interface
  71  "Kill this grob after the line breaking process."
  72  '() )
  73
  74 (ly:add-interface
  75  'piano-pedal-interface
  76  "A piano pedal sign"
  77  '())
  78
  79
  80 (ly:add-interface
  81  'rhythmic-grob-interface
  82  "Any object with a rhythmic basis. Used to determine which grobs
  83 are interesting enough to maintain a hara-kiri staff."
  84  '()
  85  )
  86
  87 (ly:add-interface
  88  'stanza-number-interface
  89  "A stanza number, to be put in from of a lyrics line"
  90  '()
  91  )
  92
  93 ;;; todo: this is not typesetting info. Move to interpretation.
  94 (ly:add-interface
  95  'tablature-interface
  96  "An interface for any notes set in a tablature staff"
  97  '())
  98