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  'rhythmic-grob-interface
  30  "Any object with a rhythmic basis. Used to determine which grobs
  31 are interesting enough to maintain a hara-kiri staff."
  32  '()
  33  )
  34
  35 (ly:add-interface
  36  'ligature-interface
  37  "A ligature"
  38  '()
  39  )
  40
  41 (ly:add-interface
  42  'ligature-bracket-interface
  43  "A bracket indicating a ligature in the original edition"
  44  '(width thickness height ligature-primitive-callback))
  45
  46 (ly:add-interface
  47  'mark-interface
  48  "a rehearsal mark"
  49  '(
  50    ))
  51
  52 ;;; todo: this is not typesetting info. Move to interpretation.
  53 (ly:add-interface
  54  'tablature-interface
  55  "tablature notes"
  56  '())
  57
  58
  59
  60 ;; todo: figure out where  to put this doco:
  61
  62 "
  63 Grob properties form a name space where you can set variables per
  64 object.  Each object however, may have multiple functions. For
  65 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
  66 is printed above or below the staff, it is a dynamic sign, and it is a
  67 kind of text.
  68
  69 To reflect this different functions of a grob, procedures and variables
  70 are grouped into so-called interfaces.  The dynamic text for example
  71 supports the  following interfaces:
  72 @table @code
  73 @item font-interface
  74   The glyph is built from characters from a font, hence the
  75 @code{font-interface}. For objects supporting @code{font-interface}, you
  76 can select alternate fonts by setting @code{font-style},
  77 @code{font-point-size}, etc.
  78
  79 @item dynamic-interface
  80   Dynamic interface is not associated with any variable or function in
  81 particular, but this makes it possible to distinguish this grob from
  82 other similar grobs (like @code{TextScript}), that have no meaning of
  83 dynamics.
  84
  85 @item text-interface
  86   This interface is for texts that are to be set using special routines
  87 to stack text into lines, using kerning, etc.
  88
  89 @item general-grob-interface
  90   This interface is supported by all grob types.
  91 @end table
  92 "