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--2005  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  'string-number-interface
  27  "A string number instruction"
  28  '()
  29  )
  30
  31 (ly:add-interface
  32  'fret-diagram-interface
  33  "A fret diagram"
  34  '(align-dir barre-type dot-color dot-radius finger-code fret-count
  35   label-dir number-type size string-count thickness)
  36 )
  37
  38 (ly:add-interface
  39  'ligature-interface
  40  "A ligature"
  41  '()
  42  )
  43
  44 (ly:add-interface
  45  'ligature-bracket-interface
  46  "A bracket indicating a ligature in the original edition"
  47  '(width thickness height ligature-primitive-callback))
  48
  49 (ly:add-interface
  50  'lyric-syllable-interface
  51  "a single piece of lyrics"
  52  '())
  53
  54 (ly:add-interface
  55  'lyric-interface
  56  "Any object that is related to lyrics."
  57  '())
  58
  59 (ly:add-interface
  60  'mark-interface
  61  "a rehearsal mark"
  62  '())
  63
  64 (ly:add-interface
  65  'metronome-mark-interface
  66  "a rehearsal mark"
  67  '(
  68    ))
  69
  70
  71 (ly:add-interface
  72  'multi-measure-interface
  73  "Multi measure rest, and the text or number that is printed over it."
  74  '())
  75
  76
  77 (ly:add-interface
  78 'note-name-interface
  79  "Note name"
  80  '(style))
  81
  82 (ly:add-interface
  83  'only-prebreak-interface
  84  "Kill this grob after the line breaking process."
  85  '())
  86
  87 (ly:add-interface
  88  'piano-pedal-interface
  89  "A piano pedal sign"
  90  '())
  91
  92
  93 (ly:add-interface
  94  'rhythmic-grob-interface
  95  "Any object with a rhythmic basis. Used to determine which grobs
  96 are interesting enough to maintain a hara-kiri staff."
  97  '()
  98  )
  99
 100 (ly:add-interface
 101  'stanza-number-interface
 102  "A stanza number, to be put in from of a lyrics line"
 103  '()
 104  )
 105
 106 ;;; todo: this is not typesetting info. Move to interpretation.
 107 (ly:add-interface
 108  'tablature-interface
 109  "An interface for any notes set in a tablature staff"
 110  '())
 111
 112
 113 (ly:add-interface
 114  'vertically-spaceable-interface
 115  "Objects that should be kept at constant vertical distances. Typically:
 116 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."
 117  '())