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::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 | |
| 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::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 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 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) |
| Assignment operator delegates to base, preserving OthersBase state. | |
| OthersBase & | operator= (OthersBase &&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. | |
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
|
strong |
Member Function Documentation
◆ calcIsSymbolFont()
|
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.
