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?
18 'cluster-beacon-interface
20 "A place holder for the cluster spanner to determine the vertical
21 extents of a cluster spanner at this X position.
29 "Any kind of loudness sign"
35 "A fingering instruction"
46 'ligature-bracket-interface
47 "A bracket indicating a ligature in the original edition"
48 '(width thickness height ligature-primitive-callback))
57 'metronome-mark-interface
63 'rhythmic-grob-interface
64 "Any object with a rhythmic basis. Used to determine which grobs
65 are interesting enough to maintain a hara-kiri staff."
68 ;;; todo: this is not typesetting info. Move to interpretation.
75 'piano-pedal-interface
80 ;; todo: figure out where to put this doco:
83 Grob properties form a name space where you can set variables per
84 object. Each object however, may have multiple functions. For
85 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
86 is printed above or below the staff, it is a dynamic sign, and it is a
89 To reflect this different functions of a grob, procedures and variables
90 are grouped into so-called interfaces. The dynamic text for example
91 supports the following interfaces:
94 The glyph is built from characters from a font, hence the
95 @code{font-interface}. For objects supporting @code{font-interface}, you
96 can select alternate fonts by setting @code{font-style},
97 @code{font-point-size}, etc.
99 @item dynamic-interface
100 Dynamic interface is not associated with any variable or function in
101 particular, but this makes it possible to distinguish this grob from
102 other similar grobs (like @code{TextScript}), that have no meaning of
106 This interface is for texts that are to be set using special routines
107 to stack text into lines, using kerning, etc.
109 @item general-grob-interface
110 This interface is supported by all grob types.