ATE::IArrayUnderlinePosition Class Reference

Provides access to an ordered collection of underline position values. More...

#include <IText.h>

List of all members.

Public Member Functions
	IArrayUnderlinePosition ()
	Constructor.
	IArrayUnderlinePosition (const IArrayUnderlinePosition &src)
	Copy constructor.
IArrayUnderlinePosition &	operator= (const IArrayUnderlinePosition &rhs)
	Assignment operator.
bool	operator== (const IArrayUnderlinePosition &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IArrayUnderlinePosition &rhs) const
	Comparison operator tests for inequality.
	IArrayUnderlinePosition (ArrayUnderlinePositionRef arrayunderlineposition)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IArrayUnderlinePosition ()
	Destructor.
ArrayUnderlinePositionRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of members of this set.
UnderlinePosition	GetFirst () const
	Retrieves the first member of this set.
UnderlinePosition	GetLast () const
	Retrieves the last member of this set.
UnderlinePosition	Item (ATETextDOM::Int32 index) const
	Retrieves a member of this set by position index.

---

Detailed Description

Provides access to an ordered collection of underline position values.

See UnderlinePosition.

---

Constructor & Destructor Documentation

ATE::IArrayUnderlinePosition::IArrayUnderlinePosition

(

)

Constructor.

Returns:

The new object.

ATE::IArrayUnderlinePosition::IArrayUnderlinePosition

(

const IArrayUnderlinePosition &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sArrayUnderlinePosition.

ATE::IArrayUnderlinePosition::IArrayUnderlinePosition

(

ArrayUnderlinePositionRef

arrayunderlineposition

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

arrayunderlineposition

The C object.

Returns:

The new C++ object.

ATE::IArrayUnderlinePosition::~IArrayUnderlinePosition

(

)

[virtual]

Destructor.

References ATE::sArrayUnderlinePosition.

---

Member Function Documentation

UnderlinePosition ATE::IArrayUnderlinePosition::GetFirst

(

)

const

Retrieves the first member of this set.

Returns:

The member value.

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

UnderlinePosition ATE::IArrayUnderlinePosition::GetLast

(

)

const

Retrieves the last member of this set.

Returns:

The member value.

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

ArrayUnderlinePositionRef ATE::IArrayUnderlinePosition::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IArrayUnderlinePosition::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::IArrayUnderlinePosition::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sArrayUnderlinePosition.

UnderlinePosition ATE::IArrayUnderlinePosition::Item

(

ATETextDOM::Int32

index

)

const

Retrieves a member of this set by position index.

Use with GetSize() to iterate through members.

Parameters:

index

The 0-based position index.

Returns:

The member value.

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

bool ATE::IArrayUnderlinePosition::operator!=

(

const IArrayUnderlinePosition &

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.

IArrayUnderlinePosition & ATE::IArrayUnderlinePosition::operator=

(

const IArrayUnderlinePosition &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sArrayUnderlinePosition.

bool ATE::IArrayUnderlinePosition::operator==

(

const IArrayUnderlinePosition &

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