AIFXGFileFormatSuite Struct Reference
[API Suite List]

Stream interface to be passed to AIFXGFileFormatSuite::ExportFXGToStream(). More...

#include <AIFXGFileFormat.h>

Public Attributes
AIAPI AIErr(*	CreateFXGSaveParams )(AIFXGFileFormatSaveParams *fxgSaveParams)
	Creates an FXG save-options object with default values.
AIAPI AIErr(*	DisposeFXGSaveParams )(AIFXGFileFormatSaveParams fxgSaveParams)
	Destroys the FXG save-options object created with `CreateFXGSaveParams()`.
AIAPI ai::int16(*	GetFXGSaveVersion )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current FXG version value from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveVersion )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgVersion)
	Sets the FXG save version value in an FXG save-options object.
AIAPI AIBoolean(*	GetFXGSavePreserveAIEditCapability )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current "Save Illustrator Private Data" flag value from an FXG save-options object.
AIAPI AIErr(*	SetFXGSavePreserveAIEditCapability )(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiEditCap)
	Sets the "Preserve AI Editing capabilities" flag in an FXG save-options object.
AIAPI ai::int16(*	GetFXGSaveTextPolicy )(const AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current preserve policy for Text from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveTextPolicy )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgTextPreservePolicy)
	Sets the preserve policy for Text in an FXG save-options object.
AIAPI ai::int16(*	GetFXGSaveFilterPolicy )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current preserve policy for FXG Filters from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveFilterPolicy )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgFilterPreservePolicy)
	Sets the preserve policy for FXG Filters in an FXG save-options object.
AIAPI ai::int16(*	GetFXGSaveGradientPolicy )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current preserve policy for Gradients from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveGradientPolicy )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgGradientPreservePolicy)
	Sets the preserve policy for Gradients in an FXG save-options object.
AIAPI AIBoolean(*	GetFXGSaveIncludeSymbol )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the "Include Symbols" flag from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveIncludeSymbol )(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiIncludeSymbol)
	Sets the "Include Symbols" flag in an FXG save-options object.
AIAPI AIBoolean(*	GetFXGSaveIncludeXMP )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the "Include XMP" flag from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveIncludeXMP )(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiIncludeXMP)
	Sets the "Include Symbols" flag in an FXG save-options object.
AIAPI ai::int16(*	GetFXGSaveRasterizeResolution )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 *outCustomResolution)
	Retrieves the rasterize resolution from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveRasterizeResolution )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgRasterizeResolution, ai::int32 customResolution)
	Sets the rasterize resolution in an FXG save-options object.
AIAPI AIBoolean(*	GetFXGSaveDownsampleLinkedImages )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the "Downsample Linked Images" flag from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveDownsampleLinkedImages )(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiDownSampleLinkedImages)
	Sets the "Downsample Linked Images" flag in an FXG save-options object.
AIAPI AIBoolean(*	GetFXGSaveWriteImages )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the "WriteImages" flag from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveWriteImages )(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean writeImages)
	Sets the "WriteImages" flag in an FXG save-options object.
AIAPI AIErr(*	ExportFXGToFile )(AIArtHandle art, const ai::FilePath &filePath, AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 fxgExportFlags, const ai::UnicodeString &artBoardRange, const ai::UnicodeString &customProgressText, AIFXGSaveWarnings *saveWarnings)
	Generates FXG to a file.
AIAPI AIErr(*	ExportFXGToStream )(AIArtHandle art, AIFXGWriteStreamInterface streamInterface, AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 fxgExportFlags, const ai::UnicodeString &artBoardRange, const ai::UnicodeString &customProgressText, AIFXGSaveWarnings saveWarnings)
	Generates FXG to a stream through callbacks.
AIAPI ai::int16(*	GetFXGSaveExpandOptionBlends )(AIFXGFileFormatSaveParams fxgSaveParams)
	Retrieves the current expand option for Blends from an FXG save-options object.
AIAPI AIErr(*	SetFXGSaveExpandOptionBlends )(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgBlendsExpandOption)
	Sets the expand option for Blends in an FXG save-options object.
AIAPI AIErr(*	DisposeFXGSaveWarnings )(AIFXGSaveWarnings saveWarnings)
	Destroys the FXG save-warnings object created with `ExportFXGToFile()` or `ExportFXGToStream()`.
AIAPI ai::int32(*	GetFXGSaveWarningCount )(AIFXGSaveWarnings saveWarnings)
	Retrieves the number of warnings stored in the FXG save-warnings object.
AIAPI AIErr(*	GetNthFXGSaveWarning )(AIFXGSaveWarnings saveWarnings, ai::int32 index, ai::UnicodeString &warningZStr)
	Retrieves a warning from the FXG save-warnings object.

