scm/define-grob-interfaces.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2009  Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 ;; should include default value?
  21
  22
  23 (ly:add-interface
  24  'accidental-suggestion-interface
  25  "An accidental, printed as a suggestion (typically: vertically over a
  26 note)."
  27  '())
  28
  29 (ly:add-interface
  30  'ambitus-interface
  31  "The line between note heads for a pitch range."
  32  '(gap note-heads thickness))
  33
  34 (ly:add-interface
  35  'bass-figure-interface
  36  "A bass figure text."
  37  '(implicit))
  38
  39 (ly:add-interface
  40  'bass-figure-alignment-interface
  41  "Align a bass figure."
  42  '())
  43
  44 (ly:add-interface
  45  'bend-after-interface
  46  "A doit or drop."
  47  '(thickness delta-position))
  48
  49 (ly:add-interface
  50  'dynamic-interface
  51  "Any kind of loudness sign."
  52  '())
  53
  54 (ly:add-interface
  55  'dynamic-line-spanner-interface
  56  "Dynamic line spanner."
  57  '(avoid-slur))
  58
  59 (ly:add-interface
  60  'dynamic-text-interface
  61  "An absolute text dynamic."
  62  '(right-padding))
  63
  64 (ly:add-interface
  65  'dynamic-text-spanner-interface
  66  "Dynamic text spanner."
  67  '(text))
  68
  69 (ly:add-interface
  70  'finger-interface
  71  "A fingering instruction."
  72  '())
  73
  74 (ly:add-interface
  75  'fret-diagram-interface
  76  "A fret diagram"
  77  '(align-dir fret-diagram-details size dot-placement-list
  78    thickness))
  79
  80 (ly:add-interface
  81  'grace-spacing-interface
  82  "Keep track of durations in a run of grace notes."
  83  '(columns common-shortest-duration))
  84
  85 (ly:add-interface
  86  'instrument-specific-markup-interface
  87  "Instrument-specific markup (like fret boards or harp pedal diagrams)."
  88  '(fret-diagram-details harp-pedal-details size thickness))
  89
  90 (ly:add-interface
  91  'key-cancellation-interface
  92  "A key cancellation."
  93  '())
  94
  95 (ly:add-interface
  96  'ligature-bracket-interface
  97  "A bracket indicating a ligature in the original edition."
  98  '(width thickness height))
  99
 100 (ly:add-interface
 101  'ligature-interface
 102  "A ligature."
 103  '())
 104
 105 (ly:add-interface
 106  'lyric-interface
 107  "Any object that is related to lyrics."
 108  '())
 109
 110 (ly:add-interface
 111  'lyric-syllable-interface
 112  "A single piece of lyrics."
 113  '())
 114
 115 (ly:add-interface
 116  'mark-interface
 117  "A rehearsal mark."
 118  '())
 119
 120 (ly:add-interface
 121  'metronome-mark-interface
 122  "A metronome mark."
 123  '())
 124
 125 (ly:add-interface
 126  'multi-measure-interface
 127  "Multi measure rest, and the text or number that is printed over it."
 128  '(bound-padding))
 129
 130 (ly:add-interface
 131  'note-name-interface
 132  "Note names."
 133  '())
 134
 135 (ly:add-interface
 136  'only-prebreak-interface
 137  "Kill this grob after the line breaking process."
 138  '())
 139
 140 (ly:add-interface
 141  'parentheses-interface
 142  "Parentheses for other objects."
 143  '(padding stencils))
 144
 145 (ly:add-interface
 146  'percent-repeat-interface
 147  "Beat, Double and single measure repeats."
 148  '(dot-negative-kern slash-negative-kern slope thickness))
 149
 150 (ly:add-interface
 151  'piano-pedal-interface
 152  "A piano pedal sign."
 153  '())
 154
 155 (ly:add-interface
 156  'piano-pedal-script-interface
 157  "A piano pedal sign, fixed size."
 158  '())
 159
 160 (ly:add-interface
 161  'pitched-trill-interface
 162  "A note head to indicate trill pitches."
 163  '(accidental-grob))
 164
 165 (ly:add-interface
 166  'rhythmic-grob-interface
 167  "Any object with a duration.  Used to determine which grobs are
 168 interesting enough to maintain a hara-kiri staff."
 169  '())
 170
 171 (ly:add-interface
 172  'spacing-options-interface
 173  "Supports setting of spacing variables."
 174  '(spacing-increment shortest-duration-space))
 175
 176 (ly:add-interface
 177  'stanza-number-interface
 178  "A stanza number, to be put in from of a lyrics line."
 179  '())
 180
 181 (ly:add-interface
 182  'string-number-interface
 183  "A string number instruction."
 184  '())
 185
 186 (ly:add-interface
 187  'stroke-finger-interface
 188  "A right hand finger instruction."
 189  '(digit-names))
 190
 191 (ly:add-interface
 192  'system-start-text-interface
 193  "Text in front of the system."
 194  '(long-text self-alignment-X self-alignment-Y text))
 195
 196 (ly:add-interface
 197  'tab-note-head-interface
 198  "A note head in tablature."
 199  '(details))
 200
 201 (ly:add-interface
 202  'trill-spanner-interface
 203  "A trill spanner."
 204  '())
 205
 206 (ly:add-interface
 207  'trill-pitch-accidental-interface
 208  "An accidental for trill pitch."
 209  '())
 210
 211 (ly:add-interface
 212  'unbreakable-spanner-interface
 213  "A spanner that should not be broken across line breaks.  Override
 214 with @code{breakable=##t}."
 215  '(breakable))
 216
 217 (ly:add-interface
 218  'vertically-spaceable-interface
 219  "Objects that should be kept at constant vertical distances.  Typically:
 220 @rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."
 221  '())
 222
 223 (ly:add-interface
 224  'volta-interface
 225  "A volta repeat."
 226  '())