MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::others::SmartShapeCustomLine::DashedParams Class Reference

Hold parameters for LineStyle::Dashed. More...

#include <SmartShape.h>

+ Inheritance diagram for musx::dom::others::SmartShapeCustomLine::DashedParams:

Public Member Functions

 ContainedClassBase (const MusxInstance< Base > &parent)
 Constructs a ContainedClassBase object.
 
- Public Member Functions inherited from musx::dom::ContainedClassBase
 ContainedClassBase (const MusxInstance< Base > &parent)
 Constructs a ContainedClassBase object.
 
template<typename ParentClass = Base>
MusxInstance< ParentClass > getParent () const
 Get the parent.
 
- 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 SharedNodesgetUnlinkedNodes () 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< DashedParams > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Efix lineWidth {}
 Dashed line width.
 
Efix dashOn {}
 Dash length.
 
Efix dashOff {}
 Length of gap between dashes.
 

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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (Base &&) noexcept
 no-op move assignment operator allows subclasses to move their values.
 

Detailed Description

Hold parameters for LineStyle::Dashed.

Member Function Documentation

◆ ContainedClassBase()

musx::dom::ContainedClassBase::ContainedClassBase ( const MusxInstance< Base > &  parent)
inline

Constructs a ContainedClassBase object.

Parameters
parentA shared pointer to the parent document.