Base class for lyrics text. More...

#include <Texts.h>

Inheritance diagram for musx::dom::texts::LyricsTextBase:

Public Member Functions
void	createSyllableInfo ()
	Creates the syllables array. Used by the factory but available at any time.

	TextsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper textNumber)
	Constructs a `TextsBase` object.

Public Member Functions inherited from musx::dom::TextsBase
	TextsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper textNumber)
	Constructs a `TextsBase` object.

Cmper	getTextNumber () const
	Returns the raw text number.

void	setTextNumber (Cmper textNumber)
	Sets the raw text number.

std::shared_ptr< FontInfo >	parseFirstFontInfo () const
	Returns a shared pointer to a FontInfo instance that reflects the first font information in the text.

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.

Public Attributes
std::vector< std::shared_ptr< LyricsSyllableInfo > >	syllables
	the syllable info for the lyric text, constructed by the factory

Public Attributes inherited from musx::dom::TextsBase
std::string	text
	Raw Enigma string (with Enigma string tags), encoded UTF-8.

Additional Inherited Members
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.

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

Base class for lyrics text.

Member Function Documentation

◆ TextsBase()

musx::dom::TextsBase::TextsBase	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		Cmper	textNumber
	)

inline

Constructs a TextsBase object.

Parameters

document	A weak pointer to the parent document
partId	Always 0, but this parameter is needed for the generic factory routine
shareMode	Always `ShareMode::All`, but this parameter is needed for the generic factory routine.
textNumber	The text number (`Cmper`).

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ TextsBase()