LilyPondCommand

class indicatortools.LilyPondCommand(name=None, format_slot=None, prefix='\')

A LilyPond command.

Example 1. Dotted slur:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> slur = spannertools.Slur()
>>> attach(slur, staff[:])
>>> command = indicatortools.LilyPondCommand('slurDotted')
>>> attach(command, 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.LilyPondCommand.LilyPondCommand" [color=black, fontcolor=white, group=2, label=<<B>LilyPondCommand</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.LilyPondCommand.LilyPondCommand"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

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

Read-only properties

LilyPondCommand.default_scope

Gets default scope of LilyPond command.

Example 1. Dotted slur:

>>> command = indicatortools.LilyPondCommand('slurDotted')
>>> command.default_scope is None
True

Returns none.

LilyPondCommand.format_slot

Gets format slot of LilyPond command.

Example 1. Dotted slur:

>>> command = indicatortools.LilyPondCommand('slurDotted')
>>> command.format_slot
'opening'

Defaults to ‘opening’.

Returns string.

LilyPondCommand.name

Gets name of LilyPond command.

Example 1. Dotted slur:

>>> command = indicatortools.LilyPondCommand('slurDotted')
>>> command.name
'slurDotted'

Returns string.

LilyPondCommand.prefix

Gets prefix.

Defaults to ‘\’.

Set to string.

Returns string.

Class & static methods

static LilyPondCommand.list_allowable_format_slots()

Lists allowable format slots.

Example 1. Default:

>>> commands = indicatortools.LilyPondCommand.list_allowable_format_slots()
>>> for command in commands:
...     command
... 
'after'
'before'
'closing'
'opening'
'right'

Returns tuple of strings.

Special methods

(AbjadValueObject).__copy__(*args)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(expr)

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

Returns true or false.

LilyPondCommand.__format__(format_specification='')

Formats LilyPond command.

Set format_specification to ‘’, ‘lilypond‘ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(expr)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.