]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-grob-properties.scm
* lily/melisma-engraver.cc (try_music): use melismaBusyProperties.
[lilypond.git] / scm / define-grob-properties.scm
index cf6484e9add38a7defcdecbe9ff6f7252595aae7..6bcb585d5336385d450bbe3c44e2ba42794d34a9 100644 (file)
@@ -61,7 +61,9 @@ the grob to the nearest open space.
 
 (grob-property-description 'accidental-grobs list? "Alis with (NOTENAME . GROBLIST) entries")
 (grob-property-description 'accidentals list? "List of alteration numbers.")
-(grob-property-description 'add-stem boolean? "does this flexa shape require an additional stem on the left side?.")
+(grob-property-description 'add-cauda boolean? "does this flexa require an additional cauda on the left side?.")
+(grob-property-description 'add-join boolean? "is this ligature head joined with the next one by a vertical line?")
+(grob-property-description 'add-stem boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
 (grob-property-description 'adjust-if-on-staffline boolean? "If this grob is on a staff line, adjust its appearance, so that it better fits into the staff.  E.g., if set true on stem grobs, flares of mensural flags will always be aligned with the staff lines, regardless if the associated note head is printed on a staff line or inbetween.")
 (grob-property-description 'after-line-breaking-callback procedure? "Procedure taking a grob as argument.
 This procedure is called (using dependency resolution) after line breaking. Return value is ignored.")
@@ -126,6 +128,7 @@ column as start/begin point. Only columns that have grobs or act as bounds are s
 (grob-property-description 'c0-position integer? "integer indicating the position of central C.")
 (grob-property-description 'cautionary-style symbol? "style  of cautionary accidentals. Choices are 'smaller (one size smaller) or 'parentheses.")
 (grob-property-description 'cautionary boolean? "is this a cautionary accidentals.?")
+(grob-property-description 'cavum boolean? "is this neume outlined?.")
 
 (grob-property-description 'center-element ly:grob? "grob which will
 be at the center of the group after aligning (when using
@@ -177,7 +180,10 @@ mean centre distance weighted per note
 (grob-property-description 'dot-count integer? "number of dots.")
 (grob-property-description 'duration-log integer? "2-log of the notehead duration, i.e. 0=whole note, 1 = half note, etc.")
 (grob-property-description 'edge-height pair? "a cons that specifies the heights of the vertical edges '(LEFT-height . RIGHT-height).")
-(grob-property-description 'edge-widen pair? "a cons that specifies the widths of the slanted edges '(LEFT-width . RIGHT-width).")
+(grob-property-description 'bracket-flare number-pair? "a pair
+ that specifies how much edges of brackets  should slant outward.
+ Value 0.0 means straight edges")
+
 (grob-property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text).")
 (grob-property-description 'elements grob-list? "list of grobs, type depending on the Grob where this is set in.")
 (grob-property-description 'expand-limit integer? "maximum number of measures expanded in church rests.")
@@ -220,10 +226,6 @@ style-sheet's normal size, -1 is smaller, +1 is bigger.")
 (grob-property-description 'font-series symbol? "partial font definition: medium, bold.")
 (grob-property-description 'font-shape symbol? "partial font definition: upright or italic.")
 
-(grob-property-description 'font-style symbol? "a precooked set of font
-definitions, eg. finger volta timesig mark script large Large
-dynamic.")
-
 (grob-property-description 'force-hshift number? "amount of
 collision_note_width that overides automatic collision settings. This
 is used by @ref{note-collision-interface}.")
@@ -283,16 +285,14 @@ space to add. For barline, space after a thick line.")
 (grob-property-description 'layer number? "The output layer [0..2].  The default is 1.")
 
 (grob-property-description 'left-position number? "position of left part of spanner.")
-(grob-property-description 'right-position number? "position of right part of spanner.")
 (grob-property-description 'left-padding ly:dimension? "space left of accs.")
 
-(grob-property-description 'left-widen boolean? "Whether the left edge of a piano pedal bracket should be widened by the first element of edge-widen.")
-
 (grob-property-description 'length ly:dimension? "Stem length for unbeamed stems, only for user override.")
 (grob-property-description 'lengths list? "Stem length given
 multiplicity of flag.  The Nth element of the list gives the stem
 length of a note with N flags.
 ")
+(grob-property-description 'linea boolean? "attach vertical lines to this neume?.")
 (grob-property-description 'line-count integer? "Number of staff
 lines.  If you want to override this for staffs individually, you must
 use @code{\outputproperty}. @code{\property .. \override} will not
@@ -357,7 +357,6 @@ provided in @code{input/regression/molecule-hacking.ly}.
 (grob-property-description 'oriscus boolean? "is this neume an oriscus?.")
 (grob-property-description 'enclose-bounds boolean? "whether a text spanner should extend to the outer edge of the spanned notes")
 (grob-property-description 'padding ly:dimension? "add this much extra space between objects that are next to each other.")
-(grob-property-description 'pedal-type symbol? "Style of piano pedal: text, bracket or mixed.")
 (grob-property-description 'pedal-text ly:grob? "Pointer to the text of a mixed-style piano pedal.")
 (grob-property-description 'penalty number? "Penalty for breaking at
 this column. 10000 or more means forbid linebreak, -10000 or less
@@ -374,9 +373,11 @@ as a real penalty.")
 (grob-property-description 'positions pair? "cons of staff positions (LEFT . RIGHT")
 (grob-property-description 'prefix-set number? "DOCME")
 (grob-property-description 'ratio number? "Slur parameter.  See height-limit.")
+(grob-property-description 'remove-first boolean?
+                          "Remove the first staff of a orchestral score?")
 (grob-property-description 'right-padding ly:dimension? "space right of accs.")
+(grob-property-description 'right-position number? "position of right part of spanner.")
 (grob-property-description 'right-trim-amount ly:dimension? "shortening of the lyric extender on the right.")
-(grob-property-description 'right-widen boolean? "Whether the right edge of a piano pedal bracket should be widened by the second element of edge-widen")
 (grob-property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts.")
 (grob-property-description 'self-alignment-X number-or-grob? "real number: -1 =
 left aligned, 0 = center, 1 right-aligned in X direction.
@@ -387,7 +388,6 @@ reference point.
 
 TODO: revise typing.")
 (grob-property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis.")
-(grob-property-description 'semivocalis boolean? "is this neume a lisquescending one?.")
 (grob-property-description 'shorten ly:dimension? "the amount of space that a stem should be shortened (DOCME!)")
 (grob-property-description 'shorten-pair number-pair? "the length on each side to shorten a text-spanner, for example a pedal bracket")
 (grob-property-description 'common-shortest-duration ly:moment?
@@ -435,8 +435,8 @@ the Nth element of the list gives the amount stem shortening of a note with N fl
 (grob-property-description 'style symbol? "a string determining what style of  glyph is typeset. Valid choices depend on the function that is reading this property. .")
 (grob-property-description 'support-head ly:grob? "the note head at
 one end of the stem.")
-(grob-property-description 'text markup? "Text markup.  See reference manual for more information.")
-(grob-property-description 'text-start boolean? "Indicator for whether a piano pedal bracket has leading text, such as Ped.")
+(grob-property-description 'text markup? "Text markup.  See the
+notation manual for more information.")
 (grob-property-description 'thick-thickness number? "thickness, measured in stafflinethickness.")
 (grob-property-description 'thickness number? "thickness, measured in stafflinethickness.")
 (grob-property-description 'thin-kern number? "space after a hair-line.")
@@ -447,6 +447,7 @@ one end of the stem.")
 same as setting molecule-callback to #f, but this retains the
 dimensions of this grob, which means that you can erase grobs
 individually. .")
+(grob-property-description 'tremolo-flag ly:grob? "The tremolo object on a stem.")
 (grob-property-description 'bracket-visibility boolean-or-symbol? "
 This controls the visibility of the tuplet bracket.
 Setting it to false will prevent printing of the
@@ -531,10 +532,13 @@ staff in a row more often, when the heights of the notes vary.
 (grob-property-description 'grace-space-factor number? "space grace at this fraction of the increment.")
 (grob-property-description 'position-callbacks list? "list of
 functions set spanner positions.")
-(grob-property-description 'join-left boolean? "is this ligature head joined with the previous one?")
+
+;;; Junk me, replace it by add-join.
+(grob-property-description 'join-left boolean? "is this ligature head joined with the previous one by a vertical line?")
+
 (grob-property-description 'join-left-amount number? "DOCME")
 
-(grob-property-description 'delta-pitch number? "the interval between this and the neighbouring note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
+(grob-property-description 'delta-pitch number? "the interval between this and the next note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
 (grob-property-description 'head-width ly:dimension? "width of this ligature head")
 (grob-property-description 'primitive integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. [TODO: change this]")
 (grob-property-description 'minimum-beam-collision-distance ly:dimension?