FoscMarkupCommand

Returns a FoscMarkupCommand.


Description

FoscMarkupCommand


Attributes Summary

Class Methods

*combineMarkupCommands Combines markup command and / or strings.

Instance Properties

argument Gets markup command arguments.
command Gets markup command name.
forceQuotes Is true when markup command should force quotes around arguments. Otherwise false.
forceQuotes_

Instance Methods: SPECIAL

== Is true when argument is a markup command with command and arguments equal
format Formats markup command.
hash Hashes markup command.
asCompileString (abjad: repr)
str Gets string representation of markup command.


Usage

  1. Example

    m = FoscMarkupCommand('draw-circle', 0, 1, 2, 3);
    FoscMarkup(m).format;
    \markup {
        \draw-circle
            #0
            #1
            #2
            #3
    }


Class Methods


*combineMarkupCommands

Combines markup command and / or strings.

LilyPond’s \combine markup command can only take two arguments, so in order to combine more than two stencils, a cascade of \combine commands must be employed. combine_markup_commands simplifies this process.

Returns a markup command instance, or a string if that was the only argument.


Instance Properties


argument

Gets markup command arguments.

Returns array.


command

Gets markup command name.

Returns string.

! TODO: change to MarkupCommand.name


forceQuotes

Is true when markup command should force quotes around arguments. Otherwise false.

The rendered result of forced and unforced quotes is the same.

Defaults to false.

Returns true or false.


forceQuotes_


Instance Methods: SPECIAL


==

Is true when argument is a markup command with command and arguments equal to those of this markup command. Otherwise false.

Returns true or false.


format

Formats markup command.

Returns string.


hash

Hashes markup command.

Returns integer.


asCompileString

(abjad: repr)

Gets markup command interpreter representation.

Returns string.


str

Gets string representation of markup command.

Returns string.