AIMEFontSuite Struct Reference

#include <AIFont.h>

Public Attributes
AIAPI AIErr(*	GetGlyphSet )(AIFontKey theFont, int AILanguage, ai::int32 otFeature, AIGlyphSet *result)
	Retrieves a glyph set, which contains information about alternate glyphs within an OpenType font.
AIAPI AIErr(*	GetOTFeatures )(AIFontKey theFont, int AILanguage, ai::int32 featureList, ai::int32 featureCount)
	Retrieves all OpenType features supported by a particular font.
AIAPI ai::int32(*	GetGlyphsForFeatureAccessInfo )(ai::int32 theFeature, AIFontKey fontKey, int AILanguage, AIBoolean existFlag, AIGlyphSet *glyphSet)
	Reports whether there are any glyphs for a given Open Type feature in a given font, or retrieves the glyph set containing the glyphs, if any.
AIAPI AIErr(*	GetGlyphUnicodeValue )(AIGlyphID mGlyphID, AIFontKey fontKey, int AILanguage, const char desiredOTFeature, ASUnicode theChar, int resultLength, char otFeatures, ai::int32 otFeatureCount, ai::int32 **otFeatureIndex)
	Retrieves the Unicode character for a given glyph in a given font, with information about what OpenType features were applied.
AIAPI int(*	GetCurrentLanguage )()
	Retrieves the language code for the current system language.
AIAPI int(*	SLOLanguageToAILanguage )(ATE::Language sloLang)
	Converts an Adobe Text Engine language object to an Illustrator language code.
AIAPI AIErr(*	GetGlyphLanguage )(AIGlyphInfo glyphInfo, int *result)
	Retrieves the language from a glyph-information structure.

Member Data Documentation

Retrieves the language code for the current system language.

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

Retrieves the language from a glyph-information structure.

Parameters:

	glyphInfo	The glyph-information structure.
	result	[out] A buffer in which to return the language code.

Retrieves a glyph set, which contains information about alternate glyphs within an OpenType font.

Parameters:

	theFont	An OpenType font.
	AILanguage	The language code for the current system language.
	otFeature	When zero, gets information about all glyphs. Otherwise, specify the feature of interest, as a 4-byte character sequence (in a `ai::int32`) for an OpenType feature tag.
	result	[out] A buffer in which to return the glyph set. You must release this object using `ReleaseGlyphSet()` when it is no longer needed.

See also:: For the set of registered features tags, http://partners.adobe.com/public/developer/opentype/index_tag3.html

Reports whether there are any glyphs for a given Open Type feature in a given font, or retrieves the glyph set containing the glyphs, if any.

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

Parameters:

	theFeature	The feature, a 4-byte character sequence (in a `ai::int32`) representing an OpenType feature tag.
	fontKey	The font key.
	AILanguage	The language code for the current system language.
	existFlag	When true, the function reports on whether the font contains any glyphs for the feature. A font can define an OpenType feature, but assign no glyphs to that feature. Use this assure that at least one glyph is present. When false, the function retrieves the glyph set containing the glyphs (if any). This is the same as using `GetGlyphSet()`.
	result	[out] A buffer in which to return the glyph set. You must release this object using `ReleaseGlyphSet()` when it is no longer needed.

Returns:: Non-zero (true) if the font contains at least one glyph for the given feature, zero (false) otherwise.

See also:: For the set of registered features tags, http://partners.adobe.com/public/developer/opentype/index_tag3.html

AIAPI AIErr(* AIMEFontSuite::GetGlyphUnicodeValue)(AIGlyphID mGlyphID, AIFontKey fontKey, int AILanguage, const char *desiredOTFeature, ASUnicode *theChar, int *resultLength, char **otFeatures, ai::int32 *otFeatureCount, ai::int32 **otFeatureIndex)

Retrieves the Unicode character for a given glyph in a given font, with information about what OpenType features were applied.

Parameters:

	mGlyphID	The glyph identifier.
	fontKey	The font key.
	AILanguage	The language code for the current system language.
	desiredOTFeature	A string containing the OpenType features of interest. See `GetGlyphOTFeatures()`. The mapping of glyphs and feature sets to characters is not 1:1, so the returned character can have a different set of features than those requested.
	theChar	[out] A buffer in which to return the Unicode character.
	resultLength	[out] A buffer in which to return the number of features in `theChar`.
	otFeatures	[out] A buffer in which to return the OpenType features set that was applied to `theChar`. See `GetGlyphOTFeatures()`. You must release this memory with `SPBasicSuite::FreeBlock()` when it is no longer needed.
	otFeatureCount	[out] A buffer in which to return the number of features in `otFeatures`.
	otFeatureIndex	[out] A buffer in which to return an array of length `otFeatureCount` containing the number of alternates available for each feature listed in the `otFeatures` array. You must release this memory with `SPBasicSuite::FreeBlock()` when it is no longer needed.

AIAPI AIErr(* AIMEFontSuite::GetOTFeatures)(AIFontKey theFont, int AILanguage, ai::int32 *featureList, ai::int32 *featureCount)

Retrieves all OpenType features supported by a particular font.

Parameters:

	theFont	The font key.
	AILanguage	The language code for the current system language.
	featureList	[in, out] An array of OpenType features of length `featureCount`. Each value is a 4-byte character sequence (in a `ai::int32`) representing an OpenType feature tag. Caller must provide the array. Pass NULL to obtain the size of the array required.
	featureCount	[out] A buffer in which to return the size of array required for `featureList`.

See also:: For the set of registered features tags, http://partners.adobe.com/public/developer/opentype/index_tag3.html

Converts an Adobe Text Engine language object to an Illustrator language code.

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

Parameters:

sloLang

The Adobe Text Engine language object.

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