scm/interface-description.scm

   1 ;;;; interface-description.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2002  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 ; should include default value?
  10
  11 (ly:add-interface
  12 'note-name-interface
  13  "Note name"
  14  '(style))
  15
  16 (ly:add-interface
  17  'dynamic-interface
  18    "Any kind of loudness sign"
  19    '()
  20     )
  21
  22 (ly:add-interface
  23  'finger-interface
  24  "A fingering instruction"
  25  '()
  26  )
  27
  28 (ly:add-interface
  29  'ligature-interface
  30  "A ligature"
  31  '()
  32  )
  33
  34 (ly:add-interface
  35  'ligature-bracket-interface
  36  "A bracket indicating a ligature in the original edition"
  37  '(width thickness height ligature-primitive-callback))
  38
  39
  40 (ly:add-interface
  41  'mark-interface
  42  "a rehearsal mark"
  43  '(
  44    ))
  45
  46 ;;; todo: this is not typesetting info. Move to interpretation.
  47 (ly:add-interface
  48  'tablature-interface
  49  "tablature notes"
  50  '())
  51
  52
  53
  54 ;; todo: figure out where  to put this doco:
  55
  56 "
  57 Grob properties form a name space where you can set variables per
  58 object.  Each object however, may have multiple functions. For
  59 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
  60 is printed above or below the staff, it is a dynamic sign, and it is a
  61 kind of text.
  62
  63 To reflect this different functions of a grob, procedures and variables
  64 are grouped into so-called interfaces.  The dynamic text for example
  65 supports the  following interfaces:
  66 @table @code
  67 @item font-interface
  68   The glyph is built from characters from a font, hence the
  69 @code{font-interface}. For objects supporting @code{font-interface}, you
  70 can select alternate fonts by setting @code{font-style},
  71 @code{font-point-size}, etc.
  72
  73 @item dynamic-interface
  74   Dynamic interface is not associated with any variable or function in
  75 particular, but this makes it possible to distinguish this grob from
  76 other similar grobs (like @code{TextScript}), that have no meaning of
  77 dynamics.
  78
  79 @item text-interface
  80   This interface is for texts that are to be set using special routines
  81 to stack text into lines, using kerning, etc.
  82
  83 @item general-grob-interface
  84   This interface is supported by all grob types.
  85 @end table
  86 "