Loading...
Searching...
No Matches
Public Types |
Public Member Functions |
Static Public Member Functions |
Public Attributes |
Static Public Attributes |
List of all members
musx::dom::others::ChordSuffixElement Class Reference
Represents a single element in a chord suffix (e.g., a symbol like "1" or "+"). More...
#include <Others.h>
Inheritance diagram for musx::dom::others::ChordSuffixElement:
Public Types | |
| enum class | Prefix { None , Minus , Plus , Sharp , Flat } |
| Enum for chord symbol prefix options. 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 | |
| ChordSuffixElement (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci) | |
| 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. | |
| Cmper | getPartId () const |
| Gets the partId for this instance (or 0 for score) | |
| std::shared_ptr< others::PartDefinition > | getPartDefinition () const |
| Gets the others::PartDefinition corresponding to getPartId. | |
| 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< ChordSuffixElement > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| std::shared_ptr< FontInfo > | font |
Font info for this symbol (xml nodes are <fontID>, <fontSize>, and <efx>) | |
| char32_t | symbol {} |
Unicode symbol (xml node is <suffix>) | |
| Evpu | xdisp {} |
| Horizontal displacement in EVPU. | |
| Evpu | ydisp {} |
| Vertical displacement in EVPU. | |
| bool | isNumber {} |
| Indicates the symbol value is numeric rather than a UTF-32 character. | |
| Prefix | prefix {} |
| Optional prefix for the symbol, e.g., "plus". | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "chordSuffix" |
| 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. | |
| Protected Member Functions inherited from musx::dom::Base | |
| Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode) | |
| Constructs the base class and enforces the static constexpr XmlNodeName. | |
| Base & | operator= (const Base &) |
| assignment constructor: m_unlinkedNodes is intentionally omitted | |
Detailed Description
Represents a single element in a chord suffix (e.g., a symbol like "1" or "+").
Each chord suffix consists of one or more such elements, each with its own font and positioning. The inci is a 0-based index for the element.
The cmper is a unique identifier used by details::ChordAssign to reference the suffix and its playback information. (See ChordSuffixPlayback.) Suffixes are a library from which chord assignments select their particular suffix.
This class is identified by the XML node name "chordSuffix".
Member Enumeration Documentation
◆ Prefix
|
strong |
