LilyPondLiteral

class indicatortools.LilyPondLiteral(name=None, format_slot=None)

LilyPond literal.

Dotted slur:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> slur = spannertools.Slur()
>>> attach(slur, staff[:])
>>> literal = indicatortools.LilyPondLiteral(r'\slurDotted')
>>> attach(literal, staff[0])
>>> show(staff) 

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.LilyPondLiteral.LilyPondLiteral" [color=black, fontcolor=white, group=2, label=<<B>LilyPondLiteral</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.LilyPondLiteral.LilyPondLiteral"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

default_scope Gets default scope of LilyPond literal.
format_slot Gets format slot of LilyPond literal.
list_allowable_format_slots() Lists allowable format slots.
name Gets name of LilyPond literal.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats LilyPond literal.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

LilyPondLiteral.default_scope

Gets default scope of LilyPond literal.

>>> literal = indicatortools.LilyPondLiteral(r'\slurDotted')
>>> literal.default_scope is None
True

Returns none.

LilyPondLiteral.format_slot

Gets format slot of LilyPond literal.

>>> literal = indicatortools.LilyPondLiteral(r'\slurDotted')
>>> literal.format_slot
'opening'

Defaults to ‘opening’.

Returns string.

LilyPondLiteral.name

Gets name of LilyPond literal.

>>> literal = indicatortools.LilyPondLiteral(r'\slurDotted')
>>> literal.name
'\\slurDotted'

Returns string.

Class & static methods

static LilyPondLiteral.list_allowable_format_slots()

Lists allowable format slots.

>>> for slot in LilyPondLiteral.list_allowable_format_slots():
...     slot
... 
'after'
'before'
'closing'
'opening'
'right'

Returns tuple.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

LilyPondLiteral.__format__(format_specification='')

Formats LilyPond literal.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.