musx::dom::others::TextBlock Class Reference

Represents the attributes of a Finale "textBlock". More...

#include <Others.h>

Inheritance diagram for musx::dom::others::TextBlock:

Public Types
enum class	TextType { Block , Expression }
	Enum for textTag values. 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
	TextBlock (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
std::shared_ptr< TextsBase >	getRawTextBlock () const
	Gets the raw text block (from the texts pool) based on textType.
std::string	getText (bool trimTags=false, util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	return display text with Enigma tags removed
bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the cmper 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.

Static Public Member Functions
static std::string	getText (const DocumentPtr &document, const Cmper textId, bool trimTags=false, util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii)
	return display text with Enigma tags removed
static const xml::XmlElementArray< TextBlock > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Cmper	textId {}
	Cmper of the text block. (xml tag is <textID>)
int	lineSpacingPercentage {}
	Line spacing percentage.
bool	newPos36 {}
	This is likely a compatibility setting. Best guess is that blocks created before Finale 3.6 do not have this set.
bool	showShape {}
	Show shape.
bool	noExpandSingleWord {}
	Do not expand single word.
bool	wordWrap {}
	Wrap words (in frames)
Evpu	width {}
	Width of frame.
Evpu	height {}
	Height of frame.
bool	roundCorners {}
	Use rounded corners on frame.
Efix	cornerRadius {}
	Corner radius for rounded corners.
TextType	textType {}
	Text tag indicating the type of text block. (xml tag is <textTag>)

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

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase 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

Represents the attributes of a Finale "textBlock".

Todo:

After identifying all possible fields, remove the override of TextBlock::requireAllFields.

The cmper is the textBlock ID, representing unique text blocks in the Finale document. This class is identified by the XML node name "textBlock".

Member Enumeration Documentation

TextType

enum class musx::dom::others::TextBlock::TextType

strong

Enum for textTag values.

Enumerator
Block	textId is a Cmper for a texts::BlockText
Expression	textId is a Cmper for a texts::ExpressionText

Member Function Documentation

requireAllFields()

bool musx::dom::others::TextBlock::requireAllFields ( ) const

inlineoverridevirtual

Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.

Remarks

This value only escapes errors on fields. Enum values must still have all values provided to avoid error messages or exceptions.

Reimplemented from musx::dom::Base.