musx::dom::details::LyricAssignVerse Class Reference

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

#include <Details.h>

Inheritance diagram for musx::dom::details::LyricAssignVerse:

Public Types
using	BaselineType = BaselineLyricsVerse
	The baseline type for this item.
using	TextType = texts::LyricsVerse
	The text type for this item.
Public Types inherited from musx::dom::EntryDetailsBase
enum class	StemSelection { MatchEntry , UpStem , DownStem , Any }
	The options for choosing which version to retrieve for stem-specific details. More...
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
MusxInstance< texts::LyricsTextBase >	getLyricText () const override
	Get the raw lyric text for this assignment.
	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.
util::EnigmaParsingContext	getRawTextCtx () const
	Return an Enigma parsing context for the associated lyrics text block.
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
Public Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DetailsBase &)=default
	explicit default copy constructor
	DetailsBase (DetailsBase &&) noexcept=default
	explicit default move constructor
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).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
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	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< Base > &ptrToThis)
	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 = "lyrDataVerse"
	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 for an index into texts::LyricsTextBase::syllables. (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.
Evpu	wext {}
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.
DetailsBase &	operator= (const DetailsBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
DetailsBase &	operator= (DetailsBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	Base (const Base &)=default
	explicit default copy constructor
	Base (Base &&) noexcept=default
	explicit default move constructor
Base &	operator= (const Base &)
	no-op copy assignment operator allows subclasses to copy their values.
Base &	operator= (Base &&) noexcept
	no-op move assignment operator allows subclasses to move their values.
Static Protected Member Functions inherited from musx::dom::EntryDetailsBase
template<typename EDUP , typename EDDOWN , typename EDBASE >
static MusxInstance< EDBASE >	getStemDependentDetail (const EntryInfoPtr &entryInfo, StemSelection stemSelection)
	Implement retrieval of stem-specific details. (Actual functions are defined per stem-specific class)

Detailed Description

Contains the syllable assignments for lyrics verse blocks.

Entry::lyricDetail is set if the entry has verse lyric assignment.

Member Function Documentation

getLyricText()

MusxInstance< texts::LyricsTextBase > musx::dom::details::LyricAssignVerse::getLyricText ( ) const

overridevirtual

Get the raw lyric text for this assignment.

Implements musx::dom::details::LyricAssign.

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.
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.