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