AITextFrame.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIFont.h"
#include "AIHitTest.h"
#include "ATESuites.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AITextFrameSuite
	This suite provides functions that manage art objects of type kTextFrameArt. More...
struct	AITextFrameMESuite
	This suite is used in conjunction with AITextFrameSuite. More...
struct	AITextFrameHitSuite
	This suite is used in conjunction with AIHitTestSuite and AITextFrameSuite. More...
Defines
#define	kAITextFrameSuite   "AI Text Frame Suite"
#define	kAITextFrameSuiteVersion4   AIAPI_VERSION(4)
#define	kAITextFrameSuiteVersion   kAITextFrameSuiteVersion4
#define	kAITextFrameVersion   kAITextFrameSuiteVersion
#define	kAITextFrameMESuite   "AI Text Frame ME Suite"
#define	kAITextFrameMESuiteVersion3   AIAPI_VERSION(3)
#define	kAITextFrameMESuiteVersion   kAITextFrameMESuiteVersion3
#define	kAITextFrameMEVersion   kAITextFrameMESuiteVersion
#define	kAITextFrameVersion   kAITextFrameSuiteVersion
#define	kAITextFrameHitSuite   "AI Text Frame Hit Suite"
#define	kAITextFrameHitSuiteVersion2   AIAPI_VERSION(2)
#define	kAITextFrameHitSuiteVersion   kAITextFrameHitSuiteVersion2
#define	kAITextFrameHitVersion   kAITextFrameHitSuiteVersion
Typedefs
typedef AITextType	AITextFrameType
	An opaque reference to a text frame.
Enumerations
enum	AITextType { kUnknownTextType = -1, kPointTextType, kInPathTextType, kOnPathTextType }
	Types of text frames. More...
enum	AITextDirection { kAITextLeftToRightDirection, kAITextRightToLeftDirection }
	Text direction constants. More...
enum	AITextPart {   kAITextNowhere = 0, kAITextText = 1, kAITextInport = 2, kAITextOutPort = 3,   kAITextStart = 4, kAITextMiddle = 5, kAITextEnd = 6 }
	Parts of a text object that can be hit. More...
enum	TextAntialiasingAvailableTypes {   kTextAntialiasingInvalid = 0, kTextAntialiasingNone, kTextAntialiasingSharp, kTextAntialiasingCrisp,   kTextAntialiasingStrong }
	Types of Text Antialiasing available. More...

---

Detailed Description

---

Define Documentation

#define kAITextFrameHitSuite   "AI Text Frame Hit Suite"

#define kAITextFrameHitSuiteVersion   kAITextFrameHitSuiteVersion2

#define kAITextFrameHitSuiteVersion2   AIAPI_VERSION(2)

#define kAITextFrameHitVersion   kAITextFrameHitSuiteVersion

#define kAITextFrameMESuite   "AI Text Frame ME Suite"

#define kAITextFrameMESuiteVersion   kAITextFrameMESuiteVersion3

#define kAITextFrameMESuiteVersion3   AIAPI_VERSION(3)

#define kAITextFrameMEVersion   kAITextFrameMESuiteVersion

#define kAITextFrameSuite   "AI Text Frame Suite"

#define kAITextFrameSuiteVersion   kAITextFrameSuiteVersion4

#define kAITextFrameSuiteVersion4   AIAPI_VERSION(4)

#define kAITextFrameVersion   kAITextFrameSuiteVersion

#define kAITextFrameVersion   kAITextFrameSuiteVersion

---

Typedef Documentation

typedef AITextType AITextFrameType

An opaque reference to a text frame.

See AITextFrameSuite.

---

Enumeration Type Documentation

enum AITextDirection

Text direction constants.

See AITextFrameMESuite.

Enumerator:

kAITextLeftToRightDirection
kAITextRightToLeftDirection

enum AITextPart

Parts of a text object that can be hit.

See AITextFrameHitSuite.

Enumerator:

kAITextNowhere
kAITextText	Direct hit on text.
kAITextInport	Hit on "in" port of either in-path or on-path text.
kAITextOutPort	Hit on "out" port of either in-path or on-path text.
kAITextStart	Hit on start point of on-path text.
kAITextMiddle	Hit on middle point of on-path text.
kAITextEnd	Hit on end point of OnPath text.

enum AITextType

Types of text frames.

See AITextFrameSuite.

Enumerator:

kUnknownTextType
kPointTextType	Point text, defined by an anchor point for the position of the first character.
kInPathTextType	In-path text, an associated path object defines the area the text flows into.
kOnPathTextType	On-path text, an associated path object defines the area the text flows along.

enum TextAntialiasingAvailableTypes

Types of Text Antialiasing available.

See AITextFrameHitSuite.

Enumerator:

kTextAntialiasingInvalid
kTextAntialiasingNone
kTextAntialiasingSharp
kTextAntialiasingCrisp
kTextAntialiasingStrong