LilyPond Internals Reference: 3.1.25 Clef

### 3.1.25 Clef

Clef objects are created by: Clef_engraver.

Standard settings:

> `avoid-slur` (symbol):

>   `'inside`

>   Method of handling slur collisions. Choices are `inside`, `outside`, `around`, and `ignore`. `inside` adjusts the slur if needed to keep the grob inside the slur. `outside` moves the grob vertically to the outside of the slur. `around` moves the grob vertically to the outside of the slur only if there is a collision. `ignore` does not move either. In grobs whose notational significance depends on vertical position (such as accidentals, clefs, etc.), `outside` and `around` behave like `ignore`.

> `break-align-anchor` (number):

>   `ly:break-aligned-interface::calc-extent-aligned-anchor`

>   Grobs aligned to this break-align grob will have their X-offsets shifted by this number. In bar lines, for example, this is used to position grobs relative to the (visual) center of the bar line.

> `break-align-symbol` (symbol):

>   `'clef`

>   This key is used for aligning and spacing breakable items.

> `break-visibility` (vector):

>   `#(#f #f #t)`

>   A vector of 3 booleans, `#(end-of-line unbroken begin-of-line)`. `#t` means visible, `#f` means killed.

> `glyph-name` (string):

>   `ly:clef::calc-glyph-name`

>   The glyph name within the font.

> `non-musical` (boolean):

>   `#t`

>   True if the grob belongs to a `NonMusicalPaperColumn`.

> `space-alist` (list):

>   `'((cue-clef extra-space . 2.0) (staff-bar extra-space . 0.7) (key-cancellation minimum-space . 3.5) (key-signature minimum-space . 3.5) (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`.

> `stencil` (stencil):

>   `ly:clef::print`

>   The symbol to print.

> `Y-offset` (number):

>   `ly:staff-symbol-referencer::callback`

>   The vertical amount that this object is moved relative to its Y-parent.

This object supports the following interface(s): break-aligned-interface, clef-interface, font-interface, grob-interface, item-interface and staff-symbol-referencer-interface.

#### Internals Reference