Options controlling chord symbol and fretboard rendering. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::ChordOptions:

Public Types
enum class	ChordAlignment { Left , Center }
	Horizontal alignment for chord symbols. More...

enum class	ChordStyle { Standard , European , German , Roman , NashvilleA , NashvilleB , Solfeggio , Scandinavian }
	Chord spelling style. More...

Public Types inherited from musx::dom::EnigmaBase
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...

using	SharedNodes = std::set< std::string >
	The container type for shared nodes.

Public Member Functions
	ChordOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor function.

Public Member Functions inherited from musx::dom::EnigmaBase
Cmper	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.

ShareMode	getShareMode () const
	Gets the sharing mode for this instance.

const SharedNodes &	getUnlinkedNodes () const
	Gets the unlinked nodes for this instance. (Only populated for `ShareMode::Partial`)

void	addUnlinkedNode (const std::string &nodeName)
	Adds a shared node for this instance.

virtual void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.

virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.

Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.

DocumentPtr	getDocument () const
	Gets a reference to the Document.

Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< ChordOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
double	fretPercent {}
	Percent size of fretboard relative to default. (1.0 is 100%)

double	chordPercent {}
	Percent size of chord symbol relative to default. (1.0 is 100%)

Evpu	chordSharpLift {}
	Vertical offset for sharp chord symbols.

Evpu	chordFlatLift {}
	Vertical offset for flat chord symbols.

Evpu	chordNaturalLift {}
	Vertical offset for natural chord symbols.

bool	showFretboards {}
	Display fretboards.

Cmper	fretStyleId {}
	Default others::FretboardStyle ID.

Cmper	fretInstId {}
	Default others::FretInstrument ID.

bool	multiFretItemsPerStr {}
	Allow multiple fret items per string.

bool	italicizeCapoChords {}
	Italicize capo chords.

ChordAlignment	chordAlignment {}
	Horizontal alignment for chord symbols.

ChordStyle	chordStyle {}
	Style of chord spelling.

bool	useSimpleChordSpelling {}
	Use simplified chord spelling.

bool	chordPlayback {}
	Enable chord symbol playback.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "chordOptions"
	The XML node name for this type.

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OptionsBase
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.

Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.

	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor

	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor

EnigmaBase &	operator= (const EnigmaBase &)
	no-op copy assignment operator allows subclasses to copy their values.

EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.

	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor

	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor

DocumentElement &	operator= (const DocumentElement &)
	no-op copy assignment operator allows subclasses to copy their values.

DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Options controlling chord symbol and fretboard rendering.

This class is identified by the XML node name "chordOptions".

Member Enumeration Documentation

strong

Horizontal alignment for chord symbols.

Only Left and Center are allowed. There is no Right alignment of chords.

Enumerator
Left	this is the default and may not appear in the xml

strong

Chord spelling style.

Enumerator
Standard	this is the default and may not appear in the xml