hdi::core::TextGlyphRun Class Reference

Encapsulates glyph run functionality from the Illustrator SDK. More...

#include <hdicoreTextGlyphRun.h>

Public Member Functions
	TextGlyphRun ()
	Creates a new TextGlyphRun object.
	TextGlyphRun (const TextGlyphRun &gr_)
	TextGlyphRun copy constructor.
virtual	~TextGlyphRun ()
	Destructs a TextGlyphRun object.
virtual TextGlyphRun &	operator= (const TextGlyphRun &rhs_)
	Overloaded assignment operator for TextGlyphRun objects.
virtual bool	operator== (const TextGlyphRun &rhs_) const
	Tests whether a given TextGlyphRun object is the same as another.
virtual bool	operator!= (const TextGlyphRun &rhs_) const
	Tests whether a given TextGlyphRun object is not the same as another.
virtual std::unique_ptr< ATE::IGlyphRun >	ateGlyphRun () const
	Gets the ATE glyph run ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextGlyphRun object is empty.
virtual std::unique_ptr< TextLine >	textLine () const
	Retrieves the text-line parent of this glyph run.
virtual int32_t	glyphCount () const
	Retrieves the number of glyphs in this run.
virtual int32_t	charCount () const
	Retrieves the number of characters in this run.
virtual int32_t	originsCount () const
	Retrieves the count of origin points in this run.
virtual bool	origin (const int32_t index_, ArtboardPoint &pt__) const
	Retrieves an origin point for a glyph in this run.
virtual int32_t	glyphIDCount () const
	Retrieves the count of glyph identifiers in this run.
virtual bool	glyphID (const int32_t index_, int32_t &id__) const
	Retrieves a glyph identifier for a glyph in this run.
virtual std::unique_ptr< TextCharFeatures >	charFeatures () const
	Retrieves the character features of this run.
virtual GlyphOrientation	glyphOrientation () const
	Retrieves the glyph orientation of this run.
virtual double	ascent () const
	Retrieves the ascent of this run.
virtual double	descent () const
	Retrieves the descent of this run.
virtual double	tracking () const
	Retrieves the tracking (space between each character) of this run.
virtual double	spaceGlyphWidth () const
	Retrieves the width of the space glyph in the font for this run.
virtual double	distToBaseline () const
	Retrieves the distance to the baseline in the font for this run.
virtual double	underlinePosition () const
	Retrieves the underline position in the font for this run.
virtual double	underlineThickness () const
	Retrieves the underline thickness in the font for this run.
virtual double	minCapHeight () const
	Retrieves the minimum height for capital letters in the font for this run.
virtual double	maxCapHeight () const
	Retrieves the maximum height for capital letters in the font for this run.
virtual std::unique_ptr< Font >	flattenedFont () const
	Retrieves the component font for this run if the character-feature font is a composite font, otherwise retrieves the character-feature font.
virtual std::string	contents (const std::string &le_="\n") const
	Gets the value (contents) of the glyph run.

Friends
aip::TextGlyphRun *	__accessImpl (const TextGlyphRun &)
TextGlyphRun	__accessCtor (const aip::TextGlyphRun &)

Detailed Description

Encapsulates glyph run functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextGlyphRun() [1/2]

hdi::core::TextGlyphRun::TextGlyphRun

(

)

Creates a new TextGlyphRun object.

Author

GW

Date

08/2014

Note

New TextGlyphRun objects do not relate to any text glyph run on the Illustrator artboard; they are designed to be "receivers" of some other TextGlyphRun object via the overloaded assignment operator or assigned to some other existent text art.

TextGlyphRun() [2/2]

hdi::core::TextGlyphRun::TextGlyphRun

(

const TextGlyphRun &

gr_

)

TextGlyphRun copy constructor.

Author

GW

Date

08/2014

Parameters

gr_	TextGlyphRun object to copy values from

~TextGlyphRun()

virtual hdi::core::TextGlyphRun::~TextGlyphRun ( )

virtual

Destructs a TextGlyphRun object.

Author

GW

Date

08/2014

Member Function Documentation

ascent()

virtual double hdi::core::TextGlyphRun::ascent ( ) const

virtual

Retrieves the ascent of this run.

Author

GW

Date

08/2014

Returns

The ascent value, in document points

ateGlyphRun()

virtual std::unique_ptr< ATE::IGlyphRun > hdi::core::TextGlyphRun::ateGlyphRun ( ) const

virtual

Gets the ATE glyph run ref around which the target object is wrapped.

Author

GW

Date

08/2014

Returns

ATE::IGlyphRunRef for the target object

Note

Generally, you shouldn't need to call this method. Only use it if you know what you're doing. If a specific piece of functionality provided by Illustrator is not handled by this class (or related classes), then it should probably be added to the hdi_core library.

charCount()

virtual int32_t hdi::core::TextGlyphRun::charCount ( ) const

virtual

Retrieves the number of characters in this run.

Author

GW

Date

08/2014

Returns

The number of characters, or -1 for error

charFeatures()

virtual std::unique_ptr< TextCharFeatures > hdi::core::TextGlyphRun::charFeatures ( ) const

virtual

Retrieves the character features of this run.

Author

GW

Date

08/2014

Returns

The character features object

Note

Only the following features will be defined: Font, FontSize, HorizontalScale, VerticalScale, Tracking, BaselineShift, FillColor, StrokeColor, fBlend, Fill, Stroke, FillFirst, FillOverPrint, StrokeOverPrint, FillBackgroundColor, FillBackground, LineCap, LineJoin, LineWidth, MiterLimit, LineDashOffset, and LineDashArray.

contents()

