1 ;;;; interface-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ; should include default value?
13 'cluster-beacon-interface
15 "A place holder for the cluster spanner to determine the vertical
16 extents of a cluster spanner at this X position.
24 "Any kind of loudness sign"
30 "A fingering instruction"
41 'ligature-bracket-interface
42 "A bracket indicating a ligature in the original edition"
43 '(width thickness height ligature-primitive-callback))
46 'lyric-syllable-interface
47 "a single piece of lyrics"
56 'metronome-mark-interface
67 'only-prebreak-interface
68 "Kill this grob after the line breaking process."
72 'piano-pedal-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."
85 'stanza-number-interface
90 ;;; todo: this is not typesetting info. Move to interpretation.
97 ;; todo: figure out where to put this doco:
100 Grob properties form a name space where you can set variables per
101 object. Each object however, may have multiple functions. For
102 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
103 is printed above or below the staff, it is a dynamic sign, and it is a
106 To reflect this different functions of a grob, procedures and variables
107 are grouped into so-called interfaces. The dynamic text for example
108 supports the following interfaces:
111 The glyph is built from characters from a font, hence the
112 @code{font-interface}. For objects supporting @code{font-interface}, you
113 can select alternate fonts by setting @code{font-style},
114 @code{font-point-size}, etc.
116 @item dynamic-interface
117 Dynamic interface is not associated with any variable or function in
118 particular, but this makes it possible to distinguish this grob from
119 other similar grobs (like @code{TextScript}), that have no meaning of
123 This interface is for texts that are to be set using special routines
124 to stack text into lines, using kerning, etc.
126 @item general-grob-interface
127 This interface is supported by all grob types.