X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=3fb91c199e76d461901b443133095ea102f8c738;hb=f2d9875f7adfb9c932f1df70690de8de1e59adcc;hp=1319cf645d225343d4f39f149284d135534dbbd2;hpb=78ced01f86872235117cb7d11afa59d3f220e32c;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index 1319cf645d..3fb91c199e 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -37,9 +37,12 @@ callback for @code{after-line-breaking}.") @code{0}: around center of width, @code{1}: right side.") (allow-loose-spacing ,boolean? "If set, column can be detached from main spacing.") + (allow-span-bar ,boolean? "If false, no inter-staff barline will +be created below this barline.") (alteration ,number? "Alteration numbers for accidental.") (alteration-alist ,list? "List of @code{(@var{pitch} . @var{accidental})} pairs for key signature.") + (annotation ,string? "Annotate a grob for debug purposes.") (arpeggio-direction ,ly:dir? "If set, put an arrow on the arpeggio squiggly line.") (arrow-length ,number? "Arrow length.") @@ -135,7 +138,7 @@ middle@tie{}C.") (clip-edges ,boolean? "Allow outward pointing beamlets at the edges of beams?") (collapse-height ,ly:dimension? "Minimum height of system start -delimiter. If equal or smaller, the bracket is removed.") +delimiter. If equal or smaller, the bracket/brace/line is removed.") (color ,color? "The color of this grob.") (common-shortest-duration ,ly:moment? "The most common shortest note length. This is used in spacing. Enlarging this sets the score @@ -314,7 +317,7 @@ if this column is the start of a system.") (line-positions ,list? "Vertical positions of staff lines.") (line-thickness ,number? "The thickness of the tie or slur contour.") - (long-text ,markup? "Text markup. See @usermanref{Text + (long-text ,markup? "Text markup. See @ruser{Text markup}.") (max-beam-connect ,integer? "Maximum number of beams to connect @@ -406,11 +409,14 @@ at a column with a negative penalty.") whether to put a page turn at this column. Can be @code{force} or @code{allow}.") (parenthesized ,boolean? "Parenthesize this grob.") - (positions ,pair? "Pair of staff coordinates @code{(@var{left} -. @var{right})}, where both @var{left} and @var{right} are in -@code{staff-space} units of the current staff. LilyPond uses these -values to select which slur candidate positions to use; if extreme -positions are requested, LilyPond selects the closest positions.") + (positions ,number-pair? "Pair of staff coordinates +@code{(@var{left} . @var{right})}, where both @var{left} and +@var{right} are in @code{staff-space} units of the current staff. +For slurs, this value selects which slur candidate to use; if +extreme 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.") (ratio ,number? "Parameter for slur shape. The higher this number, the quicker the slur attains its @code{height-limit}.") @@ -517,7 +523,7 @@ through flag on.") typeset. Valid choices depend on the @code{stencil} callback reading this property.") - (text ,markup? "Text markup. See @usermanref{Text markup}.") + (text ,markup? "Text markup. See @ruser{Text markup}.") ;;FIXME -- Should both be the same? (text-direction ,ly:dir? "This controls the ordering of the words. The default @code{RIGHT} is for roman text. Arabic or Hebrew @@ -601,6 +607,9 @@ function is to protect objects from being garbage collected.") (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") + (bar-extent ,number-pair? "The Y-extent of the actual barline. +This may differ from 'Y-extent because it does not include the dots in +a repeat barline.") (bars ,ly:grob-array? "A list of bar line pointers.") (beam ,ly:grob? "A pointer to the beam, if applicable.") (bounded-by-me ,ly:grob-array? "A list of spanners that have this @@ -648,6 +657,8 @@ columns.") (note-head ,ly:grob? "A single note head.") (note-heads ,ly:grob-array? "A list of note head grobs.") + (padding-pairs ,list? "An alist mapping @code{(@var{name} . @var{name})} +to distances.") (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano pedal.") (pure-Y-common ,ly:grob? "A cache of the @@ -723,7 +734,7 @@ entries @code{name} and @code{interfaces}.") did its job. This ensures that a positioning is only done once.") (pure-Y-extent ,number-pair? "The estimated height of a system.") - (quant-score ,string? "The Beam quanting score -- can be stored for + (quant-score ,string? "The beam quanting score; stored for debugging.") (quantize-position ,boolean? "If set, a vertical alignment is aligned to be within staff spaces.")