ATE::ITextFrame Class Reference

This class encapsulates a text frame, which manages the layout of a text range into rows and columns. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITextFrame ()
	Constructor.
	ITextFrame (const ITextFrame &src)
	Copy constructor.
ITextFrame &	operator= (const ITextFrame &rhs)
	Assignment operator.
bool	operator== (const ITextFrame &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITextFrame &rhs) const
	Comparison operator tests for inequality.
	ITextFrame (TextFrameRef textframe)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITextFrame ()
	Destructor.
TextFrameRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
IStory	GetStory () const
	Retrieves the parent story of this text frame.
ITextRange	GetTextRange (bool bIncludeOverflow=true) const
	Retrieves the text range of this frame.
ITextLinesIterator	GetTextLinesIterator () const
	Retrieves a text-line iterator with which you can access the text lines of this text frame.
FrameType	GetType () const
	Retrieves the type of this text frame.
LineOrientation	GetLineOrientation () const
	Retrieves the line orientation of this text frame.
bool	GetSelected () const
	Reports whether this frame is selected.
ATETextDOM::RealMatrix	GetMatrix () const
	Retrieves the transformation matrix of this text frame.
ATETextDOM::Int32	GetRowCount () const
	Retrieves the number of rows for this text frame.
ATETextDOM::Int32	GetColumnCount () const
	Retrieves the number of columns for this text frame.
bool	GetRowMajorOrder () const
	Reports whether the text range is arranged in row-major order.
ATETextDOM::Real	GetRowGutter () const
	Retrieves the row gutter value for this text frame.
ATETextDOM::Real	GetColumnGutter () const
	Retrieves the column gutter value for this text frame.
ATETextDOM::Real	GetSpacing () const
	Retrieves the line spacing value for this text frame.
bool	GetOpticalAlignment () const
	Reports whether optical alignment is on for this text frame.
ParagraphDirection	GetStoryDirection () const
	Retrieves the paragraph direction for this text frame.
void	SetRowCount (ATETextDOM::Int32 rowCount)
	Sets the number of rows for this text frame.
void	SetColumnCount (ATETextDOM::Int32 columnCount)
	Sets the number of columns for this text frame.
void	SetRowMajorOrder (bool isRowMajor)
	Turns row-major order on or off for this text frame.
void	SetRowGutter (ATETextDOM::Real gutter)
	Sets the row gutter value for this text frame.
void	SetColumnGutter (ATETextDOM::Real gutter)
	Sets the column gutter value for this text frame.
void	SetSpacing (ATETextDOM::Real spacing)
	Sets the line spacing value for this text frame.
void	SetOpticalAlignment (bool isActive)
	Turns optical alignment on or off for this text frame.
void	SetLineOrientation (LineOrientation lineOrientation)
	Sets the line orientation value for this text frame.
void	SetStoryDirection (ParagraphDirection direction)
	Sets the paragragh direction for this text frame.

---

Detailed Description

This class encapsulates a text frame, which manages the layout of a text range into rows and columns.

The methods allow you to add, access, and manipulate text frames for use with the Adobe Text Engine (ATE). The frame is associated with an ITextRange, and contains ITextLine objects representing rows of text, which you can access through an ITextLinesIterator. A text frame can be part of an IStory.

---

Constructor & Destructor Documentation

ATE::ITextFrame::ITextFrame

(

)

Constructor.

Returns:

The new object.

ATE::ITextFrame::ITextFrame

