ATE::ITextLine Class Reference

This class encapsulates a line of text in a text frame. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITextLine ()
	Constructor.
	ITextLine (const ITextLine &src)
	Copy constructor.
ITextLine &	operator= (const ITextLine &rhs)
	Assignment operator.
bool	operator== (const ITextLine &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITextLine &rhs) const
	Comparison operator tests for inequality.
	ITextLine (TextLineRef textline)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITextLine ()
	Destructor.
TextLineRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
IGlyphRunsIterator	GetGlyphRunsIterator () const
	Retrieves a glyph-run iterator with which you can access the glyph runs of this line.
IGlyphRunsIterator	GetVisualGlyphRunsIterator () const
	Retrieves a glyph-run iterator with which you can access the glyph runs of this line, handling the special case of text that contains a mixture of left-to-right (LTR) and right-to-left (RTL) text.
ITextFrame	GetTextFrame () const
	Retrieves the parent text frame of this line.
ITextRange	GetTextRange () const
	Retrieves the text range for this line.
IArrayLine	GetBaselines () const
	Retrieves an array of baselines (IArrayLine) specified by a start and end point in the coordinate space of the containing text frame.

---

Detailed Description

This class encapsulates a line of text in a text frame.

The line is part of an ITextFrame, contains IGlyphRun objects that you can access with an IGlyphRunIterator, and is associated with an ITextRange.

See also:

ITextFrame::GetTextLinesIterator()

---

Constructor & Destructor Documentation

ATE::ITextLine::ITextLine

(

)

Constructor.

Returns:

The new object.

ATE::ITextLine::ITextLine

(

const ITextLine &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTextLine.

ATE::ITextLine::ITextLine

(

TextLineRef

textline

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

textline

The C object.

Returns:

The new C++ object.

ATE::ITextLine::~ITextLine

(

)

[virtual]

Destructor.

References ATE::sTextLine.

---

Member Function Documentation

IArrayLine ATE::ITextLine::GetBaselines

(

)

const

Retrieves an array of baselines (IArrayLine) specified by a start and end point in the coordinate space of the containing text frame.

An array is required since each composed line can contain several segments due to intrusions such as text wraps and Japanese features such as warichu.

Returns:

The array of baselines.

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

IGlyphRunsIterator ATE::ITextLine::GetGlyphRunsIterator

(

)

const

Retrieves a glyph-run iterator with which you can access the glyph runs of this line.

Returns:

The glyph-run iterator object.

See also:

GetVisualGlyphRunsIterator()

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

TextLineRef ATE::ITextLine::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ITextFrame ATE::ITextLine::GetTextFrame

(

)

const

Retrieves the parent text frame of this line.

Returns:

The text frame object.

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

ITextRange ATE::ITextLine::GetTextRange

(

)

const

Retrieves the text range for this line.

Returns:

The text range object.

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

IGlyphRunsIterator ATE::ITextLine::GetVisualGlyphRunsIterator

(

)

const

Retrieves a glyph-run iterator with which you can access the glyph runs of this line, handling the special case of text that contains a mixture of left-to-right (LTR) and right-to-left (RTL) text.

If this case is not expected, use GetGlyphRunsIterator().

Returns:

The glyph-run iterator object.

See also:

GetGlyphRunsIterator()

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

bool ATE::ITextLine::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTextLine.

bool ATE::ITextLine::operator!=

(

const ITextLine &

rhs

)

const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are not the same.

ITextLine & ATE::ITextLine::operator=

(

const ITextLine &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTextLine.

bool ATE::ITextLine::operator==

(

const ITextLine &

rhs

)

const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are the same.

---

The documentation for this class was generated from the following files:

• IText.h
• IText.cpp