X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-interfaces.scm;h=59a97b69670867c6c85ed0dd4d8aae976374c9b7;hb=77831141fb83d0a046b0c78f06f8e58bef19ee68;hp=a6dfb3a63d6725a8df66b1a18ba582e039481cfa;hpb=d4ba37c298813e0f7008ef8388e126c34d8f8dd3;p=lilypond.git diff --git a/scm/define-grob-interfaces.scm b/scm/define-grob-interfaces.scm index a6dfb3a63d..59a97b6967 100644 --- a/scm/define-grob-interfaces.scm +++ b/scm/define-grob-interfaces.scm @@ -1,10 +1,26 @@ -;;;; interface-description.scm -- part of generated backend documentation +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2007 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen +;;;; +;;;; LilyPond is free software: you can redistribute it and/or modify +;;;; it under the terms of the GNU General Public License as published by +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . + +;; The interfaces defined here generally have no code (e.g., +;; dynamic-interface), or have callbacks defined entirely in +;; scheme. Others interfaces are defined in lily/*.cc with the +;; ADD_INTERFACE function. ;; should include default value? @@ -15,6 +31,37 @@ note)." '()) +(ly:add-interface + 'ambitus-interface + "The line between note heads for a pitch range." + '(gap + length-fraction + maximum-gap + note-heads + thickness)) + +(ly:add-interface + 'bar-line-interface + "Print a special bar symbol. It replaces the regular bar +symbol with a special symbol. The argument @var{bartype} +is a string which specifies the kind of bar line to print. + +The list of allowed glyphs and predefined bar lines can be +found in @file{scm/bar-line.scm}. + +@code{gap} is used for the gaps in dashed bar lines." + '(allow-span-bar + bar-extent + gap + glyph + glyph-name + hair-thickness + has-span-bar + kern + rounded + thin-kern + thick-thickness)) + (ly:add-interface 'bass-figure-interface "A bass figure text." @@ -28,7 +75,15 @@ note)." (ly:add-interface 'bend-after-interface "A doit or drop." - '(thickness delta-position)) + '(delta-position + thickness)) + +(ly:add-interface + 'clef-modifier-interface + "The number describing transposition of the clef, placed below +or above clef sign. Usually this is 8 (octave transposition) +or 15 (two octaves), but LilyPond allows any integer here." + '()) (ly:add-interface 'dynamic-interface @@ -40,34 +95,81 @@ note)." "Dynamic line spanner." '(avoid-slur)) +(ly:add-interface + 'dynamic-text-interface + "An absolute text dynamic." + '(right-padding)) + (ly:add-interface 'dynamic-text-spanner-interface "Dynamic text spanner." '(text)) +(ly:add-interface + 'episema-interface + "An episema line." + '()) + (ly:add-interface 'finger-interface "A fingering instruction." '()) +(ly:add-interface + 'footnote-interface + "Make a footnote." + '(automatically-numbered + footnote + footnote-text + numbering-assertion-function)) + +(ly:add-interface + 'footnote-spanner-interface + "Make a footnote spanner." + '(footnote-text + spanner-placement)) + (ly:add-interface 'fret-diagram-interface - "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)) + "A fret diagram" + '(align-dir + dot-placement-list + fret-diagram-details + size + thickness)) + +(ly:add-interface + 'glissando-interface + "A glissando." + '(glissando-index)) (ly:add-interface 'grace-spacing-interface "Keep track of durations in a run of grace notes." - '(columns common-shortest-duration)) + '(columns + common-shortest-duration)) + +(ly:add-interface + 'inline-accidental-interface + "An inlined accidental (i.e. normal accidentals, cautionary +accidentals)." + '()) + +(ly:add-interface + 'instrument-specific-markup-interface + "Instrument-specific markup (like fret boards or harp pedal diagrams)." + '(fret-diagram-details graphical harp-pedal-details size thickness)) (ly:add-interface 'key-cancellation-interface "A key cancellation." '()) +(ly:add-interface + 'ligature-head-interface + "A note head that can become part of a ligature." + '()) + (ly:add-interface 'ligature-bracket-interface "A bracket indicating a ligature in the original edition." @@ -93,6 +195,12 @@ thickness)) "A rehearsal mark." '()) +(ly:add-interface + 'measure-counter-interface + "A counter for numbering measures." + '(columns + count-from)) + (ly:add-interface 'metronome-mark-interface "A metronome mark." @@ -106,7 +214,7 @@ thickness)) (ly:add-interface 'note-name-interface "Note names." - '(style)) + '()) (ly:add-interface 'only-prebreak-interface @@ -116,7 +224,16 @@ thickness)) (ly:add-interface 'parentheses-interface "Parentheses for other objects." - '(padding stencils)) + '(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 @@ -142,7 +259,20 @@ interesting enough to maintain a hara-kiri staff." (ly:add-interface 'spacing-options-interface "Supports setting of spacing variables." - '(spacing-increment shortest-duration-space)) + '(spacing-increment + shortest-duration-space)) + +(ly:add-interface + 'span-bar-interface + "A bar line that is spanned between other barlines. + This interface is used for bar lines that connect different + staves." + '(glyph-name + elements + pure-Y-common + pure-relevant-grobs + pure-relevant-items + pure-relevant-spanners)) (ly:add-interface 'stanza-number-interface @@ -161,14 +291,16 @@ interesting enough to maintain a hara-kiri staff." (ly:add-interface 'system-start-text-interface - "A text at the beginning of a system." - '(text long-text collapse-height style)) + "Text in front of the system." + '(long-text + self-alignment-X + self-alignment-Y + text)) -;;; todo: this is not typesetting info. Move to interpretation. (ly:add-interface - 'tablature-interface - "An interface for any notes set in a tablature staff." - '()) + 'tab-note-head-interface + "A note head in tablature." + '(details display-cautionary span-start)) (ly:add-interface 'trill-spanner-interface @@ -187,7 +319,6 @@ 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." + 'volta-interface + "A volta repeat." '())