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--2007  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
  15 note)."
  16  '())
  17
  18 (ly:add-interface
  19  'bass-figure-interface
  20  "A bass figure text."
  21  '(implicit))
  22
  23 (ly:add-interface
  24  'bass-figure-alignment-interface
  25  "Align a bass figure."
  26  '())
  27
  28 (ly:add-interface
  29  'bend-after-interface
  30  "A doit or drop."
  31  '(thickness delta-position))
  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  'dynamic-text-spanner-interface
  45  "Dynamic text spanner."
  46  '(text))
  47
  48 (ly:add-interface
  49  'finger-interface
  50  "A fingering instruction."
  51  '())
  52
  53 (ly:add-interface
  54  'fret-diagram-interface
  55  "A fret diagram"
  56
  57  '(align-dir fret-diagram-details size string-fret-finger-combinations
  58    thickness))
  59
  60 (ly:add-interface
  61  'grace-spacing-interface
  62  "Keep track of durations in a run of grace notes."
  63  '(columns common-shortest-duration))
  64
  65 (ly:add-interface
  66  'key-cancellation-interface
  67  "A key cancellation."
  68  '())
  69
  70 (ly:add-interface
  71  'ligature-bracket-interface
  72  "A bracket indicating a ligature in the original edition."
  73  '(width thickness height))
  74
  75 (ly:add-interface
  76  'ligature-interface
  77  "A ligature."
  78  '())
  79
  80 (ly:add-interface
  81  'lyric-interface
  82  "Any object that is related to lyrics."
  83  '())
  84
  85 (ly:add-interface
  86  'lyric-syllable-interface
  87  "A single piece of lyrics."
  88  '())
  89
  90 (ly:add-interface
  91  'mark-interface
  92  "A rehearsal mark."
  93  '())
  94
  95 (ly:add-interface
  96  'metronome-mark-interface
  97  "A metronome mark."
  98  '())
  99
 100 (ly:add-interface
 101  'multi-measure-interface
 102  "Multi measure rest, and the text or number that is printed over it."
 103  '(bound-padding))
 104
 105 (ly:add-interface
 106  'note-name-interface
 107  "Note names."
 108  '(style))
 109
 110 (ly:add-interface
 111  'only-prebreak-interface
 112  "Kill this grob after the line breaking process."
 113  '())
 114
 115 (ly:add-interface
 116  'parentheses-interface
 117  "Parentheses for other objects."
 118  '(padding stencils))
 119
 120 (ly:add-interface
 121  'piano-pedal-interface
 122  "A piano pedal sign."
 123  '())
 124
 125 (ly:add-interface
 126  'piano-pedal-script-interface
 127  "A piano pedal sign, fixed size."
 128  '())
 129
 130 (ly:add-interface
 131  'pitched-trill-interface
 132  "A note head to indicate trill pitches."
 133  '(accidental-grob))
 134
 135 (ly:add-interface
 136  'rhythmic-grob-interface
 137  "Any object with a duration.  Used to determine which grobs are
 138 interesting enough to maintain a hara-kiri staff."
 139  '())
 140
 141 (ly:add-interface
 142  'spacing-options-interface
 143  "Supports setting of spacing variables."
 144  '(spacing-increment shortest-duration-space))
 145
 146 (ly:add-interface
 147  'stanza-number-interface
 148  "A stanza number, to be put in from of a lyrics line."
 149  '())
 150
 151 (ly:add-interface
 152  'string-number-interface
 153  "A string number instruction."
 154  '())
 155
 156 (ly:add-interface
 157  'stroke-finger-interface
 158  "A right hand finger instruction."
 159  '(digit-names))
 160
 161 ;;; todo: this is not typesetting info. Move to interpretation.
 162 (ly:add-interface
 163  'tablature-interface
 164  "An interface for any notes set in a tablature staff."
 165  '())
 166
 167 (ly:add-interface
 168  'trill-spanner-interface
 169  "A trill spanner."
 170  '())
 171
 172 (ly:add-interface
 173  'trill-pitch-accidental-interface
 174  "An accidental for trill pitch."
 175  '())
 176
 177 (ly:add-interface
 178  'unbreakable-spanner-interface
 179  "A spanner that should not be broken across line breaks.  Override
 180 with @code{breakable=##t}."
 181  '(breakable))
 182
 183 (ly:add-interface
 184  'vertically-spaceable-interface
 185  "Objects that should be kept at constant vertical distances.  Typically:
 186 @rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."
 187  '())