LEFT | RIGHT |
1 ;;;; This file is part of LilyPond, the GNU music typesetter. | 1 ;;;; This file is part of LilyPond, the GNU music typesetter. |
2 ;;;; | 2 ;;;; |
3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl> | 3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl> |
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> | 4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> |
5 ;;;; | 5 ;;;; |
6 ;;;; LilyPond is free software: you can redistribute it and/or modify | 6 ;;;; LilyPond is free software: you can redistribute it and/or modify |
7 ;;;; it under the terms of the GNU General Public License as published by | 7 ;;;; it under the terms of the GNU General Public License as published by |
8 ;;;; the Free Software Foundation, either version 3 of the License, or | 8 ;;;; the Free Software Foundation, either version 3 of the License, or |
9 ;;;; (at your option) any later version. | 9 ;;;; (at your option) any later version. |
10 ;;;; | 10 ;;;; |
(...skipping 20 matching lines...) Expand all Loading... |
31 (apply define-grob-property x)) | 31 (apply define-grob-property x)) |
32 | 32 |
33 `( | 33 `( |
34 ;; | 34 ;; |
35 ;; a | 35 ;; a |
36 ;; | 36 ;; |
37 (add-stem-support ,boolean? "If set, the @code{Stem} object is | 37 (add-stem-support ,boolean? "If set, the @code{Stem} object is |
38 included in this script's support.") | 38 included in this script's support.") |
39 (after-line-breaking ,boolean? "Dummy property, used to trigger | 39 (after-line-breaking ,boolean? "Dummy property, used to trigger |
40 callback for @code{after-line-breaking}.") | 40 callback for @code{after-line-breaking}.") |
41 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side, | 41 (align-dir ,ly:dir? "Which side to align? @w{@code{-1}}: left side, |
42 @code{0}: around center of width, @code{1}: right side.") | 42 @code{0}: around center of width, @code{1}: right side.") |
43 (allow-loose-spacing ,boolean? "If set, column can be detached | 43 (allow-loose-spacing ,boolean? "If set, column can be detached |
44 from main spacing.") | 44 from main spacing.") |
45 (allow-span-bar ,boolean? "If false, no inter-staff bar line will | 45 (allow-span-bar ,boolean? "If false, no inter-staff bar line will |
46 be created below this bar line.") | 46 be created below this bar line.") |
47 (alteration ,number? "Alteration numbers for accidental.") | 47 (alteration ,number? "Alteration numbers for accidental.") |
48 (alteration-alist ,list? "List of @code{(@var{pitch} | 48 (alteration-alist ,list? "List of @code{(@var{pitch} |
49 . @var{accidental})} pairs for key signature.") | 49 . @var{accidental})} pairs for key signature.") |
50 (annotation ,string? "Annotate a grob for debug purposes.") | 50 (annotation ,string? "Annotate a grob for debug purposes.") |
51 (annotation-balloon ,boolean? "Print the balloon around an annotation.") | 51 (annotation-balloon ,boolean? "Print the balloon around an annotation.") |
(...skipping 105 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
157 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}. | 157 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}. |
158 @code{#t} means visible, @code{#f} means killed.") | 158 @code{#t} means visible, @code{#f} means killed.") |
159 (breakable ,boolean? "Allow breaks here.") | 159 (breakable ,boolean? "Allow breaks here.") |
160 | 160 |
161 | 161 |
162 ;; | 162 ;; |
163 ;; c | 163 ;; c |
164 ;; | 164 ;; |
165 (c0-position ,integer? "An integer indicating the position of | 165 (c0-position ,integer? "An integer indicating the position of |
166 middle@tie{}C.") | 166 middle@tie{}C.") |
167 (circled-tip ,boolean? "Put a circle at start/end of | 167 (circled-tip ,boolean? "Put a circle at start/@/end of |
168 hairpins (al/del niente).") | 168 hairpins (al/@/del niente).") |
169 (clip-edges ,boolean? "Allow outward pointing beamlets at the | 169 (clip-edges ,boolean? "Allow outward pointing beamlets at the |
170 edges of beams?") | 170 edges of beams?") |
171 (collapse-height ,ly:dimension? "Minimum height of system start | 171 (collapse-height ,ly:dimension? "Minimum height of system start |
172 delimiter. If equal or smaller, the bracket/brace/line is removed.") | 172 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.") |
173 (collision-interfaces ,list? "A list of interfaces for which | 173 (collision-interfaces ,list? "A list of interfaces for which |
174 automatic beam-collision resolution is run.") | 174 automatic beam-collision resolution is run.") |
175 (collision-voice-only ,boolean? "Does automatic beam collsion apply | 175 (collision-voice-only ,boolean? "Does automatic beam collsion apply |
176 only to the voice in which the beam was created?") | 176 only to the voice in which the beam was created?") |
177 (color ,color? "The color of this grob.") | 177 (color ,color? "The color of this grob.") |
178 (common-shortest-duration ,ly:moment? "The most common shortest | 178 (common-shortest-duration ,ly:moment? "The most common shortest |
179 note length. This is used in spacing. Enlarging this sets the score | 179 note length. This is used in spacing. Enlarging this sets the score |
180 tighter.") | 180 tighter.") |
181 (concaveness ,number? "A beam is concave if its inner stems are | 181 (concaveness ,number? "A beam is concave if its inner stems are |
182 closer to the beam than the two outside stems. This number is a | 182 closer to the beam than the two outside stems. This number is a |
(...skipping 23 matching lines...) Expand all Loading... |
206 @code{staff-staff-spacing} when it is unset, for ungrouped staves | 206 @code{staff-staff-spacing} when it is unset, for ungrouped staves |
207 and for grouped staves that do not have the relevant | 207 and for grouped staves that do not have the relevant |
208 @code{StaffGrouper} property set (@code{staff-staff-spacing} or | 208 @code{StaffGrouper} property set (@code{staff-staff-spacing} or |
209 @code{staffgroup-staff-spacing}).") | 209 @code{staffgroup-staff-spacing}).") |
210 (details ,list? "Alist of parameters for detailed grob behavior. | 210 (details ,list? "Alist of parameters for detailed grob behavior. |
211 More information on the allowed parameters for a grob can be found by | 211 More information on the allowed parameters for a grob can be found by |
212 looking at the top of the Internals Reference page for each interface | 212 looking at the top of the Internals Reference page for each interface |
213 having a @code{details} property.") | 213 having a @code{details} property.") |
214 (digit-names ,vector? "Names for string finger digits.") | 214 (digit-names ,vector? "Names for string finger digits.") |
215 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or | 215 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or |
216 @code{#X}), then this property determines whether the object is placed | 216 @code{X}), then this property determines whether the object is placed |
217 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the | 217 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the |
218 other object. Otherwise, it determines whether the object is placed | 218 other object. Otherwise, it determines whether the object is placed |
219 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also | 219 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also |
220 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1}, | 220 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}}, |
221 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, | 221 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1}, |
222 @code{#CENTER}=@code{0}.") | 222 @code{CENTER}=@code{0}.") |
223 (dot-count ,integer? "The number of dots.") | 223 (dot-count ,integer? "The number of dots.") |
224 (dot-negative-kern ,number? "The space to remove between a dot | 224 (dot-negative-kern ,number? "The space to remove between a dot |
225 and a slash in percent repeat glyphs. Larger values bring the two | 225 and a slash in percent repeat glyphs. Larger values bring the two |
226 elements closer together.") | 226 elements closer together.") |
227 (dot-placement-list ,list? "List consisting of | 227 (dot-placement-list ,list? "List consisting of |
228 @code{(@var{description} @var{string-number} @var{fret-number} | 228 @code{(@var{description} @var{string-number} @var{fret-number} |
229 @var{finger-number})} entries used to define fret diagrams.") | 229 @var{finger-number})} entries used to define fret diagrams.") |
230 (duration-log ,integer? "The 2-log of the note head duration, | 230 (duration-log ,integer? "The 2-log of the note head duration, |
231 i.e., @code{0} = whole note, @code{1} = half note, etc.") | 231 i.e., @code{0} = whole note, @code{1} = half note, etc.") |
232 | 232 |
233 | 233 |
234 ;; | 234 ;; |
235 ;; e | 235 ;; e |
236 ;; | 236 ;; |
237 (eccentricity ,number? "How asymmetrical to make a slur. | 237 (eccentricity ,number? "How asymmetrical to make a slur. |
238 Positive means move the center to the right.") | 238 Positive means move the center to the right.") |
239 (edge-height ,pair? "A pair of numbers specifying the heights of | 239 (edge-height ,pair? "A pair of numbers specifying the heights of |
240 the vertical edges: @code{(@var{left-height} . @var{right-height})}.") | 240 the vertical edges: @code{(@var{left-height} . @var{right-height})}.") |
241 (edge-text ,pair? "A pair specifying the texts to be set at the | 241 (edge-text ,pair? "A pair specifying the texts to be set at the |
242 edges: @code{(@var{left-text} . @var{right-text})}.") | 242 edges: @code{(@var{left-text} . @var{right-text})}.") |
| 243 (round-up-exceptions ,list? "A list of pairs where car is the numerator |
| 244 and cdr the denominator of a moment. Each pair in this list means that |
| 245 the multi-measure rests of the corresponding length will be rounded up to |
| 246 the longer rest. See @var{round-up-to-longer-rest}.") |
243 (expand-limit ,integer? "Maximum number of measures expanded in | 247 (expand-limit ,integer? "Maximum number of measures expanded in |
244 church rests.") | 248 church rests.") |
245 ;; remove me? | 249 ;; remove me? |
246 (extra-dy ,number? "Slope glissandi this much extra.") | 250 (extra-dy ,number? "Slope glissandi this much extra.") |
247 (extra-offset ,number-pair? "A pair representing an offset. This | 251 (extra-offset ,number-pair? "A pair representing an offset. This |
248 offset is added just before outputting the symbol, so the typesetting | 252 offset is added just before outputting the symbol, so the typesetting |
249 engine is completely oblivious to it. The values are measured in | 253 engine is completely oblivious to it. The values are measured in |
250 @code{staff-space} units of the staff's @code{StaffSymbol}.") | 254 @code{staff-space} units of the staff's @code{StaffSymbol}.") |
251 (extra-spacing-height ,number-pair? "In the horizontal spacing | 255 (extra-spacing-height ,number-pair? "In the horizontal spacing |
252 problem, we increase the height of each item by this amount (by adding | 256 problem, we increase the height of each item by this amount (by adding |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
289 @code{roman}.") | 293 @code{roman}.") |
290 (font-name ,string? "Specifies a file name (without extension) of | 294 (font-name ,string? "Specifies a file name (without extension) of |
291 the font to load. This setting overrides selection using | 295 the font to load. This setting overrides selection using |
292 @code{font-family}, @code{font-series} and @code{font-shape}.") | 296 @code{font-family}, @code{font-series} and @code{font-shape}.") |
293 (font-series ,symbol? "Select the series of a font. Choices | 297 (font-series ,symbol? "Select the series of a font. Choices |
294 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.") | 298 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.") |
295 (font-shape ,symbol? "Select the shape of a font. Choices | 299 (font-shape ,symbol? "Select the shape of a font. Choices |
296 include @code{upright}, @code{italic}, @code{caps}.") | 300 include @code{upright}, @code{italic}, @code{caps}.") |
297 (font-size ,number? "The font size, compared to the | 301 (font-size ,number? "The font size, compared to the |
298 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size, | 302 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size, |
299 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is | 303 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is |
300 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 | 304 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 |
301 larger. Fractional values are allowed.") | 305 larger. Fractional values are allowed.") |
302 (footnote-text ,markup? "A footnote for the grob.") | 306 (footnote-text ,markup? "A footnote for the grob.") |
303 (force-hshift ,number? "This specifies a manual shift for notes | 307 (force-hshift ,number? "This specifies a manual shift for notes |
304 in collisions. The unit is the note head width of the first voice | 308 in collisions. The unit is the note head width of the first voice |
305 note. This is used by @rinternals{note-collision-interface}.") | 309 note. This is used by @rinternals{note-collision-interface}.") |
306 (fraction ,number-pair? "Numerator and denominator of a time | 310 (fraction ,number-pair? "Numerator and denominator of a time |
307 signature object.") | 311 signature object.") |
308 (french-beaming ,boolean? "Use French beaming style for this | 312 (french-beaming ,boolean? "Use French beaming style for this |
309 stem. The stem stops at the innermost beams.") | 313 stem. The stem stops at the innermost beams.") |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
345 @code{custom}. Default@tie{}\"~a\". | 349 @code{custom}. Default@tie{}\"~a\". |
346 @item | 350 @item |
347 @code{fret-label-font-mag} -- The magnification of the font used to | 351 @code{fret-label-font-mag} -- The magnification of the font used to |
348 label the lowest fret number. Default@tie{}0.5. | 352 label the lowest fret number. Default@tie{}0.5. |
349 @item | 353 @item |
350 @code{fret-label-vertical-offset} -- The offset of the fret label from | 354 @code{fret-label-vertical-offset} -- The offset of the fret label from |
351 the center of the fret in direction parallel to strings. | 355 the center of the fret in direction parallel to strings. |
352 Default@tie{}0. | 356 Default@tie{}0. |
353 @item | 357 @item |
354 @code{label-dir} -- Side to which the fret label is attached. | 358 @code{label-dir} -- Side to which the fret label is attached. |
355 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1}, | 359 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1}, |
356 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}. | 360 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}. |
357 @item | 361 @item |
358 @code{mute-string} -- Character string to be used to indicate muted | 362 @code{mute-string} -- Character string to be used to indicate muted |
359 string. Default @code{\"x\"}. | 363 string. Default @code{\"x\"}. |
360 @item | 364 @item |
361 @code{number-type} -- Type of numbers to use in fret label. Choices | 365 @code{number-type} -- Type of numbers to use in fret label. Choices |
362 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and | 366 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and |
363 @code{custom}. In the later case, the format string is supplied by | 367 @code{custom}. In the later case, the format string is supplied by |
364 the @code{fret-label-custom-format} property. | 368 the @code{fret-label-custom-format} property. |
365 Default @code{roman-lower}. | 369 Default @code{roman-lower}. |
366 @item | 370 @item |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
423 ;; | 427 ;; |
424 (hair-thickness ,number? "Thickness of the thin line in a bar | 428 (hair-thickness ,number? "Thickness of the thin line in a bar |
425 line.") | 429 line.") |
426 (harp-pedal-details ,list? "An alist of detailed grob properties | 430 (harp-pedal-details ,list? "An alist of detailed grob properties |
427 for harp pedal diagrams. Each alist entry consists of a | 431 for harp pedal diagrams. Each alist entry consists of a |
428 @code{(@var{property} . @var{value})} pair. The properties which can | 432 @code{(@var{property} . @var{value})} pair. The properties which can |
429 be included in harp-pedal-details include the following: | 433 be included in harp-pedal-details include the following: |
430 | 434 |
431 @itemize @bullet | 435 @itemize @bullet |
432 @item | 436 @item |
433 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal | 437 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal |
434 boxes above/below the horizontal line. Default value@tie{}0.8. | 438 boxes above/@/below the horizontal line. Default value@tie{}0.8. |
435 @item | 439 @item |
436 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4. | 440 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4. |
437 @item | 441 @item |
438 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0. | 442 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0. |
439 @item | 443 @item |
440 @code{space-before-divider} -- Space between boxes before the first | 444 @code{space-before-divider} -- Space between boxes before the first |
441 divider (so that the diagram can be made symmetric). Default | 445 divider (so that the diagram can be made symmetric). Default |
442 value@tie{}0.8. | 446 value@tie{}0.8. |
443 @item | 447 @item |
444 @code{space-after-divider} -- Space between boxes after the first | 448 @code{space-after-divider} -- Space between boxes after the first |
(...skipping 242 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
687 score?") | 691 score?") |
688 (restore-first ,boolean? "Print a natural before the | 692 (restore-first ,boolean? "Print a natural before the |
689 accidental.") | 693 accidental.") |
690 (rhythmic-location ,rhythmic-location? "Where (bar number, | 694 (rhythmic-location ,rhythmic-location? "Where (bar number, |
691 measure position) in the score.") | 695 measure position) in the score.") |
692 (right-bound-info ,list? "An alist of properties for determining | 696 (right-bound-info ,list? "An alist of properties for determining |
693 attachments of spanners to edges.") | 697 attachments of spanners to edges.") |
694 (right-padding ,ly:dimension? "Space to insert on the right side | 698 (right-padding ,ly:dimension? "Space to insert on the right side |
695 of an object (e.g., between note and its accidentals).") | 699 of an object (e.g., between note and its accidentals).") |
696 (rotation ,list? "Number of degrees to rotate this object, and | 700 (rotation ,list? "Number of degrees to rotate this object, and |
697 what point to rotate around. For example, @code{#'(45 0 0)} rotates | 701 what point to rotate around. For example, @code{'(45 0 0)} rotates |
698 by 45 degrees around the center of this object.") | 702 by 45 degrees around the center of this object.") |
699 (round-to-longer-rest ,boolean? "Displays the longer multi-measure | 703 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure |
700 rest when the length of a measure is between two values of | 704 rest when the length of a measure is between two values of |
701 @code{usable-duration-logs}. For example, displays a breve instead of a whole | 705 @code{usable-duration-logs}. For example, displays a breve instead of a whole |
702 in a 3/2 measure.") | 706 in a 3/2 measure.") |
703 | 707 |
704 | 708 |
705 ;; | 709 ;; |
706 ;; s | 710 ;; s |
707 ;; | 711 ;; |
708 (same-direction-correction ,number? "Optical correction amount | 712 (same-direction-correction ,number? "Optical correction amount |
709 for stems that are placed in tight configurations. This amount is | 713 for stems that are placed in tight configurations. This amount is |
710 used for stems with the same direction to compensate for note head to | 714 used for stems with the same direction to compensate for note head to |
711 stem distance.") | 715 stem distance.") |
712 (script-priority ,number? "A sorting key that determines in what | 716 (script-priority ,number? "A sorting key that determines in what |
713 order a script is within a stack of scripts.") | 717 order a script is within a stack of scripts.") |
714 (self-alignment-X ,number? "Specify alignment of an object. The | 718 (self-alignment-X ,number? "Specify alignment of an object. The |
715 value @code{-1} means left aligned, @code{0}@tie{}centered, and | 719 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and |
716 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical | 720 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical |
717 values may also be specified.") | 721 values may also be specified.") |
718 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for | 722 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for |
719 the Y@tie{}axis.") | 723 the Y@tie{}axis.") |
720 (shape ,symbol? "This setting determines what shape a grob | 724 (shape ,symbol? "This setting determines what shape a grob |
721 has. Valid choices depend on the @code{stencil} callback reading | 725 has. Valid choices depend on the @code{stencil} callback reading |
722 this property.") | 726 this property.") |
723 (shorten-pair ,number-pair? "The lengths to shorten a | 727 (shorten-pair ,number-pair? "The lengths to shorten a |
724 text-spanner on both sides, for example a pedal bracket. Positive | 728 text-spanner on both sides, for example a pedal bracket. Positive |
725 values shorten the text-spanner, while negative values lengthen it.") | 729 values shorten the text-spanner, while negative values lengthen it.") |
726 (shortest-duration-space ,ly:dimension? "Start with this much | 730 (shortest-duration-space ,ly:dimension? "Start with this much |
727 space for the shortest duration. This is expressed in | 731 space for the shortest duration. This is expressed in |
728 @code{spacing-increment} as unit. See also | 732 @code{spacing-increment} as unit. See also |
729 @rinternals{spacing-spanner-interface}.") | 733 @rinternals{spacing-spanner-interface}.") |
730 (shortest-playing-duration ,ly:moment? "The duration of the | 734 (shortest-playing-duration ,ly:moment? "The duration of the |
731 shortest note playing here.") | 735 shortest note playing here.") |
732 (shortest-starter-duration ,ly:moment? "The duration of the | 736 (shortest-starter-duration ,ly:moment? "The duration of the |
733 shortest note that starts here.") | 737 shortest note that starts here.") |
734 (side-axis ,number? "If the value is @code{#X} (or | 738 (side-axis ,number? "If the value is @code{X} (or |
735 equivalently@tie{}@code{0}), the object is placed horizontally next to | 739 equivalently@tie{}@code{0}), the object is placed horizontally next to |
736 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is | 740 the other object. If the value is @code{Y} or@tie{}@code{1}, it is |
737 placed vertically.") | 741 placed vertically.") |
738 (side-relative-direction ,ly:dir? "Multiply direction of | 742 (side-relative-direction ,ly:dir? "Multiply direction of |
739 @code{direction-source} with this to get the direction of this | 743 @code{direction-source} with this to get the direction of this |
740 object.") | 744 object.") |
741 (simple-Y ,boolean? "Should the Y placement of a spanner | 745 (simple-Y ,boolean? "Should the Y placement of a spanner |
742 disregard changes in system heights?") | 746 disregard changes in system heights?") |
743 (size ,number? "Size of object, relative to standard size.") | 747 (size ,number? "Size of object, relative to standard size.") |
744 (skyline-horizontal-padding ,number? "For determining the | 748 (skyline-horizontal-padding ,number? "For determining the |
745 vertical distance between two staves, it is possible to have a | 749 vertical distance between two staves, it is possible to have a |
746 configuration which would result in a tight interleaving of grobs from | 750 configuration which would result in a tight interleaving of grobs from |
(...skipping 24 matching lines...) Expand all Loading... |
771 duration. Typically, the width of a note head. See also | 775 duration. Typically, the width of a note head. See also |
772 @rinternals{spacing-spanner-interface}.") | 776 @rinternals{spacing-spanner-interface}.") |
773 (spacing-pair ,pair? "A pair of alignment symbols which set an object's | 777 (spacing-pair ,pair? "A pair of alignment symbols which set an object's |
774 spacing relative to its left and right @code{BreakAlignment}s. | 778 spacing relative to its left and right @code{BreakAlignment}s. |
775 | 779 |
776 For example, a @code{MultiMeasureRest} will ignore prefatory items at its | 780 For example, a @code{MultiMeasureRest} will ignore prefatory items at its |
777 bounds (i.e., clefs, key signatures and time signatures) using the following | 781 bounds (i.e., clefs, key signatures and time signatures) using the following |
778 override: | 782 override: |
779 | 783 |
780 @example | 784 @example |
781 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar) | 785 \\override MultiMeasureRest |
| 786 #'spacing-pair = #'(staff-bar . staff-bar) |
782 @end example") | 787 @end example") |
783 (spanner-id ,string? "An identifier to distinguish concurrent spanners.") | 788 (spanner-id ,string? "An identifier to distinguish concurrent spanners.") |
784 (springs-and-rods ,boolean? "Dummy variable for triggering | 789 (springs-and-rods ,boolean? "Dummy variable for triggering |
785 spacing routines.") | 790 spacing routines.") |
786 (stacking-dir ,ly:dir? "Stack objects in which direction?") | 791 (stacking-dir ,ly:dir? "Stack objects in which direction?") |
787 (staff-affinity ,ly:dir? "The direction of the staff to use | 792 (staff-affinity ,ly:dir? "The direction of the staff to use |
788 for spacing the current non-staff line. Choices are @code{UP}, | 793 for spacing the current non-staff line. Choices are @code{UP}, |
789 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff | 794 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff |
790 line will be placed equidistant between the two nearest staves on | 795 line will be placed equidistant between the two nearest staves on |
791 either side, unless collisions or other spacing constraints | 796 either side, unless collisions or other spacing constraints |
(...skipping 89 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
881 should use @code{LEFT}.") | 886 should use @code{LEFT}.") |
882 (thick-thickness ,number? "Bar line thickness, measured in | 887 (thick-thickness ,number? "Bar line thickness, measured in |
883 @code{line-thickness}.") | 888 @code{line-thickness}.") |
884 (thickness ,number? "Line thickness, generally measured in | 889 (thickness ,number? "Line thickness, generally measured in |
885 @code{line-thickness}.") | 890 @code{line-thickness}.") |
886 (thin-kern ,number? "The space after a hair-line in a bar line.") | 891 (thin-kern ,number? "The space after a hair-line in a bar line.") |
887 (tie-configuration ,list? "List of @code{(@var{position} . | 892 (tie-configuration ,list? "List of @code{(@var{position} . |
888 @var{dir})} pairs, indicating the desired tie configuration, where | 893 @var{dir})} pairs, indicating the desired tie configuration, where |
889 @var{position} is the offset from the center of the staff in staff | 894 @var{position} is the offset from the center of the staff in staff |
890 space and @var{dir} indicates the direction of the tie | 895 space and @var{dir} indicates the direction of the tie |
891 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry | 896 (@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry |
892 in the list causes the corresponding tie to be formatted | 897 in the list causes the corresponding tie to be formatted |
893 automatically.") | 898 automatically.") |
894 (to-barline ,boolean? "If true, the spanner will stop at the bar | 899 (to-barline ,boolean? "If true, the spanner will stop at the bar |
895 line just before it would otherwise stop.") | 900 line just before it would otherwise stop.") |
896 (toward-stem-shift ,number? "Amount by which scripts are shifted | 901 (toward-stem-shift ,number? "Amount by which scripts are shifted |
897 toward the stem if their direction coincides with the stem direction. | 902 toward the stem if their direction coincides with the stem direction. |
898 @code{0.0} means keep the default position (centered on the note | 903 @code{0.0} means keep the default position (centered on the note |
899 head), @code{1.0} means centered on the stem. Interpolated values are | 904 head), @code{1.0} means centered on the stem. Interpolated values are |
900 possible.") | 905 possible.") |
901 (transparent ,boolean? "This makes the grob invisible.") | 906 (transparent ,boolean? "This makes the grob invisible.") |
(...skipping 84 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
986 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring | 991 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring |
987 dynamic spanners.") | 992 dynamic spanners.") |
988 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its | 993 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its |
989 function is to protect objects from being garbage collected.") | 994 function is to protect objects from being garbage collected.") |
990 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.") | 995 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.") |
991 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") | 996 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") |
992 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") | 997 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") |
993 | 998 |
994 (bars ,ly:grob-array? "An array of bar line pointers.") | 999 (bars ,ly:grob-array? "An array of bar line pointers.") |
995 (beam ,ly:grob? "A pointer to the beam, if applicable.") | 1000 (beam ,ly:grob? "A pointer to the beam, if applicable.") |
| 1001 (bound-alignment-interfaces ,list "Interfaces to be used |
| 1002 for positioning elements that align with a column.") |
996 (bounded-by-me ,ly:grob-array? "An array of spanners that have this | 1003 (bounded-by-me ,ly:grob-array? "An array of spanners that have this |
997 column as start/begin point. Only columns that have grobs or act as | 1004 column as start/@/begin point. Only columns that have grobs or act as |
998 bounds are spaced.") | 1005 bounds are spaced.") |
999 (bracket ,ly:grob? "The bracket for a number.") | 1006 (bracket ,ly:grob? "The bracket for a number.") |
1000 | 1007 |
1001 (columns ,ly:grob-array? "An array of grobs, typically containing | 1008 (columns ,ly:grob-array? "An array of grobs, typically containing |
1002 @code{PaperColumn} or @code{NoteColumn} objects.") | 1009 @code{PaperColumn} or @code{NoteColumn} objects.") |
1003 (conditional-elements ,ly:grob-array? "Internal use only.") | 1010 (conditional-elements ,ly:grob-array? "Internal use only.") |
1004 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide | 1011 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide |
1005 with a beam.") | 1012 with a beam.") |
1006 | 1013 |
1007 (direction-source ,ly:grob? "In case @code{side-relative-direction} is | 1014 (direction-source ,ly:grob? "In case @code{side-relative-direction} is |
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1057 (side-support-elements ,ly:grob-array? "The side support, an array of | 1064 (side-support-elements ,ly:grob-array? "The side support, an array of |
1058 grobs.") | 1065 grobs.") |
1059 (slur ,ly:grob? "A pointer to a @code{Slur} object.") | 1066 (slur ,ly:grob? "A pointer to a @code{Slur} object.") |
1060 (spacing ,ly:grob? "The spacing spanner governing this section.") | 1067 (spacing ,ly:grob? "The spacing spanner governing this section.") |
1061 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing | 1068 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing |
1062 objects.") | 1069 objects.") |
1063 (span-start ,boolean? "Is the note head at the start of a spanner?") | 1070 (span-start ,boolean? "Is the note head at the start of a spanner?") |
1064 (spanner-broken ,boolean? "Indicates whether spanner | 1071 (spanner-broken ,boolean? "Indicates whether spanner |
1065 alignment should be broken after the current spanner.") | 1072 alignment should be broken after the current spanner.") |
1066 (spanner-placement ,ly:dir? "The place of an annotation on a spanner. | 1073 (spanner-placement ,ly:dir? "The place of an annotation on a spanner. |
1067 LEFT is for the first spanner, and RIGHT is for the last. CENTER will | 1074 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last. |
1068 place it on the broken spanner that falls closest to the center of the length | 1075 @code{CENTER} will place it on the broken spanner that falls closest to the |
1069 of the entire spanner, although this behavior is unpredictable in situations | 1076 center of the length of the entire spanner, although this behavior is |
1070 with lots of rhythmic diversity. For predictable results, use LEFT and RIGHT.") | 1077 unpredictable in situations with lots of rhythmic diversity. For predictable |
| 1078 results, use @code{LEFT} and @code{RIGHT}.") |
1071 (staff-grouper ,ly:grob? "The staff grouper we belong to.") | 1079 (staff-grouper ,ly:grob? "The staff grouper we belong to.") |
1072 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.") | 1080 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.") |
1073 (stem ,ly:grob? "A pointer to a @code{Stem} object.") | 1081 (stem ,ly:grob? "A pointer to a @code{Stem} object.") |
1074 (stems ,ly:grob-array? "An array of stem objects.") | 1082 (stems ,ly:grob-array? "An array of stem objects.") |
1075 | 1083 |
1076 (tie ,ly:grob? "A pointer to a @code{Tie} object.") | 1084 (tie ,ly:grob? "A pointer to a @code{Tie} object.") |
1077 (tremolo-flag ,ly:grob? "The tremolo object on a stem.") | 1085 (tremolo-flag ,ly:grob? "The tremolo object on a stem.") |
1078 (tuplet-number ,ly:grob? "The number for a bracket.") | 1086 (tuplet-number ,ly:grob? "The number for a bracket.") |
1079 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.") | 1087 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.") |
1080 (X-common ,ly:grob? "Common reference point for axis group.") | 1088 (X-common ,ly:grob? "Common reference point for axis group.") |
(...skipping 76 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1157 the left side?") | 1165 the left side?") |
1158 (add-join ,boolean? "Is this ligature head-joined with the next one | 1166 (add-join ,boolean? "Is this ligature head-joined with the next one |
1159 by a vertical line?") | 1167 by a vertical line?") |
1160 (add-stem ,boolean? "Is this ligature head a virga and therefore needs | 1168 (add-stem ,boolean? "Is this ligature head a virga and therefore needs |
1161 an additional stem on the right side?") | 1169 an additional stem on the right side?") |
1162 (ascendens ,boolean? "Is this neume of ascending type?") | 1170 (ascendens ,boolean? "Is this neume of ascending type?") |
1163 (auctum ,boolean? "Is this neume liquescentically augmented?") | 1171 (auctum ,boolean? "Is this neume liquescentically augmented?") |
1164 | 1172 |
1165 (cavum ,boolean? "Is this neume outlined?") | 1173 (cavum ,boolean? "Is this neume outlined?") |
1166 (context-info ,integer? "Within a ligature, the final glyph or shape of | 1174 (context-info ,integer? "Within a ligature, the final glyph or shape of |
1167 a head may be affected by the left and/or right neighbour head. | 1175 a head may be affected by the left and/@/or right neighbour head. |
1168 @code{context-info} holds for each head such information about the left and | 1176 @code{context-info} holds for each head such information about the left and |
1169 right neighbour, encoded as a bit mask.") | 1177 right neighbour, encoded as a bit mask.") |
1170 | 1178 |
1171 (deminutum ,boolean? "Is this neume deminished?") | 1179 (deminutum ,boolean? "Is this neume deminished?") |
1172 (descendens ,boolean? "Is this neume of descendent type?") | 1180 (descendens ,boolean? "Is this neume of descendent type?") |
1173 | 1181 |
1174 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature | 1182 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature |
1175 grob (in @code{staff-space} units).") | 1183 grob (in @code{staff-space} units).") |
1176 (flexa-interval ,integer? "The interval spanned by the two notes of a | 1184 (flexa-interval ,integer? "The interval spanned by the two notes of a |
1177 flexa shape (1 is a second, 7 is an octave).") | 1185 flexa shape (1 is a second, 7 is an octave).") |
(...skipping 23 matching lines...) Expand all Loading... |
1201 (virga ,boolean? "Is this neume a virga?") | 1209 (virga ,boolean? "Is this neume a virga?") |
1202 | 1210 |
1203 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") | 1211 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") |
1204 | 1212 |
1205 ))) | 1213 ))) |
1206 | 1214 |
1207 (define-public all-backend-properties | 1215 (define-public all-backend-properties |
1208 (append | 1216 (append |
1209 all-internal-grob-properties | 1217 all-internal-grob-properties |
1210 all-user-grob-properties)) | 1218 all-user-grob-properties)) |
LEFT | RIGHT |