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 (ly:add-interface
  18  'bass-figure-interface
  19  "A bass figure text"
  20  '(implicit))
  21
  22 (ly:add-interface
  23  'bend-after-interface
  24  "A doit or drop."
  25  '(thickness delta-position))
  26
  27 (ly:add-interface
  28  'bass-figure-alignment-interface
  29  ""
  30  '())
  31
  32 (ly:add-interface
  33  'dynamic-interface
  34    "Any kind of loudness sign"
  35    '())
  36
  37 (ly:add-interface
  38  'dynamic-line-spanner-interface
  39    "Dynamic line spanner"
  40    '(avoid-slur))
  41
  42 (ly:add-interface
  43  'dynamic-text-spanner-interface
  44    "Dynamic text spanner"
  45    '(text))
  46
  47 (ly:add-interface
  48  'finger-interface
  49  "A fingering instruction"
  50  '())
  51
  52 (ly:add-interface
  53  'fret-diagram-interface
  54  "A fret diagram"
  55  '(align-dir barre-type dot-color dot-radius finger-code fret-count
  56   label-dir number-type size string-count
  57   string-fret-finger-combinations 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-interface
  71  "A ligature"
  72  '())
  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
  85 (ly:add-interface
  86  'lyric-syllable-interface
  87  "A single piece of lyrics"
  88  '())
  89
  90 (ly:add-interface
  91  'lyric-interface
  92  "Any object that is related to lyrics."
  93  '())
  94
  95 (ly:add-interface
  96  'mark-interface
  97  "A rehearsal mark"
  98  '())
  99
 100 (ly:add-interface
 101  'metronome-mark-interface
 102  "A metronome mark"
 103  '())
 104
 105 (ly:add-interface
 106  'multi-measure-interface
 107  "Multi measure rest, and the text or number that is printed over it."
 108  '(bound-padding))
 109
 110 (ly:add-interface
 111 'note-name-interface
 112  "Note name"
 113  '(style))
 114
 115 (ly:add-interface
 116  'only-prebreak-interface
 117  "Kill this grob after the line breaking process."
 118  '())
 119
 120 (ly:add-interface
 121  'parentheses-interface
 122  "Parentheses for other objects"
 123  '(padding stencils))
 124
 125 (ly:add-interface
 126  'piano-pedal-interface
 127  "A piano pedal sign"
 128  '())
 129
 130 (ly:add-interface
 131  'piano-pedal-script-interface
 132  "A piano pedal sign, fixed size"
 133  '())
 134
 135 (ly:add-interface
 136  'pitched-trill-interface
 137    "A note head to indicate trill pitches"
 138    '(accidental-grob))
 139
 140 (ly:add-interface
 141  'trill-pitch-accidental-interface
 142  "An accidental for trill pitch"
 143  '()
 144  )
 145
 146 (ly:add-interface
 147  'rhythmic-grob-interface
 148  "Any object with a duration. Used to determine which grobs are
 149 interesting enough to maintain a hara-kiri staff."
 150  '())
 151
 152
 153 (ly:add-interface
 154  'spacing-options-interface
 155  "Supports setting of spacing variables"
 156  '(spacing-increment shortest-duration-space))
 157
 158 (ly:add-interface
 159  'stanza-number-interface
 160  "A stanza number, to be put in from of a lyrics line"
 161  '())
 162
 163 (ly:add-interface
 164  'string-number-interface
 165  "A string number instruction"
 166  '())
 167
 168 (ly:add-interface
 169  'stroke-finger-interface
 170  "A right hand finger instruction"
 171  '(digit-names))
 172
 173 (ly:add-interface
 174  'system-start-text-interface
 175  "A text at the beginning of a system."
 176  '(text long-text collapse-height style))
 177
 178 ;;; todo: this is not typesetting info. Move to interpretation.
 179 (ly:add-interface
 180  'tablature-interface
 181  "An interface for any notes set in a tablature staff"
 182  '())
 183
 184 (ly:add-interface
 185  'unbreakable-spanner-interface
 186  "A spanner that should not be broken across line breaks. Override
 187 with @code{breakable=##t}. "
 188
 189  '(breakable))
 190
 191 (ly:add-interface
 192  'vertically-spaceable-interface
 193  "Objects that should be kept at constant vertical distances. Typically:
 194 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."
 195  '())