AIHTMLConversionSuite Struct Reference
[API Suite List]

This suite is not, by default, provided by Illustrator. More...

#include <AIHTMLConversion.h>

List of all members.

Public Attributes
AIAPI AIBoolean(*	ArtCanBeConverted )(AIArtHandle art, ai::int16 artType, ai::int32 options)
	Reports whether art can be converted with specified options.
AIAPI AIErr(*	GetArtAsHTMLText )(AIArtHandle art, ai::int32 options, AIDataFilter *stream)
	Converts the text runs in a text art object into appropriate HTML expressions in a stream.
AIAPI AIErr(*	GetConverterInfo )(char **converterName, void *otherInfo)
	Retrieves information from the provider of this HTML conversion suite.

---

Detailed Description

This suite is not, by default, provided by Illustrator.

If your plug-in provides this suite, it should use the AIHTMLConversionSuite to convert art to an HTML text flow, mapping styles as needed, then add that suite using AIHTMLConversionSuitesSuite::AddHTMLConversionSuite().

A default converter for text is part of the AISlicingSuite. That suite uses these functions to get the best possible HTML representation of a sliced text object, which in turn allows Save for Web to export Illustrator text as HTML text.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIHTMLConversionSuite and kAIHTMLConversionSuiteVersion.

---

Member Data Documentation

AIAPI AIBoolean(* AIHTMLConversionSuite::ArtCanBeConverted)(AIArtHandle art, ai::int16 artType, ai::int32 options)

Reports whether art can be converted with specified options.

Usage of options and conversion behavior is specific to the converter. (Note that this function returns a Boolean value, not an error code.)

Parameters:

	art	An art object or root of an art tree.
	options	The conversion options, a logical OR of AIHTMLConversionOptions bit flags, as defined for this converter..

AIAPI AIErr(* AIHTMLConversionSuite::GetArtAsHTMLText)(AIArtHandle art, ai::int32 options, AIDataFilter *stream)

Converts the text runs in a text art object into appropriate HTML expressions in a stream.

Usage of options and conversion behavior is specific to the converter.

Parameters:

	art	The text art object.
	options	The conversion options, a logical OR of AIHTMLConversionOptions bit flags, as defined for this converter.

Returns:

The error kAIHTMLUnsupportedTypeError if the art cannot be converted to HTML because there is no translator.
The error kAIHTMLHBufferOverflowError if there is more text than the buffer can hold.

AIAPI AIErr(* AIHTMLConversionSuite::GetConverterInfo)(char **converterName, void *otherInfo)

Retrieves information from the provider of this HTML conversion suite.

Not typically needed. The provider can return a name that represents the converter, or additional information based on what is passed in.

Parameters:

	converterName	[in, out] A buffer in which to specify and return the converter name.
	otherInfo	[in, out] A buffer in which to specify and return additional information, as defined by this converter.

---

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

• AIHTMLConversion.h