musx::dom::others::StaffStyle::Masks Class Reference

lists the masks that deterimine if this staff style overrides the staff settings More...

#include <Others.h>

Inheritance diagram for musx::dom::others::StaffStyle::Masks:

Public Member Functions
	Masks (const DocumentWeakPtr &document)
	Default constructor.
bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
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.
virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)
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.

Static Public Member Functions
static const xml::XmlElementArray< Masks > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	floatNoteheadFont {}
	overrides notehead font settings
bool	flatBeams {}
	overrides Staff::flatBeams
bool	blankMeasureRest {}
	overrides Staff::blankMeasure
bool	noOptimize {}
	overrides Staff::noOptimize
bool	notationStyle {}
	overrides notations style
bool	defaultClef {}
	overrides Staff::defaultClef
bool	staffType {}
	overrides staff properties (see StaffComposite::applyStyle)
bool	transposition {}
	overrides transposition fields
bool	blineBreak {}
	overrides Staff::blineBreak
bool	rbarBreak {}
	overrides Staff::rbarBreak
bool	negMnumb {}
	overrides Staff::hideMeasNums
bool	negRepeat {}
	overrides Staff::hideRepeats
bool	negNameScore {}
	overrides Staff::hideNameInScore
bool	hideBarlines {}
	overrides Staff::hideBarlines
bool	fullName {}
	overrides Staff::fullNameTextId
bool	abrvName {}
	overrides Staff::abbrvNameTextId
bool	floatKeys {}
	overrides Staff::floatKeys
bool	floatTime {}
	overrides Staff::floatTime
bool	hideRptBars {}
	overrides Staff::hideRptBars
bool	negKey {}
	overrides Staff::hideKeySigs
bool	negTime {}
	overrides Staff::hideTimeSigs (in Score)
bool	negClef {}
	overrides Staff::hideClefs
bool	hideStaff {}
	overrides Staff::hideMode
bool	noKey {}
	overrides Staff::noKey
bool	fullNamePos {}
	overrides presence, absence of NamePositionStyleFull instance.
bool	abrvNamePos {}
	overrides presence, absence of NamePositionStyleAbbreviated instance.
bool	showTies {}
	overrides Staff::hideTies
bool	showDots {}
	overrides Staff::hideDots
bool	showRests {}
	overrides Staff::hideRests
bool	showStems {}
	overrides stem properties (see StaffComposite::applyStyle)
bool	hideChords {}
	overrides Staff::hideChords
bool	hideFretboards {}
	overrides Staff::hideFretboards
bool	hideLyrics {}
	overrides Staff::hideLyrics
bool	showNameParts {}
	overrides Staff::showNameInParts
bool	hideStaffLines {}
	overrides Staff::hideStaffLines
bool	redisplayLayerAccis {}
	overrides Staff::redisplayLayerAccis
bool	negTimeParts {}
	overrides Staff::hideTimeSigsInParts
bool	hideKeySigsShowAccis {}
	overrides Staff::hideKeySigsShowAccis

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::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

lists the masks that deterimine if this staff style overrides the staff settings

Todo:

add masks as needed. If we ever add them all, remove Base inheritance and requireAllFields function.

Constructor & Destructor Documentation

Masks()

musx::dom::others::StaffStyle::Masks::Masks ( const DocumentWeakPtr &  document )

inlineexplicit

Default constructor.

Parameters

document

A weak pointer to the document object.

Member Function Documentation

requireAllFields()

bool musx::dom::others::StaffStyle::Masks::requireAllFields ( ) const

inlineoverridevirtual

Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.

Remarks

This value only escapes errors on fields. Enum values must still have all values provided to avoid error messages or exceptions.

Reimplemented from musx::dom::Base.