musx::dom::options::TextOptions Class Reference

Options controlling text rendering in the musx file. Many of these options are default values that are inserted into Enigma tags when a page or measure text is created. Others are default values for the assignment. As such, once a page or measure text has been created, it does not change even if these default values change. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::TextOptions:

Classes
struct	InsertSymbolInfo
	Insert symbol information. More...

Public Types
enum class	HorizontalAlignment { Left , Center , Right }
	Horizontal alignment options for page text positioning.
enum class	VerticalAlignment { Top , Center , Bottom }
	Vertical alignment options for page text positioning.
enum class	TextJustify {   Left , Center , Right , Full ,   ForcedFull }
	Text justification options. More...
enum class	DateFormat { Short , Long , Abbrev }
	Date format options. This value is coded into the Enigma date insert when the page title is created. 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
	TextOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor.
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< TextOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	textLineSpacingPercent {}
	"Line Spacing: Automatic" percent value
bool	showTimeSeconds {}
	"Include Seconds in Time Stamp"
DateFormat	dateFormat {}
	"Date Format"
int	tabSpaces {}
	"Use [x] Spaces in Place of One Tab Character"
int	textTracking {}
	"Tracking" amount in EMs (1/1000 of the font size)
Evpu	textBaselineShift {}
	"Baseline Shift" amount
Evpu	textSuperscript {}
	"Superscript" amount
bool	textWordWrap {}
	"Word Wrap"
Evpu	textPageOffset {}
	"Page Offset"
TextJustify	textJustify {}
	"Justification"
bool	textExpandSingleWord {}
	"Expand Single Word"
HorizontalAlignment	textHorzAlign {}
	"Horizontal Alignment"
VerticalAlignment	textVertAlign {}
	"Vertical Alignment"
bool	textIsEdgeAligned {}
	"Position from Page Edge"
std::unordered_map< AccidentalInsertSymbolType, std::shared_ptr< InsertSymbolInfo > >	symbolInserts
	Insert symbol information map.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "textOptions"
	The XML node name for this type.

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OptionsBase
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.
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

Options controlling text rendering in the musx file. Many of these options are default values that are inserted into Enigma tags when a page or measure text is created. Others are default values for the assignment. As such, once a page or measure text has been created, it does not change even if these default values change.

This class is identified by the XML node name "textOptions".

Member Enumeration Documentation

DateFormat

enum class musx::dom::options::TextOptions::DateFormat

strong

Date format options. This value is coded into the Enigma date insert when the page title is created.

Enumerator
Short	Short date format, based on locale. US format is MM/DD/YY (Default value may not appear in the xml)
Long	Long date format, based on locale. US format is Month DD, YYYY.
Abbrev	Abbreviated date format, based on locale. US format is Mon DD, YYYY.

TextJustify

enum class musx::dom::options::TextOptions::TextJustify

strong

Text justification options.

Enumerator
Left	"left"
Center	"center"
Right	"right"
Full	"full"
ForcedFull	"forcedFull"