Contains bookmark description text. More...

#include <Texts.h>

Inheritance diagram for musx::dom::texts::BookmarkText:

Public Member Functions
	TextsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper textNumber)
	Constructs a `TextsBase` object.

Public Member Functions inherited from musx::dom::TextsBase
	TextsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper textNumber)
	Constructs a `TextsBase` object.

Cmper	getTextNumber () const
	Returns the raw text number.

void	setTextNumber (Cmper textNumber)
	Sets the raw text number.

util::EnigmaParsingContext	getRawTextCtx (const MusxInstance< TextsBase > &ptrToThis, Cmper forPartId, std::optional< Cmper > forPageId=std::nullopt, util::EnigmaString::TextInsertCallback defaultInsertFunc=util::EnigmaString::defaultInsertsCallback) const
	Gets the raw text block.

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 Attributes
static constexpr std::string_view	XmlNodeName = "bookmarkText"
	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.

Public Attributes inherited from musx::dom::TextsBase
std::string	text
	Raw Enigma string (with Enigma string tags), encoded UTF-8.

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

Contains bookmark description text.

Note: The Enigma inserts in BookmarkText are meaningless. You can use util::EnigmaString::trimTags to trim them rather than calling the Enigma string parser.

Member Function Documentation

◆ TextsBase()

musx::dom::TextsBase::TextsBase	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		Cmper	textNumber
	)

inline

Constructs a TextsBase object.

Parameters

document	A weak pointer to the parent document
partId	Always 0, but this parameter is needed for the generic factory routine
shareMode	Always `ShareMode::All`, but this parameter is needed for the generic factory routine.
textNumber	The text number (`Cmper`).

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ TextsBase()