;;;; interface-description.scm -- part of generated backend documentation
;;;;
;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;;
+;;;; (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
-; should include default value?
+;; should include default value?
+
(ly:add-interface
-'note-name-interface
- "Note name"
- '(style))
+ 'accidental-suggestion-interface
+ "An accidental, printed as a suggestion (typically: vertically over a
+note)."
+ '())
+
+(ly:add-interface
+ 'bass-figure-interface
+ "A bass figure text."
+ '(implicit))
+
+(ly:add-interface
+ 'bass-figure-alignment-interface
+ "Align a bass figure."
+ '())
+
+(ly:add-interface
+ 'bend-after-interface
+ "A doit or drop."
+ '(thickness delta-position))
(ly:add-interface
'dynamic-interface
- "Any kind of loudness sign"
- '()
- )
+ "Any kind of loudness sign."
+ '())
+
+(ly:add-interface
+ 'dynamic-line-spanner-interface
+ "Dynamic line spanner."
+ '(avoid-slur))
+
+(ly:add-interface
+ 'dynamic-text-spanner-interface
+ "Dynamic text spanner."
+ '(text))
(ly:add-interface
'finger-interface
- "A fingering instruction"
- '()
- )
+ "A fingering instruction."
+ '())
(ly:add-interface
- 'rhythmic-grob-interface
- "Any object with a rhythmic basis. Used to determine which grobs
-are interesting enough to maintain a hara-kiri staff."
- '()
- )
+ 'fret-diagram-interface
+ "A fret diagram"
+ '(align-dir fret-diagram-details size dot-placement-list
+ thickness))
(ly:add-interface
- 'ligature-interface
- "A ligature"
- '()
- )
+ 'grace-spacing-interface
+ "Keep track of durations in a run of grace notes."
+ '(columns common-shortest-duration))
+
+(ly:add-interface
+ 'instrument-specific-markup-interface
+ "Instrument-specific markup (like fret boards or harp pedal diagrams)."
+ '(fret-diagram-details harp-pedal-details size thickness))
+
+(ly:add-interface
+ 'key-cancellation-interface
+ "A key cancellation."
+ '())
(ly:add-interface
'ligature-bracket-interface
- "A bracket indicating a ligature in the original edition"
- '(width thickness height ligature-primitive-callback))
+ "A bracket indicating a ligature in the original edition."
+ '(width thickness height))
+
+(ly:add-interface
+ 'ligature-interface
+ "A ligature."
+ '())
+
+(ly:add-interface
+ 'lyric-interface
+ "Any object that is related to lyrics."
+ '())
+
+(ly:add-interface
+ 'lyric-syllable-interface
+ "A single piece of lyrics."
+ '())
(ly:add-interface
'mark-interface
- "a rehearsal mark"
- '(
- ))
+ "A rehearsal mark."
+ '())
(ly:add-interface
'metronome-mark-interface
- "a rehearsal mark"
- '(
- ))
+ "A metronome mark."
+ '())
-;;; todo: this is not typesetting info. Move to interpretation.
(ly:add-interface
- 'tablature-interface
- "tablature notes"
+ 'multi-measure-interface
+ "Multi measure rest, and the text or number that is printed over it."
+ '(bound-padding))
+
+(ly:add-interface
+ 'note-name-interface
+ "Note names."
+ '(style))
+
+(ly:add-interface
+ 'only-prebreak-interface
+ "Kill this grob after the line breaking process."
+ '())
+
+(ly:add-interface
+ 'parentheses-interface
+ "Parentheses for other objects."
+ '(padding stencils))
+
+(ly:add-interface
+ 'percent-repeat-interface
+ "Beat, Double and single measure repeats."
+ '(dot-negative-kern slash-negative-kern slope thickness))
+
+(ly:add-interface
+ 'piano-pedal-interface
+ "A piano pedal sign."
+ '())
+
+(ly:add-interface
+ 'piano-pedal-script-interface
+ "A piano pedal sign, fixed size."
+ '())
+
+(ly:add-interface
+ 'pitched-trill-interface
+ "A note head to indicate trill pitches."
+ '(accidental-grob))
+
+(ly:add-interface
+ 'rhythmic-grob-interface
+ "Any object with a duration. Used to determine which grobs are
+interesting enough to maintain a hara-kiri staff."
'())
+(ly:add-interface
+ 'spacing-options-interface
+ "Supports setting of spacing variables."
+ '(spacing-increment shortest-duration-space))
+(ly:add-interface
+ 'stanza-number-interface
+ "A stanza number, to be put in from of a lyrics line."
+ '())
-;; todo: figure out where to put this doco:
+(ly:add-interface
+ 'string-number-interface
+ "A string number instruction."
+ '())
-"
-Grob properties form a name space where you can set variables per
-object. Each object however, may have multiple functions. For
-example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
-is printed above or below the staff, it is a dynamic sign, and it is a
-kind of text.
+(ly:add-interface
+ 'stroke-finger-interface
+ "A right hand finger instruction."
+ '(digit-names))
-To reflect this different functions of a grob, procedures and variables
-are grouped into so-called interfaces. The dynamic text for example
-supports the following interfaces:
-@table @code
-@item font-interface
- The glyph is built from characters from a font, hence the
-@code{font-interface}. For objects supporting @code{font-interface}, you
-can select alternate fonts by setting @code{font-style},
-@code{font-point-size}, etc.
+;;; todo: this is not typesetting info. Move to interpretation.
+(ly:add-interface
+ 'tablature-interface
+ "An interface for any notes set in a tablature staff."
+ '())
-@item dynamic-interface
- Dynamic interface is not associated with any variable or function in
-particular, but this makes it possible to distinguish this grob from
-other similar grobs (like @code{TextScript}), that have no meaning of
-dynamics.
+(ly:add-interface
+ 'trill-spanner-interface
+ "A trill spanner."
+ '())
-@item text-interface
- This interface is for texts that are to be set using special routines
-to stack text into lines, using kerning, etc.
+(ly:add-interface
+ 'trill-pitch-accidental-interface
+ "An accidental for trill pitch."
+ '())
-@item general-grob-interface
- This interface is supported by all grob types.
-@end table
-"
+(ly:add-interface
+ 'unbreakable-spanner-interface
+ "A spanner that should not be broken across line breaks. Override
+with @code{breakable=##t}."
+ '(breakable))
+
+(ly:add-interface
+ 'vertically-spaceable-interface
+ "Objects that should be kept at constant vertical distances. Typically:
+@rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."
+ '())
projects / lilypond.git / blobdiff