)
;; put this in an alist?
-(define
+(define-public
all-user-grob-properties
(map
(apply define-grob-property x))
`(
- (X-extent-callback ,procedure? "procedure taking an grob and axis
+ (X-extent-callback ,procedure? "Procedure taking a grob and axis
argument, returning a number-pair. The return value is the extent of
the grob. If this value is set to @code{#f}, the object is empty in
the X direction.")
"Where to put text relative to balloon.")
(balloon-padding ,ly:dimension? "Text to add to help balloon")
(balloon-original-callback ,procedure? "The
-original molecule drawer to draw the balloon around.")
+original stencil drawer to draw the balloon around.")
(bar-size ,ly:dimension? "size of a bar line.")
(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? "Baseline skip to use for multiple lines of text.")
- (bass ,list? " musical-pitch, optional.")
(beam-thickness ,ly:dimension? "thickness, measured in staffspace.")
(beam-width ,ly:dimension? "width of the tremolo sign.")
(beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
(force-hshift ,number? "amount of collision_note_width that
overides automatic collision settings. This is used by
-@ref{note-collision-interface}.")
+@internalsref{note-collision-interface}.")
(fraction ,number-pair? "fraction of a time signature.")
(french-beaming ,boolean? "Use French
(grow-direction ,ly:dir? "crescendo or ,decrescendo?.")
(hair-thickness ,number? "thickness, measured in linethickness.")
- (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
(height ,ly:dimension? "in staffspace.")
(height-limit ,ly:dimension? "Maximum slur height: the longer the
(horizontal-shift ,integer? "integer that identifies ranking of
note-column for horizontal shifting. This is used by
-@ref{note-collision-interface}.")
+@internalsref{note-collision-interface}.")
(ideal-distances ,list? "(OBJ . (DIST . STRENGTH)) pairs.")
(inclinatum ,boolean? "is this neume an ,inclinatum?.")
(interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
- (inversion ,list? " musical-pitch, optional.")
(join-heads ,boolean? "Whether to join the noteheads of an ambitus grob with a vertical line.")
(kern ,ly:dimension? "amount of extra white
space to add. For barline, space after a thick line.")
noteheads in collisions, even if they have different note heads. The
smaller of the two heads will be rendered invisible. This used
polyphonic guitar notation. The value of this setting is used by
-@ref{note-collision-interface} .")
+@internalsref{note-collision-interface} .")
(merge-differently-dotted ,boolean? " Merge
noteheads in collisions, even if they have a different number of
dots. This normal notation for some types of polyphonic music. The
-value of this setting is used by @ref{note-collision-interface} .")
+value of this setting is used by @internalsref{note-collision-interface} .")
(meta ,list? "Contains meta information. It is an alist with the
entries @code{name} and @code{interfaces}.")
(print-function ,procedure? "Function taking grob as argument,
returning a Molecule object.")
- (molecule ,ly:molecule? "Cached output of the print-function.")
+ (stencil ,ly:stencil? "Cached output of the print-function.")
(new-accidentals ,list? "list of (pitch, accidental) pairs.")
(no-spacing-rods ,boolean? "read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM).")
(pitch-max ,ly:pitch? "FIXME, JUNKME")
(pitch-min ,ly:pitch? "FIXME, JUNKME")
- (pitches ,list? "list of musical-pitch.")
(quilisma ,boolean? "is this neume a ,quilisma?.")
(positions ,pair?
This is used in spacing. Making this larger will make the score tighter.")
(shortest-duration-space ,ly:dimension? "Start
with this much space for the shortest duration. This is explessed in @code{spacing-increment} as unit. See also
-@ref{spacing-spanner-interface}.")
+@internalsref{spacing-spanner-interface}.")
(shortest-playing-duration ,ly:moment? "duration of the shortest playing in that column.")
(shortest-starter-duration ,ly:moment? "duration of the shortest notes that starts exactly in this column.")
(side-relative-direction ,ly:dir? "if set: get the direction from a different object, and multiply by this.")
(spacing-increment ,number? "Add this much space for a doubled
duration. Typically, the width of a note head. See also
-@ref{spacing-spanner-interface}.")
+@internalsref{spacing-spanner-interface}.")
(spacing-procedure ,procedure? "procedure taking grob as
argument. This is called after before-line-breaking-callback, but
(avoid-note-head ,boolean? "if set, the stem of a chord does not pass through all note head, but start at the last note head. Used by tablature.")
(staff-padding ,ly:dimension?
- "Maintain this much space to the staff. It's
-effect is similar to the padding mechanism, but this will keep objects
-above and below the staff in a row more often, when the heights of the
-notes vary.
-")
-
+ "Maintain this much space between reference points
+and the staff. Its effect is to align objects of differing sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
(use-breve-rest ,boolean? "boolean that tells multi-measure-rest
to use a breve rest to represent the duration of 1 measure instead of
whole rest. It defaults to false. It is set to true when the
)
-(define all-internal-grob-properties
+(define-public all-internal-grob-properties
(map
(lambda (x)
(apply define-internal-grob-property x))
did it's job. This ensures that a positioning is only done once.")
- (script-molecule ,pair? "Index code for script -- internal, see script.cc.")
+ (script-stencil ,pair? "Index code for script -- internal, see script.cc.")
(flag-count ,number? "")
;; TODO: use interface for this!
(chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
- (chord ,pair? "?")
- (begin-of-line-visible ,boolean? "?")
- (quant-score ,number? "Beam quanting score
--- can be stored for debugging")
+ (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
+debugging")
(least-squares-dy ,number?
"ideal beam slope, without damping.")
(ligature-primitive-callback ,procedure? "callback that brews ligature head.")
(append
all-internal-grob-properties
all-user-grob-properties))
+
projects / lilypond.git / blobdiff