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 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
51 (annotation-balloon ,boolean? "Print the balloon around an annotation.") | 51 (annotation-balloon ,boolean? "Print the balloon around an annotation.") |
52 (annotation-line ,boolean? "Print the line from an annotation to the | 52 (annotation-line ,boolean? "Print the line from an annotation to the |
53 grob that it annotates.") | 53 grob that it annotates.") |
54 (arpeggio-direction ,ly:dir? "If set, put an arrow on the | 54 (arpeggio-direction ,ly:dir? "If set, put an arrow on the |
55 arpeggio squiggly line.") | 55 arpeggio squiggly line.") |
56 (arrow-length ,number? "Arrow length.") | 56 (arrow-length ,number? "Arrow length.") |
57 (arrow-width ,number? "Arrow width.") | 57 (arrow-width ,number? "Arrow width.") |
58 (auto-knee-gap ,ly:dimension? "If a gap is found between note | 58 (auto-knee-gap ,ly:dimension? "If a gap is found between note |
59 heads where a horizontal beam fits that is larger than this number, | 59 heads where a horizontal beam fits that is larger than this number, |
60 make a kneed beam.") | 60 make a kneed beam.") |
| 61 (automatically-numbered ,boolean? "Should a footnote be automatically |
| 62 numbered?") |
61 (average-spacing-wishes ,boolean? "If set, the spacing wishes are | 63 (average-spacing-wishes ,boolean? "If set, the spacing wishes are |
62 averaged over staves.") | 64 averaged over staves.") |
63 (avoid-note-head ,boolean? "If set, the stem of a chord does not | 65 (avoid-note-head ,boolean? "If set, the stem of a chord does not |
64 pass through all note heads, but starts at the last note head.") | 66 pass through all note heads, but starts at the last note head.") |
65 (avoid-slur ,symbol? "Method of handling slur collisions. | 67 (avoid-slur ,symbol? "Method of handling slur collisions. |
66 Choices are @code{inside}, @code{outside}, @code{around}, and | 68 Choices are @code{inside}, @code{outside}, @code{around}, and |
67 @code{ignore}. @code{inside} adjusts the slur if needed to keep the | 69 @code{ignore}. @code{inside} adjusts the slur if needed to keep the |
68 grob inside the slur. @code{outside} moves the grob vertically to the | 70 grob inside the slur. @code{outside} moves the grob vertically to the |
69 outside of the slur. @code{around} moves the grob vertically to the | 71 outside of the slur. @code{around} moves the grob vertically to the |
70 outside of the slur only if there is a collision. @code{ignore} does | 72 outside of the slur only if there is a collision. @code{ignore} does |
(...skipping 195 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
266 set this to @code{(+inf.0 . -inf.0)}.") | 268 set this to @code{(+inf.0 . -inf.0)}.") |
267 (extra-X-extent ,number-pair? "A grob is enlarged in | 269 (extra-X-extent ,number-pair? "A grob is enlarged in |
268 X@tie{}dimension by this much.") | 270 X@tie{}dimension by this much.") |
269 (extra-Y-extent ,number-pair? "A grob is enlarged in | 271 (extra-Y-extent ,number-pair? "A grob is enlarged in |
270 Y@tie{}dimension by this much.") | 272 Y@tie{}dimension by this much.") |
271 | 273 |
272 | 274 |
273 ;; | 275 ;; |
274 ;; f | 276 ;; f |
275 ;; | 277 ;; |
276 (flag ,ly:stencil? "A function returning the full flag stencil | |
277 for the @code{Stem}, which is passed to the function as the only | |
278 argument. The default ly:stem::calc-stencil function uses the | |
279 @code{flag-style} property to determine the correct glyph for the | |
280 flag. By providing your own function, you can create arbitrary | |
281 flags.") | |
282 (flag-count ,number? "The number of tremolo beams.") | 278 (flag-count ,number? "The number of tremolo beams.") |
283 (flag-style ,symbol? "A symbol determining what style of flag | |
284 glyph is typeset on a @code{Stem}. Valid options include @code{'()} | |
285 for standard flags, @code{'mensural} and @code{'no-flag}, which | |
286 switches off the flag.") | |
287 (font-encoding ,symbol? "The font encoding is the broadest | 279 (font-encoding ,symbol? "The font encoding is the broadest |
288 category for selecting a font. Currently, only lilypond's system | 280 category for selecting a font. Currently, only lilypond's system |
289 fonts (Emmentaler) are using this property. Available | 281 fonts (Emmentaler) are using this property. Available |
290 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces}, | 282 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces}, |
291 @code{fetaText} (Emmentaler).") | 283 @code{fetaText} (Emmentaler).") |
292 (font-family ,symbol? "The font family is the broadest category | 284 (font-family ,symbol? "The font family is the broadest category |
293 for selecting text fonts. Options include: @code{sans}, | 285 for selecting text fonts. Options include: @code{sans}, |
294 @code{roman}.") | 286 @code{roman}.") |
295 (font-name ,string? "Specifies a file name (without extension) of | 287 (font-name ,string? "Specifies a file name (without extension) of |
296 the font to load. This setting overrides selection using | 288 the font to load. This setting overrides selection using |
(...skipping 203 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
500 | 492 |
501 ;; | 493 ;; |
502 ;; l | 494 ;; l |
503 ;; | 495 ;; |
504 (labels ,list? "List of labels (symbols) placed on a column.") | 496 (labels ,list? "List of labels (symbols) placed on a column.") |
505 (layer ,integer? "An integer which determines the order of printing | 497 (layer ,integer? "An integer which determines the order of printing |
506 objects. Objects with the lowest value of layer are drawn first, then | 498 objects. Objects with the lowest value of layer are drawn first, then |
507 objects with progressively higher values are drawn, so objects with | 499 objects with progressively higher values are drawn, so objects with |
508 higher values overwrite objects with lower values. By default most | 500 higher values overwrite objects with lower values. By default most |
509 objects are assigned a layer value of 1.") | 501 objects are assigned a layer value of 1.") |
| 502 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger |
| 503 lines for.") |
510 (ledger-line-thickness ,number-pair? "The thickness of ledger | 504 (ledger-line-thickness ,number-pair? "The thickness of ledger |
511 lines. It is the sum of 2@tie{}numbers: The first is the factor for | 505 lines. It is the sum of 2@tie{}numbers: The first is the factor for |
512 line thickness, and the second for staff space. Both contributions | 506 line thickness, and the second for staff space. Both contributions |
513 are added.") | 507 are added.") |
| 508 (ledger-positions ,list? "Repeating pattern for the vertical positions |
| 509 of ledger lines. Bracketed groups are always shown together.") |
514 (left-bound-info ,list? "An alist of properties for determining | 510 (left-bound-info ,list? "An alist of properties for determining |
515 attachments of spanners to edges.") | 511 attachments of spanners to edges.") |
516 (left-padding ,ly:dimension? "The amount of space that is put | 512 (left-padding ,ly:dimension? "The amount of space that is put |
517 left to an object (e.g., a lyric extender).") | 513 left to an object (e.g., a lyric extender).") |
518 (length ,ly:dimension? "User override for the stem length of | 514 (length ,ly:dimension? "User override for the stem length of |
519 unbeamed stems.") | 515 unbeamed stems.") |
520 (length-fraction ,number? "Multiplier for lengths. Used for | 516 (length-fraction ,number? "Multiplier for lengths. Used for |
521 determining ledger lines and stem lengths.") | 517 determining ledger lines and stem lengths.") |
522 (line-break-penalty ,number? "Penalty for a line break at this | 518 (line-break-penalty ,number? "Penalty for a line break at this |
523 column. This affects the choices of the line breaker; it avoids a | 519 column. This affects the choices of the line breaker; it avoids a |
(...skipping 159 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
683 | 679 |
684 ;; | 680 ;; |
685 ;; r | 681 ;; r |
686 ;; | 682 ;; |
687 (ratio ,number? "Parameter for slur shape. The higher this | 683 (ratio ,number? "Parameter for slur shape. The higher this |
688 number, the quicker the slur attains its @code{height-limit}.") | 684 number, the quicker the slur attains its @code{height-limit}.") |
689 (remove-empty ,boolean? "If set, remove group if it contains no | 685 (remove-empty ,boolean? "If set, remove group if it contains no |
690 interesting items.") | 686 interesting items.") |
691 (remove-first ,boolean? "Remove the first staff of an orchestral | 687 (remove-first ,boolean? "Remove the first staff of an orchestral |
692 score?") | 688 score?") |
| 689 (replacement-alist ,list? "Alist of strings. |
| 690 The key is a string of the pattern to be replaced. The value is a |
| 691 string of what should be displayed. Useful for ligatures.") |
693 (restore-first ,boolean? "Print a natural before the | 692 (restore-first ,boolean? "Print a natural before the |
694 accidental.") | 693 accidental.") |
695 (rhythmic-location ,rhythmic-location? "Where (bar number, | 694 (rhythmic-location ,rhythmic-location? "Where (bar number, |
696 measure position) in the score.") | 695 measure position) in the score.") |
697 (right-bound-info ,list? "An alist of properties for determining | 696 (right-bound-info ,list? "An alist of properties for determining |
698 attachments of spanners to edges.") | 697 attachments of spanners to edges.") |
699 (right-padding ,ly:dimension? "Space to insert on the right side | 698 (right-padding ,ly:dimension? "Space to insert on the right side |
700 of an object (e.g., between note and its accidentals).") | 699 of an object (e.g., between note and its accidentals).") |
701 (rotation ,list? "Number of degrees to rotate this object, and | 700 (rotation ,list? "Number of degrees to rotate this object, and |
702 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 |
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
840 (staffgroup-staff-spacing ,list? "The spacing alist | 839 (staffgroup-staff-spacing ,list? "The spacing alist |
841 controlling the distance between the last staff of the current | 840 controlling the distance between the last staff of the current |
842 staff-group and the staff just below it in the same system, even | 841 staff-group and the staff just below it in the same system, even |
843 if one or more non-staff lines exist between the two staves. If | 842 if one or more non-staff lines exist between the two staves. If |
844 the @code{staff-staff-spacing} property of the staff's | 843 the @code{staff-staff-spacing} property of the staff's |
845 @code{VerticalAxisGroup} grob is set, that is used instead. See | 844 @code{VerticalAxisGroup} grob is set, that is used instead. See |
846 @code{staff-staff-spacing} for a description of the alist | 845 @code{staff-staff-spacing} for a description of the alist |
847 structure.") | 846 structure.") |
848 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} | 847 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} |
849 pair where the stem attaches to the notehead.") | 848 pair where the stem attaches to the notehead.") |
850 (stem-begin-position ,number? "Where does the stem begin (the | 849 (stem-begin-position ,number? "User override for the |
851 position of the support-head)?") | 850 begin position of a stem.") |
852 (stem-end-position ,number? "Where does the stem end (the end is | |
853 opposite to the support-head)?") | |
854 ;;[TODO: doco] | 851 ;;[TODO: doco] |
855 (stem-spacing-correction ,number? "Optical correction amount for | 852 (stem-spacing-correction ,number? "Optical correction amount for |
856 stems that are placed in tight configurations. For opposite | 853 stems that are placed in tight configurations. For opposite |
857 directions, this amount is the correction for two normal sized stems | 854 directions, this amount is the correction for two normal sized stems |
858 that overlap completely.") | 855 that overlap completely.") |
859 (stemlet-length ,number? "How long should be a stem over a | 856 (stemlet-length ,number? "How long should be a stem over a |
860 rest?") | 857 rest?") |
861 (stencil ,ly:stencil? "The symbol to print.") | 858 (stencil ,ly:stencil? "The symbol to print.") |
862 (stencils ,list? "Multiple stencils, used as intermediate | 859 (stencils ,list? "Multiple stencils, used as intermediate |
863 value.") | 860 value.") |
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
936 (word-space ,ly:dimension? "Space to insert between words in | 933 (word-space ,ly:dimension? "Space to insert between words in |
937 texts.") | 934 texts.") |
938 | 935 |
939 | 936 |
940 ;; | 937 ;; |
941 ;; x | 938 ;; x |
942 ;; | 939 ;; |
943 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.") | 940 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.") |
944 (X-offset ,number? "The horizontal amount that this object is | 941 (X-offset ,number? "The horizontal amount that this object is |
945 moved relative to its X-parent.") | 942 moved relative to its X-parent.") |
| 943 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner |
| 944 in the form @code{(@var{left} . @var{right})}, where both @var{left} and |
| 945 @var{right} are in @code{staff-space} units of the current staff.") |
946 | 946 |
947 | 947 |
948 ;; | 948 ;; |
949 ;; y | 949 ;; y |
950 ;; | 950 ;; |
951 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.") | 951 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.") |
952 (Y-offset ,number? "The vertical amount that this object is moved | 952 (Y-offset ,number? "The vertical amount that this object is moved |
953 relative to its Y-parent.") | 953 relative to its Y-parent.") |
954 | 954 |
955 ;; | 955 ;; |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1014 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary
grob?") | 1014 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary
grob?") |
1015 (dot ,ly:grob? "A reference to a @code{Dots} object.") | 1015 (dot ,ly:grob? "A reference to a @code{Dots} object.") |
1016 (dots ,ly:grob-array? "Multiple @code{Dots} objects.") | 1016 (dots ,ly:grob-array? "Multiple @code{Dots} objects.") |
1017 | 1017 |
1018 (elements ,ly:grob-array? "An array of grobs; the type is depending on | 1018 (elements ,ly:grob-array? "An array of grobs; the type is depending on |
1019 the grob where this is set in.") | 1019 the grob where this is set in.") |
1020 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid | 1020 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid |
1021 in addition to notes and stems.") | 1021 in addition to notes and stems.") |
1022 | 1022 |
1023 (figures ,ly:grob-array? "Figured bass objects for continuation line.") | 1023 (figures ,ly:grob-array? "Figured bass objects for continuation line.") |
| 1024 (flag ,ly:grob? "A pointer to a @code{Flag} object.") |
1024 | 1025 |
1025 (glissando-index ,integer? "The index of a glissando in its note | 1026 (glissando-index ,integer? "The index of a glissando in its note |
1026 column.") | 1027 column.") |
1027 (grace-spacing ,ly:grob? "A run of grace notes.") | 1028 (grace-spacing ,ly:grob? "A run of grace notes.") |
1028 | 1029 |
1029 (heads ,ly:grob-array? "An array of note heads.") | 1030 (heads ,ly:grob-array? "An array of note heads.") |
1030 | 1031 |
1031 (items-worth-living ,ly:grob-array? "An array of interesting items. If | 1032 (items-worth-living ,ly:grob-array? "An array of interesting items. If |
1032 empty in a particular staff, then that staff is erased.") | 1033 empty in a particular staff, then that staff is erased.") |
1033 | 1034 |
(...skipping 173 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1207 (virga ,boolean? "Is this neume a virga?") | 1208 (virga ,boolean? "Is this neume a virga?") |
1208 | 1209 |
1209 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") | 1210 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") |
1210 | 1211 |
1211 ))) | 1212 ))) |
1212 | 1213 |
1213 (define-public all-backend-properties | 1214 (define-public all-backend-properties |
1214 (append | 1215 (append |
1215 all-internal-grob-properties | 1216 all-internal-grob-properties |
1216 all-user-grob-properties)) | 1217 all-user-grob-properties)) |
LEFT | RIGHT |