Detailed Description

Stream interface to be passed to AIFXGFileFormatSuite::ExportFXGToStream().

This suite provides functions that allow you to export an AI document or art object to FXG.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIFXGFileFormatSuite and kAIFXGFileFormatVersion.

Member Data Documentation

AIAPI AIErr(* AIFXGFileFormatSuite::CreateFXGSaveParams)(AIFXGFileFormatSaveParams *fxgSaveParams)

Creates an FXG save-options object with default values.

This should be freed when no longer needed, using DisposeFXGSaveParams()

Parameters:

fxgSaveParams

[out] Save options with default values.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::DisposeFXGSaveParams)(AIFXGFileFormatSaveParams fxgSaveParams)

Destroys the FXG save-options object created with CreateFXGSaveParams().

Parameters:

fxgSaveParams

[in] The save-options object.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::DisposeFXGSaveWarnings)(AIFXGSaveWarnings saveWarnings)

Destroys the FXG save-warnings object created with ExportFXGToFile() or ExportFXGToStream().

Parameters:

saveWarnings

[in] The save-warnings object.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::ExportFXGToFile)(AIArtHandle art, const ai::FilePath &filePath, AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 fxgExportFlags, const ai::UnicodeString &artBoardRange, const ai::UnicodeString &customProgressText, AIFXGSaveWarnings *saveWarnings)

Generates FXG to a file.

Parameters:

	art	[in] Art which you want to export as FXG. Pass NULL to generate FXG for entire document.
	filepath	[in] The file path for the master document FXG
	fxgSaveParams	[in] The FXG save options parameters. See `AIFXGFileFormatSaveParams`
	fxgExportFlags	[in] The export flags. See `AIFXGExportFlagEnum`
	artBoardRange	[in] If the export flag `kAIFXGExportFlagArtboards` is passed, the artboard range.
	customProgressText	[in] An optional message to display in the progress bar. If NULL, a default message is displayed.
	saveWarnings	[out] A list to store warning message ids, which gets generated while saving to FXG. Dispose it via `DisposeFXGSaveWarnings()`. Pass NULL if you do not want to receive any warning messages.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::ExportFXGToStream)(AIArtHandle art, AIFXGWriteStreamInterface *streamInterface, AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 fxgExportFlags, const ai::UnicodeString &artBoardRange, const ai::UnicodeString &customProgressText, AIFXGSaveWarnings *saveWarnings)

Generates FXG to a stream through callbacks.

Parameters:

	art	[in] The art which you want to export as FXG. Pass NULL to generate FXG for entire document.
	streamInterface	[in] The stream implementation with callbacks, See `AIFXGWriteStreamInterface`
	fxgSaveParams	[in] The FXG save options parameters. See `AIFXGFileFormatSaveParams`
	fxgExportFlags	[in] The export flags. See `AIFXGExportFlagEnum`
	artBoardRange	[in] If the export flag `kAIFXGExportFlagArtboards` is passed, the artboard range.
	customProgressText	[in] An optional message to display in the progress bar. If NULL, a default message is displayed.
	saveWarnings	[out] A list to store warning message ids, which gets generated while saving to FXG. Dispose it via `DisposeFXGSaveWarnings()`. Pass NULL if you do not want to receive any warning messages.

Returns:: kNoErr on success.

AIAPI AIBoolean(* AIFXGFileFormatSuite::GetFXGSaveDownsampleLinkedImages)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the "Downsample Linked Images" flag from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: True if linked images should be downsampled to 72 ppi, false otherwise.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveExpandOptionBlends)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current expand option for Blends from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: The expand option for Blends, an AIFXGExpandArtOptionEnum value.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveFilterPolicy)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current preserve policy for FXG Filters from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: The preserve policy for FXG Filters, an AIFXGPreservePolicy value.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveGradientPolicy)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current preserve policy for Gradients from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: The preserve policy for Gradients, an AIFXGPreservePolicy value.

AIAPI AIBoolean(* AIFXGFileFormatSuite::GetFXGSaveIncludeSymbol)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the "Include Symbols" flag from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: True if All Symbols should be written in FXG, whether they are used or not.

AIAPI AIBoolean(* AIFXGFileFormatSuite::GetFXGSaveIncludeXMP)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the "Include XMP" flag from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: True if XMP should be written in FXG,

AIAPI AIBoolean(* AIFXGFileFormatSuite::GetFXGSavePreserveAIEditCapability)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current "Save Illustrator Private Data" flag value from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: True if AI editing capabilities should be preserved using application private data.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveRasterizeResolution)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int32 *outCustomResolution)

