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 (ly:add-interface
  13  'cluster-beacon-interface
  14
  15  "A place holder for the cluster spanner to determine the vertical
  16 extents of a cluster spanner at this X position.
  17
  18  "
  19  '(positions)
  20  )
  21
  22 (ly:add-interface
  23  'dynamic-interface
  24    "Any kind of loudness sign"
  25    '()
  26     )
  27
  28 (ly:add-interface
  29  'finger-interface
  30  "A fingering instruction"
  31  '()
  32  )
  33
  34 (ly:add-interface
  35  'ligature-interface
  36  "A ligature"
  37  '()
  38  )
  39
  40 (ly:add-interface
  41  'ligature-bracket-interface
  42  "A bracket indicating a ligature in the original edition"
  43  '(width thickness height ligature-primitive-callback))
  44
  45 (ly:add-interface
  46  'lyric-syllable-interface
  47  "a single piece of lyrics"
  48  '())
  49
  50 (ly:add-interface
  51  'lyric-interface
  52  "Any object that is related to lyrics."
  53  '())
  54
  55 (ly:add-interface
  56  'mark-interface
  57  "a rehearsal mark"
  58  '())
  59
  60 (ly:add-interface
  61  'metronome-mark-interface
  62  "a rehearsal mark"
  63  '(
  64    ))
  65
  66
  67 (ly:add-interface
  68  'multi-measure-interface
  69  "Multi measure rest, and friends (mmrest number, mmrest text)."
  70  '())
  71
  72
  73 (ly:add-interface
  74 'note-name-interface
  75  "Note name"
  76  '(style))
  77
  78 (ly:add-interface
  79  'only-prebreak-interface
  80  "Kill this grob after the line breaking process."
  81  '() )
  82
  83 (ly:add-interface
  84  'piano-pedal-interface
  85  "A piano pedal sign"
  86  '())
  87
  88
  89 (ly:add-interface
  90  'rhythmic-grob-interface
  91  "Any object with a rhythmic basis. Used to determine which grobs
  92 are interesting enough to maintain a hara-kiri staff."
  93  '()
  94  )
  95
  96 (ly:add-interface
  97  'stanza-number-interface
  98  "A stanza number, to be put in from of a lyrics line"
  99  '()
 100  )
 101
 102 ;;; todo: this is not typesetting info. Move to interpretation.
 103 (ly:add-interface
 104  'tablature-interface
 105  "An interface for any notes set in a tablature staff"
 106  '())
 107