Abstract representation of a staff clef. More...

Inheritance diagram for ARClef:

Public Types
enum	cleftype { UNDEFINED, OFF, AUTO, VIOLIN, BASS, BRATSCHE, PERC, DOUBLEG, TAB }

enum	octavatype { LOW15 = -2, LOW8 = -1, NONE = 0, HIGH8 = 1, HIGH15 = 2 }

Public Types inherited from ARMusicalTag
enum	ORDER { kDontMove =-1, kStartOrder, kStaffOrder, kInstrumentOrder, kClefOrder, kKeyOrder, kMeterOrder, kTitleOrder, kComposerOrder, kFooterOrder, kSystemFormatOrder, kAccoladeOrder, kDefaultOrder }

enum	ASSOCIATION { LA, RA, DC, EL, ER }

enum	RANGE { NO, ONLY, RANGEDC }

Public Member Functions
	ARClef ()

	ARClef (const ARClef &clef)

	ARClef (const TYPE_TIMEPOSITION &timeposition)

	ARClef (const std::string &theName)

virtual	~ARClef ()

virtual bool	IsStateTag () const

virtual int	getOrder () const

virtual const char *	getParamsStr () const

virtual const char *	getTagName () const

virtual std::string	getGMNName () const

virtual bool	operator== (const ARClef &clef) const

virtual void	setTagParameters (const TagParameterMap &params)

void	setName (const std::string &theName)

const std::string &	getName () const

int	getLine () const

cleftype	getClefType () const

octavatype	getOctavaType () const

ARMusicalObject *	isARClef ()

Public Member Functions inherited from ARMTParameter
	ARMTParameter (const TYPE_TIMEPOSITION &tp, const ARMTParameter *copy=0)

	ARMTParameter (int pid=-1, const ARMTParameter *copy=0)

virtual	~ARMTParameter ()

Public Member Functions inherited from ARMusicalTag
	ARMusicalTag (const TYPE_TIMEPOSITION &tp, const ARMusicalTag *copy=0)

	ARMusicalTag (int pid=-1, const ARMusicalTag *copy=0)

virtual	~ARMusicalTag ()

virtual void	accept (ARVisitor &visitor)

virtual bool	MatchEndTag (const char *endstr)

void	setAllowRange (int pallow)

void	setIsAuto (bool isauto)

bool	getIsAuto () const

void	print (std::ostream &os) const

void	setAssociation (ASSOCIATION p_assoc)

ASSOCIATION	getAssociation () const

virtual RANGE	getRangeSetting () const

virtual void	setError (int i=1)

virtual int	getError () const

int	getID () const

void	setID (int pid)

virtual void	setRange (bool p)

virtual bool	getRange () const

void	setColor (const char *cp)

void	setRGBColor (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)

void	setSize (float newsize)

virtual const TagParameterFloat *	getSize () const

const TagParameterString *	getColor () const

const TagParameterRGBColor *	getRGBColor () const

const TagParameterFloat *	getDX () const

const TagParameterFloat *	getDY () const

const ARMusicalObject *	isARMusicalTag () const

template<typename T >
const T *	getParameter (const char *param, bool usedefault=false) const

template<typename T >
const T *	getParameter (const char name1, const char name2) const

template<typename T >
const T *	getDefaultParameter (const char *param) const

virtual void	setTagParameters (TagParametersList &params)

virtual void	clearTagDefaultParameter (const char *param)

virtual const TagParameterMap &	getTagParameters () const

virtual const TagParameterMap &	getSupportedTagParameters () const

virtual void	addTagParameter (STagParameterPtr param)

virtual void	copyParameters (const TagParameterMap &map)

virtual void	setupTagParameters (const TagParameterMap &map)

virtual void	setIsInHeader (bool state)

virtual bool	isInHeader () const

Public Member Functions inherited from ARMusicalObject
	ARMusicalObject ()

	ARMusicalObject (const TYPE_TIMEPOSITION &relativeTimepositionOfMusicalObject)

	ARMusicalObject (const ARMusicalObject &armo)

virtual	~ARMusicalObject ()

virtual ARMusicalObject *	Copy () const

virtual const TYPE_DURATION &	getDuration () const

virtual const TYPE_TIMEPOSITION &	getRelativeTimePosition () const

virtual TYPE_TIMEPOSITION	getRelativeEndTimePosition () const

virtual void	setRelativeTimePosition (const TYPE_TIMEPOSITION &newRelativeTimePosition)

virtual void	setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)

virtual void	setDuration (const TYPE_DURATION &dur)

virtual bool	isEventClass () const

virtual void	browse (TimeUnwrap &mapper) const

virtual int	getVoiceNum () const

virtual void	printGMNName (std::ostream &os) const

virtual void	setVoiceNum (int num)

virtual void	setDrawGR (bool on)

virtual bool	getDrawGR () const

virtual ARMusicalObject *	isARRepeatBegin ()

virtual ARNote *	isARNote ()

