Class: TLineInformationIterator

Declaration: TextDisplay.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Provides access to information about the lines of text drawn by a TTextDisplay object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class should be derived only if you are deriving TTextDisplay itself. Any TTextDisplay deriving using other than the default mechanism for breaking lines should derive TLineInformationIterator.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TLineInformationIterator::TLineInformationIterator

TLineInformationIterator (const TTextDisplay *)
TLineInformationIterator (const TLineInformationIterator &)

Interface Category:

API.

Purpose:

Creates a TLineInformationIterator from a TTextDisplay.
Copy constructor.

Calling Context:

Used by TTextDisplay to create a TLineInformationIterator.
Called to copy an object.

Parameters:

const TTextDisplay * -The TTextDisplay object whose line breaking information this object accesses.
const TLineInformationIterator & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::operator=

TLineInformationIterator & operator =(const TLineInformationIterator &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLineInformationIterator & -The object to copy.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::~TLineInformationIterator

virtual ~ TLineInformationIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::First

virtual bool First (TTextRange & textRange, TGRect & textboundary, GCoordinate & baselineOffset)

Interface Category:

API.

Purpose:

Provides positioning information for the first line of text drawn by a TTextDisplay object.

Calling Context:

Called to obtain positioning information for the first line of text drawn by a TTextDisplay object.

Parameters:

TTextRange & textRange -The range of the TTextDisplay's text on the first line.
TGRect & textboundary -The smallest rectangle surrounding the text on the first line.
GCoordinate & baselineOffset -The offset relative to the TTextDisplay's boundary rectangle of the first line. This is a text offset and its interpretation depends on the direction of the text. For example, if text is horizontal and left-to-right, the baseline offset is the distance between the baseline of the text and the top of the boundary rectangle.

Return Value:

Returns true if there is at least one line of text drawn by the TTextDisplay object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::Last

virtual bool Last (TTextRange & textRange, TGRect & textboundary, GCoordinate & baselineOffset)

Interface Category:

API.

Purpose:

Provides positioning information for the last line of text drawn by a TTextDisplay object.

Calling Context:

Called to obtain positioning information for the last line of text drawn by a TTextDisplay object.

Parameters:

TTextRange & textRange -The range of the TTextDisplay's text on the last line.
TGRect & textboundary -The smallest rectangle surrounding the text on the last line.
GCoordinate & baselineOffset -The offset relative to the TTextDisplay's boundary rectangle of the last line. This is a text offset and its interpretation depends on the direction of the text. For example, if text is horizontal and left-to-right, the baseline offset is the distance between the baseline of the text and the top of the boundary rectangle.

Return Value:

Returns true if there is at least one line of text drawn by the TTextDisplay object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::Next

virtual bool Next (TTextRange & textRange, TGRect & textboundary, GCoordinate & baselineOffset)

Interface Category:

API.

Purpose:

Provides positioning information for the line of text drawn by a TTextDisplay object following the current line.

Calling Context:

Called to obtain positioning information for the line of text drawn by a TTextDisplay object following the current line.

Parameters:

TTextRange & textRange -The range of the TTextDisplay's text on the line of text following the current line.
TGRect & textboundary -The smallest rectangle surrounding the text on the line following the current line.
GCoordinate & baselineOffset -The offset relative to the TTextDisplay's boundary rectangle of the line of text following the current line. This is a text offset and its interpretation depends on the direction of the text. For example, if text is horizontal and left-to-right, the baseline offset is the distance between the baseline of the text and the top of the boundary rectangle.

Return Value:

Returns true if the current line is not the last line of text drawn by the TTextDisplay object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineInformationIterator::Previous

virtual bool Previous (TTextRange & textRange, TGRect & textboundary, GCoordinate & baselineOffset)

Interface Category:

API.

Purpose:

Provides positioning information for the line of text drawn by a TTextDisplay object preceding the current line.

Calling Context:

Called to obtain positioning information for the line of text drawn by a TTextDisplay object preceding the current line.

Parameters:

TTextRange & textRange -The range of the TTextDisplay's text on the line of text preceding the current line.
TGRect & textboundary -The smallest rectangle surrounding the text on the line preceding the current line.
GCoordinate & baselineOffset -The offset relative to the TTextDisplay's boundary rectangle of the line of text preceding the current line. This is a text offset and its interpretation depends on the direction of the text. For example, if text is horizontal and left-to-right, the baseline offset is the distance between the baseline of the text and the top of the boundary rectangle.

Return Value:

Returns true if the current line is not the first line of text drawn by the TTextDisplay object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.