AIATETextUtilSuite Struct Reference
[API Suite List]

It provides utilities for working with text. More...

#include <AIATETextUtil.h>

Public Attributes
AIAPI AIErr(*	GetBoundsFromTextRange )(ATE::TextRangeRef tr, AIRealRect *bounds)
	Retrieves the bounds of a text range.
AIAPI AIErr(*	GetApplicationTextResources )(ATE::ApplicationTextResourcesRef *result)
	Retrieves application global resources related to text.
AIAPI AIErr(*	GetTextResourcesFromDocument )(AIDocumentHandle pDocument, ATE::TextResourcesRef *pResources)
	Retrieves per-document global resources related to text.
AIAPI AIErr(*	GetCompositeFont )(const ai::FilePath &, ATE::CompFontRef *compFont)
	Retrieves the composite font from a composite font file.
AIAPI AIErr(*	WriteCompositeFont )(const ai::FilePath &, const ATE::CompFontRef compFontRef)
	Creates or replaces a composite font file, writing the information from a specified composite font.
AIAPI AIErr(*	GetKinsokuFile )(const ai::FilePath &, ATE::KinsokuRef *kinsokuRef)
	Retrieves the Kinsoku order information from a Kinsoku file.
AIAPI AIErr(*	WriteKinsokuFile )(const ai::FilePath &, const ATE::KinsokuRef kinsokuRef)
	Creates or replaces a Kinsoku file, writing the information from a specified Kinsoku reference.
AIAPI AIErr(*	GetMojiKumiFile )(const ai::FilePath &, ATE::MojiKumiRef *mojikumeRef)
	Retrieves the MojiKumi information from a MojiKumi file.
AIAPI AIErr(*	WriteMojiKumiFile )(const ai::FilePath &, const ATE::MojiKumiRef mojikumeRef)
	Creates or replaces a MojiKumi file, writing the information from a specified MojiKumi reference.
AIAPI AIErr(*	UpdateParagraphPaletteKinsoku )(ai::int32 index)
	Internal.
AIAPI AIErr(*	UpdateParagraphPaletteMojiKumi )(ai::int32 index)
	Internal.
AIAPI AIErr(*	GetSpellFile )(const ai::FilePath &pSrcFileSpec, ATE::SpellRef *pDst)
	Retrieves the spell-check dictionary for file.
AIAPI AIErr(*	SetCurrentFont )(AIFontKey theFont)
	Changes the font of the currently selected text object or objects.
AIAPI AIErr(*	GetCurrentFont )(AIFontKey *result)
	Retrieves the font of the currently selected text object or objects.
AIAPI AIErr(*	SetCurrentFontSize )(AIReal theFontSize)
	Changes the font size of the currently selected text object or objects.
AIAPI AIErr(*	GetCurrentFontSize )(AIReal *result)
	Retrieves the font size of the currently selected text object or objects.
AIAPI AIErr(*	GetUnderlinePoints )(const ATE::GlyphRunRef gr, ATE::ArrayRealPointRef *pPoints)
	Retrieves an array of points representing the visual, flattened, representation of the underline for a glyph run.
AIAPI AIErr(*	GetStrikethroughPoints )(const ATE::GlyphRunRef gr, ATE::ArrayRealPointRef *pPoints)
	Retrieves an array of points representing the visual, flattened, representation of the strikethrough for a glyph run.These points represent a polygon, not a bezier.

Detailed Description

It provides utilities for working with text.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIATETextUtilSuite and kAIATETextUtilVersion.

Member Data Documentation

AIAPI AIErr(* AIATETextUtilSuite::GetApplicationTextResources)(ATE::ApplicationTextResourcesRef *result)

Retrieves application global resources related to text.

Parameters:

result [out] A buffer in which to return the resource values. Access the font resources in this opaque structure using the ATE::IApplicationTextResources wrapper.

See also:: IText.h

AIAPI AIErr(* AIATETextUtilSuite::GetBoundsFromTextRange)(ATE::TextRangeRef tr, AIRealRect *bounds)

Retrieves the bounds of a text range.

Parameters:

	tr	The text range.
	bounds	[out] A buffer in which to return the bounding box.

Returns:: The error kAIATEInvalidBounds if the text range is hidden due to smaller frame size.

AIAPI AIErr(* AIATETextUtilSuite::GetCompositeFont)(const ai::FilePath &, ATE::CompFontRef *compFont)

Retrieves the composite font from a composite font file.

Parameters:

	filePath	The file.
	compFont	[out] A buffer in which to return the composite font. Access the contents of this opaque structure using the `ATE::ICompFont` wrapper.

See also:: IText.h

AIAPI AIErr(* AIATETextUtilSuite::GetCurrentFont)(AIFontKey *result)

Retrieves the font of the currently selected text object or objects.

Parameters:

theFont [out] A buffer in which to return the font, or NULL if more than one font is used.

