Contains File Info text (from Finale's Score Manager) More...

#include <Texts.h>

Inheritance diagram for musx::dom::texts::FileInfoText:

Public Types
enum class	TextType : Cmper { Title = 1 , Composer = 2 , Copyright = 3 , Description = 4 , Lyricist = 5 , Arranger = 6 , Subtitle = 7 }
	Represents various text types for the file header. 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
	FileInfoText (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper textNumber)
	Constructs a `FileInfoText` object.

	FileInfoText (const DocumentWeakPtr &document, Cmper textNumber)
	Constructs a `FileInfoText` object.

TextType	getTextType () const
	Returns the TextType of the current instance.

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.

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

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

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 File Info text (from Finale's Score Manager)

Member Enumeration Documentation

◆ TextType

enum class musx::dom::texts::FileInfoText::TextType : Cmper

strong

Represents various text types for the file header.

Use these values to search the TextsPool for file info text.

Enumerator
Title	Title of the piece.
Composer	Composer of the piece.
Copyright	Copyright information for the piece.
Description	Description of the piece.
Lyricist	Lyricist the piece.
Arranger	Arranger of the piece.
Subtitle	Subtitle of the piece.

Constructor & Destructor Documentation

◆ FileInfoText() [1/2]

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

inlineexplicit

Constructs a FileInfoText object.

Parameters

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

◆ FileInfoText() [2/2]

musx::dom::texts::FileInfoText::FileInfoText	(	const DocumentWeakPtr &	document,
		Cmper	textNumber
	)

inlineexplicit

Constructs a FileInfoText object.

Parameters

document	A weak pointer to the parent document
textNumber	The text number (`Cmper`).

Public Types

Public Member Functions