musx::dom::others Namespace Reference

Classes in the OthersPool. More...

Classes
class	AcciAmountFlats
	Lists the aleration values of each nth flat in a custom key signature. Normally these values are all set to the number of EDO divisions in a chromatic half-step. More...
class	AcciAmountSharps
	Lists the aleration values of each nth sharp in a custom key signature. Normally these values are all set to the number of EDO divisions in a chromatic half-step. More...
class	AcciOrderFlats
	Lists the order of flats by pitch class index (0..6 = C..B) in a custom key signature. Note that while flats are numbered from 1-7, this table is indexed 0-6. More...
class	AcciOrderSharps
	Lists the order of sharps by pitch class index (0..6 = C..B) in a custom key signature. Note that while sharps are numbered from 1-7, this table is indexed 0-6. More...
class	ArticulationDef
	Stores the properties and behaviors of articulation definitions. More...
class	BeatChartElement
	A single beat chart element from Finale's music spacing system. More...
class	ChordSuffixElement
	Represents a single element in a chord suffix (e.g., a symbol like "1" or "+"). More...
class	ChordSuffixPlayback
	Represents a list of repeat ending numbers for a RepeatEndingStart instance. More...
class	ClefList
	Represents an element in multimeasure clef list with its positioning and percentage values. More...
class	DrumStaff
	Identifies the percussion map ("drum library") for a staff with percussion notation. More...
class	DrumStaffStyle
	Identifies the percussion map ("drum library") for a staff style with percussion notation. More...
class	Enclosure
	Represents the enclosure settings for text expressions. More...
class	FileAlias
	Opaque storage for a platform-specific alias handle associated with a graphic. More...
class	FileDescription
	Describes the locator flavor Finale used for the associated file/graphic. More...
class	FilePath
	Stores a human-readable path/leaf name recorded by Finale. More...
class	FileUrlBookmark
	Opaque storage for a platform-specific URL/bookmark blob (e.g., macOS CFURL bookmark). More...
class	FontDefinition
	The name and font characteristics of fonts contained. More...
class	Frame
	Represents the attributes of a TGF entry frame. More...
class	FretboardGroup
	A named group of fretboard diagrams associated with a specific fretboard instrument. More...
class	FretboardStyle
	Fretboard diagram style: shapes, spacing, fonts, and offsets. More...
class	FretInstrument
	Describes a fretted instrument (strings, frets, name, clef). It is used for both TAB notation and FretboardGroup instances. More...
class	KeyAttributes
	Represents the attributes associated with a Finale key signature. More...
class	KeyFormat
	The key format for a custom key signature. More...
class	KeyMapArray
	An array of step elements from which one can create a key map. More...
class	LayerAttributes
	Represents the attributes of a Finale "layer". More...
class	MarkingCategory
	Represents a category of markings used. More...
class	MarkingCategoryName
	Represents the name associated with a MarkingCategory. More...
class	Measure
	Represents the attributes of a measure. More...
class	MeasureExprAssign
	Assigns a TextExpressionDef or ShapeExpressionDef to a measure. More...
class	MeasureNumberRegion
	Represents the Measure Number Region with detailed font and enclosure settings for score and part data. More...
class	MultimeasureRest
	Represents the attributes of a multimeasure rest in the page layout. More...
class	MultiStaffGroupId
	Represents a group ID for a multi-staff setup. More...
class	MultiStaffInstrumentGroup
	Represents a group of instruments spanning multiple staves. More...
class	MusicRange
	Represents a range of music using measure and EDUs. More...
class	NamePositionAbbreviated
	Overrides abbreviated name positioning for Staff. More...
class	NamePositionFull
	Overrides full name positioning for Staff. More...
class	NamePositioning
	Contains horizontal and vertical offsets, alignment, and expansion settings for name positioning. More...
class	NamePositionStyleAbbreviated
	Overrides abbreviated name positioning for StaffStyle. More...
class	NamePositionStyleFull
	Overrides full name positioning for StaffStyle. More...
