ATE::IParaStyles Class Reference

Encapsulates a set of paragraph styles as a text resource. More...

#include <IText.h>

List of all members.

Public Member Functions
	IParaStyles ()
	Constructor.
	IParaStyles (const IParaStyles &src)
	Copy constructor.
IParaStyles &	operator= (const IParaStyles &rhs)
	Assignment operator.
bool	operator== (const IParaStyles &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IParaStyles &rhs) const
	Comparison operator tests for inequality.
	IParaStyles (ParaStylesRef parastyles)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IParaStyles ()
	Destructor.
ParaStylesRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
bool	IsEmpty () const
	Reports whether the set is empty.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of members of this set.
void	ShowAllStyles () const
	Shows all styles.
void	ShowOnlyUnreferencedStyles () const
	Shows only styles to which there are not references in text.
void	ShowOnlyStylesReferencedIn (ITextRange pRange) const
	Shows only styles that are used in a text range.
void	MoveStyleTo (IParaStyle pStyle, ATETextDOM::Int32 position)
	Reorders styles in this set by moving a style to a given position.

---

Detailed Description

Encapsulates a set of paragraph styles as a text resource.

A style set contains a collection of IParaStyle objects. Use an IParaStylesIterator object to iterate through the set.

---

Constructor & Destructor Documentation

ATE::IParaStyles::IParaStyles

(

)

Constructor.

Returns:

The new object.

ATE::IParaStyles::IParaStyles

(

const IParaStyles &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sParaStyles.

ATE::IParaStyles::IParaStyles

(

ParaStylesRef

parastyles

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

parastyles

The C object.

Returns:

The new C++ object.

ATE::IParaStyles::~IParaStyles

(

)

[virtual]

Destructor.

References ATE::sParaStyles.

---

Member Function Documentation

ParaStylesRef ATE::IParaStyles::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IParaStylesIterator::IParaStylesIterator().

ATETextDOM::Int32 ATE::IParaStyles::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::IParaStyles::IsEmpty

(

)

const

Reports whether the set is empty.

Returns:

True if the set is empty.

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

bool ATE::IParaStyles::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sParaStyles.

void ATE::IParaStyles::MoveStyleTo	(	IParaStyle	pStyle,
		ATETextDOM::Int32	position
	)

Reorders styles in this set by moving a style to a given position.

Parameters:

	pStyle	The style object.
	position	The new 0-based position index.

Returns:

Nothing.

References ATE::IParaStyle::GetRef(), ATE::sParaStyles, and ATE::Throw_ATE_Exception().

bool ATE::IParaStyles::operator!=

(

const IParaStyles &

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.

IParaStyles & ATE::IParaStyles::operator=

(

const IParaStyles &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sParaStyles.

bool ATE::IParaStyles::operator==

(

const IParaStyles &

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::IParaStyles::ShowAllStyles

(

)

const

Shows all styles.

Returns:

Nothing.

See also:

ShowOnlyUnreferencedStyles(), ShowOnlyStylesReferencedIn()

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

void ATE::IParaStyles::ShowOnlyStylesReferencedIn

(

ITextRange

pRange

)

const

Shows only styles that are used in a text range.

Parameters:

pRange

The text range object.

Returns:

Nothing.

See also:

ShowAllStyles(), ShowOnlyUnreferencedStyles()

References ATE::ITextRange::GetRef(), ATE::sParaStyles, and ATE::Throw_ATE_Exception().

void ATE::IParaStyles::ShowOnlyUnreferencedStyles

(

)

const

Shows only styles to which there are not references in text.

Returns:

Nothing.

See also:

ShowAllStyles(), ShowOnlyStylesReferencedIn()

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

---

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

• IText.h
• IText.cpp