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