AITextFrameMESuite Struct Reference
[API Suite List]

This suite is used in conjunction with AITextFrameSuite. More...

#include <AITextFrame.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetDirection )(AIArtHandle textFrame, AITextDirection *dir)
	Retrieves the orientation of text in a text frame (left-to-right or right-to-left).
AIAPI AIErr(*	SetDirection )(AIArtHandle textFrame, AITextDirection dir)
	Sets the orientation of text in a text frame (left-to-right or right-to-left).
AIAPI AIErr(*	NewPointTextME )(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIRealPoint anchor, AIArtHandle *newTextFrame)
	Creates a new point text object at a given position in the paint order.
AIAPI AIErr(*	NewInPathTextME )(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)
	Creates a new in-path text object at a given position in the paint order.
AIAPI AIErr(*	NewOnPathTextME )(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIReal startT, AIReal endT, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)
	Creates a new on-path text object at a given position in the paint order, placing the text with a starting and ending path segment.
AIAPI AIErr(*	NewOnPathText2ME )(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIRealPoint anchor, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)
	Creates a new on-path text object at a given position in the paint order, placing the text with an anchor point.
AIAPI AIErr(*	FullReflow )(AIArtHandle newTextFrame)

---

Detailed Description

This suite is used in conjunction with AITextFrameSuite.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAITextFrameMESuite and kAITextFrameMEVersion.

---

Member Data Documentation

AIAPI AIErr(* AITextFrameMESuite::FullReflow)(AIArtHandle newTextFrame)

AIAPI AIErr(* AITextFrameMESuite::GetDirection)(AIArtHandle textFrame, AITextDirection *dir)

Retrieves the orientation of text in a text frame (left-to-right or right-to-left).

Parameters:

textFrame

The text freme object. dir [out] A buffer in which to return the text-direction constant.

AIAPI AIErr(* AITextFrameMESuite::NewInPathTextME)(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)

Creates a new in-path text object at a given position in the paint order.

Parameters:

	paintOrder	The paint order position, relative to the prep object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	orient	The text orientation value.
	path	The associated path object (an art object of type kPathArt).
	baseFrame	Optional. Another text frame with which to link the new text frame.
	append	When true, append the new frame to the base frame, when false, prepend it. Ignored if baseFrame is NULL.
	newTextFrame	[out] A buffer in which to return the new art object.

AIAPI AIErr(* AITextFrameMESuite::NewOnPathText2ME)(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIRealPoint anchor, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)

Creates a new on-path text object at a given position in the paint order, placing the text with an anchor point.

Parameters:

	paintOrder	The paint order position, relative to the prep object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	orient	The text orientation value.
	path	The associated path object (an art object of type kPathArt).
	anchor	The start point of the baseline of the first character.
	baseFrame	Optional. Another text frame with which to link the new text frame.
	append	When true, append the new frame to the base frame, when false, prepend it. Ignored if baseFrame is NULL.
	newTextFrame	[out] A buffer in which to return the new art object.

AIAPI AIErr(* AITextFrameMESuite::NewOnPathTextME)(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIArtHandle path, AIReal startT, AIReal endT, AIArtHandle baseFrame, AIBool8 append, AIArtHandle *newTextFrame)

Creates a new on-path text object at a given position in the paint order, placing the text with a starting and ending path segment.

Parameters:

	paintOrder	The paint order position, relative to the prep object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	orient	The text orientation value.
	path	The associated path object (an art object of type kPathArt).
	startT	The 0-based index of the segment of the path at which the text starts.
	endT	The 0-based index of the segment of the path at which the text ends. If less than the start value, defaults to the number of segments (the end of the path).
	baseFrame	Optional. Another text frame with which to link the new text frame.
	append	When true, append the new frame to the base frame, when false, prepend it. Ignored if baseFrame is NULL.
	newTextFrame	[out] A buffer in which to return the new art object.

AIAPI AIErr(* AITextFrameMESuite::NewPointTextME)(short paintOrder, AIArtHandle prep, AITextOrientation orient, AITextDirection dir, AIRealPoint anchor, AIArtHandle *newTextFrame)

Creates a new point text object at a given position in the paint order.

Parameters:

	paintOrder	The paint order position, relative to the prep object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	orient	The text orientation value.
	anchor	The start point of the baseline of the first character.
	newTextFrame	[out] A buffer in which to return the new art object.

AIAPI AIErr(* AITextFrameMESuite::SetDirection)(AIArtHandle textFrame, AITextDirection dir)

Sets the orientation of text in a text frame (left-to-right or right-to-left).

Parameters:

textFrame

The text freme object. dir The text-direction constant.

---

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

• AITextFrame.h