class	OssiaBounds
	Stores additional positioning offsets for ossia passages. More...
class	OssiaHeader
	Header properties for an ossia passage (clef, key, time, grouping). More...
class	OssiaMusic
	Stores display and source options for an ossia passage. More...
class	Page
	Represents the attributes of a page in the page layout. More...
class	PageGraphicAssign
	Represents a page graphic assignment with positioning and page-range properties. More...
class	PageOssiaAssign
	Represents the assignment of an ossia passage to a specific page. More...
class	PageTextAssign
	Represents a page text assignment with positioning and page range properties. More...
class	PartDefinition
	Represents the attributes of a Finale "partDef". More...
class	PartGlobals
	Represents global values that can vary by part. More...
class	PartVoicing
	Defines voicing options for linked parts, either by selection rules or by assigning a layer. More...
class	PercussionNoteInfo
	Represents percussion notehead and staff position info for a given percussion note type. More...
class	RepeatBack
	Represents a repeat-backward marker with positioning and behavior properties. More...
class	RepeatEndingStart
	Represents a repeat ending start marker in the document. More...
class	RepeatEndingText
	Represents the text associated with a RepeatEndingStart. More...
class	RepeatPassList
	Represents a list of repeat ending numbers for a RepeatEndingStart instance. More...
class	ShapeData
	Represents the data for instruction associated with a ShapeDef. More...
class	ShapeDef
	Represents a shape created in Finale's Shape Designer. More...
class	ShapeExpressionDef
	Stores the properties and behaviors of shape expressions. More...
class	ShapeGraphicAssign
	Represents a graphic assignment anchored to a specific staff and measure. More...
struct	ShapeInstruction
	Helper functions and structs for decoding instruction data vectors in ShapeDef. More...
class	ShapeInstructionList
	Represents the data for instruction associated with a ShapeDef. More...
class	SmartShape
	Represents a Finale smart shape. More...
class	SmartShapeCustomLine
	Represents a Finale smart shape custom line style. More...
class	SmartShapeMeasureAssign
	Assigns a smart shape or center shape to a measure. More...
class	SplitMeasure
	Defines the split point(s) where a measure may be divided between two systems. A measure can only split once, but Finale stores them as an array. Perhaps this was intended to support alternative break positions depending on spacing. See the warning below for the actual behavior. More...
class	Staff
	Represents the definition of a Finale staff. More...
class	StaffComposite
	Represents a composite of an underlying Staff instance with any applicable StaffStyle instances applied. More...
class	StaffList
	Defines a staff list. See subclasses for how it is used. More...
class	StaffListCategoryName
	This class specified the name of a staff list used by @ ref MarkingCategory. More...
class	StaffListCategoryParts
	This class is used by MarkingCategory to define the staves for parts in a staff list. More...
class	StaffListCategoryScore
	This class is used by MarkingCategory to define the staves for parts in a staff list. More...
class	StaffListRepeatName
	This class specified the name of a staff list used by RepeatEndingStart, RepeatBack, and TextRepeatAssign. More...
class	StaffListRepeatParts
	This class is used by repeat classes to define the staves for parts in a staff list. More...
class	StaffListRepeatPartsForced
	This class is used by repeat classes to define the forced staves for parts in a staff list. Repeats on these staves appear even if the staff has turned them off with Staff::hideRepeats or Staff::hideRptBars. More...
class	StaffListRepeatScore
	This class is used by repeat classes to define the staves for the score in a staff list. More...
class	StaffListRepeatScoreForced
	This class is used by repeat classes to define the forced staves for the score in a staff list. Repeats on these staves appear even if the staff has turned them off with Staff::hideRepeats or Staff::hideRptBars. More...
class	StaffStyle
	Represents a Finale staff style. More...
class	StaffStyleAssign
	Represents an assignment. More...
class	StaffSystem
	Represents the attributes of a staff system in the page layout. More...
class	StaffUsed
	An array of StaffUsed defines a set of staves in a staff system or in Scroll View. More...
class	SystemLock
	Locks a span of one or more measures so that they always appear in a StaffSystem together. More...
