ATE::IInhibitReflow Class Reference

A convenience class for temporarily inhibiting reflow in a text story. More...

#include <IText.h>

List of all members.

Public Member Functions
	IInhibitReflow ()
	Constructor.
	IInhibitReflow (const IStory &story)
	Constructor.
	IInhibitReflow (const IInhibitReflow &reflow)
	Copy constructor.
virtual	~IInhibitReflow ()
	Destructor.
IInhibitReflow &	operator= (const IInhibitReflow &rhs)
	Assignment operator.
Protected Attributes
IStory	fStory

---

Detailed Description

A convenience class for temporarily inhibiting reflow in a text story.

By default, as edits are made to the contents of a text story and its attributes, the story contents are reflowed through the story containers. This operation can be expensive. Use this class to inhibit reflow when batching together a series of edits to one or more text objects. Destroy the object when all the edits are complete, so that reflow is automatically resumed.

---

Constructor & Destructor Documentation

ATE::IInhibitReflow::IInhibitReflow

(

)

[inline]

Constructor.

Returns:

The new object.

ATE::IInhibitReflow::IInhibitReflow

(

const IStory &

story

)

[inline]

Constructor.

Creates a reflow inhibitor object for a story.

Parameters:

story

The story object.

Returns:

The new reflow inhibitor object.

References fStory, and ATE::IStory::SuspendReflow().

ATE::IInhibitReflow::IInhibitReflow

(

const IInhibitReflow &

reflow

)

[inline]

Copy constructor.

Parameters:

reflow

The object to copy.

Returns:

The new object.

References fStory, and ATE::IStory::SuspendReflow().

virtual ATE::IInhibitReflow::~IInhibitReflow

(

)

[inline, virtual]

Destructor.

References fStory, ATE::IStory::IsNull(), and ATE::IStory::ResumeReflow().

Referenced by operator=().

---

Member Function Documentation

IInhibitReflow& ATE::IInhibitReflow::operator=

(

const IInhibitReflow &

rhs

)

[inline]

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References fStory, ATE::IStory::IsNull(), ATE::IStory::SuspendReflow(), and ~IInhibitReflow().

---

Member Data Documentation

IStory ATE::IInhibitReflow::fStory [protected]

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

---

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

• IText.h