Represents the attributes associated with a Finale key signature. More...
#include <Others.h>
Inheritance diagram for musx::dom::others::KeyAttributes:Public Member Functions | |
| KeyAttributes (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor function. | |
| 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. | |
| 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 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. | |
| 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< KeyAttributes > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| int | harmRefer {} |
| int | middleCKey {} |
| MIDI key number to use for middle C. This value transposes playback if it is set other than the MIDI middle C value of 60. | |
| Cmper | fontSym {} |
| int | gotoKey {} |
| Cmper | symbolList {} |
| Cmper of the symbol list that specifies the accidentals for the key. These are stored in incidents of details::KeySymbolListElement. | |
| bool | hasClefOctv {} |
| If true, the key signature has clef octave override tables. See details::ClefOctaveFlats and details::ClefOctaveSharps. | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "keysAttrib" |
| 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::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. | |
| 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. | |
Represents the attributes associated with a Finale key signature.
This class is identified by the XML node name "keysAttrib". The cmper is the key signature ID.
| Cmper musx::dom::others::KeyAttributes::fontSym {} |
If non-zero, the Font symbol ID used for accidentals in this key. Only the font ID can be specified. The size and style are inherited from the settings in options::FontOptions::FontType::Key.
| int musx::dom::others::KeyAttributes::gotoKey {} |
According to the Finale manual, this specifies the number of "scale steps" between each key on the MIDI keyboard. Presumably this means EDO division steps, but in any case it is not well implemented and seems not to work as intended. A value other than 1 is unlikely.
| int musx::dom::others::KeyAttributes::harmRefer {} |
Changes the meaning of 0 in the note tables for key signatures. The Finale manual recommends never changing it from 0. It also appears not to work as documented if changed. It was part of the original Finale 1.0 release and was likely never tested much since then.
1.9.8 