AICSXSExtensionSuite Struct Reference
[API Suite List]

This suite provides access to information about the status of Creative Suite extensions that might be loaded into Illustrator. More...

#include <AICSXSExtension.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetExtensionState )(const char *extensionId, ai::int32 &state)
	Retrieves the current registration and load state of an extension.
AIAPI AIErr(*	IsPrimaryStageVisible )(const char *extensionId, AIBoolean &isVisible)
	Reports whether an extension's main window is currently visible in the UI.
AIAPI AIErr(*	LaunchExtension )(const char *extensionId)
	Launches extension of specified extension ID.
AIAPI AIErr(*	SendEventToExtension )(const char *extensionId, const char *eventID, const char *appId, const char *data)
	Sends Provided Event To Extension with the provided data.
AIAPI AIErr(*	ShowExtension )(const char *extensionId, bool show)
	Sets the visibility of a panel.
AIAPI AIErr(*	UnloadExtension )(const char *extensionId)
	Unloads extension of specified extension ID.

---

Detailed Description

This suite provides access to information about the status of Creative Suite extensions that might be loaded into Illustrator.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAICSXSExtensionSuite and kAICSXSExtensionVersion.

---

Member Data Documentation

AIAPI AIErr(* AICSXSExtensionSuite::GetExtensionState)(const char *extensionId, ai::int32 &state)

Retrieves the current registration and load state of an extension.

Parameters:

	extensionId	[in] The unique identifier of the extension.
	state	[out] A buffer in which to return the current state, an AICSXSExtensionState constant value.

AIAPI AIErr(* AICSXSExtensionSuite::IsPrimaryStageVisible)(const char *extensionId, AIBoolean &isVisible)

Reports whether an extension's main window is currently visible in the UI.

Parameters:

	extensionId	[in] The unique identifier of the extension.
	isVisible	[out] True if the extension's main window appears in the UI, false otherwise.

AIAPI AIErr(* AICSXSExtensionSuite::LaunchExtension)(const char *extensionId)

Launches extension of specified extension ID.

Parameters:

extensionId

[in] The unique identifier of the extension.

AIAPI AIErr(* AICSXSExtensionSuite::SendEventToExtension)(const char *extensionId, const char *eventID, const char *appId, const char *data)

Sends Provided Event To Extension with the provided data.

Parameters:

	extensionId	[in] The unique identifier of the extension.
	eventID	[in] The unique identifier of the event.
	appId	[in] The unique identifier of Application.
	data	[in] data is optional. it can be used to send some data to extension along with the event

AIAPI AIErr(* AICSXSExtensionSuite::ShowExtension)(const char *extensionId, bool show)

Sets the visibility of a panel.

NOTE: This suite function does not "launch" any extension. It simply changes visibility state of container of the input extension If you need to know the "launch" status of an extension use GetExtensionState.

Parameters:

	extensionId	[in] The unique identifier of the extension.
	show	[in] weather to show/hide the extension panel.

AIAPI AIErr(* AICSXSExtensionSuite::UnloadExtension)(const char *extensionId)

Unloads extension of specified extension ID.

Parameters:

extensionId

[in] The unique identifier of the extension.

---

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

• AICSXSExtension.h