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

A text string. More...

Inheritance diagram for GRText:
GRPTagARNotationElement GRPositionTag GRARNotationElement GRTag GRNotationElement GObject GRVisitable GRFingering GRMark

Classes

class  GRTextSaveStruct
 

Public Member Functions

 GRText (GRStaff *, const ARText *abstractRepresentationOfText)
 
virtual ~GRText ()
 
virtual void accept (GRVisitor &visitor)
 
virtual void removeAssociation (GRNotationElement *el)
 
virtual void tellPosition (GObject *caller, const NVPoint &inPosition)
 
virtual void addAssociation (GRNotationElement *el)
 
virtual void OnDraw (VGDevice &hdc) const
 
virtual FloatRect getTextMetrics (VGDevice &hdc, const GRStaff *staff) const
 
virtual float getLineHeight (VGDevice &hdc) const
 
const ARTextgetARText () const
 
virtual unsigned int getTextAlign () const
 
virtual float getLeftSpace () const
 
virtual float getRightSpace () const
 
virtual void setPosition (const NVPoint &inPosition)
 
virtual void setHPosition (float nx)
 
void mustFollowPitch (bool flag)
 
virtual bool checkCollisionWith () const
 
virtual bool isLyrics () const
 
virtual const GRTextisText () const
 
- Public Member Functions inherited from GRPTagARNotationElement
 GRPTagARNotationElement (GuidoPos p_ep, const ARMusicalObject *el, bool ownsAR=false)
 
 GRPTagARNotationElement (const ARMusicalObject *el, bool ownsAR=false)
 
virtual ~GRPTagARNotationElement ()
 
virtual const NVPointgetOffset () const
 
virtual float getSize () const
 
virtual int getFontSize () const
 
const unsigned char * getColRef () const
 
- Public Member Functions inherited from GRPositionTag
 GRPositionTag (const ARMusicalTag *armt=0)
 
 GRPositionTag (GuidoPos p_ep, const ARMusicalTag *armt=0)
 
virtual ~GRPositionTag ()
 
virtual void ResumeTag (GRStaff *grstaff, GuidoPos assocpos)
 
virtual void BreakTag (GRStaff *grstaff, GuidoPos &assocpos)
 
virtual void StaffBegin (GRStaff *grstaff=0)
 
virtual void StaffFinished (GRStaff *grstaff=0)
 
virtual void FinishPTag (GRStaff *)
 
virtual void RangeEnd (GRStaff *grstaff=0)
 
virtual bool DeleteStaff (GRStaff *grstaff)
 
void changeCurrentSystem (GRSystem *psystem)
 
void DeleteAllSSEs ()
 
GuidoPos getEndPos () const
 
GRSystemStartEndStructgetSystemStartEndStruct (const GRSystem *grsystem) const
 
void addSystemStartEndStruct (GRSystemStartEndStruct *sse)
 
- Public Member Functions inherited from GRTag
 GRTag (const ARMusicalTag *artag=0, float curLSPACE=50.0f)
 
virtual ~GRTag ()
 
virtual bool operator!= (const GRTag &tag) const
 
virtual bool operator== (const GRTag &tag) const
 
int getIsAuto () const
 
bool IsStateTag () const
 
virtual float getSConst () const
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual void setSConst (float val)
 
void setTagType (TAGTYPE ntyp)
 
TAGTYPE getTagType () const
 
void setError (int p_error)
 
int getError () const
 
- Public Member Functions inherited from GRARNotationElement
 GRARNotationElement (const ARMusicalObject *abstractRepresentationOfNotationElement, bool p_ownsAR=false)
 
virtual ~GRARNotationElement ()
 
virtual const ARMusicalObjectgetAbstractRepresentation ()
 
virtual const ARMusicalObjectgetAbstractRepresentation () const
 
virtual void setOwnership (bool ownsAR)
 
virtual bool isChordComma () const
 
- Public Member Functions inherited from GRNotationElement
 GRNotationElement ()
 
virtual ~GRNotationElement ()
 
GRStaffgetGRStaff () const
 
virtual void setGRStaff (GRStaff *in)
 
GRSystemSlicegetGRSystemSlice () const
 
virtual int getStaffNumber () const
 
virtual void setLeftSpace (float lspace)
 
virtual void setRightSpace (float rspace)
 
virtual void setNeedsSpring (int inFlag)
 
virtual int getNeedsSpring () const
 
virtual int getSpringID () const
 
virtual void tellSpringID (int inSpringID)
 
NEPointerListgetAssociations ()
 
const NEPointerListgetAssociations () const
 
virtual void removeAssociation (const NEPointerList &nl)
 
