|
| TextBlock (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) |
| Constructor function.
|
|
util::EnigmaParsingContext | getRawTextCtx (Cmper forPartId, std::optional< Cmper > forPageId=std::nullopt, util::EnigmaString::TextInsertCallback defaultInsertFunc=util::EnigmaString::defaultInsertsCallback) const |
| Gets the raw text block context (from the texts pool) based on textType.
|
|
| 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 | textId {} |
| Cmper of the text block. (xml tag is <textID> )
|
|
Cmper | shapeId {} |
| If non-zero, the Cmper of the custom frame shape. (xml tag is <shapeID> )
|
|
Evpu | width {} |
| Width of standard frame. If zero, the width expands to fit the text.
|
|
Evpu | height {} |
| Height of standard frame. If zero, the height expands to fit the text.
|
|
int | lineSpacingPercentage {} |
| Line spacing percentage.
|
|
Evpu | xAdd {} |
| Horizontal offset from handle.
|
|
Evpu | yAdd {} |
| Vertical offset from handle.
|
|
TextJustify | justify {} |
| Justification (left, center, right, full, force full)
|
|
bool | newPos36 {} |
|
bool | showShape {} |
| Show shape.
|
|
bool | noExpandSingleWord {} |
| Do not expand single word.
|
|
bool | wordWrap {} |
| Wrap words (in frames)
|
|
Efix | inset {} |
| Text inset from frame (all sides)
|
|
Efix | stdLineThickness {} |
| Thickness of standard frame line. (xml tag is <stdLine> )
|
|
bool | roundCorners {} |
| Use rounded corners on frame.
|
|
Efix | cornerRadius {} |
| Corner radius for rounded corners.
|
|
TextType | textType {} |
| Text tag indicating the type of text block. (xml tag is <textTag> )
|
|
Represents the attributes of a Finale "textBlock".
The cmper is the textBlock ID, representing unique text blocks in the Finale document. This class is identified by the XML node name "textBlock".