musx::dom::others::FontDefinition Class Reference

The name and font characteristics of fonts contained. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::FontDefinition:

Public Types
enum class	CharacterSetBank { MacOS , Windows }
	The character set for the bank. More...
Public Types inherited from musx::dom::EnigmaBase
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...

Public Member Functions
	FontDefinition (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
bool	calcIsSymbolFont () const
	Calculates if this font is a symbol font.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper 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::EnigmaBase
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.
virtual void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.
virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.
Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< FontDefinition > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
CharacterSetBank	charsetBank {}
	The character set bank.
int	charsetVal {}
int	pitch {}
	Represents the <pitch> element, e.g., 0. (use unknown)
int	family {}
	Represents the <family> element, e.g., 0. (use unknown)
std::string	name
	The font name e.g., "Broadway Copyist Text".

Static Public Attributes
static constexpr uint32_t	SYMBOL_CHARSET_MAC = 0xfff
	macOS symbol charset (4095).
static constexpr uint32_t	SYMBOL_CHARSET_WIN = 2
	Windows symbol charset.
static constexpr std::string_view	XmlNodeName = "fontName"
	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.
OthersBase &	operator= (const OthersBase &other)
	Copy assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.
OthersBase &	operator= (OthersBase &&other) noexcept
	Move assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.
Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor
	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor
EnigmaBase &	operator= (const EnigmaBase &)
	Copy assignment preserves the destination DOM instance's document, source part, and sharing mode.
EnigmaBase &	operator= (EnigmaBase &&) noexcept
	Move assignment preserves the destination DOM instance's document, source part, and sharing mode.
Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.
	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor
	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor
DocumentElement &	operator= (const DocumentElement &)
	Copy assignment preserves the destination DOM instance's document and part ID.
DocumentElement &	operator= (DocumentElement &&) noexcept
	Move assignment preserves the destination DOM instance's document and part ID.

Detailed Description

The name and font characteristics of fonts contained.

The cmper is the font ID used in classes throughout the document.

This class is identified by the XML node name "fontName".

Member Enumeration Documentation

CharacterSetBank

enum class musx::dom::others::FontDefinition::CharacterSetBank

strong

The character set for the bank.

Enumerator
Windows	xml value is "Mac" xml value is "Win"

Member Function Documentation

calcIsSymbolFont()

bool musx::dom::others::FontDefinition::calcIsSymbolFont ( ) const

inline

Calculates if this font is a symbol font.

The code points in symbol fonts are mapped directly to the glyph index of the font without any attempt at linguistic mapping.

Many legacy symbol fonts in Finale were music fonts following more-or-less the layout of Adobe Sonata font, so this may be an appropriate proxy for telling if the font is a legacy music font, at least in some contexts. The same font face (e.g., Engraver) may appear as either a Windows symbol font or a macOS symbol font, depending on the origin of the font and of the document.

Member Data Documentation

charsetVal

int musx::dom::others::FontDefinition::charsetVal {}

A value specifying the character set. The meaning is dependent on charsetBank. A value of 0 indicates ANSI character set for Windows and MacRoman for macOS. A value of 2 (SYMBOL_CHARSET) indicates a symbol font for Windows. A value of 4095 (0xfff) indicates a symbol font for macOS. Other values are possible but less likely.