ATE::ITabStops Class Reference

Encapsulates a set if tab stops in a paragraph. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITabStops ()
	Constructor.
	ITabStops (const ITabStops &src)
	Copy constructor.
ITabStops &	operator= (const ITabStops &rhs)
	Assignment operator.
bool	operator== (const ITabStops &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITabStops &rhs) const
	Comparison operator tests for inequality.
	ITabStops (TabStopsRef tabstops)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITabStops ()
	Destructor.
TabStopsRef	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.
ITabStop	GetFirst () const
	Retrieves the first member of this set.
ITabStop	GetLast () const
	Retrieves the last member of this set.
void	ReplaceOrAdd (const ITabStop &pTabStop)
	Replaces or adds a tab stop to this set.
ITabStop	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
void	Remove (ATETextDOM::Int32 nIndex)
	Removes a member from the set.
void	RemoveAll ()
	Removes all members from the set.

---

Detailed Description

Encapsulates a set if tab stops in a paragraph.

You can create a new set of tab stops to apply to a paragraph, with IParaFeatures::SetTabStops(), or retrieve the existing tab stops with IParaFeatures::GetTabStops(). Tab stop sets are collected in an IArrayTabStops object, which you can retrieve from a set of paragraphs using IParaInspector::GetTabStops. Use an ITabStopsIterator object to iterate through each set in the array.

---

Constructor & Destructor Documentation

ATE::ITabStops::ITabStops

(

)

Constructor.

Creates an empty container.

Returns:

The new object.

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

ATE::ITabStops::ITabStops

(

const ITabStops &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTabStops.

ATE::ITabStops::ITabStops

(

TabStopsRef

tabstops

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

tabstops

The C object.

Returns:

The new C++ object.

ATE::ITabStops::~ITabStops

(

)

[virtual]

Destructor.

References ATE::sTabStops.

---

Member Function Documentation

ITabStop ATE::ITabStops::GetFirst

(

)

const

Retrieves the first member of this set.

Returns:

The member object.

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

ITabStop ATE::ITabStops::GetLast

(

)

const

Retrieves the last member of this set.

Returns:

The member object.

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

TabStopsRef ATE::ITabStops::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ITabStopsIterator::ITabStopsIterator(), and ATE::IParaFeatures::SetTabStops().

ATETextDOM::Int32 ATE::ITabStops::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::ITabStops::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTabStops.

ITabStop ATE::ITabStops::Item

(

ATETextDOM::Int32

nIndex

)

const

Retrieves a member of this set by position index.

Use with GetSize() to iterate through members.

Parameters:

nIndex

The 0-based position index.

Returns:

The member object.

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

bool ATE::ITabStops::operator!=

(

const ITabStops &

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.

ITabStops & ATE::ITabStops::operator=

(

const ITabStops &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTabStops.

bool ATE::ITabStops::operator==

(

const ITabStops &

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.

void ATE::ITabStops::Remove

(

ATETextDOM::Int32

nIndex

)

Removes a member from the set.

Parameters:

nIndex

The 0-based position index of the member to remove.

Returns:

Nothing.

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

void ATE::ITabStops::RemoveAll

(

)

Removes all members from the set.

Returns:

Nothing.

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

void ATE::ITabStops::ReplaceOrAdd

(

const ITabStop &

pTabStop

)

Replaces or adds a tab stop to this set.

Parameters:

pTabStop

The replacement or new tab stop object.

Returns:

Nothing.

References ATE::ITabStop::GetRef(), ATE::sTabStops, and ATE::Throw_ATE_Exception().

---

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

• IText.h
• IText.cpp