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

The text tag. More...

Inheritance diagram for ARText:
ARFontAble ARPositionTag ARMTParameter ARMusicalTag ARMusicalObject ARVisitable ARComposer ARFingering ARFooter ARLabel ARMark ARTitle

Public Member Functions

 ARText (const std::string &p_txt, float p_offsety, bool isLyric=false)
 
 ARText ()
 
virtual ~ARText ()
 
virtual void setTagParameters (const TagParameterMap &params)
 
virtual const char * getText () const
 
virtual void copyLyricsParams (const ARLyrics *lyrics)
 
virtual const char * getParamsStr () const
 
virtual const char * getTagName () const
 
virtual std::string getGMNName () const
 
void setAutoPos (bool state)
 
bool isLyric () const
 
bool isAutoPos () const
 
- Public Member Functions inherited from ARFontAble
 ARFontAble ()
 
virtual ~ARFontAble ()
 
const char * getFont () const
 
const char * getTextFormat () const
 
const char * getTextAttributes () const
 
float getFSize () 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 bool IsStateTag () 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 ()
 
- Public Member Functions inherited from ARPositionTag
 ARPositionTag ()
 
virtual ~ARPositionTag ()
 
virtual ARMusicalObjectCopy () const
 
virtual void setPosition (GuidoPos p_pos)
 
virtual GuidoPos getPosition () const
 
virtual GuidoPos getStartPosition () const
 
virtual void setStartPosition (GuidoPos p_pos)
 
virtual GuidoPos getEndPosition () const
 
virtual void setEndPosition (GuidoPos p_pos)
 
virtual void setCorrespondence (ARPositionTag *p_cor)
 
virtual ARPositionTaggetCorrespondence () const
 
virtual void setParentCorrespondence (ARPositionTag *parent)
 
virtual bool isEndTagClass () const
 
virtual ARMusicalObjectisARDisplayDuration ()
 
virtual ARMusicalObjectisARChordTag ()
 
virtual ARMusicalObjectisARGrace ()
 
virtual const ARMusicalObjectisARFeatheredBeam () const
 

Protected Attributes

std::string fText
 
bool fIsLyric
 
bool fIsAutoPos
 
- Protected Attributes inherited from ARFontAble
std::string fTextFormat
 
std::string fFontName
 
float fFontSize = 0.f
 
std::string fTextAttributes
 
- 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
 
- Protected Attributes inherited from ARPositionTag
GuidoPos pos
 
GuidoPos ep
 
ARPositionTagmPositionTag
 
ARPositionTagmParentCorrespondence
 

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)
 
- Protected Member Functions inherited from ARMusicalTag
virtual TagParameterMap checkTagParameters (TagParametersList &params, const std::string pTemplate)
 
virtual void checkUnitParameters (TagParameterMap &map)
 

Detailed Description

The text tag.

Constructor & Destructor Documentation

◆ ARText() [1/2]

ARText::ARText ( const std::string &  p_txt,
float  p_offsety,
bool  isLyric = false 
)

◆ ARText() [2/2]

ARText::ARText ( )

◆ ~ARText()

virtual ARText::~ARText ( )
inlinevirtual

Member Function Documentation

◆ copyLyricsParams()

virtual void ARText::copyLyricsParams ( const ARLyrics lyrics)
virtual

◆ getGMNName()

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

Implements ARPositionTag.

Reimplemented in ARTitle, ARFingering, ARMark, ARComposer, ARFooter, and ARLabel.

◆ getParamsStr()

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

Reimplemented from ARFontAble.

Reimplemented in ARTitle, ARMark, ARComposer, ARFooter, and ARLabel.

◆ getTagName()

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

Reimplemented from ARMusicalTag.

Reimplemented in ARTitle, ARFingering, ARMark, ARComposer, ARFooter, and ARLabel.

◆ getText()

virtual const char* ARText::getText ( ) const
inlinevirtual

◆ isAutoPos()

bool ARText::isAutoPos ( ) const
inline

◆ isLyric()

bool ARText::isLyric ( ) const
inline

◆ setAutoPos()

void ARText::setAutoPos ( bool  state)
inline

◆ setTagParameters()

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

Reimplemented from ARFontAble.

Reimplemented in ARMark, ARFingering, and ARComposer.

Member Data Documentation

◆ fIsAutoPos

bool ARText::fIsAutoPos
protected

◆ fIsLyric

bool ARText::fIsLyric
protected

◆ fText

std::string ARText::fText
protected

Guido Project Copyright © 2019 Grame-CNCM