X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=77e3202d9025c8894df995f0d54ae828072bb6c8;hb=4db19a76f2a36fe112d45bafba4cf065be6ebca8;hp=d17171b06873aecef7af393a0c093269b6307240;hpb=fd55150e792a7963287f5346206c8491de86d915;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index d17171b068..77e3202d90 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -42,12 +42,9 @@ called first. The functions take a grob and axis argument. ") (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.") (accidentals ,list? "List of alteration numbers.") - - + (align-dir ,ly:dir? "Which side to align? @code{-1}: left side, @code{0}: around center of width, @code{1}: right side.") -;;TODO -- change to fret-alignment? - (alignment ,ly:dir? "Alignment for fret diagram. See @code {align-dir}.") (arch-angle ,number? "Turning angle of the hook of a system brace" ) (arch-height ,ly:dimension? "Height of the hook of a system brace.") (arch-thick ,number? "Thickness of the hook of system brace.") @@ -84,8 +81,6 @@ original stencil drawer to draw the balloon around.") (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.") (barre-type ,symbol? "Type of barre indication used in a fret diagram. Choices include @code{curved} and @code{straight}.") - (barre-vertical-offset ,number? "Offset for barre indication on fret -diagram, from center of dot, in terms of dot radius.") (base-shortest-duration ,ly:moment? "Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.") (baseline-skip ,ly:dimension? "Distance between base lines of @@ -111,10 +106,9 @@ beaming patterns from stem to stem inside a beam.") called before line breaking, but after splitting breakable items at potential line breaks.") (between-cols ,pair? "Where to attach a loose column to") - (bezier-height ,number? "Height of bezier sandwich used for curved -barre indicator in fret diagrams.") - (bezier-thick, ,number? "Thickness of bezier sandwich used for curved -barre indicator in fret diagrams.") + (bracket-flare ,number-pair? "A pair of numbers specifying how +much edges of brackets should slant outward. Value 0.0 means straight +edges") (bracket-thick ,number? "width of a system start bracket.") (break-align-symbol ,symbol? "This key is used for aligning and spacing breakable items.") @@ -174,11 +168,6 @@ line).") ;; [FIXME: use dash-period/dash length; see text-spanner] (dashed ,number? " number representing the length of the dashes.") - (neutral-direction ,ly:dir? "Which direction to take in the -center of the staff.") - (neutral-position ,number? "Position (in half staff spaces) where -to flip the direction of custos stem.") - ;; todo: why is this tunable? (dir-function ,procedure? "The function to determine the @@ -196,23 +185,13 @@ mean center distance weighted per note ") (direction ,ly:dir? "Up or down, left or right?") - (dot-color ,symbol? "Color of dots in fret diagram. Options include + (dot-color ,symbol? "Color of dots. Options include @code{black} and @code{white}.") - (dot-label-font-mag ,number? "Magnification of font used to label dots in -fret diagram.") - (dot-position ,number? "Position of dot for fret diagram, in terms of -fret spacing. 0.5 is middle of fret space, 1.0 is on bottom fret line, -0.0 is on top fret line. Generally slightly above 0.5.") - (dot-radius ,number? "Radius of dots used in fret diagrams, in terms of -fret spacing.") + (dot-radius ,number? "Radius of dots.") (dot-count ,integer? "The number of dots.") (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.") (edge-height ,pair? "A pair of number specifying the heights of the vertical edges '(@var{left-height} . @var{right-height}).") - (bracket-flare ,number-pair? "A pair of numbers specifying how -much edges of brackets should slant outward. Value 0.0 means straight -edges") - (edge-text ,pair? "A pair specifying the texts to be set at the edges '(@var{left-text} . @var{right-text}).") (expand-limit ,integer? "maximum number of measures expanded in church rests.") @@ -241,11 +220,6 @@ Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset. attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.") (finger-code ,symbol? "Code for the type of fingering indication in a fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.") - (finger-xoffset ,number? "X offset of the text labeling fingering below -the string of a fret-diagram, in units of string spaces.") - (finger-yoffset ,number? "Y offset of the text labeling fingering below -the string of a fret-diagram, in units of fret spaces.") - (flag-style ,symbol? "a string determining what style of flag-glyph is typeset on a Stem. Valid options include @code{()} and @@ -283,8 +257,7 @@ signature object.") (french-beaming ,boolean? "Use French beaming style for this stem. The stem will stop at the innermost beams.") (fret-count ,integer? "The number of frets in a fret diagram.") - (fret-label-vertical-offset ,number? "Vertical offset of text used to -label the top fret in a fret diagram.") + ;; ugh: double, change. (full-size-change ,boolean? "Don't make a change clef smaller.") (non-default ,boolean? "Set for manually specified clefs.") @@ -320,8 +293,6 @@ bar line, this is the amount of space after a thick line.") (knee-spacing-correction ,number? "Factor for the optical correction amount for kneed beams. Set between 0 for no correction and 1 for full correction.") - (label-font-magnification ,number? "Magnification of font used to -label the top fret on a fret diagram") (layer ,number? "The output layer [0..2]: layers define the order of printing objects. Objects in lower layers are overprinted by objects in higher layers.") @@ -364,6 +335,11 @@ this long. This requires an appropriate routine for the should move (after padding).") (print-function ,procedure? "Function taking grob as argument, returning a @code{Stencil} object.") + (neutral-direction ,ly:dir? "Which direction to take in the +center of the staff.") + (neutral-position ,number? "Position (in half staff spaces) where +to flip the direction of custos stem.") + (new-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})} pairs.") (note-names ,vector? "Vector of strings containing names for @@ -430,8 +406,7 @@ note that starts here.") "Multiply direction of @code{direction-source} with this to get the direction of this object.") -;;TODO -- change size to fret-diagram-size - (size ,number? "Size of fret diagram.") + (size ,number? "Size of object, relative to standard size.") (slope ,number? "The slope of this object.") (slope-limit ,number? "Set slope to zero if slope is running away steeper than this.") @@ -478,8 +453,6 @@ stems that are placed in tight configurations. For opposite directions, this amount is the correction for two normal sized stems that overlap completely.") (string-count ,integer? "The number of strings in a fret diagram.") - (string-label-font-mag ,number? "Mangification for font used to label -finger indications below strings in fret diagram") (style ,symbol? "This setting determines in what style a grob is typeset. Valid choices depend on the @code{print-function} that is reading this property.") @@ -489,17 +462,12 @@ reading this property.") @code{linethickness}.") (thickness ,number? "Bar line thickness, measured in @code{linethickness}.") -;;TODO -- change to fret-thickness - (thickness ,number? "Thickness of fret and string lines in a fret -diagram. Multiplier on bar thickness.") (thin-kern ,number? "The space after a hair-line in a bar line.") (forced-distance ,ly:dimension? "A fixed distance between object reference points in an alignment.") (threshold ,number-pair? "(@var{min} . @var{max}), where @var{min} and @var{max} are dimensions in staff space.") - (top-fret-thickness ,number? "Thickness of the top fret in a fret -diagram, as a multiplier of the standard fret thickness.") (transparent ,boolean? "This is almost the same as setting @code{print-function} to @code{#f}, but this retains the dimensions of this grob, which means that grobs can be erased individually.") @@ -526,12 +494,6 @@ happen?") words in texts.") (width ,ly:dimension? "The width of a grob measured in staff space.") (x-gap ,ly:dimension? "The horizontal gap between note head and tie.") - (xo-font-mag ,number? "Magnification for the font used to label mute -and open strings in a fret diagram.") - (xo-horizontal-offset ,number? "Horizontal offset for characters used -to label mute and open strings in a fret diagram.") - (xo-padding ,number? "Vertical padding for mute and open indicators -in fret diagram.") (y-free ,ly:dimension? "The minimal vertical gap between slur and note heads or stems.") (y-offset ,ly:dimension? "Extra vertical offset for ties away @@ -636,7 +598,7 @@ entries @code{name} and @code{interfaces}.") (chord-tremolo ,boolean? "if set, this beam is a tremolo. ") (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.") (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.") - (quant-score ,number? "Beam quanting score -- can be stored for + (quant-score ,string? "Beam quanting score -- can be stored for debugging") (least-squares-dy ,number? "ideal beam slope, without damping.")