ATE::ITabStop Class Reference

Encapsulates a tab stop in a paragraph. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITabStop ()
	Constructor.
	ITabStop (const ITabStop &src)
	Copy constructor.
ITabStop &	operator= (const ITabStop &rhs)
	Assignment operator.
bool	operator== (const ITabStop &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITabStop &rhs) const
	Comparison operator tests for inequality.
	ITabStop (TabStopRef tabstop)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITabStop ()
	Destructor.
TabStopRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
TabType	GetTabType () const
	Retrieves the type of this tab stop (right or left).
void	SetTabType (TabType tabType)
	Sets the type of this tab stop (right or left).
ATETextDOM::Real	GetPosition () const
	Retrieves the position of this tab stop.
void	SetPosition (ATETextDOM::Real position)
	Sets the position of this tab stop.
bool	HasLeader () const
	Reports whether this tab stop uses a leader.
void	GetLeader (ATETextDOM::Unicode *leader, ATETextDOM::Int32 maxLength) const
	Retrieves the leader string for this tab stop.
void	SetLeader (ATETextDOM::Unicode *leader)
	Sets the leader string for this tab stop.
ATETextDOM::Unicode	GetDecimalCharacter () const
	Retrieves the decimal character for this tab stop.
void	SetDecimalCharacter (ATETextDOM::Unicode decimalChar)
	Sets the decimal character for this tab stop.

---

Detailed Description

Encapsulates a tab stop in a paragraph.

Tab stops are collected in an ITabStops object, which you can retrieve from a paragraph using IParaFeatures::GetTabStops. Use an ITabStopsIterator object to iterate through the collection.

---

Constructor & Destructor Documentation

ATE::ITabStop::ITabStop

(

)

Constructor.

Returns:

The new object.

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

ATE::ITabStop::ITabStop

(

const ITabStop &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTabStop.

ATE::ITabStop::ITabStop

(

TabStopRef

tabstop

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

tabstop

The C object.

Returns:

The new C++ object.

ATE::ITabStop::~ITabStop

(

)

[virtual]

Destructor.

References ATE::sTabStop.

---

Member Function Documentation

ATETextDOM::Unicode ATE::ITabStop::GetDecimalCharacter

(

)

const

Retrieves the decimal character for this tab stop.

Returns:

A string containing the character.

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

void ATE::ITabStop::GetLeader	(	ATETextDOM::Unicode *	leader,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the leader string for this tab stop.

Parameters:

	leader	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer.

Returns:

Nothing.

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

ATETextDOM::Real ATE::ITabStop::GetPosition

(

)

const

Retrieves the position of this tab stop.

Returns:

The tab position in document points.

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

TabStopRef ATE::ITabStop::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ITabStops::ReplaceOrAdd().

TabType ATE::ITabStop::GetTabType

(

)

const

Retrieves the type of this tab stop (right or left).

Returns:

The tab type constant.

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

bool ATE::ITabStop::HasLeader

(

)

const

Reports whether this tab stop uses a leader.

Returns:

True if the tab uses a leader.

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

bool ATE::ITabStop::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTabStop.

bool ATE::ITabStop::operator!=

(

const ITabStop &

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.

ITabStop & ATE::ITabStop::operator=

(

const ITabStop &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTabStop.

bool ATE::ITabStop::operator==

(

const ITabStop &

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::ITabStop::SetDecimalCharacter

(

ATETextDOM::Unicode

decimalChar

)

Sets the decimal character for this tab stop.

Parameters:

decimalChar

A string containing the character.

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

void ATE::ITabStop::SetLeader

(

ATETextDOM::Unicode *

leader

)

Sets the leader string for this tab stop.

Parameters:

leader

The string.

Returns:

Nothing.

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

void ATE::ITabStop::SetPosition

(

ATETextDOM::Real

position

)

Sets the position of this tab stop.

Parameters:

position

The tab position in document points.

Returns:

Nothing.

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

void ATE::ITabStop::SetTabType

(

TabType

tabType

)

Sets the type of this tab stop (right or left).

Parameters:

tabType

The tab type constant.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp