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