AIAPI AIErr(* AIATETextUtilSuite::GetCurrentFontSize)(AIReal *result)

Retrieves the font size of the currently selected text object or objects.

Parameters:

theFont [out] A buffer in which to return the font size, in points, or NULL if more than one font size is used.

AIAPI AIErr(* AIATETextUtilSuite::GetKinsokuFile)(const ai::FilePath &, ATE::KinsokuRef *kinsokuRef)

Retrieves the Kinsoku order information from a Kinsoku file.

Parameters:

	filePath	The file.
	kinsokuRef	[out] A buffer in which to return the Kinsoku information. Access the contents of this opaque structure using the `ATE::IKinsoku` wrapper.

See also:: IText.h

AIAPI AIErr(* AIATETextUtilSuite::GetMojiKumiFile)(const ai::FilePath &, ATE::MojiKumiRef *mojikumeRef)

Retrieves the MojiKumi information from a MojiKumi file.

Parameters:

	filePath	The file.
	mojikumiRef	[out] A buffer in which to return the MojiKumi information. Access the contents of this opaque structure using the `ATE::IMojiKumi` wrapper.

See also:: IText.h

AIAPI AIErr(* AIATETextUtilSuite::GetSpellFile)(const ai::FilePath &pSrcFileSpec, ATE::SpellRef *pDst)

Retrieves the spell-check dictionary for file.

Parameters:

	filePath	The file.
	pDst	[out] A buffer in which to return the spell-check information.

AIAPI AIErr(* AIATETextUtilSuite::GetStrikethroughPoints)(const ATE::GlyphRunRef gr, ATE::ArrayRealPointRef *pPoints)

Retrieves an array of points representing the visual, flattened, representation of the strikethrough for a glyph run.These points represent a polygon, not a bezier.

It is always closed, although the last point is not equal to the first one. The coordinate are hard, use AIHardSoftSuite to convert them into soft coordinates before working with them.

Parameters:

	gr	The glyph run.
	pPoints	[out] A buffer in which to return the array of points.

AIAPI AIErr(* AIATETextUtilSuite::GetTextResourcesFromDocument)(AIDocumentHandle pDocument, ATE::TextResourcesRef *pResources)

Retrieves per-document global resources related to text.

Parameters:

pResources [out] A buffer in which to return the resource values. Access the font resources in this opaque structure using the ATE::ITextResources wrapper.

See also:: IText.h

AIAPI AIErr(* AIATETextUtilSuite::GetUnderlinePoints)(const ATE::GlyphRunRef gr, ATE::ArrayRealPointRef *pPoints)

Retrieves an array of points representing the visual, flattened, representation of the underline for a glyph run.

These points represent a polygon, not a bezier. It is always closed, although the last point is not equal to the first one. The coordinate are hard, use AIHardSoftSuite to convert them into soft coordinates before working with them.

Parameters:

	gr	The glyph run.
	pPoints	[out] A buffer in which to return the array of points.

AIAPI AIErr(* AIATETextUtilSuite::SetCurrentFont)(AIFontKey theFont)

Changes the font of the currently selected text object or objects.

Parameters:

theFont

The new font.

AIAPI AIErr(* AIATETextUtilSuite::SetCurrentFontSize)(AIReal theFontSize)

Changes the font size of the currently selected text object or objects.

Parameters:

theFont

The new size, in points.

AIAPI AIErr(* AIATETextUtilSuite::UpdateParagraphPaletteKinsoku)(ai::int32 index)

Internal.

Updates the Kinsoku information shown for an entry in the Paragraph palette.

AIAPI AIErr(* AIATETextUtilSuite::UpdateParagraphPaletteMojiKumi)(ai::int32 index)

Internal.

Updates the MojuKumi information shown for an entry in the Paragraph palette.

AIAPI AIErr(* AIATETextUtilSuite::WriteCompositeFont)(const ai::FilePath &, const ATE::CompFontRef compFontRef)

Creates or replaces a composite font file, writing the information from a specified composite font.

Parameters:

	filePath	The file path.
	compFont	The composite font.

AIAPI AIErr(* AIATETextUtilSuite::WriteKinsokuFile)(const ai::FilePath &, const ATE::KinsokuRef kinsokuRef)

Creates or replaces a Kinsoku file, writing the information from a specified Kinsoku reference.

Parameters:

	filePath	The file.
	kinsokuRef	The new Kinsoku information.

AIAPI AIErr(* AIATETextUtilSuite::WriteMojiKumiFile)(const ai::FilePath &, const ATE::MojiKumiRef mojikumeRef)

Creates or replaces a MojiKumi file, writing the information from a specified MojiKumi reference.

Parameters:

	filePath	The file.
	mojikumiRef	The new MojiKumi information.

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

AIATETextUtil.h

AIATETextUtilSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIATETextUtilSuite Struct Reference
[API Suite List]