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