LPPart explanation of what LPPart is and/or does

Inherits from: Object : LPObj

More detailed prose description of LPPart.

See also: Object [some other help files]

Some Important Issues Regarding LPPart (optional)

Explanation of the issues. For more information see Nil and [some other help files].

Creation / Class Methods

*new (id, clef, timeSig, keySig, voice)

Short prose description of method.

id - Explanation of id. Default value is nil. Other information.

clef - Explanation of clef. Default value is nil. Other information.

timeSig - Explanation of timeSig. Default value is nil. Other information.

keySig - Explanation of keySig. Default value is nil. Other information.

voice - Explanation of voice. Default value is nil. Other information.

// inline example

g = LPPart.new;

g.doSomething; // explanation

g.cleanUpMethod;

Accessing Instance and Class Variables

timeSig_(arg1)

timeSig

Explanation including the type of timeSig and a link to its help file.

Default value is nil.

keySig_(arg1)

keySig

Explanation including the type of keySig and a link to its help file.

Default value is nil.

clef_(arg1)

clef

Explanation including the type of clef and a link to its help file.

Default value is nil.

voices

Explanation including the type of voices and a link to its help file.

Default value is nil.

id_(arg1)

id

Explanation including the type of id and a link to its help file.

Default value is nil.

staffLines_(arg1)

staffLines

Explanation including the type of staffLines and a link to its help file.

Default value is nil.

spatial_(arg1)

spatial

Explanation including the type of spatial and a link to its help file.

Default value is nil.

Doing Some Task (optional)

A short bit of prose explaining something about the task.

initLPPart (argID, argVoice, argClef, argTimeSig, argKeySig)

Short prose description of method.

argID - Explanation of argID. Default value is nil. Other information.

argVoice - Explanation of argVoice. Default value is nil. Other information.

argClef - Explanation of argClef. Default value is nil. Other information.

argTimeSig - Explanation of argTimeSig. Default value is nil. Other information.

argKeySig - Explanation of argKeySig. Default value is nil. Other information.

// inline example

g = LPPart.initLPPart;

g.doSomething; // explanation

g.cleanUpMethod;

useSpatial (hideTime, hideBars)

Short prose description of method.

hideTime - Explanation of hideTime. Default value is true. Other information.

hideBars - Explanation of hideBars. Default value is true. Other information.

// inline example

g = LPPart.useSpatial;

g.doSomething; // explanation

g.cleanUpMethod;

hideClef

Short prose description of method.

// inline example

g = LPPart.hideClef;

g.doSomething; // explanation

g.cleanUpMethod;

hideKeySig

Short prose description of method.

// inline example

g = LPPart.hideKeySig;

g.doSomething; // explanation

g.cleanUpMethod;

hideTimeSig

Short prose description of method.

// inline example

g = LPPart.hideTimeSig;

g.doSomething; // explanation

g.cleanUpMethod;

hideBarLine

Short prose description of method.

// inline example

g = LPPart.hideBarLine;

g.doSomething; // explanation

g.cleanUpMethod;

showClef

Short prose description of method.

// inline example

g = LPPart.showClef;

g.doSomething; // explanation

g.cleanUpMethod;

showKeySig

Short prose description of method.

// inline example

g = LPPart.showKeySig;

g.doSomething; // explanation

g.cleanUpMethod;

showTimeSig

Short prose description of method.

// inline example

g = LPPart.showTimeSig;

g.doSomething; // explanation

g.cleanUpMethod;

showBarLine

Short prose description of method.

// inline example

g = LPPart.showBarLine;

g.doSomething; // explanation

g.cleanUpMethod;

setNumStaffLines (numLines)

Short prose description of method.

numLines - Explanation of numLines. Default value is nil. Other information.

// inline example

g = LPPart.setNumStaffLines;

g.doSomething; // explanation

g.cleanUpMethod;

addVoice (aVoice)

Short prose description of method.

aVoice - Explanation of aVoice. Default value is nil. Other information.

// inline example

g = LPPart.addVoice;

g.doSomething; // explanation

g.cleanUpMethod;

add (anEvent)

Short prose description of method.

anEvent - Explanation of anEvent. Default value is nil. Other information.

// inline example

g = LPPart.add;

g.doSomething; // explanation

g.cleanUpMethod;

output (file, score)

Short prose description of method.

file - Explanation of file. Default value is nil. Other information.

score - Explanation of score. Default value is nil. Other information.

// inline example

g = LPPart.output;

g.doSomething; // explanation

g.cleanUpMethod;

headOutput (file)

Short prose description of method.

file - Explanation of file. Default value is nil. Other information.

// inline example

g = LPPart.headOutput;

g.doSomething; // explanation

g.cleanUpMethod;

addVoiceOverride (layoutObj, layoutProp, value, context)

Short prose description of method.

layoutObj - Explanation of layoutObj. Default value is nil. Other information.

layoutProp - Explanation of layoutProp. Default value is nil. Other information.

value - Explanation of value. Default value is nil. Other information.

context - Explanation of context. Default value is nil. Other information.

// inline example

g = LPPart.addVoiceOverride;

g.doSomething; // explanation

g.cleanUpMethod;

Examples

// what this example does

e = LPPart.new;

e.instanceMethod(someObject);

e.cleanUp;

...