AICommandManagerSuite Struct Reference

#include <AICommandManager.h>

List of all members.

Public Attributes
AIAPI AIErr(*	AddCommand )(AICommandID commandID, const char *name, const ai::UnicodeString &localizedName)
	For internal use only.
AIAPI AIErr(*	GetCommandIDFromName )(const char *name, AICommandID *commandID)
	Retrieves a command identifier from the name.
AIAPI AIErr(*	GetCommandIDFromLocalizedName )(const ai::UnicodeString &localizedName, AICommandID *commandID)
	Retrieves a command identifier from the display label.
AIAPI AIErr(*	GetCommandName )(AICommandID commandID, char *name)
	Retrieves a command name from the identifier.
AIAPI AIErr(*	GetCommandLocalizedName )(AICommandID commandID, ai::UnicodeString &localizedName)
	Retrieves a command display label from the identifier.
AIAPI AIErr(*	TestFunctionKey )(ai::int32 fkey, ai::uint32 aiModifiers, AIBoolean *used)
	Not implemented.
AIAPI AIErr(*	SetActionFunctionKey )(ai::int32 fkey, ai::uint32 aiModifiers)
	Not implemented.
AIAPI AIErr(*	ClearActionFunctionKey )(ai::int32 fkey, ai::uint32 aiModifiers)
	Not implemented.
AIAPI AIErr(*	GetCommandIDFromShortCutKey )(int key, ai::uint32 aiModifiers, AICommandID *commandID)
	Retrieves a command identifier from the keyboard shortcut.
AIAPI AIErr(*	SearchCommandLocalizedName )(const ai::UnicodeString &partialName, ai::UnicodeString &localizedName)
	Retrieves a command display label by matching a string containing a partial version of the name.
AIAPI AIErr(*	GetShortCutKeyFromCommandID )(AICommandID commandID, ai::int32 context, ai::int32 *key, ai::uint32 *aiModifiers, ai::int32 *represent)
	Not implemented.
AIAPI AIErr(*	SetShortCutKeyFromCommandID )(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)
	Not implemented.
AIAPI AIErr(*	DeleteShortCutKeyFromCommandID )(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)
	Not implemented.
AIAPI AIErr(*	GetShortCutKeyOfCommandEx )(AICommandID commandID, ai::int32 context, char *commandStr, ai::int32 *key, ai::uint32 *aiModifiers, ai::int32 *represent)
	Not implemented.
AIAPI AIErr(*	SetShortCutKeyOfCommandEx )(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent, const char *commandStr, char *localizedStr, SPPluginRef pluginRef)
	Not implemented.
AIAPI AIErr(*	DeleteShortCutKeyOfCommandEx )(AICommandID commandID, ai::int32 context, char *commandStr, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)
	Not implemented.
AIAPI AIErr(*	GetCommandExFromShortCutKey )(ai::int32 key, ai::uint32 aiModifiers, ai::int32 context, AICommandID *commandID, SPPluginRef *pluginRef, char *commandStr, ai::int32 maxCommandStr, char *localizedStr, ai::int32 maxLocalizedStr)
	Not implemented.
AIAPI AIErr(*	SetActionFunctionKeyEx )(ai::int32 fkey, ai::uint32 aiModifiers, char *commandStr)
	Not implemented.
AIAPI AIErr(*	CountCommands )(ai::int32 *totalCommands)
	Not implemented.
AIAPI AIErr(*	GetNthCommandInfo )(ai::int32 index, AICommandID *commandID, ai::int32 *context, ai::int32 *key, ai::int32 *represent, ai::uint32 *aiModifiers, SPPluginRef *pluginRef, char *commandStr, ai::int32 maxCommandStr, char *localizedStr, ai::int32 maxLocalizedStr)
	Not implemented.
AIAPI AIErr(*	DeleteCommand )(AICommandID commandID)
	For internal use only.
AIAPI AIErr(*	GetCommandNotifierName )(AICommandID commandID, ai::UnicodeString &notifierName)
	Retrieves a command notifier name from the identifier.

---

Detailed Description

Deprecated:

Use AIMenuSuite instead. This suite provides an older mechanism for manipulating Illustrator menu commands, It is provided for compatibility, but has been superseded by AIMenuSuite.

---

Member Data Documentation

AIAPI AIErr(* AICommandManagerSuite::AddCommand)(AICommandID commandID, const char *name, const ai::UnicodeString &localizedName)

For internal use only.

Creates a menu command.

Parameters:

	commandID	The unique identifier for the command.
	name	The unique identifying name string of the command.
	localizedName	The localized display label for the command, which appears in the menu.

