GNU LilyPond

Welcome to the home of the GNU Music Typesetter

Node:Clef, Next:ChordName, Previous:BreathingSign, Up:LilyPond backend

Clef

Clef grobs are created by: Clef_engraver

break-aligned-interface

Items that are aligned in prefatory matter

break-align-symbol (symbol):

the index in the spacing table (symbol) of the to be aligned item. Default value: 'Clef_item

visibility-lambda (procedure):

a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY). Default value: #<procedure begin-of-line-visible (d)>

breakable (boolean):

boolean indicating if this is a breakable item (clef, barline, key sig, etc.). Default value: #t

font-interface

Any symbol that is typeset through fixed sets of glyphs (ie. fonts)

font-style (symbol):

a precooked set of font definitions, eg. finger volta timesig mark script large Large dynamic. Default value: (unset)

font-series (symbol):

partial font definition: medium, bold. Default value: (unset)

font-shape (symbol):

partial font definition: upright or italic. Default value: (unset)

font-family (symbol):

partial font definition: music roman braces dynamic math ... Default value: 'music

font-name (symbol):

partial font definition: base name of font file FIXME: should override other partials. Default value: (unset)

font-design-size (number):

partial font definition: exact font size in points FIXME: should override font-relative-size. Default value: (unset)

font-relative-size (number):

partial font definition: the relative size compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller. Default value: (unset)

clef-interface

A clef sign

non-default (boolean):

not set because of existence of a bar?. Default value: (unset)

full-size-change (boolean):

if set, don't make a change clef smaller. Default value: (unset)

glyph (symbol):

a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property. . Default value: (unset)

general-grob-interface

All grobs support this

X-offset-callbacks (list):

list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first. Default value: (unset)

Y-offset-callbacks (list):

see X-offset-callbacks. Default value: '(#<primitive-procedure Staff_symbol_referencer::callback>)

X-extent-callback (procedure):

procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob. Default value: (unset)

Y-extent-callback (procedure):

see X-extent-callback. Default value: (unset)

molecule-callback (procedure):

Function taking grob as argument, returning a Scheme encoded Molecule. Default value: #<primitive-procedure Clef::brew_molecule>

font-relative-size (number):

partial font definition: the relative size compared the `normal' size. 0 is style-sheet's normal size, -1 is smaller, +1 is bigger, -1 is smaller. Default value: (unset)

extra-offset (pair of numbers):

pair of reals (a cons) forcing an extra offset before outputting. extra-offset is added just before `printing' the grob, so the typesetting engine is completely oblivious to it.

Default value: (unset)

interfaces (list):

list of symbols indicating the interfaces supported by this object. Is initialized from the meta field. Default value: (unset)

dependencies (list):

list of score-grob pointers that indicate who to compute first for certain global passes. Default value: (unset)

no-spacing-rods (boolean):

read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM). Default value: (unset)

extra-extent-X (pair of numbers):

enlarge in X dimension by this much, measured in staff space. Default value: (unset)

extra-extent-Y (pair of numbers):

see extra-extent-Y. Default value: (unset)

minimum-extent-X (pair of numbers):

minimum size in X dimension, measured in staff space. Default value: (unset)

minimum-extent-Y (pair of numbers):

see minimum-extent-Y. Default value: (unset)

origin (input location):

location in input file of the definition. Default value: (unset)

transparent (boolean):

This is almost the same as setting molecule-callback to #f, but this retains the dimensions of this grob, which means that you can erase grobs individually. . Default value: (unset)

Please send GNU LilyPond questions and comments to lilypond-user@gnu.org.

Please send comments on these web pages to lilypond@packages.debian.org

Copyright (c) 1997--2001 Han-Wen Nienhuys and Jan Nieuwenhuizen.

Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.