musx::dom::details::LyricAssignChorus Class Reference

Contains the syllable assignments for lyrics chorus blocks. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::LyricAssignChorus:

Public Types
using	TextType = texts::LyricsChorus
	The text type for this item.
Public Types inherited from musx::dom::Base
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
	LyricAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
	Constructor function.
Public Member Functions inherited from musx::dom::details::LyricAssign
	LyricAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
	Constructor function.
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
Public Member Functions inherited from musx::dom::DetailsBase
Cmper	getCmper1 () const
	Gets the cmper1 key value.
Cmper	getCmper2 () const
	Gets the cmper2 key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Public Member Functions inherited from musx::dom::Base
virtual	~Base () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the partId for this instance (or 0 for score)
std::shared_ptr< others::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
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 ()
	Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
virtual bool	requireAllFields () const
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

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

Additional Inherited Members
Static Public Member Functions inherited from musx::dom::details::LyricAssign
static const xml::XmlElementArray< LyricAssign > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Public Attributes inherited from musx::dom::details::LyricAssign
Cmper	lyricNumber {}
	the text number of the lyric.
unsigned	syllable {}
	the 1-based syllable number. Subtract 1 to get the index. (xml node is <syll>)
Evpu	horzOffset {}
	horizontal offset from default position. (xml node is <horzOff>)
Evpu	vertOffset {}
	horizontal offset from default position. (xml node is <vertOff>)
Evpu	floatingHorzOff {}
	This appears to have something to do with note spacing. It may simply be a cache that Finale changes as needed.
int	wext {}
	Somehow indicates a word extension, but its meaning is uncertain. It does not appear to be a smart shape cmper.
bool	displayVerseNum {}
	If set, the text block number displays to the left of the syllable. (E.g., when numbering verses in a hymn.)
Protected Member Functions inherited from musx::dom::EntryDetailsBase
	EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
	Constructs a EntryDetailsBase object.
Protected Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
	Constructs a DetailsBase object.
Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Contains the syllable assignments for lyrics chorus blocks.

Member Function Documentation

LyricAssign()

musx::dom::details::LyricAssign::LyricAssign ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, EntryNumber  entnum, Inci  inci  )

inlineexplicit

Constructor function.

Parameters

document	A weak pointer to the associated document.
partId	The part that this is for (probably always 0).
shareMode	The sharing mode for this LyricAssign
entnum	The entry number of this assignment.
inci	The 0-based inci. Each lyric text block has a separate instance, if assigned.