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--2006  Han-Wen Nienhuys <hanwen@xs4all.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
  18 (ly:add-interface
  19  'bass-figure-interface
  20  "A bass figure text"
  21  '(implicit))
  22
  23 (ly:add-interface
  24  'bend-after-interface
  25  "A doit or drop."
  26  '(thickness delta-position))
  27
  28 (ly:add-interface
  29  'bass-figure-alignment-interface
  30  ""
  31  '())
  32
  33 (ly:add-interface
  34  'dynamic-interface
  35    "Any kind of loudness sign"
  36    '())
  37
  38 (ly:add-interface
  39  'dynamic-line-spanner-interface
  40    "Dynamic line spanner"
  41    '(avoid-slur))
  42
  43 (ly:add-interface
  44  'finger-interface
  45  "A fingering instruction"
  46  '())
  47
  48 (ly:add-interface
  49  'fret-diagram-interface
  50  "A fret diagram"
  51  '(align-dir barre-type dot-color dot-radius finger-code fret-count
  52   label-dir number-type size string-count thickness))
  53
  54 (ly:add-interface
  55  'grace-spacing-interface
  56  "Keep track of durations in a run of grace notes."
  57  '(columns common-shortest-duration))
  58
  59 (ly:add-interface
  60  'ligature-interface
  61  "A ligature"
  62  '())
  63
  64 (ly:add-interface
  65  'ligature-bracket-interface
  66  "A bracket indicating a ligature in the original edition"
  67  '(width thickness height))
  68
  69
  70 (ly:add-interface
  71  'lyric-syllable-interface
  72  "a single piece of lyrics"
  73  '())
  74
  75 (ly:add-interface
  76  'lyric-interface
  77  "Any object that is related to lyrics."
  78  '())
  79
  80 (ly:add-interface
  81  'mark-interface
  82  "a rehearsal mark"
  83  '())
  84
  85 (ly:add-interface
  86  'metronome-mark-interface
  87  "a rehearsal mark"
  88  '())
  89
  90 (ly:add-interface
  91  'multi-measure-interface
  92  "Multi measure rest, and the text or number that is printed over it."
  93  '(bound-padding))
  94
  95 (ly:add-interface
  96 'note-name-interface
  97  "Note name"
  98  '(style))
  99
 100 (ly:add-interface
 101  'only-prebreak-interface
 102  "Kill this grob after the line breaking process."
 103  '())
 104
 105 (ly:add-interface
 106  'parentheses-interface
 107  "Parentheses for other objects"
 108  '(padding))
 109
 110 (ly:add-interface
 111  'piano-pedal-interface
 112  "A piano pedal sign"
 113  '())
 114
 115 (ly:add-interface
 116  'pitched-trill-interface
 117    "A note head to indicate trill pitches"
 118    '(accidental-grob))
 119
 120 (ly:add-interface
 121  'rhythmic-grob-interface
 122  "Any object with a rhythmic basis. Used to determine which grobs
 123 are interesting enough to maintain a hara-kiri staff."
 124  '())
 125
 126
 127 (ly:add-interface
 128  'spacing-options-interface
 129  "Supports setting of spacing variables"
 130  '(spacing-increment shortest-duration-space))
 131
 132 (ly:add-interface
 133  'stanza-number-interface
 134  "A stanza number, to be put in from of a lyrics line"
 135  '())
 136
 137 (ly:add-interface
 138  'string-number-interface
 139  "A string number instruction"
 140  '())
 141
 142 (ly:add-interface
 143  'system-start-text-interface
 144  "A text at the beginning of a system."
 145  '(text long-text collapse-height style))
 146
 147 ;;; todo: this is not typesetting info. Move to interpretation.
 148 (ly:add-interface
 149  'tablature-interface
 150  "An interface for any notes set in a tablature staff"
 151  '())
 152
 153 (ly:add-interface
 154  'vertically-spaceable-interface
 155  "Objects that should be kept at constant vertical distances. Typically:
 156 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."
 157  '())