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