X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-interfaces.scm;h=fb6088abf58c4d42fc724121bde4369397f4c37b;hb=4010f8d7625cae0b97280b14db617641bb989203;hp=f181a74de65b9f0d3c367d867118fd052a2b3eb0;hpb=44cd71d183c9fed49942c3e5322ecf34a320dce2;p=lilypond.git diff --git a/scm/define-grob-interfaces.scm b/scm/define-grob-interfaces.scm index f181a74de6..fb6088abf5 100644 --- a/scm/define-grob-interfaces.scm +++ b/scm/define-grob-interfaces.scm @@ -1,48 +1,81 @@ ;;;; interface-description.scm -- part of generated backend documentation ;;;; ;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2004 Han-Wen Nienhuys +;;;; +;;;; (c) 1998--2007 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen -; should include default value? +;; should include default value? + + +(ly:add-interface + '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 'fret-diagram-interface - "A fret diagram" - '(align-dir barre-type dot-color dot-radius finger-code fret-count - size string-count thickness) -) + "A fret diagram." + '(align-dir barre-type dot-color dot-radius finger-code fret-count +label-dir number-type size string-count xo-font-magnification +mute-string open-string orientation string-fret-finger-combinations +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 + '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 - 'lyric-syllable-interface - "a single piece of lyrics" + 'ligature-interface + "A ligature." '()) (ly:add-interface @@ -50,56 +83,106 @@ "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." + '()) (ly:add-interface '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 name" + '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 'piano-pedal-interface - "A piano pedal sign" + "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 rhythmic basis. Used to determine which grobs -are interesting enough to maintain a hara-kiri staff." - '() - ) + "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" - '() - ) + "A stanza number, to be put in from of a lyrics line." + '()) + +(ly:add-interface + 'string-number-interface + "A string number instruction." + '()) + +(ly:add-interface + 'stroke-finger-interface + "A right hand finger instruction." + '(digit-names)) ;;; todo: this is not typesetting info. Move to interpretation. (ly:add-interface 'tablature-interface - "An interface for any notes set in a tablature staff" + "An interface for any notes set in a tablature staff." + '()) + +(ly:add-interface + 'trill-spanner-interface + "A trill spanner." '()) +(ly:add-interface + 'trill-pitch-accidental-interface + "An accidental for trill pitch." + '()) + +(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: +@internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts." + '())