1 ;;;; music-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define-public all-music-properties '())
11 (define (music-property-description symbol type? description)
12 (if (not (equal? #f (object-property symbol 'music-doc)))
14 (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
17 (set-object-property! symbol 'music-type? type?)
18 (set-object-property! symbol 'music-doc description)
19 (set! all-music-properties (cons symbol all-music-properties))
24 (music-property-description 'iterator-ctor procedure? "Function to construct music-event-iterator object for this Music")
25 (music-property-description 'duration ly:duration? "Duration of this note/lyric.")
26 (music-property-description 'metronome-count number? "How many beats in a minute?")
27 (music-property-description 'span-type string? "What kind of spanner should be created?
29 TODO: consider making type into symbol")
30 (music-property-description 'articulations music-list?
31 "Articulation events specifically for this note.")
32 (music-property-description 'articulation-type string? "key for script definitions alist.
34 TODO: consider making type into symbol ")
35 (music-property-description 'bass boolean? "Set if this note is a bass note in a chord")
36 (music-property-description 'cautionary boolean? "If set, this alteration needs cautionary accidental")
37 (music-property-description 'change-to-id string? "name of the context to change to ")
38 (music-property-description 'change-to-type symbol? "type of the context to change to.")
39 (music-property-description 'compress-procedure procedure? "compress this music expression. Argument 1: the music, arg 2: factor")
40 (music-property-description 'context-id string? "name of context")
41 (music-property-description 'context-type symbol? "type of context")
42 (music-property-description 'denominator integer? "denominator in a time signature")
43 (music-property-description 'digit integer? "digit for fingering")
44 (music-property-description 'direction ly:dir? "Print this up or down?")
45 (music-property-description 'tags list? "List of symbols that for denoting extra details,
46 eg. @code{\\tag #'part ...} could tag a piece of music as only being active in a part.")
49 (music-property-description 'text-type symbol? "Particular type of text script (eg. finger, dynamic).")
50 (music-property-description 'tempo-unit ly:duration? "The unit for the metronome count.")
51 (music-property-description 'tonic ly:pitch? "Base of the scale")
52 (music-property-description 'element ly:music? "The single child of a Music_wrapper music object, or the body of a repeat.")
53 (music-property-description 'elements music-list? "A list of elements for sequential of simultaneous music, or the alternatives of repeated music. ")
54 (music-property-description 'force-accidental boolean? "If set, a cautionary accidental should always be printed on this note")
55 (music-property-description 'grob-property symbol? "The symbol of the grob property to set. ")
56 (music-property-description 'grob-value scheme? "The value of the grob property to set")
57 (music-property-description 'inversion boolean? "If set, this chord note is inverted.")
58 (music-property-description 'label markup? "label of a mark.")
59 (music-property-description 'last-pitch ly:pitch? "The last pitch after relativization.")
60 (music-property-description 'length procedure? "How to compute the duration of this music")
61 (music-property-description 'internal-class-name string? "C++ class to use for this Music object")
62 (music-property-description 'name symbol? "Name of this music object")
63 (music-property-description 'numerator integer? "numerator of a time signature")
64 (music-property-description 'once boolean? "Apply this operation only during one time step?")
65 (music-property-description 'octavation integer?
66 "This pitch was octavated by how many octaves?
67 For chord inversions, this is negative.")
68 (music-property-description 'origin ly:input-location? "where was this piece of music defined?")
69 (music-property-description 'penalty number? "Penalty for break hint.")
70 (music-property-description 'pitch ly:pitch? "the pitch of this note")
71 (music-property-description 'pitch-alist list? "list of pitches jointly forming the scale of a key signature")
72 (music-property-description 'pop-first boolean? "Do a revert before we try to do a override on some grob property.")
73 (music-property-description 'procedure procedure?
74 "The function to run with \\applycontext. It must take a single argument, being the context.")
75 (music-property-description 'property-operations list?
76 "Do these operations for instantiating the context.")
77 (music-property-description 'predicate procedure? "the predicate of a \\outputproperty")
78 (music-property-description 'type symbol? "The type of this music object. Determines iteration in some cases.")
79 (music-property-description 'types list? "The types of this music object. Determines iteration in some cases.")
80 (music-property-description 'repeat-count integer? "do a @code{\repeat} how ofen?")
81 (music-property-description 'span-direction ly:dir? "Does this start or stop a spanner?")
83 (music-property-description 'start-moment-function procedure? "Function to compute the negative length of
84 starting grace notes.")
85 (music-property-description 'string-number integer? "The number of the string in a String_number_req")
86 (music-property-description 'symbol symbol? "Grob name to perform an override/revert on.")
87 (music-property-description 'text markup? "markup expression to be printed")
89 (music-property-description 'tremolo-type integer? "")
90 (music-property-description 'value scheme? "Assignment value for a
91 translation property")
92 (music-property-description 'what symbol? "What to change for auto-change. FIXME, naming")
94 (music-property-description 'figure string? "a `figure' (which may be
95 a string) for figured bass")
96 (music-property-description 'alteration number? "alteration for figured bass")
97 (music-property-description 'bracket-start boolean? "start a bracket
98 here. TODO: use span requests?")
99 (music-property-description 'bracket-stop boolean? "stop a bracket here.")