Next: , Previous: ChordName, Up: All layout objects



Clef

Clef objects are created by: Clef_engraver

Standard settings:

print-function (procedure):
Clef::print

Function taking grob as argument, returning a Stencil object.

before-line-breaking-callback (procedure):
Clef::before_line_breaking

This procedure is called before line breaking, but after splitting breakable items at potential line breaks.

breakable (boolean):
#t

Can this object appear at a line break, like clefs and bar lines?

font-family (symbol):
'music

The font family is the broadest category for selecting text fonts. Options include: sans, roman

break-align-symbol (symbol):
'clef

This key is used for aligning and spacing breakable items.

break-visibility (procedure):
begin-of-line-visible

A function that takes the break direction and returns a cons of booleans containing (transparent . empty). The following variables are predefined: all-visible, begin-of-line-visible, end-of-line-visible, begin-of-line-invisible, end-of-line-invisible, all-invisible.

space-alist (list):
'((ambitus extra-space . 2.0) (staff-bar extra-space . 0.7) (key-signature minimum-space . 4.0) (time-signature minimum-space . 4.2) (first-note minimum-fixed-space . 5.0) (next-note extra-space . 0.5) (right-edge extra-space . 0.5))

A table that specifies distances between prefatory items, like clef and time-signature. The format is an alist of spacing tuples: (break-align-symbol type . distance), where type can be the symbols minimum-space or extra-space.

Y-offset-callbacks (list):
'(#<primitive-procedure Staff_symbol_referencer::callback>)

see X-offset-callbacks.

This object supports the following interfaces: item-interface, break-aligned-interface, font-interface, staff-symbol-referencer-interface, clef-interface and grob-interface

Read comments on this page, or add one.

This page is for LilyPond-2.2.6 (stable-branch).

Report errors to <bug-lilypond@gnu.org>.