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 145 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
156 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar}, | 156 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar}, |
157 @code{key-cancellation}, @code{key-signature}, @code{time-signature}, | 157 @code{key-cancellation}, @code{key-signature}, @code{time-signature}, |
158 and @code{custos}.") | 158 and @code{custos}.") |
159 (break-overshoot ,number-pair? "How much does a broken spanner | 159 (break-overshoot ,number-pair? "How much does a broken spanner |
160 stick out of its bounds?") | 160 stick out of its bounds?") |
161 (break-visibility ,vector? "A vector of 3@tie{}booleans, | 161 (break-visibility ,vector? "A vector of 3@tie{}booleans, |
162 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}. | 162 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}. |
163 @code{#t} means visible, @code{#f} means killed.") | 163 @code{#t} means visible, @code{#f} means killed.") |
164 (breakable ,boolean? "Allow breaks here.") | 164 (breakable ,boolean? "Allow breaks here.") |
165 | 165 |
166 | |
167 ;; | 166 ;; |
168 ;; c | 167 ;; c |
169 ;; | 168 ;; |
170 (c0-position ,integer? "An integer indicating the position of | 169 (c0-position ,integer? "An integer indicating the position of |
171 middle@tie{}C.") | 170 middle@tie{}C.") |
172 (circled-tip ,boolean? "Put a circle at start/@/end of | 171 (circled-tip ,boolean? "Put a circle at start/@/end of |
173 hairpins (al/@/del niente).") | 172 hairpins (al/@/del niente).") |
174 (clip-edges ,boolean? "Allow outward pointing beamlets at the | 173 (clip-edges ,boolean? "Allow outward pointing beamlets at the |
175 edges of beams?") | 174 edges of beams?") |
176 (collapse-height ,ly:dimension? "Minimum height of system start | 175 (collapse-height ,ly:dimension? "Minimum height of system start |
177 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.") | 176 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.") |
178 (collision-interfaces ,list? "A list of interfaces for which | 177 (collision-interfaces ,list? "A list of interfaces for which |
179 automatic beam-collision resolution is run.") | 178 automatic beam-collision resolution is run.") |
180 (collision-voice-only ,boolean? "Does automatic beam collsion apply | 179 (collision-voice-only ,boolean? "Does automatic beam collsion apply |
181 only to the voice in which the beam was created?") | 180 only to the voice in which the beam was created?") |
182 (color ,color? "The color of this grob.") | 181 (color ,color? "The color of this grob.") |
183 (common-shortest-duration ,ly:moment? "The most common shortest | 182 (common-shortest-duration ,ly:moment? "The most common shortest |
184 note length. This is used in spacing. Enlarging this sets the score | 183 note length. This is used in spacing. Enlarging this sets the score |
185 tighter.") | 184 tighter.") |
186 (concaveness ,number? "A beam is concave if its inner stems are | 185 (concaveness ,number? "A beam is concave if its inner stems are |
187 closer to the beam than the two outside stems. This number is a | 186 closer to the beam than the two outside stems. This number is a |
188 measure of the closeness of the inner stems. It is used for damping | 187 measure of the closeness of the inner stems. It is used for damping |
189 the slope of the beam.") | 188 the slope of the beam.") |
190 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether | 189 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether |
191 this grob looks as a continued break.") | 190 this grob looks as a continued break.") |
192 (consistent-broken-slope ,boolean? "Keep a beam's slope across line | |
193 breaks.") | |
194 (control-points ,list? "List of offsets (number pairs) that form | 191 (control-points ,list? "List of offsets (number pairs) that form |
195 control points for the tie, slur, or bracket shape. For B@'eziers, | 192 control points for the tie, slur, or bracket shape. For B@'eziers, |
196 this should list the control points of a third-order B@'ezier curve.") | 193 this should list the control points of a third-order B@'ezier curve.") |
197 | 194 |
198 ;; | 195 ;; |
199 ;; d | 196 ;; d |
200 ;; | 197 ;; |
201 (damping ,number? "Amount of beam slope damping.") | 198 (damping ,number? "Amount of beam slope damping.") |
202 (dash-definition ,pair? "List of @code{dash-elements} defining the | 199 (dash-definition ,pair? "List of @code{dash-elements} defining the |
203 dash structure. Each @code{dash-element} has a starting t value, | 200 dash structure. Each @code{dash-element} has a starting t value, |
(...skipping 94 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
298 (font-size ,number? "The font size, compared to the | 295 (font-size ,number? "The font size, compared to the |
299 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size, | 296 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size, |
300 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is | 297 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is |
301 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 | 298 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 |
302 larger. Fractional values are allowed.") | 299 larger. Fractional values are allowed.") |
303 (footnote ,boolean? "Should this be a footnote or in-note?") | 300 (footnote ,boolean? "Should this be a footnote or in-note?") |
304 (footnote-text ,markup? "A footnote for the grob.") | 301 (footnote-text ,markup? "A footnote for the grob.") |
305 (force-hshift ,number? "This specifies a manual shift for notes | 302 (force-hshift ,number? "This specifies a manual shift for notes |
306 in collisions. The unit is the note head width of the first voice | 303 in collisions. The unit is the note head width of the first voice |
307 note. This is used by @rinternals{note-collision-interface}.") | 304 note. This is used by @rinternals{note-collision-interface}.") |
308 (fraction ,number-pair? "Numerator and denominator of a time | 305 (fraction ,fraction? "Numerator and denominator of a time |
309 signature object.") | 306 signature object.") |
310 (french-beaming ,boolean? "Use French beaming style for this | 307 (french-beaming ,boolean? "Use French beaming style for this |
311 stem. The stem stops at the innermost beams.") | 308 stem. The stem stops at the innermost beams.") |
312 (fret-diagram-details ,list? "An alist of detailed grob | 309 (fret-diagram-details ,list? "An alist of detailed grob |
313 properties for fret diagrams. Each alist entry consists of a | 310 properties for fret diagrams. Each alist entry consists of a |
314 @code{(@var{property} . @var{value})} pair. The properties which can | 311 @code{(@var{property} . @var{value})} pair. The properties which can |
315 be included in @code{fret-diagram-details} include the following: | 312 be included in @code{fret-diagram-details} include the following: |
316 | 313 |
317 @itemize @bullet | 314 @itemize @bullet |
318 @item | 315 @item |
(...skipping 356 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
675 @code{allow}.") | 672 @code{allow}.") |
676 (parenthesized ,boolean? "Parenthesize this grob.") | 673 (parenthesized ,boolean? "Parenthesize this grob.") |
677 (positions ,number-pair? "Pair of staff coordinates | 674 (positions ,number-pair? "Pair of staff coordinates |
678 @code{(@var{left} . @var{right})}, where both @var{left} and | 675 @code{(@var{left} . @var{right})}, where both @var{left} and |
679 @var{right} are in @code{staff-space} units of the current staff. For | 676 @var{right} are in @code{staff-space} units of the current staff. For |
680 slurs, this value selects which slur candidate to use; if extreme | 677 slurs, this value selects which slur candidate to use; if extreme |
681 positions are requested, the closest one is taken.") | 678 positions are requested, the closest one is taken.") |
682 (prefer-dotted-right ,boolean? "For note collisions, prefer to | 679 (prefer-dotted-right ,boolean? "For note collisions, prefer to |
683 shift dotted up-note to the right, rather than shifting just the | 680 shift dotted up-note to the right, rather than shifting just the |
684 dot.") | 681 dot.") |
685 | |
686 | 682 |
687 ;; | 683 ;; |
688 ;; r | 684 ;; r |
689 ;; | 685 ;; |
690 (ratio ,number? "Parameter for slur shape. The higher this | 686 (ratio ,number? "Parameter for slur shape. The higher this |
691 number, the quicker the slur attains its @code{height-limit}.") | 687 number, the quicker the slur attains its @code{height-limit}.") |
692 (remove-empty ,boolean? "If set, remove group if it contains no | 688 (remove-empty ,boolean? "If set, remove group if it contains no |
693 interesting items.") | 689 interesting items.") |
694 (remove-first ,boolean? "Remove the first staff of an orchestral | 690 (remove-first ,boolean? "Remove the first staff of an orchestral |
695 score?") | 691 score?") |
(...skipping 302 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
998 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring | 994 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring |
999 dynamic spanners.") | 995 dynamic spanners.") |
1000 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its | 996 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its |
1001 function is to protect objects from being garbage collected.") | 997 function is to protect objects from being garbage collected.") |
1002 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.") | 998 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.") |
1003 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") | 999 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.") |
1004 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") | 1000 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.") |
1005 | 1001 |
1006 (bars ,ly:grob-array? "An array of bar line pointers.") | 1002 (bars ,ly:grob-array? "An array of bar line pointers.") |
1007 (beam ,ly:grob? "A pointer to the beam, if applicable.") | 1003 (beam ,ly:grob? "A pointer to the beam, if applicable.") |
| 1004 (beam-segments ,list? "Internal representation of beam segments.") |
1008 (bound-alignment-interfaces ,list "Interfaces to be used | 1005 (bound-alignment-interfaces ,list "Interfaces to be used |
1009 for positioning elements that align with a column.") | 1006 for positioning elements that align with a column.") |
1010 (bounded-by-me ,ly:grob-array? "An array of spanners that have this | 1007 (bounded-by-me ,ly:grob-array? "An array of spanners that have this |
1011 column as start/@/begin point. Only columns that have grobs or act as | 1008 column as start/@/begin point. Only columns that have grobs or act as |
1012 bounds are spaced.") | 1009 bounds are spaced.") |
1013 (bracket ,ly:grob? "The bracket for a number.") | 1010 (bracket ,ly:grob? "The bracket for a number.") |
1014 | 1011 |
1015 (columns ,ly:grob-array? "An array of grobs, typically containing | 1012 (columns ,ly:grob-array? "An array of grobs, typically containing |
1016 @code{PaperColumn} or @code{NoteColumn} objects.") | 1013 @code{PaperColumn} or @code{NoteColumn} objects.") |
1017 (conditional-elements ,ly:grob-array? "Internal use only.") | 1014 (conditional-elements ,ly:grob-array? "Internal use only.") |
1018 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide | 1015 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide |
1019 with a beam.") | 1016 with a beam.") |
1020 | 1017 |
1021 (direction-source ,ly:grob? "In case @code{side-relative-direction} is | 1018 (direction-source ,ly:grob? "In case @code{side-relative-direction} is |
1022 set, which grob to get the direction from.") | 1019 set, which grob to get the direction from.") |
1023 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary
grob?") | 1020 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary
grob?") |
1024 (dot ,ly:grob? "A reference to a @code{Dots} object.") | 1021 (dot ,ly:grob? "A reference to a @code{Dots} object.") |
1025 (dots ,ly:grob-array? "Multiple @code{Dots} objects.") | 1022 (dots ,ly:grob-array? "Multiple @code{Dots} objects.") |
1026 | 1023 |
1027 (elements ,ly:grob-array? "An array of grobs; the type is depending on | 1024 (elements ,ly:grob-array? "An array of grobs; the type is depending on |
1028 the grob where this is set in.") | 1025 the grob where this is set in.") |
1029 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid | 1026 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid |
1030 in addition to notes and stems.") | 1027 in addition to notes and stems.") |
1031 | 1028 |
1032 (figures ,ly:grob-array? "Figured bass objects for continuation line.") | 1029 (figures ,ly:grob-array? "Figured bass objects for continuation line.") |
1033 (flag ,ly:grob? "A pointer to a @code{Flag} object.") | 1030 (flag ,ly:grob? "A pointer to a @code{Flag} object.") |
1034 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.") | 1031 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.") |
| 1032 (full-score-pure-minimum-translations ,list? "A list of translations |
| 1033 for a full score's worth of grobs.") |
1035 | 1034 |
1036 (glissando-index ,integer? "The index of a glissando in its note | 1035 (glissando-index ,integer? "The index of a glissando in its note |
1037 column.") | 1036 column.") |
1038 (grace-spacing ,ly:grob? "A run of grace notes.") | 1037 (grace-spacing ,ly:grob? "A run of grace notes.") |
1039 | 1038 |
| 1039 (has-span-bar ,pair? "A pair of booleans indicating whether a a span bar |
| 1040 is drawn above, or respectively below, this staff.") |
1040 (heads ,ly:grob-array? "An array of note heads.") | 1041 (heads ,ly:grob-array? "An array of note heads.") |
1041 | 1042 |
1042 (items-worth-living ,ly:grob-array? "An array of interesting items. If | 1043 (items-worth-living ,ly:grob-array? "An array of interesting items. If |
1043 empty in a particular staff, then that staff is erased.") | 1044 empty in a particular staff, then that staff is erased.") |
1044 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.") | 1045 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.") |
1045 (in-note-padding ,number? "Padding between in-notes.") | 1046 (in-note-padding ,number? "Padding between in-notes.") |
1046 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.") | 1047 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.") |
1047 | 1048 |
1048 (keep-alive-with ,ly:grob-array? "An array of other | 1049 (keep-alive-with ,ly:grob-array? "An array of other |
1049 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.") | 1050 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.") |
(...skipping 170 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1220 (virga ,boolean? "Is this neume a virga?") | 1221 (virga ,boolean? "Is this neume a virga?") |
1221 | 1222 |
1222 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") | 1223 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") |
1223 | 1224 |
1224 ))) | 1225 ))) |
1225 | 1226 |
1226 (define-public all-backend-properties | 1227 (define-public all-backend-properties |
1227 (append | 1228 (append |
1228 all-internal-grob-properties | 1229 all-internal-grob-properties |
1229 all-user-grob-properties)) | 1230 all-user-grob-properties)) |
LEFT | RIGHT |