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--2003  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  'cluster-beacon-interface
  14
  15  "A place holder for the cluster spanner to determine the vertical
  16 extents of a cluster spanner at this X position.
  17
  18  "
  19  '(positions)
  20  )
  21
  22 (ly:add-interface
  23  'dynamic-interface
  24    "Any kind of loudness sign"
  25    '()
  26     )
  27
  28 (ly:add-interface
  29  'finger-interface
  30  "A fingering instruction"
  31  '()
  32  )
  33
  34 (ly:add-interface
  35  'ligature-interface
  36  "A ligature"
  37  '()
  38  )
  39
  40 (ly:add-interface
  41  'ligature-bracket-interface
  42  "A bracket indicating a ligature in the original edition"
  43  '(width thickness height ligature-primitive-callback))
  44
  45 (ly:add-interface
  46  'lyric-syllable-interface
  47  "a single piece of lyrics"
  48  '())
  49
  50 (ly:add-interface
  51  'mark-interface
  52  "a rehearsal mark"
  53  '())
  54
  55 (ly:add-interface
  56  'metronome-mark-interface
  57  "a rehearsal mark"
  58  '(
  59    ))
  60
  61 (ly:add-interface
  62 'note-name-interface
  63  "Note name"
  64  '(style))
  65
  66 (ly:add-interface
  67  'only-prebreak-interface
  68  "Kill this grob after the line breaking process."
  69  '() )
  70
  71 (ly:add-interface
  72  'piano-pedal-interface
  73  "A piano pedal sign"
  74  '())
  75
  76
  77 (ly:add-interface
  78  'rhythmic-grob-interface
  79  "Any object with a rhythmic basis. Used to determine which grobs
  80 are interesting enough to maintain a hara-kiri staff."
  81  '()
  82  )
  83 ;;; todo: this is not typesetting info. Move to interpretation.
  84 (ly:add-interface
  85  'tablature-interface
  86  "tablature notes"
  87  '())
  88
  89
  90 ;; todo: figure out where  to put this doco:
  91
  92 "
  93 Grob properties form a name space where you can set variables per
  94 object.  Each object however, may have multiple functions. For
  95 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
  96 is printed above or below the staff, it is a dynamic sign, and it is a
  97 kind of text.
  98
  99 To reflect this different functions of a grob, procedures and variables
 100 are grouped into so-called interfaces.  The dynamic text for example
 101 supports the  following interfaces:
 102 @table @code
 103 @item font-interface
 104   The glyph is built from characters from a font, hence the
 105 @code{font-interface}. For objects supporting @code{font-interface}, you
 106 can select alternate fonts by setting @code{font-style},
 107 @code{font-point-size}, etc.
 108
 109 @item dynamic-interface
 110   Dynamic interface is not associated with any variable or function in
 111 particular, but this makes it possible to distinguish this grob from
 112 other similar grobs (like @code{TextScript}), that have no meaning of
 113 dynamics.
 114
 115 @item text-interface
 116   This interface is for texts that are to be set using special routines
 117 to stack text into lines, using kerning, etc.
 118
 119 @item general-grob-interface
 120   This interface is supported by all grob types.
 121 @end table
 122 "