ATE::IGlyphRun Class Reference

Encapsulates a glyph run as a text resource. More...

#include <IText.h>

Public Member Functions
	IGlyphRun ()
	Constructor.
	IGlyphRun (const IGlyphRun &src)
	Copy constructor.
IGlyphRun &	operator= (const IGlyphRun &rhs)
	Assignment operator.
bool	operator== (const IGlyphRun &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IGlyphRun &rhs) const
	Comparison operator tests for inequality.
	IGlyphRun (GlyphRunRef glyphrun)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IGlyphRun ()
	Destructor.
GlyphRunRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ITextLine	GetTextLine () const
	Retrieves the text-line parent of this glyph run.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of glyphs in this run.
ATETextDOM::Int32	GetCharacterCount () const
	Retrieves the number of characters in this run.
IArrayRealPoint	GetOrigins () const
	Retrieves the origin points of each glyph in this run.
IArrayGlyphID	GetGlyphIDs () const
	Retrieves the unique identifiers of each glyph in this run.
ATETextDOM::RealMatrix	GetMatrix () const
	Retrieves the transformation matrix of this run, which specifies the full transformation.
ICharFeatures	GetCharFeatures () const
	Retrieves the character features of this run.
GlyphOrientation	GetGlyphOrientation () const
	Retrieves the glyph orientation of this run.
ATETextDOM::Real	GetAscent () const
	Retrieves the ascent of this run.
ATETextDOM::Real	GetDescent () const
	Retrieves the descent of this run.
ATETextDOM::Real	GetTracking () const
	Retrieves the tracking (space between each character) of this run,.
ATETextDOM::Real	GetSpaceGlyphWidth () const
	Retrieves the width of the space glyph in the font for this run.
ATETextDOM::Real	GetDistanceToBaseline () const
	Retrieves the distance to the baseline in the font for this run.
ATETextDOM::Real	GetUnderlinePosition () const
	Retrieves the underline position in the font for this run.
ATETextDOM::Real	GetUnderlineThickness () const
	Retrieves the underline thickness in the font for this run.
ATETextDOM::Real	GetMaxCapHeight () const
	Retrieves the maximum height for capital letters in the font for this run.
ATETextDOM::Real	GetMinCapHeight () const
	Retrieves the minimum height for capital letters in the font for this run.
IFont	GetFlattenedFont () const
	Retrieves the component font for this run if the character-feature font is a composite font, otherwise retrieves the character-feature font.
ATETextDOM::Int32	GetContents (ATETextDOM::Unicode *text, ATETextDOM::Int32 maxLength) const
	Retrieves the contents of this run as a Unicode string.
ATETextDOM::Int32	GetContents (char *text, ATETextDOM::Int32 maxLength) const
	Retrieves the contents of this run as a C string.

Detailed Description

Encapsulates a glyph run as a text resource.

The methods allow you to add, access, and manipulate glyph runs for use with the Adobe Text Engine (ATE). A glyph run belongs to a ITextLine object. It contains a string of characters, along with drawing information for them.

Constructor & Destructor Documentation

ATE::IGlyphRun::IGlyphRun ( )

Constructor.

Returns:: The new object.

ATE::IGlyphRun::IGlyphRun ( const IGlyphRun & src )

Copy constructor.

Parameters:

src

The object to copy.

Returns:: The new object.

References ATE::sGlyphRun.

ATE::IGlyphRun::IGlyphRun ( GlyphRunRef glyphrun ) [explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

glyphrun

The C object.

Returns:: The new C++ object.

ATE::IGlyphRun::~IGlyphRun ( ) [virtual]

Destructor.

References ATE::sGlyphRun.

Member Function Documentation

ATETextDOM::Real ATE::IGlyphRun::GetAscent ( ) const

Retrieves the ascent of this run.

Returns:: The ascent value, in document points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::IGlyphRun::GetCharacterCount ( ) const

Retrieves the number of characters in this run.

Use to determine the size of buffer to pass to GetContents().

Returns:: The number of characters.

See also:: GetSize()

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ICharFeatures ATE::IGlyphRun::GetCharFeatures ( ) const

Retrieves the character features of this run.

Only the following members are defined:
Font
FontSize
HorizontalScale
VerticalScale
Tracking
BaselineShift
FillColor
StrokeColor
fBlend
Fill
Stroke
FillFirst
FillOverPrint
StrokeOverPrint
FillBackgroundColor
FillBackground
LineCap
LineJoin
LineWidth
MiterLimit
LineDashOffset
LineDashArray

Returns:: The character features object.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::IGlyphRun::GetContents	(	char *	text,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the contents of this run as a C string.

Parameters:

	text	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer. Use `GetCharacterCount()` to determine what size is needed.

Returns:: The number of characters written to the text buffer.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::IGlyphRun::GetContents	(	ATETextDOM::Unicode *	text,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the contents of this run as a Unicode string.

Parameters:

	text	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer. Use `GetCharacterCount()` to determine what size is needed.

Returns:: The number of characters written to the text buffer.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::IGlyphRun::GetDescent ( ) const

Retrieves the descent of this run.

Returns:: The descent value, in document points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::IGlyphRun::GetDistanceToBaseline ( ) const

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

Returns:: The distance value, in document points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

IFont ATE::IGlyphRun::GetFlattenedFont ( ) const

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

Returns:: The font object.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

IArrayGlyphID ATE::IGlyphRun::GetGlyphIDs ( ) const

Retrieves the unique identifiers of each glyph in this run.

Returns:: The array of identifiers.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

GlyphOrientation ATE::IGlyphRun::GetGlyphOrientation ( ) const

Retrieves the glyph orientation of this run.

Returns:: The orientation constant.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::RealMatrix ATE::IGlyphRun::GetMatrix ( ) const

Retrieves the transformation matrix of this run, which specifies the full transformation.

To get the location of an individual glyph, you must transform the origin by the value in the GetOrigins() array, then concatinate this matrix with the text frame matrix, returned by ITextFrame::GetMatrix().

Returns:: The transformation matrix.

References ATE::ATEFloatMatrixToATERealMatrix(), ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::IGlyphRun::GetMaxCapHeight ( ) const

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

Returns:: The height value, in document points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::IGlyphRun::GetMinCapHeight ( ) const

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

Returns:: The height value, in document points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

IArrayRealPoint ATE::IGlyphRun::GetOrigins ( ) const

Retrieves the origin points of each glyph in this run.

Returns:: The array of origin points.

References ATE::sGlyphRun, and ATE::Throw_ATE_Exception().

GlyphRunRef ATE::IGlyphRun::GetRef ( ) const

Retrieves a reference to this object.

Returns:: The object reference.

ATETextDOM::Int32 ATE::IGlyphRun::GetSize ( ) const

Retrieves the number of glyphs in this run.

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