ATE::ICharStyles Class Reference

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

#include <IText.h>

List of all members.

Public Member Functions
	ICharStyles ()
	Constructor.
	ICharStyles (const ICharStyles &src)
	Copy constructor.
ICharStyles &	operator= (const ICharStyles &rhs)
	Assignment operator.
bool	operator== (const ICharStyles &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICharStyles &rhs) const
	Comparison operator tests for inequality.
	ICharStyles (CharStylesRef charstyles)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICharStyles ()
	Destructor.
CharStylesRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
bool	IsEmpty () const
	Reports whether this is 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 (ICharStyle pStyle, ATETextDOM::Int32 position)
	Reorders styles in this set by moving a style to a given position.

---

Detailed Description

Encapsulates a set of character styles as a text resource.

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

---

Constructor & Destructor Documentation

ATE::ICharStyles::ICharStyles

(

)

Constructor.

Returns:

The new object.

ATE::ICharStyles::ICharStyles

(

const ICharStyles &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCharStyles.

ATE::ICharStyles::ICharStyles

(

CharStylesRef

charstyles

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

charstyles

The C object.

Returns:

The new C++ object.

ATE::ICharStyles::~ICharStyles

(

)

[virtual]

Destructor.

References ATE::sCharStyles.

---

Member Function Documentation

CharStylesRef ATE::ICharStyles::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::ICharStylesIterator::ICharStylesIterator().

ATETextDOM::Int32 ATE::ICharStyles::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::ICharStyles::IsEmpty

(

)

const

Reports whether this is set is empty.

Returns:

True if this set contains no style objects.

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

bool ATE::ICharStyles::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCharStyles.

void ATE::ICharStyles::MoveStyleTo	(	ICharStyle	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::ICharStyle::GetRef(), ATE::sCharStyles, and ATE::Throw_ATE_Exception().

bool ATE::ICharStyles::operator!=

(

const ICharStyles &

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.

ICharStyles & ATE::ICharStyles::operator=

(

const ICharStyles &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCharStyles.

bool ATE::ICharStyles::operator==

(

const ICharStyles &

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

(

)

const

Shows all styles.

Returns:

Nothing.

See also:

ShowOnlyUnreferencedStyles(), ShowOnlyStylesReferencedIn()

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

void ATE::ICharStyles::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::sCharStyles, and ATE::Throw_ATE_Exception().

void ATE::ICharStyles::ShowOnlyUnreferencedStyles

(

)

const

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

Returns:

Nothing.

See also:

ShowAllStyles(), ShowOnlyStylesReferencedIn()

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

---

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

• IText.h
• IText.cpp