Loading...
Searching...
No Matches
Public Member Functions |
Static Public Member Functions |
Public Attributes |
Static Public Attributes |
List of all members
musx::dom::options::MusicSymbolOptions Class Reference
Specifies font-specific glyphs used to render common musical symbols. More...
#include <Options.h>
Inheritance diagram for musx::dom::options::MusicSymbolOptions:
Public Member Functions | |
| MusicSymbolOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All) | |
| Constructor function. | |
| 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< MusicSymbolOptions > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| char32_t | noteheadQuarter {} |
| Code point for quarter notehead (FontOptions::FontType::Noteheads) | |
| char32_t | noteheadHalf {} |
| Code point for half notehead (FontOptions::FontType::Noteheads) | |
| char32_t | noteheadWhole {} |
| Code point for whole notehead (FontOptions::FontType::Noteheads) | |
| char32_t | noteheadDblWhole {} |
| Code point for double whole notehead (FontOptions::FontType::Noteheads) | |
| char32_t | natural {} |
| Code point for natural sign (FontOptions::FontType::Accis) | |
| char32_t | flat {} |
| Code point for flat sign (FontOptions::FontType::Accis) | |
| char32_t | sharp {} |
| Code point for sharp sign (FontOptions::FontType::Accis) | |
| char32_t | dblFlat {} |
| Code point for double flat sign (FontOptions::FontType::Accis) | |
| char32_t | dblSharp {} |
| Code point for double sharp sign (FontOptions::FontType::Accis) | |
| char32_t | parenNatural {} |
| Code point for parenthesized natural (FontOptions::FontType::Accis) | |
| char32_t | parenFlat {} |
| Code point for parenthesized flat (FontOptions::FontType::Accis) | |
| char32_t | parenSharp {} |
| Code point for parenthesized sharp (FontOptions::FontType::Accis) | |
| char32_t | parenDblFlat {} |
| Code point for parenthesized double flat (FontOptions::FontType::Accis) | |
| char32_t | parenDblSharp {} |
| Code point for parenthesized double sharp (FontOptions::FontType::Accis) | |
| char32_t | chordNatural {} |
| Code point for chord natural sign (FontOptions::FontType::ChordAcci) | |
| char32_t | chordFlat {} |
| Code point for chord flat sign (FontOptions::FontType::ChordAcci) | |
| char32_t | chordSharp {} |
| Code point for chord sharp sign (FontOptions::FontType::ChordAcci) | |
| char32_t | chordDblFlat {} |
| Code point for chord double flat sign (FontOptions::FontType::ChordAcci) | |
| char32_t | chordDblSharp {} |
| Code point for chord double sharp sign (FontOptions::FontType::ChordAcci) | |
| char32_t | keySigNatural {} |
| Code point for key signature natural (FontOptions::FontType::Key) | |
| char32_t | keySigFlat {} |
| Code point for key signature flat (FontOptions::FontType::Key) | |
| char32_t | keySigSharp {} |
| Code point for key signature sharp (FontOptions::FontType::Key) | |
| char32_t | keySigDblFlat {} |
| Code point for key signature double flat (FontOptions::FontType::Key) | |
| char32_t | keySigDblSharp {} |
| Code point for key signature double sharp (FontOptions::FontType::Key) | |
| char32_t | restLonga {} |
| Code point for longa rest (FontOptions::FontType::Rests) | |
| char32_t | restDblWhole {} |
| Code point for double whole rest (FontOptions::FontType::Rests) | |
| char32_t | restWhole {} |
| Code point for whole rest (FontOptions::FontType::Rests) | |
| char32_t | restHalf {} |
| Code point for half rest (FontOptions::FontType::Rests) | |
| char32_t | restQuarter {} |
| Code point for quarter rest (FontOptions::FontType::Rests) | |
| char32_t | restEighth {} |
| Code point for eighth rest (FontOptions::FontType::Rests) | |
| char32_t | rest16th {} |
| Code point for 16th rest (FontOptions::FontType::Rests) | |
| char32_t | rest32nd {} |
| Code point for 32nd rest (FontOptions::FontType::Rests) | |
| char32_t | rest64th {} |
| Code point for 64th rest (FontOptions::FontType::Rests) | |
| char32_t | rest128th {} |
| Code point for 128th rest (FontOptions::FontType::Rests) | |
| char32_t | restDefMeas {} |
| Code point for default measure rest (FontOptions::FontType::Rests) | |
| char32_t | oneBarRepeat {} |
| Code point for one-bar repeat (FontOptions::FontType::AltNotSlash) | |
| char32_t | twoBarRepeat {} |
| Code point for two-bar repeat (FontOptions::FontType::AltNotSlash) | |
| char32_t | slashBar {} |
| Code point for slash bar (FontOptions::FontType::AltNotSlash) | |
| char32_t | quarterSlash {} |
| Code point for quarter slash (FontOptions::FontType::AltNotSlash) | |
| char32_t | halfSlash {} |
| Code point for half slash (FontOptions::FontType::AltNotSlash) | |
| char32_t | wholeSlash {} |
| Code point for whole slash (FontOptions::FontType::AltNotSlash) | |
| char32_t | dblWholeSlash {} |
| Code point for double whole slash (FontOptions::FontType::AltNotSlash) | |
| char32_t | timeSigPlus {} |
| Code point for time signature plus sign (FontOptions::FontType::TimePlus) | |
| char32_t | timeSigPlusParts {} |
| Code point for time signature plus (parts) (FontOptions::FontType::TimePlusParts) | |
| char32_t | timeSigAbrvCommon {} |
| Code point for common time abbreviation (FontOptions::FontType::Time) | |
| char32_t | timeSigAbrvCut {} |
| Code point for cut time abbreviation (FontOptions::FontType::Time) | |
| char32_t | timeSigAbrvCommonParts {} |
| Code point for common time abbreviation (parts) (FontOptions::FontType::TimeParts) | |
| char32_t | timeSigAbrvCutParts {} |
| Code point for cut time abbreviation (parts) (FontOptions::FontType::TimeParts) | |
| char32_t | augDot {} |
| Code point for augmentation dot (FontOptions::FontType::AugDots) | |
| char32_t | forwardRepeatDot {} |
| Code point for forward repeat dot (FontOptions::FontType::ReptDots) | |
| char32_t | backRepeatDot {} |
| Code point for backward repeat dot (FontOptions::FontType::ReptDots) | |
| char32_t | eightVaUp {} |
| Code point for 8va (ottava) up (FontOptions::FontType::SmartShape8va) | |
| char32_t | eightVbDown {} |
| Code point for 8vb (ottava) down (FontOptions::FontType::SmartShape8vb) | |
| char32_t | fifteenMaUp {} |
| Code point for 15ma (quindicesima) up (FontOptions::FontType::SmartShape15ma) | |
| char32_t | fifteenMbDown {} |
| Code point for 15mb (quindicesima) down (FontOptions::FontType::SmartShape15mb) | |
| char32_t | trillChar {} |
| Code point for trill symbol (FontOptions::FontType::SmartShapeTrill) | |
| char32_t | wiggleChar {} |
| Code point for wiggle (trill line) symbol (FontOptions::FontType::SmartShapeWiggle) | |
| char32_t | flagUp {} |
| Code point for upward flag (FontOptions::FontType::Flags) | |
| char32_t | flagDown {} |
| Code point for downward flag (FontOptions::FontType::Flags) | |
| char32_t | flag16Up {} |
| Code point for 16th note upward flag (FontOptions::FontType::Flags) | |
| char32_t | flag16Down {} |
| Code point for 16th note downward flag (FontOptions::FontType::Flags) | |
| char32_t | flag2Up {} |
| Code point for 32nd note upward flag (FontOptions::FontType::Flags) | |
| char32_t | flag2Down {} |
| Code point for 32nd note downward flag (FontOptions::FontType::Flags) | |
| char32_t | flagStraightUp {} |
| Code point for straight upward flag (FontOptions::FontType::Flags) | |
| char32_t | flagStraightDown {} |
| Code point for straight downward flag (FontOptions::FontType::Flags) | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "musicSymbolOptions" |
| The XML node name for this type. | |
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::OptionsBase | |
| OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode) | |
| Constructs the OptionsBase and validates XmlNodeName in the derived class. | |
| 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
Specifies font-specific glyphs used to render common musical symbols.
Each field stores a code point identifying the glyph to use for a particular notation symbol. The font used to interpret a given value is determined by the associated FontOptions::FontType for that symbol category (e.g., noteheads, accidentals, rests).
- For SMuFL-compliant fonts, values are Unicode code points corresponding to SMuFL glyphs.
- For non-SMuFL music fonts (such as Maestro), values typically represent raw glyph indices rather than Unicode code points.
Use FontInfo::calcIsSymbolFont to determine whether a (non-SMuFL) font uses raw glyph indices.
This class corresponds to the XML element "musicSymbolOptions".
