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