AIAPI AIErr(* AICommandManagerSuite::ClearActionFunctionKey)(ai::int32 fkey, ai::uint32 aiModifiers)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::CountCommands)(ai::int32 *totalCommands)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::DeleteCommand)(AICommandID commandID)

For internal use only.

Deletes a menu command.

Parameters:

commandID

The command identifier.

AIAPI AIErr(* AICommandManagerSuite::DeleteShortCutKeyFromCommandID)(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::DeleteShortCutKeyOfCommandEx)(AICommandID commandID, ai::int32 context, char *commandStr, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::GetCommandExFromShortCutKey)(ai::int32 key, ai::uint32 aiModifiers, ai::int32 context, AICommandID *commandID, SPPluginRef *pluginRef, char *commandStr, ai::int32 maxCommandStr, char *localizedStr, ai::int32 maxLocalizedStr)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::GetCommandIDFromLocalizedName)(const ai::UnicodeString &localizedName, AICommandID *commandID)

Retrieves a command identifier from the display label.

Parameters:

	localizedName	The localized label string of the command.
	commandID	[out] A buffer in which to return the ID.

AIAPI AIErr(* AICommandManagerSuite::GetCommandIDFromName)(const char *name, AICommandID *commandID)

Retrieves a command identifier from the name.

Parameters:

	name	The unique identifying name string of the command.
	commandID	[out] A buffer in which to return the ID.

AIAPI AIErr(* AICommandManagerSuite::GetCommandIDFromShortCutKey)(int key, ai::uint32 aiModifiers, AICommandID *commandID)

Retrieves a command identifier from the keyboard shortcut.

Parameters:

	key	The keyboard shortcut key code. See AI documentation.
	aiModifiers	A logical OR of modifier key flags. See AI documentation.
	commandID	[out] A buffer in which to return the command ID.

Returns:

The error kBadParameterErr if no command ID exists for this shortcut.

AIAPI AIErr(* AICommandManagerSuite::GetCommandLocalizedName)(AICommandID commandID, ai::UnicodeString &localizedName)

Retrieves a command display label from the identifier.

Parameters:

	commandID	The command ID.
	localizedName	[out] A buffer in which to return the localized display label string.

AIAPI AIErr(* AICommandManagerSuite::GetCommandName)(AICommandID commandID, char *name)

Retrieves a command name from the identifier.

Parameters:

	commandID	The command ID.
	name	[out] A buffer in which to return the unique identifying name string.

AIAPI AIErr(* AICommandManagerSuite::GetCommandNotifierName)(AICommandID commandID, ai::UnicodeString &notifierName)

Retrieves a command notifier name from the identifier.

Parameters:

	commandID	The command ID.
	name	[out] A buffer in which to return the unique command notifier string.

AIAPI AIErr(* AICommandManagerSuite::GetNthCommandInfo)(ai::int32 index, AICommandID *commandID, ai::int32 *context, ai::int32 *key, ai::int32 *represent, ai::uint32 *aiModifiers, SPPluginRef *pluginRef, char *commandStr, ai::int32 maxCommandStr, char *localizedStr, ai::int32 maxLocalizedStr)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::GetShortCutKeyFromCommandID)(AICommandID commandID, ai::int32 context, ai::int32 *key, ai::uint32 *aiModifiers, ai::int32 *represent)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::GetShortCutKeyOfCommandEx)(AICommandID commandID, ai::int32 context, char *commandStr, ai::int32 *key, ai::uint32 *aiModifiers, ai::int32 *represent)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::SearchCommandLocalizedName)(const ai::UnicodeString &partialName, ai::UnicodeString &localizedName)

Retrieves a command display label by matching a string containing a partial version of the name.

Parameters:

	partialName	The string to match.
	localizedName	[out] A buffer in which to return the localized display label string of a command.

AIAPI AIErr(* AICommandManagerSuite::SetActionFunctionKey)(ai::int32 fkey, ai::uint32 aiModifiers)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::SetActionFunctionKeyEx)(ai::int32 fkey, ai::uint32 aiModifiers, char *commandStr)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::SetShortCutKeyFromCommandID)(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::SetShortCutKeyOfCommandEx)(AICommandID commandID, ai::int32 context, ai::int32 key, ai::uint32 aiModifiers, ai::int32 represent, const char *commandStr, char *localizedStr, SPPluginRef pluginRef)

Not implemented.

AIAPI AIErr(* AICommandManagerSuite::TestFunctionKey)(ai::int32 fkey, ai::uint32 aiModifiers, AIBoolean *used)

Not implemented.

---

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

• AICommandManager.h