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