X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=6434c15c4687cf5f0710d999200985112d1d2f2e;hb=b586253323a60a4ca9acab1a53759504af88b944;hp=25ad8648336dcd0257af4bb5d990b9b66fd02f31;hpb=28f3294954eff1f263d3b2e3de1c520f4d2fbdfc;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index 25ad864833..6434c15c46 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -108,6 +108,7 @@ default length of the beamlet to the right. The actual length of a beamlet is determined by taking either the default length or the length specified by @code{beamlet-max-length-proportion}, whichever is smaller.") + (beam-gap ,number-pair? "Size of a gap in a @code{Beam}.") (beamlet-max-length-proportion ,pair? "The maximum length of a beamlet, as a proportion of the distance between two adjacent stems.") (before-line-breaking ,boolean? "Dummy property, used to trigger @@ -200,6 +201,9 @@ this grob looks as a continued break.") (control-points ,list? "List of offsets (number pairs) that form control points for the tie, slur, or bracket shape. For B@'eziers, this should list the control points of a third-order B@'ezier curve.") + (count-from ,integer? "The first measure in a measure count +receives this number. The following measures are numbered in +increments from this initial value.") ;; ;; d @@ -276,16 +280,20 @@ problem, we pad each item by this amount (by adding the @q{car} on the left side of the item and adding the @q{cdr} on the right side of the item). In order to make a grob take up no horizontal space at all, set this to @code{(+inf.0 . -inf.0)}.") - (extra-X-extent ,number-pair? "A grob is enlarged in -X@tie{}dimension by this much.") - (extra-Y-extent ,number-pair? "A grob is enlarged in -Y@tie{}dimension by this much.") ;; ;; f ;; (flag-count ,number? "The number of tremolo beams.") + (flat-positions ,list? "Flats in key signatures are placed +within the specified ranges of staff-positions. The general form +is a list of pairs, with one pair for each type of clef, in order +of the staff-position at which each clef places C: +@code{(alto treble tenor soprano baritone mezzosoprano bass)}. +If the list contains a single element it applies for all clefs. +A single number in place of a pair sets accidentals within the octave +ending at that staff-position.") (font-encoding ,symbol? "The font encoding is the broadest category for selecting a font. Currently, only lilypond's system fonts (Emmentaler) are using this property. Available @@ -424,8 +432,15 @@ read from the NonMusicalPaperColumn that begins the measure.") by glissandi?") (glyph ,string? "A string determining what @q{style} of glyph is typeset. Valid choices depend on the function that is reading this -property.") - (glyph-name ,string? "The glyph name within the font.") +property. + +In combination with (span) bar lines, it is a string resembling the +bar line appearance in ASCII form.") + (glyph-name ,string? "The glyph name within the font. + +In the context of (span) bar lines, @var{glyph-name} represents +a processed form of @code{glyph}, where decisions about line breaking +etc. are already taken.") (glyph-name-alist ,list? "An alist of key-string pairs.") (graphical ,boolean? "Display in graphical (vs. text) form.") (grow-direction ,ly:dir? "Crescendo or decrescendo?") @@ -474,6 +489,9 @@ units.") slur, the closer it is to this height.") (hide-tied-accidental-after-break ,boolean? "If set, an accidental that appears on a tied note after a line break will not be displayed.") + (horizon-padding ,number? "The amount to pad the axis +along which a @code{Skyline} is built for the +@code{side-position-interface}.") (horizontal-shift ,integer? "An integer that identifies ranking of @code{NoteColumn}s for horizontal shifting. This is used by @rinternals{note-collision-interface}.") @@ -716,6 +734,8 @@ positions are requested, the closest one is taken.") (prefer-dotted-right ,boolean? "For note collisions, prefer to shift dotted up-note to the right, rather than shifting just the dot.") + (protrusion ,number? "In an arpeggio bracket, the length of the +horizontal edges.") ;; ;; r @@ -740,6 +760,7 @@ of an object (e.g., between note and its accidentals).") (rotation ,list? "Number of degrees to rotate this object, and what point to rotate around. For example, @code{'(45 0 0)} rotates by 45 degrees around the center of this object.") + (rounded ,boolean? "Decide whether lines should be drawn rounded or not.") (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure rest when the length of a measure is between two values of @code{usable-duration-logs}. For example, displays a breve instead of a whole @@ -753,14 +774,24 @@ in a 3/2 measure.") for stems that are placed in tight configurations. This amount is used for stems with the same direction to compensate for note head to stem distance.") - (script-priority ,number? "A sorting key that determines in what -order a script is within a stack of scripts.") + (script-priority ,number? "A key for determining the order of +scripts in a stack, by being added to the position of the script in +the user input, the sum being the overall priority. Smaller means +closer to the head.") (self-alignment-X ,number? "Specify alignment of an object. The value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical values may also be specified.") (self-alignment-Y ,number? "Like @code{self-alignment-X} but for the Y@tie{}axis.") + (sharp-positions ,list? "Sharps in key signatures are placed +within the specified ranges of staff-positions. The general form +is a list of pairs, with one pair for each type of clef, in order +of the staff-position at which each clef places C: +@code{(alto treble tenor soprano baritone mezzosoprano bass)}. +If the list contains a single element it applies for all clefs. +A single number in place of a pair sets accidentals within the octave +ending at that staff-position.") (shorten-pair ,number-pair? "The lengths to shorten a text-spanner on both sides, for example a pedal bracket. Positive values shorten the text-spanner, while negative values lengthen it.") @@ -798,6 +829,8 @@ slashes in percent repeat glyphs. Larger values bring the two elements closer together.") (slope ,number? "The slope of this object.") (slur-padding ,number? "Extra distance between slur and script.") + (snap-radius ,number? "The maximum distance between two objects that +will cause them to snap to alignment along an axis.") (space-alist ,list? "A table that specifies distances between prefatory items, like clef and time-signature. The format is an alist of spacing tuples: @code{(@var{break-align-symbol} @var{type} @@ -1031,7 +1064,6 @@ constructed from a whole number of squiggles.") dynamic spanners.") (all-elements ,ly:grob-array? "An array of all grobs in this line. Its function is to protect objects from being garbage collected.") - (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.") (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") @@ -1070,8 +1102,6 @@ in addition to notes and stems.") a whole system.") (footnotes-after-line-breaking ,ly:grob-array? "Footnote grobs of a broken system.") - (full-score-pure-minimum-translations ,list? "A list of translations -for a full score's worth of grobs.") (glissando-index ,integer? "The index of a glissando in its note column.") @@ -1096,6 +1126,8 @@ empty in a particular staff, then that staff is erased.") for this column.") (melody-spanner ,ly:grob? "The @code{MelodyItem} object for a stem.") + (minimum-translations-alist ,list? "An list of translations for a given +start and end point.") (neighbors ,ly:grob-array? "The X-axis neighbors of a grob. Used by the pure-from-neighbor-interface to determine various grob heights.")