|
| PartDefinition (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) |
| Constructor function.
|
|
util::EnigmaParsingContext | getNameRawTextCtx () const |
| Get the raw text context for the part name if any.
|
|
std::string | getName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const |
| Get the part name if any.
|
|
bool | isScore () const |
| Return true if this part corresponds to the score.
|
|
Cmper | calcSystemIuList (Cmper systemId) const |
| Return the StaffUsed cmper by this part for the specified system.
|
|
std::optional< PageCmper > | calcPageNumberFromAssignmentId (PageCmper pageAssignmentId) const |
| Calculates a page number in this part from a page assignment ID. (See PageTextAssign.)
|
|
PageCmper | calcAssignmentIdFromPageNumber (PageCmper pageId) const |
| Calculates a page assignment ID from a page number in the part.
|
|
| OthersBase (const OthersBase &)=default |
| explicit default copy constructor
|
|
| OthersBase (OthersBase &&) noexcept=default |
| explicit default move constructor
|
|
Cmper | getCmper () const |
| Gets the cmper 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.
|
|
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.
|
|
|
Cmper | nameId {} |
| Cmper of the part name TextBlock. (xml tag is <nameID> )
|
|
int | partOrder {} |
| Value that determines the order of listed parts in Finale's UI.
|
|
int | copies {} |
| Number of copies to print.
|
|
bool | printPart {} |
| Indicates the part should be printed.
|
|
bool | extractPart {} |
| Indicates if the part should be extracted.
|
|
bool | applyFormat {} |
| Meaning uncertain. May have to do with page format for parts and whether it has been applied.
|
|
bool | needsRecalc {} |
| Indicates if the part needs update layout.
|
|
bool | useAsSmpInst {} |
| Indicates if the part is used as a SmartMusic instrument.
|
|
int | smartMusicInst {} |
| SmartMusic instrument ID (-1 if not used).
|
|
Cmper | defaultNameStaff {} |
| If non-zero, this points to the Staff that has the default name (if unspecified by nameId.)
|
|
Cmper | defaultNameGroup {} |
| If non-zero, this points to the details::StaffGroup that has the default name (if unspecified by nameId.)
|
|
int | numberOfLeadingBlankPages {} |
| The number of leading blank pages in the part. This is not in the xml but calculated in factory::DocumentFactory::create.
|
|
int | numberOfPages {} |
| The total number of pages in the part. This is not in the xml but calculated in factory::DocumentFactory::create.
|
|
|
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.
|
|
| OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt) |
| Constructs an OthersBase object.
|
|
OthersBase & | operator= (const OthersBase &other) |
| Assignment operator delegates to base, preserving OthersBase state.
|
|
OthersBase & | operator= (OthersBase &&other) noexcept |
| Assignment operator delegates to base, preserving OthersBase state.
|
|
| 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 of a Finale "partDef".
The cmper is the part definition ID, representing unique part definitions in the Finale document. This class is identified by the XML node name "partDef".