AITextFrameHitSuite Struct Reference
[API Suite List]

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

#include <AITextFrame.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	GetPart )(AIHitRef hit)
	Reports which element of a text frame was hit.

---

Detailed Description

This suite is used in conjunction with AIHitTestSuite and AITextFrameSuite.

When the AIHitTestSuite returns a hit reference that identifies a hit on a text frame, use this function to further interrogate the hit.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAITextFrameHitSuite and kAITextFrameHitVersion.

---

Member Data Documentation

AIAPI ai::int32(* AITextFrameHitSuite::GetPart)(AIHitRef hit)

Reports which element of a text frame was hit.

(Note that this function returns a constant value, not an error code.)

Parameters:

The

hit reference.

Returns:

An AITextPart value.

---

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

• AITextFrame.h