scm/define-grob-interfaces.scm

   1 ;;;; define-grob-interfaces.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2009  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  'ambitus-interface
  20  "The line between note heads for a pitch range."
  21  '(gap note-heads thickness))
  22
  23 (ly:add-interface
  24  'bass-figure-interface
  25  "A bass figure text."
  26  '(implicit))
  27
  28 (ly:add-interface
  29  'bass-figure-alignment-interface
  30  "Align a bass figure."
  31  '())
  32
  33 (ly:add-interface
  34  'bend-after-interface
  35  "A doit or drop."
  36  '(thickness delta-position))
  37
  38 (ly:add-interface
  39  'dynamic-interface
  40  "Any kind of loudness sign."
  41  '())
  42
  43 (ly:add-interface
  44  'dynamic-line-spanner-interface
  45  "Dynamic line spanner."
  46  '(avoid-slur))
  47
  48 (ly:add-interface
  49  'dynamic-text-spanner-interface
  50  "Dynamic text spanner."
  51  '(text))
  52
  53 (ly:add-interface
  54  'finger-interface
  55  "A fingering instruction."
  56  '())
  57
  58 (ly:add-interface
  59  'fret-diagram-interface
  60  "A fret diagram"
  61  '(align-dir fret-diagram-details size dot-placement-list
  62    thickness))
  63
  64 (ly:add-interface
  65  'grace-spacing-interface
  66  "Keep track of durations in a run of grace notes."
  67  '(columns common-shortest-duration))
  68
  69 (ly:add-interface
  70  'instrument-specific-markup-interface
  71  "Instrument-specific markup (like fret boards or harp pedal diagrams)."
  72  '(fret-diagram-details harp-pedal-details size thickness))
  73
  74 (ly:add-interface
  75  'key-cancellation-interface
  76  "A key cancellation."
  77  '())
  78
  79 (ly:add-interface
  80  'ligature-bracket-interface
  81  "A bracket indicating a ligature in the original edition."
  82  '(width thickness height))
  83
  84 (ly:add-interface
  85  'ligature-interface
  86  "A ligature."
  87  '())
  88
  89 (ly:add-interface
  90  'lyric-interface
  91  "Any object that is related to lyrics."
  92  '())
  93
  94 (ly:add-interface
  95  'lyric-syllable-interface
  96  "A single piece of lyrics."
  97  '())
  98
  99 (ly:add-interface
 100  'mark-interface
 101  "A rehearsal mark."
 102  '())
 103
 104 (ly:add-interface
 105  'metronome-mark-interface
 106  "A metronome mark."
 107  '())
 108
 109 (ly:add-interface
 110  'multi-measure-interface
 111  "Multi measure rest, and the text or number that is printed over it."
 112  '(bound-padding))
 113
 114 (ly:add-interface
 115  'note-name-interface
 116  "Note names."
 117  '())
 118
 119 (ly:add-interface
 120  'only-prebreak-interface
 121  "Kill this grob after the line breaking process."
 122  '())
 123
 124 (ly:add-interface
 125  'parentheses-interface
 126  "Parentheses for other objects."
 127  '(padding stencils))
 128
 129 (ly:add-interface
 130  'percent-repeat-interface
 131  "Beat, Double and single measure repeats."
 132  '(dot-negative-kern slash-negative-kern slope thickness))
 133
 134 (ly:add-interface
 135  'piano-pedal-interface
 136  "A piano pedal sign."
 137  '())
 138
 139 (ly:add-interface
 140  'piano-pedal-script-interface
 141  "A piano pedal sign, fixed size."
 142  '())
 143
 144 (ly:add-interface
 145  'pitched-trill-interface
 146  "A note head to indicate trill pitches."
 147  '(accidental-grob))
 148
 149 (ly:add-interface
 150  'rhythmic-grob-interface
 151  "Any object with a duration.  Used to determine which grobs are
 152 interesting enough to maintain a hara-kiri staff."
 153  '())
 154
 155 (ly:add-interface
 156  'spacing-options-interface
 157  "Supports setting of spacing variables."
 158  '(spacing-increment shortest-duration-space))
 159
 160 (ly:add-interface
 161  'stanza-number-interface
 162  "A stanza number, to be put in from of a lyrics line."
 163  '())
 164
 165 (ly:add-interface
 166  'string-number-interface
 167  "A string number instruction."
 168  '())
 169
 170 (ly:add-interface
 171  'stroke-finger-interface
 172  "A right hand finger instruction."
 173  '(digit-names))
 174
 175 (ly:add-interface
 176  'system-start-text-interface
 177  "Text in front of the system."
 178  '(long-text self-alignment-X self-alignment-Y text))
 179
 180 (ly:add-interface
 181  'trill-spanner-interface
 182  "A trill spanner."
 183  '())
 184
 185 (ly:add-interface
 186  'trill-pitch-accidental-interface
 187  "An accidental for trill pitch."
 188  '())
 189
 190 (ly:add-interface
 191  'unbreakable-spanner-interface
 192  "A spanner that should not be broken across line breaks.  Override
 193 with @code{breakable=##t}."
 194  '(breakable))
 195
 196 (ly:add-interface
 197  'vertically-spaceable-interface
 198  "Objects that should be kept at constant vertical distances.  Typically:
 199 @rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."
 200  '())