class	TempoChange
	A single tempo change value entered with Finale's Tempo tool. More...
class	TextBlock
	Represents the attributes of a Finale "textBlock". More...
class	TextExpressionDef
	Stores the properties and behaviors of text expressions. More...
class	TextExpressionEnclosure
	The enclosure for a text expression (if it exists) More...
class	TextRepeatAssign
	Represents a text repeat assignment with positioning and behavior properties. More...
class	TextRepeatDef
	Defines text repeat elements with font styling and justification. More...
class	TextRepeatEnclosure
	The enclosure for a text expression (if it exists) More...
class	TextRepeatText
	Represents the text associated with a TextRepeatDef. More...
class	TimeCompositeLower
	Represents the lower composite time signature array. More...
class	TimeCompositeUpper
	Represents the upper composite time signature structure. More...
class	TonalCenterFlats
	Maps the number of flats to a tonal center for a linear custom key. If there are zero flats or sharps, do not use this table. Use TonalCenterSharps for zero. If the key has flats, the number is returned as a negative number (-1..-7) from KeySignature::getAlteration. Use the absolute value of that number to index this table. More...
class	TonalCenterSharps
	Maps number of sharps (0..7) to a tonal center for a linear custom key. Also maps 0 sharps or flats. For a non-linear key, the first element is the tonal center and the rest are meaningless. More...

Enumerations
enum class	RehearsalMarkStyle {   None , Letters , LetterNumbers , LettersLowerCase ,   LettersNumbersLowerCase , Numbers , MeasureNumber }
	Specifies the sequencing style for rehearsal marks. More...
enum class	PlaybackType {   None , Tempo , MidiController , KeyVelocity ,   Transpose , Channel , MidiPatchChange , PercussionMidiMap ,   MidiPitchWheel , ChannelPressure , RestrikeKeys , Dump ,   PlayTempoToolChanges , IgnoreTempoToolChanges , Swing , SmartPlaybackOn ,   SmartPlaybackOff }
	Specifies the playback behavior for the an expression or marking category. More...
enum class	HorizontalMeasExprAlign {   LeftBarline , Manual , LeftOfAllNoteheads , LeftOfPrimaryNotehead ,   Stem , CenterPrimaryNotehead , CenterAllNoteheads , RightOfAllNoteheads ,   StartTimeSig , AfterClefKeyTime , StartOfMusic , CenterOverBarlines ,   CenterOverMusic , RightBarline }
	Specifies the horizontal alignment relative to musical elements for an expression or marking category. More...
enum class	VerticalMeasExprAlign {   AboveStaff , Manual , RefLine , BelowStaff ,   TopNote , BottomNote , AboveEntry , BelowEntry ,   AboveStaffOrEntry , BelowStaffOrEntry }
	Specifies the vertical alignment relative to musical elements for an expression or marking category. More...
enum class	HorizontalTextJustification { Left , Center , Right }
	Specifies the horizontal alignment for text expressions and marking categories. More...
enum class	RepeatActionType {   JumpAuto , JumpAbsolute , JumpRelative , JumpToMark ,   Stop , NoJump }
	Enum for the possible values of the <action> element. More...
enum class	RepeatTriggerType { Always , OnPass , UntilPass }
	Enum for the possible values of the <trigger> element. More...

Detailed Description

Classes in the OthersPool.

Enumeration Type Documentation

HorizontalMeasExprAlign

enum class musx::dom::others::HorizontalMeasExprAlign

strong

Specifies the horizontal alignment relative to musical elements for an expression or marking category.

Enumerator
LeftBarline	Align with left barline (the default). (xml value is "leftEdge", if encountered)
Manual	"Horizontal Click Position" alignment.
LeftOfAllNoteheads	Align left of all noteheads.
LeftOfPrimaryNotehead	Align to the left of the primary notehead.
Stem	Align to the stem.
CenterPrimaryNotehead	Align to the center of the primary notehead.
CenterAllNoteheads	Align to the center of all noteheads.
RightOfAllNoteheads	Align to the right of all noteheads.
StartTimeSig	Align at the start of the time signature.
AfterClefKeyTime	Align after clef/key/time/repeat.
StartOfMusic	Align at start of music.
CenterOverBarlines	Align over the center of the barlines.
CenterOverMusic	Align over the center of music.
RightBarline	Align with left barline. (xml value is "rightEdge")

