ATE::IStory Class Reference

This class represents a text flow. More...

#include <IText.h>

List of all members.

Public Member Functions
	IStory ()
	Constructor.
	IStory (const IStory &src)
	Copy constructor.
IStory &	operator= (const IStory &rhs)
	Assignment operator.
bool	operator== (const IStory &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IStory &rhs) const
	Comparison operator tests for inequality.
	IStory (StoryRef story)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IStory ()
	Destructor.
StoryRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetIndex () const
	Retrieves the index position of this story in its IStories collection.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of characters in this story.
IStories	GetStories () const
	navigation objects.
ITextRange	GetTextRange () const
	Retrieves the text range that contains the entire text of this story.
ITextRanges	GetTextSelection () const
	Retrieves the set of text ranges that contains the selected text of this story.
IParagraphsIterator	GetParagraphsIterator () const
	Creates an iterator object for the set of paragraphs in this story.
IWordsIterator	GetWordsIterator () const
	Creates an iterator object for the set of words in this story.
ITextRunsIterator	GetTextRunsIterator () const
	Creates an iterator object for the set of text runs in this story.
ITextFramesIterator	GetTextFramesIterator () const
	Creates an iterator object for the set of text frames in this story.
ITextFrame	GetFrame (ATETextDOM::Int32 frameIndex) const
	Retrieves a text frame from this story.
void	SetKernForSelection (const ITextRange &textRange, AutoKernType autoKernType)
	Kerning management for auto or optical kerns.
void	SetKernAtChar (ATETextDOM::Int32 charIndex, ATETextDOM::Int32 value)
	for manual kerns
void	GetKern (const ITextRange &textRange, AutoKernType *pAutoKernType, ATETextDOM::Int32 *value) const
	Retrieves the kerning type and value for a text range in this story.
AutoKernType	GetModelKernAtChar (ATETextDOM::Int32 charIndex, ATETextDOM::Int32 *pManualKernValue) const
	Retrieves the kerning type and value for a character in this story.
ITextRange	GetTextRange (ATETextDOM::Int32 start, ATETextDOM::Int32 end) const
	Retrieves an arbitrary text range from this story.
IStory	Duplicate ()
	Creates a new story that is a copy of this one.
void	SuspendReflow ()
	Suspends reflow calculation for this story.
void	ResumeReflow ()
	Resumes normal reflow calculation after a call to SuspendReflow().

---

Detailed Description

This class represents a text flow.

A story contains paragraphs, words, text runs, and text frames. You can get a text range for any arbitrary subset of the text, or for the selected text.

<<need some discussion of how this is organized, why you access text at different levels>>

Kerning is managed at the story level.

A set of stories is collected in an IStories object.

---

Constructor & Destructor Documentation

ATE::IStory::IStory

(

)

Constructor.

Returns:

The new object.

Referenced by Duplicate().

ATE::IStory::IStory

