Loading...
Searching...
No Matches
Public Types |
Public Member Functions |
Static Public Member Functions |
Public Attributes |
Static Public Attributes |
List of all members
musx::dom::details::Bracket Class Reference
Represents a bracket, used in two different contexts: More...
#include <Details.h>
Inheritance diagram for musx::dom::details::Bracket:
Public Types | |
| enum class | BracketStyle : int { None = 0 , ThickLine = 1 , BracketStraightHooks = 2 , PianoBrace = 3 , Unknown4 , Unknown5 , BracketCurvedHooks = 6 , Unknown7 , DeskBracket = 8 } |
| Bracket types. 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 | |
| Bracket (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, Inci inci) | |
| Constructor for top-level instances. | |
| Bracket (const DocumentWeakPtr &document) | |
| Constructor for embedded instances. | |
| Public Member Functions inherited from musx::dom::DetailsBase | |
| DetailsBase (const DetailsBase &)=default | |
| explicit default copy constructor | |
| DetailsBase (DetailsBase &&) noexcept=default | |
| explicit default move constructor | |
| 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). | |
| 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< Bracket > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| BracketStyle | style {} |
Bracket style (xml node is <id>) | |
| Evpu | horzAdjLeft {} |
"Distance from Left Edge of Staff" (xml node is <bracPos>) | |
| Evpu | vertAdjTop {} |
"Vertical Adjust (Top of Bracket)" (xml node is <bracTop>) | |
| Evpu | vertAdjBot {} |
"Vertical Adjust (Bottom of Bracket)" (xml node is <bracBot>) | |
| bool | showOnSingleStaff {} |
"Show Bracket If Group Contains Only One Staff" (only applies to staff groups: xml node is <onSingle>) | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "brackSpec" |
| The XML node name for this type. | |
Additional Inherited Members | |
| 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. | |
| DetailsBase & | operator= (const DetailsBase &other) |
| Assignment operator delegates to base, preserving OthersBase state. | |
| DetailsBase & | operator= (DetailsBase &&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
Represents a bracket, used in two different contexts:
- Ossia bracket groups: Bracket is a top-level object that helps define an ossia.
- cmper1: The bracket group number for the ossia.
- cmper2: Always appears to be zero.
- inci: The index within the ossia bracket group.
- Staff groups: Bracket is embedded inside StaffGroup.
- In this case cmper1, cmper2, and inci have no meaning and should be zero.
Member Enumeration Documentation
◆ BracketStyle
|
strong |
Bracket types.