virtual const ARNote *	isARNote () const

virtual ARTab *	isARTab ()

virtual const ARTab *	isARTab () const

virtual ARMusicalObject *	isARCoda ()

virtual ARMusicalObject *	isARSegno ()

virtual ARMusicalObject *	isARNewPage ()

virtual ARMusicalObject *	isARNewSystem ()

virtual ARMusicalObject *	isARKey ()

virtual ARMusicalObject *	isARNaturalKey ()

virtual ARMusicalObject *	isARBeamState ()

virtual ARMusicalObject *	isARFinishBar ()

virtual ARMusicalObject *	isARMeter ()

virtual ARMusicalObject *	isARRepeatEnd ()

virtual ARMusicalObject *	isARRest ()

virtual ARMusicalObject *	isARSecondGlue ()

virtual ARMusicalObject *	isARPossibleBreak ()

virtual AROctava *	isAROctava ()

virtual ARGrace *	isARGrace ()

virtual ARSpace *	isARSpace ()

virtual ARTempo *	isARTempo ()

virtual const ARMusicalObject *	isARDummyRangeEnd () const

virtual const ARMusicalObject *	isARNoteFormat () const

virtual const ARMusicalObject *	isARBar () const

virtual const ARMusicalObject *	isARStaff () const

virtual const ARMusicalObject *	isARJump () const

virtual const ARMusicalObject *	isARChordComma () const

virtual const ARMusicalObject *	isARUserChordTag () const

virtual bool	isEmptyNote () const

Public Member Functions inherited from ARVisitable
	ARVisitable ()

virtual	~ARVisitable ()

Additional Inherited Members
Static Public Member Functions inherited from ARMusicalObject
static bool	IsPowerOfTwoDenom (const TYPE_DURATION &dur)

Protected Member Functions inherited from ARMusicalTag
virtual TagParameterMap	checkTagParameters (TagParametersList &params, const std::string pTemplate)

virtual void	checkUnitParameters (TagParameterMap &map)

Protected Attributes inherited from ARMusicalTag
int	id

bool	isAuto

ASSOCIATION	assoc

RANGE	rangesetting

int	error

bool	mHasRange

Protected Attributes inherited from ARMusicalObject
TYPE_TIMEPOSITION	relativeTimePosition

int	fVoiceNum

bool	fDrawGR = true

Detailed Description

Abstract representation of a staff clef.

Member Enumeration Documentation

◆ cleftype

enum ARClef::cleftype

Enumerator
UNDEFINED
OFF
AUTO
VIOLIN
BASS
BRATSCHE
PERC
DOUBLEG
TAB

◆ octavatype

enum ARClef::octavatype

Enumerator
LOW15
LOW8
NONE
HIGH8
HIGH15

Constructor & Destructor Documentation

◆ ARClef() [1/4]

ARClef::ARClef ( )

◆ ARClef() [2/4]

ARClef::ARClef ( const ARClef & clef )

◆ ARClef() [3/4]

ARClef::ARClef ( const TYPE_TIMEPOSITION & timeposition )

◆ ARClef() [4/4]

ARClef::ARClef ( const std::string & theName )

◆ ~ARClef()

virtual ARClef::~ARClef ( )

inlinevirtual

Member Function Documentation

◆ getClefType()

cleftype ARClef::getClefType ( ) const

inline

◆ getGMNName()

virtual std::string ARClef::getGMNName ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

◆ getLine()

int ARClef::getLine ( ) const

inline

◆ getName()

const std::string& ARClef::getName ( ) const

inline

◆ getOctavaType()

octavatype ARClef::getOctavaType ( ) const

inline

◆ getOrder()

virtual int ARClef::getOrder ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

◆ getParamsStr()

virtual const char* ARClef::getParamsStr ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

◆ getTagName()

virtual const char* ARClef::getTagName ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

◆ isARClef()

ARMusicalObject* ARClef::isARClef ( )

inlinevirtual

Reimplemented from ARMusicalObject.

◆ IsStateTag()

virtual bool ARClef::IsStateTag ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

◆ operator==()

virtual bool ARClef::operator== ( const ARClef & clef ) const

virtual

◆ setName()

void ARClef::setName ( const std::string & theName )

◆ setTagParameters()

virtual void ARClef::setTagParameters ( const TagParameterMap & params )

virtual

Reimplemented from ARMusicalTag.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ cleftype

◆ octavatype

Constructor & Destructor Documentation

◆ ARClef() [1/4]

◆ ARClef() [2/4]

◆ ARClef() [3/4]

◆ ARClef() [4/4]

◆ ~ARClef()

Member Function Documentation

◆ getClefType()

◆ getGMNName()

◆ getLine()

◆ getName()

◆ getOctavaType()

◆ getOrder()

◆ getParamsStr()

◆ getTagName()

◆ isARClef()

◆ IsStateTag()

◆ operator==()

◆ setName()

◆ setTagParameters()