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