ATE::IStories Class Reference

Encapsulates a set of stories. More...

#include <IText.h>

List of all members.

Public Member Functions
	IStories ()
	Constructor.
	IStories (const IStories &src)
	Copy constructor.
IStories &	operator= (const IStories &rhs)
	Assignment operator.
bool	operator== (const IStories &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IStories &rhs) const
	Comparison operator tests for inequality.
	IStories (StoriesRef stories)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IStories ()
	Destructor.
StoriesRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of members of this set.
IStory	GetFirst ()
	Retrieves the first member of this set.
IStory	GetLast ()
	Retrieves the last member of this set.
bool	HasFocus () const
	Reports whether a member story has the input focus.
IStory	GetFocus () const
	Retrieves the member story that has input focus.
void	SetFocus (const IStory &story)
	Sets the input focus to a member story, deselecting everything in the document.
void	LoseFocus ()
	Removes input focus from the story currently being edited, deselecting everything in the document.
ITextRanges	GetTextRanges () const
	Retrieves the set of text ranges in these stories.
ITextRanges	GetTextSelection () const
	Retrieves the set of text ranges for selected text in these stories.
IParagraphsIterator	GetParagraphsIterator () const
	Creates an iterator object for the set of paragraphs in these stories.
IWordsIterator	GetWordsIterator () const
	Creates an iterator object for the set of words in these stories.
ITextRunsIterator	GetTextRunsIterator () const
	Creates an iterator object for the set of text runs in these stories.
IDocumentTextResources	GetDocumentTextResources () const
	Retrieves the document text resources for these stories.
IStory	Item (ATETextDOM::Int32 nIndex) const
	Retrieves a member of this set by position index.
void	SuspendReflow ()
	Suspends reflow calculation for these stories.
void	ResumeReflow ()
	Resumes normal reflow calculation after a call to SuspendReflow().

---

Detailed Description

Encapsulates a set of stories.

Contains a collection of IStory objects. Use to access the text and input focus of the member stories, and to temporarily suspend reflow calculations for efficiency when altering the text.

---

Constructor & Destructor Documentation

ATE::IStories::IStories

(

)

Constructor.

Returns:

The new object.

ATE::IStories::IStories

(

const IStories &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sStories.

ATE::IStories::IStories

(

StoriesRef

stories

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

stories

The C object.

Returns:

The new C++ object.

ATE::IStories::~IStories

(

)

[virtual]

Destructor.

References ATE::sStories.

---

Member Function Documentation

IDocumentTextResources ATE::IStories::GetDocumentTextResources

(

)

const

Retrieves the document text resources for these stories.

Returns:

The document text resources object.

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

IStory ATE::IStories::GetFirst

(

)

Retrieves the first member of this set.

Returns:

The member object.

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

IStory ATE::IStories::GetFocus

(

)

const

Retrieves the member story that has input focus.

Returns:

The story currently being edited, or a NULL oject if no text is being edited.

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

IStory ATE::IStories::GetLast

(

)

Retrieves the last member of this set.

Returns:

The member object.

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

IParagraphsIterator ATE::IStories::GetParagraphsIterator

(

)

const

Creates an iterator object for the set of paragraphs in these stories.

Returns:

The paragraph iterator object.

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

StoriesRef ATE::IStories::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IStories::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

ITextRanges ATE::IStories::GetTextRanges

(

)

const

Retrieves the set of text ranges in these stories.

Returns:

The text range set object.

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

ITextRunsIterator ATE::IStories::GetTextRunsIterator

(

)

const

Creates an iterator object for the set of text runs in these stories.

Returns:

The text run iterator object.

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

ITextRanges ATE::IStories::GetTextSelection

(

)

const

Retrieves the set of text ranges for selected text in these stories.

Returns:

The text range set object.

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

IWordsIterator ATE::IStories::GetWordsIterator

(

)

const

Creates an iterator object for the set of words in these stories.

Returns:

The word iterator object.

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

bool ATE::IStories::HasFocus

(

)

const

Reports whether a member story has the input focus.

Returns:

True if a story in this collection is currently being edited.

Note:

Only one story can have the focus. It can lose focus if the user selects text outside it, or clicks outside the text of the story.

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

bool ATE::IStories::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sStories.

IStory ATE::IStories::Item

(

ATETextDOM::Int32

nIndex

)

const

Retrieves a member of this set by position index.

Use with GetSize() to iterate through members.

Parameters:

nIndex

The 0-based position index.

Returns:

The member object.

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

void ATE::IStories::LoseFocus

(

)

Removes input focus from the story currently being edited, deselecting everything in the document.

Returns:

Nothing.

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

bool ATE::IStories::operator!=

(

const IStories &

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.

IStories & ATE::IStories::operator=

(

const IStories &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sStories.

bool ATE::IStories::operator==

(

const IStories &

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::IStories::ResumeReflow

(

)

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

Returns:

Nothing.

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

void ATE::IStories::SetFocus

(

const IStory &

story

)

Sets the input focus to a member story, deselecting everything in the document.

Parameters:

story

The story object.

Returns:

Nothing.

References ATE::IStory::GetRef(), ATE::sStories, and ATE::Throw_ATE_Exception().

void ATE::IStories::SuspendReflow

(

)

Suspends reflow calculation for these stories.

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

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp