Loading...
Searching...
No Matches
Public Member Functions |
Static Public Member Functions |
Public Attributes |
Static Public Attributes |
List of all members
musx::dom::others::TextExpressionDef Class Reference
Stores the properties and behaviors of text expressions. More...
#include <Others.h>
Inheritance diagram for musx::dom::others::TextExpressionDef:
Public Member Functions | |
| TextExpressionDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor. | |
| std::shared_ptr< TextBlock > | getTextBlock () const |
| Gets the enclosure for this expression, or nullptr if none. | |
| std::shared_ptr< Enclosure > | getEnclosure () const |
| Gets the enclosure for this expression, or nullptr if none. | |
| 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< TextExpressionDef > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Public Attributes | |
| Cmper | textIdKey {} |
| Identifier for the TextBlock associated with this. | |
| Cmper | categoryId {} |
| Identifier for the category of the text expression. | |
| RehearsalMarkStyle | rehearsalMarkStyle {} |
| Auto-sequencing style for rehearsal marks. | |
| int | value {} |
| Value associated with the expression (e.g., velocity). | |
| int | auxData1 {} |
| Auxiliary data for the expression. (xml node is "auxdata1") | |
| int | playPass {} |
| "Play Only on Pass" value. | |
| bool | hideMeasureNum |
| "Hide Measure Numbers" (used on Rehearsal Marks) | |
| bool | matchPlayback |
| purpose needs investigation. | |
| bool | useAuxData {} |
| Whether auxiliary data is used. | |
| bool | hasEnclosure {} |
| Whether the text expression has an enclosure. (xml node is "newEnclosure") | |
| bool | breakMmRest {} |
| Whether the text breaks multimeasure rests. | |
| bool | createdByHp {} |
| Whether the text block was created by Finale's smart playback system. | |
| PlaybackType | playbackType {} |
| Playback behavior of the text expression. | |
| HorizontalMeasExprAlign | horzMeasExprAlign {} |
| Horizontal alignment of the expression. | |
| VerticalMeasExprAlign | vertMeasExprAlign {} |
| Vertical alignment of the expression. | |
| HorizontalTextJustification | horzExprJustification {} |
| Horizontal justification of the text expression. | |
| Evpu | measXAdjust {} |
| Horizontal adjustment for measurement alignment. | |
| Evpu | yAdjustEntry {} |
| Vertical adjustment for entry alignment. | |
| Evpu | yAdjustBaseline {} |
| Vertical adjustment for baseline alignment. | |
| bool | useCategoryFonts {} |
| Whether to use category fonts. | |
| bool | useCategoryPos {} |
| Whether to use category position. | |
| std::string | description |
| Description of the text expression. (xml node is "descStr") | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "textExprDef" |
| 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 and enforces the static constexpr XmlNodeName. | |
| Base & | operator= (const Base &) |
| assignment constructor: m_unlinkedNodes is intentionally omitted | |
Detailed Description
Stores the properties and behaviors of text expressions.
This class is identified by the XML node name "textExprDef".
Constructor & Destructor Documentation
◆ TextExpressionDef()
|
inlineexplicit |
Constructor.
Initializes all fields to their default values.