virtual std::string hdi::core::TextGlyphRun::contents ( const std::string & le_ = "\n" ) const

virtual

Gets the value (contents) of the glyph run.

Author

GW

Date

08/2014

Parameters

le_	Indicates the desired line ending for the output string

Returns

A string for the value of the text art, as UTF-8

Note

Illustrator forces text art to utilize the "\r" character for line endings; if this behavior is unexpected or undesired for your application (as most systems use either "\n" or "\r\n" these days), you can specify what you'd prefer with the optional le_ argument.

descent()

virtual double hdi::core::TextGlyphRun::descent ( ) const

virtual

Retrieves the descent of this run.

Author

GW

Date

08/2014

Returns

The descent value, in document points

distToBaseline()

virtual double hdi::core::TextGlyphRun::distToBaseline ( ) const

virtual

Retrieves the distance to the baseline in the font for this run.

Author

GW

Date

08/2014

Returns

The distance value, in document points

flattenedFont()

virtual std::unique_ptr< Font > hdi::core::TextGlyphRun::flattenedFont ( ) const

virtual

Retrieves the component font for this run if the character-feature font is a composite font, otherwise retrieves the character-feature font.

Author

GW

Date

08/2014

Returns

The font object

glyphCount()

virtual int32_t hdi::core::TextGlyphRun::glyphCount ( ) const

virtual

Retrieves the number of glyphs in this run.

Author

GW

Date

08/2014

Returns

The number of glyphs, or -1 for error

Note

The number of the glyphs can be different from number of characters returned by charCount(), because of factors such as ligature and hyphenation.

glyphID()

virtual bool hdi::core::TextGlyphRun::glyphID ( const int32_t index_, int32_t & id__ ) const

virtual

Retrieves a glyph identifier for a glyph in this run.

Author

GW

Date

08/2014

Parameters

index_	Index of the glyph in question
id__	Return-by-reference for the glyph ID

Returns

true if the ID could be acquired, false otherwise

glyphIDCount()

virtual int32_t hdi::core::TextGlyphRun::glyphIDCount ( ) const

virtual

Retrieves the count of glyph identifiers in this run.

Author

GW

Date

08/2014

Returns

The count of glyph IDs, or -1 for error

glyphOrientation()

virtual GlyphOrientation hdi::core::TextGlyphRun::glyphOrientation ( ) const

virtual

Retrieves the glyph orientation of this run.

Author

GW

Date

08/2014

Returns

The orientation enum value

isEmpty()

virtual bool hdi::core::TextGlyphRun::isEmpty ( ) const

virtual

Gets whether the target TextGlyphRun object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextGlyphRun object is empty, false otherwise

maxCapHeight()

virtual double hdi::core::TextGlyphRun::maxCapHeight ( ) const

virtual

Retrieves the maximum height for capital letters in the font for this run.

Author

GW

Date

08/2014

Returns

The height value, in document points

minCapHeight()

virtual double hdi::core::TextGlyphRun::minCapHeight ( ) const

virtual

Retrieves the minimum height for capital letters in the font for this run.

Author

GW

Date

08/2014

Returns

The height value, in document points

operator!=()

virtual bool hdi::core::TextGlyphRun::operator!= ( const TextGlyphRun & rhs_ ) const

virtual

Tests whether a given TextGlyphRun object is not the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	TextGlyphRun to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different text glyph run, false otherwise

operator=()

virtual TextGlyphRun & hdi::core::TextGlyphRun::operator= ( const TextGlyphRun & rhs_ )

virtual

Overloaded assignment operator for TextGlyphRun objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextGlyphRun object to copy values from

Returns

The target TextGlyphRun object, but with its values updated to match that of rhs_

operator==()

virtual bool hdi::core::TextGlyphRun::operator== ( const TextGlyphRun & rhs_ ) const

virtual

Tests whether a given TextGlyphRun object is the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	TextGlyphRun to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same text glyph run, false otherwise

origin()

virtual bool hdi::core::TextGlyphRun::origin ( const int32_t index_, ArtboardPoint & pt__ ) const

virtual

Retrieves an origin point for a glyph in this run.

Author

GW

Date

08/2014

Parameters

index_	Index of the glyph in question
pt__	Return-by-reference for the glyph origin point

Returns

true if the origin point could be acquired, false otherwise

originsCount()

virtual int32_t hdi::core::TextGlyphRun::originsCount ( ) const

virtual

Retrieves the count of origin points in this run.

Author

GW

Date

08/2014

Returns

The count of origin points, or -1 for error

spaceGlyphWidth()

virtual double hdi::core::TextGlyphRun::spaceGlyphWidth ( ) const

virtual

Retrieves the width of the space glyph in the font for this run.

Author

GW

Date

08/2014

Returns

The width value, in document points

textLine()

virtual std::unique_ptr< TextLine > hdi::core::TextGlyphRun::textLine ( ) const

virtual

Retrieves the text-line parent of this glyph run.

Author

GW

Date

08/2014

Returns

The text-line object

tracking()

virtual double hdi::core::TextGlyphRun::tracking ( ) const

virtual

Retrieves the tracking (space between each character) of this run.

Author

GW

Date

08/2014

Returns

The tracking value, in document points

underlinePosition()

virtual double hdi::core::TextGlyphRun::underlinePosition ( ) const

virtual

Retrieves the underline position in the font for this run.

Author

GW

Date

08/2014

Returns

The position value, in document points

underlineThickness()

virtual double hdi::core::TextGlyphRun::underlineThickness ( ) const

virtual

Retrieves the underline thickness in the font for this run.

Author

GW

Date

08/2014

Returns

The thickness value, in document points