(

const IStory &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sStory.

ATE::IStory::IStory

(

StoryRef

story

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

story

The C object.

Returns:

The new C++ object.

ATE::IStory::~IStory

(

)

[virtual]

Destructor.

References ATE::sStory.

---

Member Function Documentation

IStory ATE::IStory::Duplicate

(

)

Creates a new story that is a copy of this one.

Returns:

The story object.

References IStory(), ATE::sStory, and ATE::Throw_ATE_Exception().

ITextFrame ATE::IStory::GetFrame

(

ATETextDOM::Int32

frameIndex

)

const

Retrieves a text frame from this story.

Parameters:

frameIndex

The 0-based position index.

Returns:

The text frame object.

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

ATETextDOM::Int32 ATE::IStory::GetIndex

(

)

const

Retrieves the index position of this story in its IStories collection.

Returns:

The 0-based index.

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

void ATE::IStory::GetKern	(	const ITextRange &	textRange,
		AutoKernType *	pAutoKernType,
		ATETextDOM::Int32 *	value
	)			const

Retrieves the kerning type and value for a text range in this story.

Parameters:

	textRange	The text range object.
	pAutoKernType	[out] A buffer in which to return the kerning type constant.
	value	[out] A buffer in which to return the kerning value.

Returns:

Nothing.

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

AutoKernType ATE::IStory::GetModelKernAtChar	(	ATETextDOM::Int32	charIndex,
		ATETextDOM::Int32 *	pManualKernValue
	)			const

Retrieves the kerning type and value for a character in this story.

Parameters:

	charIndex	The 0-based position index of the character.
	pManualKernValue	[out] A buffer in which to return the kerning value.

Returns:

The kerning type constant that applies to this character.

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

IParagraphsIterator ATE::IStory::GetParagraphsIterator

(

)

const

Creates an iterator object for the set of paragraphs in this story.

Returns:

The paragraph iterator object.

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

StoryRef ATE::IStory::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IStories::SetFocus(), and ATE::ITextRange::SetStory().

ATETextDOM::Int32 ATE::IStory::GetSize

(

)

const

Retrieves the number of characters in this story.

Returns:

The number of characters.

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

IStories ATE::IStory::GetStories

(

)

const

navigation objects.

Retrieves the story collection that contains this story.

Returns:

The story collection object.

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

ITextFramesIterator ATE::IStory::GetTextFramesIterator

(

)

const

Creates an iterator object for the set of text frames in this story.

Returns:

The text frame iterator object.

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

ITextRange ATE::IStory::GetTextRange	(	ATETextDOM::Int32	start,
		ATETextDOM::Int32	end
	)			const

Retrieves an arbitrary text range from this story.

Parameters:

	start	The 0-based position index of the first character in the range. If negative, 0 is used.
	end	The 0-based position index of the last character in the range. If greater than the size of the story, the last character of the story is used.

Returns:

The text range object.

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

ITextRange ATE::IStory::GetTextRange

(

)

const

Retrieves the text range that contains the entire text of this story.

Returns:

The text range object.

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

ITextRunsIterator ATE::IStory::GetTextRunsIterator

(

)

const

Creates an iterator object for the set of text runs in this story.

Returns:

The text run iterator object.

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

ITextRanges ATE::IStory::GetTextSelection

(

)

const

Retrieves the set of text ranges that contains the selected text of this story.

Returns:

The text range set object.

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

IWordsIterator ATE::IStory::GetWordsIterator

(

)

const

Creates an iterator object for the set of words in this story.

Returns:

The word iterator object.

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

bool ATE::IStory::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sStory.

Referenced by ATE::IInhibitReflow::operator=(), and ATE::IInhibitReflow::~IInhibitReflow().

bool ATE::IStory::operator!=

(

const IStory &

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.

IStory & ATE::IStory::operator=

(

const IStory &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sStory.

bool ATE::IStory::operator==

(

const IStory &

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.

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

void ATE::IStory::ResumeReflow

(

)

Resumes normal reflow calculation after a call to SuspendReflow().

Returns:

Nothing.

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

Referenced by ATE::IInhibitReflow::~IInhibitReflow().

void ATE::IStory::SetKernAtChar	(	ATETextDOM::Int32	charIndex,
		ATETextDOM::Int32	value
	)

for manual kerns

Sets a specific kern value in this story.

Parameters:

	charIndex	The 0-based position index of the character to kern.
	value	The kerning value.

Returns:

Nothing.

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

void ATE::IStory::SetKernForSelection	(	const ITextRange &	textRange,
		AutoKernType	autoKernType
	)

Kerning management for auto or optical kerns.

Sets automatic or optical kerning for a text range in this story.

Parameters:

	textRange	The text range.
	autoKernType	The kerning type constant.

Returns:

Nothing.

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

void ATE::IStory::SuspendReflow

(

)

Suspends reflow calculation for this story.

Speeds up calls that cause reflow, such as ITextRange insertion methods. Use ResumeReflow() to restore normal reflow calculation.

Returns:

Nothing.

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

Referenced by ATE::IInhibitReflow::IInhibitReflow(), and ATE::IInhibitReflow::operator=().

---

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

• IText.h
• IText.cpp