ATE::IParagraph Class Reference

This class encapsulates a paragraph of text, to which a paragraph style (IParaStyle) can be applied. More...

#include <IText.h>

List of all members.

Public Member Functions
	IParagraph ()
	Constructor.
	IParagraph (const IParagraph &src)
	Copy constructor.
IParagraph &	operator= (const IParagraph &rhs)
	Assignment operator.
bool	operator== (const IParagraph &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IParagraph &rhs) const
	Comparison operator tests for inequality.
	IParagraph (ParagraphRef paragraph)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IParagraph ()
	Destructor.
ParagraphRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetLength ()
	Retrieves the length of this paragraph.
IStory	GetStory ()
	Retrieves the story that contains this paragraph.
ITextRange	GetTextRange ()
	Retrieves the text range corresponding to this paragraph.
ITextRanges	GetTextRanges ()
	Retrieves the set of text ranges corresponding to this paragraph.
ITextRanges	GetTextSelection ()
	Retrieves the text selection in this paragraph.
IWordsIterator	GetWordsIterator ()
	Creates an iteration object with which to access the words in this paragraph.
IParagraph	GetNext ()
	Retrieves the paragraph after this one in the containing story.
IParagraph	GetPrev ()
	Retrieves the paragraph before this one in the containing story.
ATETextDOM::ATETextDomErr	GetContents (ATETextDOM::Unicode *text, ATETextDOM::Int32 maxLength)
	Retrieves the text contents of this paragraph as a Unicode string.
ATETextDOM::ATETextDomErr	GetContents (char *text, ATETextDOM::Int32 maxLength)
	Retrieves the text contents of this paragraph as a C string.

---

Detailed Description

This class encapsulates a paragraph of text, to which a paragraph style (IParaStyle) can be applied.

Paragraphs are contained in stories. Use an IParagraphsIterator object to iterate through paragraphs in a set of stories.

Use an IParaInspector object to retrieve the paragraph features that apply to a specific paragraph, after considering all inherited style values and local overrides.

---

Constructor & Destructor Documentation

ATE::IParagraph::IParagraph

(

)

Constructor.

Returns:

The new object.

Referenced by GetNext(), and GetPrev().

ATE::IParagraph::IParagraph

(

const IParagraph &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sParagraph.

ATE::IParagraph::IParagraph

(

ParagraphRef

paragraph

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

paragraph

The C object.

Returns:

The new C++ object.

ATE::IParagraph::~IParagraph

(

)

[virtual]

Destructor.

References ATE::sParagraph.

---

Member Function Documentation

ATETextDOM::ATETextDomErr ATE::IParagraph::GetContents	(	char *	text,
		ATETextDOM::Int32	maxLength
	)

Retrieves the text contents of this paragraph as a C string.

Parameters:

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

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

ATETextDOM::ATETextDomErr ATE::IParagraph::GetContents	(	ATETextDOM::Unicode *	text,
		ATETextDOM::Int32	maxLength
	)

Retrieves the text contents of this paragraph as a Unicode string.

Parameters:

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

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

ATETextDOM::Int32 ATE::IParagraph::GetLength

(

)

Retrieves the length of this paragraph.

Returns:

The number of characters in this paragraph.

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

IParagraph ATE::IParagraph::GetNext

(

)

Retrieves the paragraph after this one in the containing story.

Returns:

The paragraph object.

References IParagraph(), ATE::sParagraph, and ATE::Throw_ATE_Exception().

IParagraph ATE::IParagraph::GetPrev

(

)

Retrieves the paragraph before this one in the containing story.

Returns:

The paragraph object.

References IParagraph(), ATE::sParagraph, and ATE::Throw_ATE_Exception().

ParagraphRef ATE::IParagraph::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

IStory ATE::IParagraph::GetStory

(

)

Retrieves the story that contains this paragraph.

Returns:

The story object.

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

ITextRange ATE::IParagraph::GetTextRange

(

)

Retrieves the text range corresponding to this paragraph.

Returns:

The text range object.

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

ITextRanges ATE::IParagraph::GetTextRanges

(

)

Retrieves the set of text ranges corresponding to this paragraph.

Returns:

The text ranges object.

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

ITextRanges ATE::IParagraph::GetTextSelection

(

)

Retrieves the text selection in this paragraph.

Returns:

The text range set object.

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

IWordsIterator ATE::IParagraph::GetWordsIterator

(

)

Creates an iteration object with which to access the words in this paragraph.

Returns:

The word iterator object.

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

bool ATE::IParagraph::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sParagraph.

bool ATE::IParagraph::operator!=

(

const IParagraph &

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.

IParagraph & ATE::IParagraph::operator=

(

const IParagraph &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sParagraph.

bool ATE::IParagraph::operator==

(

const IParagraph &

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