(

const ITextFrame &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sTextFrame.

ATE::ITextFrame::ITextFrame

(

TextFrameRef

textframe

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

textframe

The C object.

Returns:

The new C++ object.

ATE::ITextFrame::~ITextFrame

(

)

[virtual]

Destructor.

References ATE::sTextFrame.

---

Member Function Documentation

ATETextDOM::Int32 ATE::ITextFrame::GetColumnCount

(

)

const

Retrieves the number of columns for this text frame.

Returns:

The number of columns.

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

ATETextDOM::Real ATE::ITextFrame::GetColumnGutter

(

)

const

Retrieves the column gutter value for this text frame.

Returns:

The column gutter value, in document points.

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

LineOrientation ATE::ITextFrame::GetLineOrientation

(

)

const

Retrieves the line orientation of this text frame.

Returns:

The line orientation constant.

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

ATETextDOM::RealMatrix ATE::ITextFrame::GetMatrix

(

)

const

Retrieves the transformation matrix of this text frame.

Returns:

The transformation matrix.

References ATE::ATEFloatMatrixToATERealMatrix(), ATE::sTextFrame, and ATE::Throw_ATE_Exception().

bool ATE::ITextFrame::GetOpticalAlignment

(

)

const

Reports whether optical alignment is on for this text frame.

Returns:

True if optical alignment is on.

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

TextFrameRef ATE::ITextFrame::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::ITextFrame::GetRowCount

(

)

const

Retrieves the number of rows for this text frame.

Returns:

The number of rows.

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

ATETextDOM::Real ATE::ITextFrame::GetRowGutter

(

)

const

Retrieves the row gutter value for this text frame.

Returns:

The row gutter value, in document points.

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

bool ATE::ITextFrame::GetRowMajorOrder

(

)

const

Reports whether the text range is arranged in row-major order.

Returns:

True if the text frame is in row-major order.

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

bool ATE::ITextFrame::GetSelected

(

)

const

Reports whether this frame is selected.

Use the AIArtSuite to set the selection.

Returns:

True if the text frame is selected.

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

ATETextDOM::Real ATE::ITextFrame::GetSpacing

(

)

const

Retrieves the line spacing value for this text frame.

Returns:

The line spacing value, in document points.

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

IStory ATE::ITextFrame::GetStory

(

)

const

Retrieves the parent story of this text frame.

Returns:

The story object.

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

ParagraphDirection ATE::ITextFrame::GetStoryDirection

(

)

const

Retrieves the paragraph direction for this text frame.

Returns:

The paragraph direction object.

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

ITextLinesIterator ATE::ITextFrame::GetTextLinesIterator

(

)

const

Retrieves a text-line iterator with which you can access the text lines of this text frame.

Returns:

The text-line iterator object.

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

ITextRange ATE::ITextFrame::GetTextRange

(

bool

bIncludeOverflow = true

)

const

Retrieves the text range of this frame.

Parameters:

bIncludeOverflow

Optional. When true (the default), if the frame is the last one in its story, the range includes any overflow text. When false, overflow text is not included.

Returns:

The text range object.

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

FrameType ATE::ITextFrame::GetType

(

)

const

Retrieves the type of this text frame.

Returns:

The type constant.

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

bool ATE::ITextFrame::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sTextFrame.

bool ATE::ITextFrame::operator!=

(

const ITextFrame &

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.

ITextFrame & ATE::ITextFrame::operator=

(

const ITextFrame &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sTextFrame.

bool ATE::ITextFrame::operator==

(

const ITextFrame &

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

void ATE::ITextFrame::SetColumnCount

(

ATETextDOM::Int32

columnCount

)

Sets the number of columns for this text frame.

Parameters:

columnCount

The number of columns.

Returns:

Nothing.

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

void ATE::ITextFrame::SetColumnGutter

(

ATETextDOM::Real

gutter

)

Sets the column gutter value for this text frame.

Parameters:

gutter

The new column-gutter value in document points.

Returns:

Nothing.

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

void ATE::ITextFrame::SetLineOrientation

(

LineOrientation

lineOrientation

)

Sets the line orientation value for this text frame.

Parameters:

lineOrientation

The new line orientation constant.

Returns:

Nothing.

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

void ATE::ITextFrame::SetOpticalAlignment

(

bool

isActive

)

Turns optical alignment on or off for this text frame.

Parameters:

isActive

True to turn optical alignment on, false to turn it off.

Returns:

Nothing.

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

void ATE::ITextFrame::SetRowCount

(

ATETextDOM::Int32

rowCount

)

Sets the number of rows for this text frame.

Parameters:

rowCount

The number of rows.

Returns:

Nothing.

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

void ATE::ITextFrame::SetRowGutter

(

ATETextDOM::Real

gutter

)

Sets the row gutter value for this text frame.

Parameters:

gutter

The new row-gutter value in document points.

Returns:

Nothing.

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

void ATE::ITextFrame::SetRowMajorOrder

(

bool

isRowMajor

)

Turns row-major order on or off for this text frame.

Parameters:

isRowMajor

True to turn row-major order on, false to turn it off.

Returns:

Nothing.

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

void ATE::ITextFrame::SetSpacing

(

ATETextDOM::Real

spacing

)

Sets the line spacing value for this text frame.

Parameters:

spacing

The new line spacing value in document points.

Returns:

Nothing.

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

void ATE::ITextFrame::SetStoryDirection

(

ParagraphDirection

direction

)

Sets the paragragh direction for this text frame.

Parameters:

direction

The paragraph direction.

Returns:

Nothing.

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

---

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

• IText.h
• IText.cpp