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@cs.uu.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
  18 (ly:add-interface
  19  'bass-figure-interface
  20  "A bass figure text"
  21  '(implicit))
  22
  23
  24 (ly:add-interface
  25  'dynamic-interface
  26    "Any kind of loudness sign"
  27    '())
  28
  29 (ly:add-interface
  30  'dynamic-line-spanner-interface
  31    "Dynamic line spanner"
  32    '(avoid-slur))
  33
  34 (ly:add-interface
  35  'finger-interface
  36  "A fingering instruction"
  37  '())
  38
  39 (ly:add-interface
  40  'string-number-interface
  41  "A string number instruction"
  42  '())
  43
  44 (ly:add-interface
  45  'fret-diagram-interface
  46  "A fret diagram"
  47  '(align-dir barre-type dot-color dot-radius finger-code fret-count
  48   label-dir number-type size string-count thickness))
  49
  50 (ly:add-interface
  51  'ligature-interface
  52  "A ligature"
  53  '())
  54
  55 (ly:add-interface
  56  'ligature-bracket-interface
  57  "A bracket indicating a ligature in the original edition"
  58  '(width thickness height))
  59
  60
  61 (ly:add-interface
  62  'lyric-syllable-interface
  63  "a single piece of lyrics"
  64  '())
  65
  66 (ly:add-interface
  67  'lyric-interface
  68  "Any object that is related to lyrics."
  69  '())
  70
  71 (ly:add-interface
  72  'mark-interface
  73  "a rehearsal mark"
  74  '())
  75
  76 (ly:add-interface
  77  'metronome-mark-interface
  78  "a rehearsal mark"
  79  '())
  80
  81 (ly:add-interface
  82  'multi-measure-interface
  83  "Multi measure rest, and the text or number that is printed over it."
  84  '())
  85
  86 (ly:add-interface
  87 'note-name-interface
  88  "Note name"
  89  '(style))
  90
  91 (ly:add-interface
  92  'only-prebreak-interface
  93  "Kill this grob after the line breaking process."
  94  '())
  95
  96 (ly:add-interface
  97  'parentheses-interface
  98  "Parentheses for other objects"
  99  '())
 100
 101 (ly:add-interface
 102  'piano-pedal-interface
 103  "A piano pedal sign"
 104  '())
 105
 106 (ly:add-interface
 107  'pitched-trill-interface
 108    "A note head to indicate trill pitches"
 109    '(accidental-grob))
 110
 111 (ly:add-interface
 112  'rhythmic-grob-interface
 113  "Any object with a rhythmic basis. Used to determine which grobs
 114 are interesting enough to maintain a hara-kiri staff."
 115  '())
 116
 117 (ly:add-interface
 118  'stanza-number-interface
 119  "A stanza number, to be put in from of a lyrics line"
 120  '())
 121
 122 (ly:add-interface
 123  'system-start-text-interface
 124  "A text at the beginning of a system."
 125  '(text long-text collapse-height style))
 126
 127 ;;; todo: this is not typesetting info. Move to interpretation.
 128 (ly:add-interface
 129  'tablature-interface
 130  "An interface for any notes set in a tablature staff"
 131  '())
 132
 133 (ly:add-interface
 134  'vertically-spaceable-interface
 135  "Objects that should be kept at constant vertical distances. Typically:
 136 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."
 137  '())