GUIDOLib  1.7.7
Guido Engine Internal Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ARPageFormat Class Reference

not yet documented More...

Inheritance diagram for ARPageFormat:
ARMTParameter ARMusicalTag ARMusicalObject ARVisitable

Public Member Functions

 ARPageFormat ()
 
virtual ~ARPageFormat ()
 
void getPageFormat (float *sx, float *sy, float *ml, float *mt, float *mr, float *mb) const
 
void setPageFormat (float sx, float sy, float ml, float mt, float mr, float mb)
 
void operator= (const ARPageFormat &format)
 
virtual bool IsStateTag () const
 
virtual TagParameterMap checkTagParameters (TagParametersList &params, const std::string pTemplate)
 
virtual void setTagParameters (const TagParameterMap &params)
 
virtual const char * getParamsStr () const
 
virtual const char * getTagName () const
 
virtual std::string getGMNName () const
 
- 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 int getOrder () const
 
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 TagParameterFloatgetSize () const
 
const TagParameterStringgetColor () const
 
const TagParameterRGBColorgetRGBColor () const
 
const TagParameterFloatgetDX () const
 
const TagParameterFloatgetDY () const
 
const ARMusicalObjectisARMusicalTag () 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 TagParameterMapgetTagParameters () const
 
virtual const TagParameterMapgetSupportedTagParameters () 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 ARMusicalObjectCopy () const
 
virtual const TYPE_DURATIONgetDuration () const
 
virtual const TYPE_TIMEPOSITIONgetRelativeTimePosition () 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 ARMusicalObjectisARRepeatBegin ()
 
virtual ARNoteisARNote ()
 
virtual const ARNoteisARNote () const
 
virtual ARTabisARTab ()
 
virtual const ARTabisARTab () const
 
virtual ARMusicalObjectisARCoda ()
 
virtual ARMusicalObjectisARSegno ()
 
virtual ARMusicalObjectisARNewPage ()
 
virtual ARMusicalObjectisARNewSystem ()
 
virtual ARMusicalObjectisARKey ()
 
virtual ARMusicalObjectisARNaturalKey ()
 
virtual ARMusicalObjectisARBeamState ()
 
virtual ARMusicalObjectisARClef ()
 
virtual ARMusicalObjectisARFinishBar ()
 
virtual ARMusicalObjectisARMeter ()
 
virtual ARMusicalObjectisARRepeatEnd ()
 
virtual ARMusicalObjectisARRest ()
 
virtual ARMusicalObjectisARSecondGlue ()
 
virtual ARMusicalObjectisARPossibleBreak ()
 
virtual AROctavaisAROctava ()
 
virtual ARGraceisARGrace ()
 
virtual ARSpaceisARSpace ()
 
virtual ARTempoisARTempo ()
 
virtual const ARMusicalObjectisARDummyRangeEnd () const
 
virtual const ARMusicalObjectisARNoteFormat () const
 
virtual const ARMusicalObjectisARBar () const
 
virtual const ARMusicalObjectisARStaff () const
 
virtual const ARMusicalObjectisARJump () const
 
virtual const ARMusicalObjectisARChordComma () const
 
virtual const ARMusicalObjectisARUserChordTag () const
 
virtual bool isEmptyNote () const
 
- Public Member Functions inherited from ARVisitable
 ARVisitable ()
 
virtual ~ARVisitable ()
 

Protected Member Functions

void ClipSize ()
 
void AdjustMargins ()
 
- Protected Member Functions inherited from ARMusicalTag
virtual void checkUnitParameters (TagParameterMap &map)
 

Protected Attributes

float mSizeX
 
float mSizeY
 
float mLeft
 
float mTop
 
float mRight
 
float mBottom
 
std::string mFormat
 
- 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
 

Additional Inherited Members

- 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 }
 
- Static Public Member Functions inherited from ARMusicalObject
static bool IsPowerOfTwoDenom (const TYPE_DURATION &dur)
 

Detailed Description

not yet documented

Constructor & Destructor Documentation

◆ ARPageFormat()

ARPageFormat::ARPageFormat ( )

◆ ~ARPageFormat()

virtual ARPageFormat::~ARPageFormat ( )
inlinevirtual

Member Function Documentation

◆ AdjustMargins()

void ARPageFormat::AdjustMargins ( )
protected

◆ checkTagParameters()

virtual TagParameterMap ARPageFormat::checkTagParameters ( TagParametersList &  params,
const std::string  pTemplate 
)
virtual

Reimplemented from ARMusicalTag.

◆ ClipSize()

void ARPageFormat::ClipSize ( )
protected

◆ getGMNName()

virtual std::string ARPageFormat::getGMNName ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ getPageFormat()

void ARPageFormat::getPageFormat ( float *  sx,
float *  sy,
float *  ml,
float *  mt,
float *  mr,
float *  mb 
) const

◆ getParamsStr()

virtual const char* ARPageFormat::getParamsStr ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ getTagName()

virtual const char* ARPageFormat::getTagName ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ IsStateTag()

virtual bool ARPageFormat::IsStateTag ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ operator=()

void ARPageFormat::operator= ( const ARPageFormat format)

◆ setPageFormat()

void ARPageFormat::setPageFormat ( float  sx,
float  sy,
float  ml,
float  mt,
float  mr,
float  mb 
)

◆ setTagParameters()

virtual void ARPageFormat::setTagParameters ( const TagParameterMap params)
virtual

Reimplemented from ARMusicalTag.

Member Data Documentation

◆ mBottom

float ARPageFormat::mBottom
protected

◆ mFormat

std::string ARPageFormat::mFormat
protected

◆ mLeft

float ARPageFormat::mLeft
protected

◆ mRight

float ARPageFormat::mRight
protected

◆ mSizeX

float ARPageFormat::mSizeX
protected

◆ mSizeY

float ARPageFormat::mSizeY
protected

◆ mTop

float ARPageFormat::mTop
protected

Guido Project Copyright © 2019 Grame-CNCM