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