Represents a single element in a Finale accidental symbol list. More...
#include <Details.h>
Inheritance diagram for musx::dom::details::KeySymbolListElement:
Public Member Functions | |
| KeySymbolListElement (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2) | |
| Constructor function. | |
| int | getAlterationValue () const |
| Returns the alteration value that this symbol corresponds with. | |
| void | integrityCheck () override |
| 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. | |
| Public Member Functions inherited from musx::dom::DetailsBase | |
| Cmper | getCmper1 () const |
Gets the cmper1 key value. | |
| Cmper | getCmper2 () const |
Gets the cmper2 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. | |
| virtual Cmper | getPartId () const |
| Gets the partId for this instance (or SCORE_PARTID for score) | |
| 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 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< KeySymbolListElement > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| std::string | accidentalString |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "keySymList" |
| 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::DetailsBase | |
| DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt) | |
| Constructs a DetailsBase object. | |
| 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
Represents a single element in a Finale accidental symbol list.
This class is identified by the XML node name "keySymList". cmper1 is the symbol list ID from others::KeyAttributes::symbolList. cmper2 is the accidental slot, which should be interpreted as a signed int.
Member Function Documentation
◆ integrityCheck()
|
inlineoverridevirtual |
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.
The default implementation should always be called inside an overridden implementation.
- Exceptions
-
musx::dom::integrity_error if there is a problem.
Reimplemented from musx::dom::Base.
Member Data Documentation
◆ accidentalString
| std::string musx::dom::details::KeySymbolListElement::accidentalString |
The symbol string used to represent the accidental. The string uses either the default font for keys or the font specified by others::KeyAttributes::fontSym if its value is non-zero. (xml node is <string>)