Retrieves the rasterize resolution from an FXG save-options object.

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

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	outCustomResolution	[out] A custom resolution value if the returned value is `kAIFXGResolutionCustom`

Returns:: The rasterize resolution, an AIFXGRasterizeResolution value.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveTextPolicy)(const AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current preserve policy for Text from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: The preserve policy for Text, an AIFXGPreservePolicy value.

AIAPI ai::int16(* AIFXGFileFormatSuite::GetFXGSaveVersion)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the current FXG version value from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: The FXG version, an AIFXGVersion value.

AIAPI ai::int32(* AIFXGFileFormatSuite::GetFXGSaveWarningCount)(AIFXGSaveWarnings saveWarnings)

Retrieves the number of warnings stored in the FXG save-warnings object.

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

Parameters:

saveWarnings

[in] The save-warnings object.

Returns:: The number of warnings.

AIAPI AIBoolean(* AIFXGFileFormatSuite::GetFXGSaveWriteImages)(AIFXGFileFormatSaveParams fxgSaveParams)

Retrieves the "WriteImages" flag from an FXG save-options object.

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

Parameters:

fxgSaveParams [in] A save-options object as returned by CreateFXGSaveParams().

Returns:: True if images should also be written while exporting FXG. If false, images are not written, which is useful when user is interested in only the XML code.

AIAPI AIErr(* AIFXGFileFormatSuite::GetNthFXGSaveWarning)(AIFXGSaveWarnings saveWarnings, ai::int32 index, ai::UnicodeString &warningZStr)

Retrieves a warning from the FXG save-warnings object.

Parameters:

	saveWarnings	The save-warnings object.
	index	The 0-based position index of the warning.
	warningZStr	[out] A buffer in which to return the warning string, in ZString format. Developer is responsible for translating to the appropriate language.

Returns:: kNoErr if a warning is found at the given index, kBadParameterErr if the index is invalid, kFXGWarningNotFoundErr if index is valid but the warning string is empty.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveDownsampleLinkedImages)(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiDownSampleLinkedImages)

Sets the "Downsample Linked Images" flag in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	aiDownSampleLinkedImages	[in] True if Linked images should be downsampled to 72 ppi, false otherwise.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveExpandOptionBlends)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgBlendsExpandOption)

Sets the expand option for Blends in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgBlendsExpandOption	[in] The preserve policy for Gradients, an `AIFXGExpandArtOptionEnum` value.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveFilterPolicy)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgFilterPreservePolicy)

Sets the preserve policy for FXG Filters in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgFilterPreservePolicy	[in] The preserve policy for FXG Filters, an `AIFXGPreservePolicy` value.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveGradientPolicy)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgGradientPreservePolicy)

Sets the preserve policy for Gradients in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgFilterPreservePolicy	[in] The preserve policy for Gradients, an `AIFXGPreservePolicy` value.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveIncludeSymbol)(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiIncludeSymbol)

Sets the "Include Symbols" flag in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	aiIncludeSymbol	[in] True if all symbols should be exported, false if only used symbols should be exported

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveIncludeXMP)(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiIncludeXMP)

Sets the "Include Symbols" flag in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	aiIncludeXMP	[in] True if XMP should be exported.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSavePreserveAIEditCapability)(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean aiEditCap)

Sets the "Preserve AI Editing capabilities" flag in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	aiEditCap	[in] true if editing capabilities should be preserved, false other wise.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveRasterizeResolution)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgRasterizeResolution, ai::int32 customResolution)

Sets the rasterize resolution in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgRasterizeResolution	[in] The rasterize resolution, an `AIFXGRasterizeResolution` value.
	customResolution	[in] A custom resolution if the resolution value is `kAIFXGResolutionCustom`

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveTextPolicy)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgTextPreservePolicy)

Sets the preserve policy for Text in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgTextPreservePolicy	[in] The preserve policy for Text, an `AIFXGPreservePolicy` value.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveVersion)(AIFXGFileFormatSaveParams fxgSaveParams, ai::int16 fxgVersion)

Sets the FXG save version value in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	fxgVersion	[in] The FXG version, an `AIFXGVersion` value.

Returns:: kNoErr on success.

AIAPI AIErr(* AIFXGFileFormatSuite::SetFXGSaveWriteImages)(AIFXGFileFormatSaveParams fxgSaveParams, AIBoolean writeImages)

Sets the "WriteImages" flag in an FXG save-options object.

Parameters:

	fxgSaveParams	[in] A save-options object as returned by `CreateFXGSaveParams()`.
	writeImages	[in] True if images should be written while exporting FXG, false otherwise.

Returns:: kNoErr on success.

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

AIFXGFileFormat.h

AIFXGFileFormatSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIFXGFileFormatSuite Struct Reference
[API Suite List]