HorizontalTextJustification

enum class musx::dom::others::HorizontalTextJustification

strong

Specifies the horizontal alignment for text expressions and marking categories.

Enumerator
Left	Justified left.
Center	Justified center.
Right	Justified right.

PlaybackType

enum class musx::dom::others::PlaybackType

strong

Specifies the playback behavior for the an expression or marking category.

Enumerator
None	Default value, no playback (the default).
Tempo	Playback affects tempo. (xml value is "time")
MidiController	Playback type for MIDI controller commands.
KeyVelocity	Playback affects key velocity. (xml value is "amplitude")
Transpose	Playback causes transposition.
Channel	Playback set the MIDI channel.
MidiPatchChange	Playback changes the MIDI patch.
PercussionMidiMap	Playback uses percussion MIDI map. (xml value is "percMidiMap")
MidiPitchWheel	Playback affects the MIDI pitch wheel. (xml value is "midiPitchwheel")
ChannelPressure	Playback affects MIDI channel pressure. (xml value is "midiPressure")
RestrikeKeys	Playback retrikes keys. (xml value is "rekey")
Dump	Playback is an arbitrary data dump. (Data is in node <playDumpText> with the same Cmper value.)
PlayTempoToolChanges	Play changes from Tempo Tool. (xml value is "startTempo")
IgnoreTempoToolChanges	Ignore changes from Tempo Tool. (xml value is "stopTempo")
Swing	Playback in swing style.
SmartPlaybackOn	Turn on smart playback. (xml value is "hpOn")
SmartPlaybackOff	Turn off smart playback. (xml value is "hpOff")

RehearsalMarkStyle

enum class musx::dom::others::RehearsalMarkStyle

strong

Specifies the sequencing style for rehearsal marks.

Enumerator
None	Default value, no rehearsal mark style.
Letters	A, B, C...AA, BB, CC.
LetterNumbers	A, B, C...A1, B1, C1.
LettersLowerCase	a, b, c...aa, bb, cc
LettersNumbersLowerCase	a, b, c...a1, b1, c1
Numbers	1, 2, 3, 4
MeasureNumber	Displays the current measure number.

RepeatActionType

enum class musx::dom::others::RepeatActionType

strong

Enum for the possible values of the <action> element.

Enumerator
JumpAuto	Automatically Jump. (the default). The targetValue is meaningless for this action.
JumpAbsolute	Jump to the measure number specified in the targetValue field.
JumpRelative	Jump relative to the current measure. The targetValue field specifies how many measures to jump. The targetValue may be positive or negative for forward or backward relative jumps.
JumpToMark	Jump to a specified repeat number (used by text repeats).
Stop	Stops playback after a number of passes (e.g. "Fine")
NoJump	Do not jump. The targetValue is meaningless for this action.

RepeatTriggerType

enum class musx::dom::others::RepeatTriggerType

strong

Enum for the possible values of the <trigger> element.

Enumerator
Always	Always jump (the default)
OnPass	Jump on a sepecified pass number.
UntilPass	Jump until a specified pass number is reached.

VerticalMeasExprAlign

enum class musx::dom::others::VerticalMeasExprAlign

strong

Specifies the vertical alignment relative to musical elements for an expression or marking category.

Enumerator
AboveStaff	Align above ths staff (the default).
Manual	"Vertical Click Position" alignment.
RefLine	Align to staff reference line.
BelowStaff	Align below the staff.
TopNote	Align with top note.
BottomNote	Align with bottom note.
AboveEntry	Align above entry.
BelowEntry	Align below entry.
AboveStaffOrEntry	Align above the staff or entry.
BelowStaffOrEntry	Align below the staff or entry.