void FreeAssociatedList ()
 
virtual NVPoint getTieEnd () const
 
virtual NVPoint getTieStart () const
 
virtual NVRect getAssociatedBoundingBox () const
 
void addToBoundingBox (GRNotationElement *in)
 
void OnDrawSymbol (VGDevice &hdc, unsigned int inSymbol, float inOffsetX=0, float inOffsetY=0, float inFontSize=0) const
 
void OnDrawText (VGDevice &hdc, NVPoint pos, const char *cp, int inCharCount=-1) const
 
void OnDrawText (VGDevice &hdc, const char *cp, int inCharCount=-1) const
 
void DrawSymbol (VGDevice &hdc, unsigned int inSymbol, float x=0, float y=0, float size=0) const
 
void DrawNumericSymbols (VGDevice &hdc, const char *symbols, float x, float y, float size, float spacing=DEFAULTNUMERICSPACE) const
 
void Show (bool status)
 
bool GetShow () const
 
virtual void SendMap (const NVRect &r, MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual void SendMap (MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual const TYPE_DURATIONgetDuration () const
 
virtual void setDuration (const TYPE_TIMEPOSITION &dur)
 
virtual void setRelativeTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual void setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual const TYPE_TIMEPOSITIONgetRelativeTimePosition () const
 
virtual void setDrawOnOff (bool onoff)
 
virtual bool getDrawOnOff ()
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void recalcVerticalPosition ()
 
virtual void print (std::ostream &os) const
 
const NEPointerListassociated () const
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
virtual bool isEmpty () const
 
virtual const GRSingleNoteisSingleNote () const
 
virtual GRSingleNoteisSingleNote ()
 
virtual const GRNoteisGRNote () const
 
virtual const GRRestisRest () const
 
virtual const GREventisGREvent () const
 
virtual GREventisGREvent ()
 
virtual const GRGlueisGRGlue () const
 
virtual const GRTempoisGRTempo () const
 
virtual const GRTrillisGRTrill () const
 
virtual const GRBarisGRBar () const
 
virtual const GRDynamicsisGRDynamic () const
 
virtual GRFingeringisGRFingering ()
 
virtual GRSlurisGRSlur ()
 
virtual const GRHarmonyisGRHarmony () const
 
- Public Member Functions inherited from GObject
virtual ~GObject ()
 
virtual void addToOffset (const NVPoint &)
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual const NVPointgetReferencePosition () const
 Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
 
const NVPointgetPosition () const
 
const NVRectgetBoundingBox () const
 
void addToBoundingBox (const NVRect &in)
 
NVRectgetReferenceBoundingBox ()
 
virtual bool isGREventClass () const
 
virtual void GetMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
virtual void DrawBoundingBox (VGDevice &hdc, const VGColor &inBrushColor) const
 
- Public Member Functions inherited from GRVisitable
virtual ~GRVisitable ()
 

Protected Member Functions

virtual const VGColor startDraw (VGDevice &hdc, unsigned int &fontalign) const
 
virtual void endDraw (VGDevice &hdc, const VGColor, unsigned int fontalign) const
 
virtual GRPositionTag::GRSaveStructgetNewGRSaveStruct ()
 
- Protected Member Functions inherited from GRPositionTag
virtual void setStartElement (const GRStaff *grstaff, GRNotationElement *n_element)
 
virtual void setEndElement (const GRStaff *grstaff, GRNotationElement *n_element)
 
- Protected Member Functions inherited from GRNotationElement
void DrawExtents (VGDevice &hdc, const VGColor &inColor) const
 
- Protected Member Functions inherited from GObject
 GObject ()
 
 GObject (const GObject &in)
 

Protected Attributes

unsigned int mTextAlign
 
bool mMustFollowPitch
 
float mStaffBottom
 
float fLineHeight = 0.f
 
- Protected Attributes inherited from GRPositionTag
SSEList mStartEndList
 
GRSystemStartEndStruct::setflag lastendflag
 
GRNotationElementlastendElement
 
GuidoPos lastendpos
 
- Protected Attributes inherited from GRTag
int isautotag
 
float sconst
 
unsigned char * mColRef
 
std::string fFontName
 
std::string fFontAttrib
 
int fFontSize
 
float mTagSize
 
NVPoint mTagOffset
 
- Protected Attributes inherited from GRARNotationElement
const ARMusicalObjectmAbstractRepresentation
 
bool mOwnsAR
 
- Protected Attributes inherited from GRNotationElement
unsigned int mSymbol
 
GRStaffmGrStaff
 
int mNeedsSpring
 
int mSpringID
 
float mLeftSpace
 
float mRightSpace
 
bool mDraw
 
bool mShow
 
bool mIsInHeader
 
TYPE_DURATION mDurationOfGR
 
NEPointerListmAssociated
 
- Protected Attributes inherited from GObject
NVPoint mPosition
 
NVRect mBoundingBox
 
NVRect mMapping
 

Additional Inherited Members

- Public Types inherited from GRTag
enum  TAGTYPE {
  VOICETAG, STAFFTAG, SYSTEMTAG, PAGETAG,
  VOICEANDSYSTEMTAG
}
 
- Static Public Member Functions inherited from GRNotationElement
static int ComparePos (const GRNotationElement *g1, const GRNotationElement *g2)
 
- Static Public Member Functions inherited from GObject
static bool positionIsOnStaffLine (float inPositionY, float inLSpace)
 
static float GetSymbolExtent (unsigned int inSymbol)
 
- Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float > sSymbolExtentMap
 
static NVPoint sRefposNone
 

Detailed Description

A text string.

Can represent standard text, lyrics, fingering, label, cue-text, marks...

Constructor & Destructor Documentation

◆ GRText()

GRText::GRText ( GRStaff ,
const ARText abstractRepresentationOfText 
)

◆ ~GRText()

virtual GRText::~GRText ( )
virtual

Member Function Documentation

◆ accept()

virtual void GRText::accept ( GRVisitor visitor)
virtual

Reimplemented from GRNotationElement.

Reimplemented in GRFingering.

◆ addAssociation()

virtual void GRText::addAssociation ( GRNotationElement el)
virtual

Reimplemented from GRPTagARNotationElement.

◆ checkCollisionWith()

virtual bool GRText::checkCollisionWith ( ) const
inlinevirtual

Reimplemented from GRNotationElement.

◆ endDraw()

virtual void GRText::endDraw ( VGDevice hdc,
const  VGColor,
unsigned int  fontalign 
) const
protectedvirtual

◆ getARText()

const ARText* GRText::getARText ( ) const

◆ getLeftSpace()

virtual float GRText::getLeftSpace ( ) const
virtual

Reimplemented from GRNotationElement.

Reimplemented in GRMark.

◆ getLineHeight()

virtual float GRText::getLineHeight ( VGDevice hdc) const
virtual

◆ getNewGRSaveStruct()

virtual GRPositionTag::GRSaveStruct* GRText::getNewGRSaveStruct ( )
inlineprotectedvirtual

Reimplemented from GRPositionTag.

◆ getRightSpace()

virtual float GRText::getRightSpace ( ) const
virtual

Reimplemented from GRNotationElement.

Reimplemented in GRMark.

◆ getTextAlign()

virtual unsigned int GRText::getTextAlign ( ) const
inlinevirtual

Reimplemented from GRNotationElement.

◆ getTextMetrics()

virtual FloatRect GRText::getTextMetrics ( VGDevice hdc,
const GRStaff staff 
) const
virtual

Reimplemented in GRMark.

◆ isLyrics()

virtual bool GRText::isLyrics ( ) const
virtual

Reimplemented from GRNotationElement.

◆ isText()

virtual const GRText* GRText::isText ( ) const
inlinevirtual

Reimplemented from GRNotationElement.

◆ mustFollowPitch()

void GRText::mustFollowPitch ( bool  flag)
inline

◆ OnDraw()

virtual void GRText::OnDraw ( VGDevice hdc) const
virtual

Reimplemented from GRNotationElement.

Reimplemented in GRMark, and GRFingering.

◆ removeAssociation()

virtual void GRText::removeAssociation ( GRNotationElement el)
virtual

Reimplemented from GRPTagARNotationElement.

◆ setHPosition()

virtual void GRText::setHPosition ( float  nx)
virtual

Reimplemented from GRNotationElement.

◆ setPosition()

virtual void GRText::setPosition ( const NVPoint inPosition)
virtual

Reimplemented from GRNotationElement.

◆ startDraw()

virtual const VGColor GRText::startDraw ( VGDevice hdc,
unsigned int &  fontalign 
) const
protectedvirtual

◆ tellPosition()

virtual void GRText::tellPosition ( GObject caller,
const NVPoint inPosition 
)
virtual

Reimplemented from GRNotationElement.

Reimplemented in GRFingering.

Member Data Documentation

◆ fLineHeight

float GRText::fLineHeight = 0.f
protected

◆ mMustFollowPitch

bool GRText::mMustFollowPitch
protected

◆ mStaffBottom

float GRText::mStaffBottom
protected

◆ mTextAlign

unsigned int GRText::mTextAlign
protected

Guido Project Copyright © 2019 Grame-CNCM