AIToolboxMessage Struct Reference

The contents of a toolbox message. More...

#include <AIToolbox.h>

List of all members.

Public Attributes
SPMessageData	d = {}
	The message data.
AIToolboxHandle	toolbox = {}
	The toolbox reference.
AIToolType	tool = 0
	The tool reference.
AIDataStackRef	iconResourceDictionary
	The icon shown in the Tools palette.
char *	name = nullptr
	Unique identifying name for the tool.
char *	title_deprecated = nullptr
	This is a deprecated field and will only be filled with an empty string.
char *	tooltip_deprecated = nullptr
	This is a deprecated field and will only be filled with an empty string.
ASHelpID	helpID_deprecated = 0
	This is a deprecated field and will not be used.
ai::IconType	iconType = ai::IconType::kInvalid
AIToolType	sameGroupAs = 0
	This is for internal purpose only to hold plugin's priority for group.
AIToolType	sameSetAs = 0
	This is for internal purpose only to hold plugin's priority for set.
bool	isThirdPartyPlugin = false
	This is for internal purpose only to hold a plugin is third party plugin or not.
ai::UnicodeString	title
	Localized display name for the tool.
ai::UnicodeString	tooltip
	Short descriptive string shown when tool is activated.

---

Detailed Description

The contents of a toolbox message.

Valid fields depend on the selector type.

---

Member Data Documentation

SPMessageData AIToolboxMessage::d = {}

The message data.

ASHelpID AIToolboxMessage::helpID_deprecated = 0

This is a deprecated field and will not be used.

AIDataStackRef AIToolboxMessage::iconResourceDictionary

The icon shown in the Tools palette.

ai::IconType AIToolboxMessage::iconType = ai::IconType::kInvalid

bool AIToolboxMessage::isThirdPartyPlugin = false

This is for internal purpose only to hold a plugin is third party plugin or not.

char* AIToolboxMessage::name = nullptr

Unique identifying name for the tool.

AIToolType AIToolboxMessage::sameGroupAs = 0

This is for internal purpose only to hold plugin's priority for group.

AIToolType AIToolboxMessage::sameSetAs = 0

This is for internal purpose only to hold plugin's priority for set.

ai::UnicodeString AIToolboxMessage::title

Localized display name for the tool.

char* AIToolboxMessage::title_deprecated = nullptr

This is a deprecated field and will only be filled with an empty string.

AIToolType AIToolboxMessage::tool = 0

The tool reference.

AIToolboxHandle AIToolboxMessage::toolbox = {}

The toolbox reference.

ai::UnicodeString AIToolboxMessage::tooltip

Short descriptive string shown when tool is activated.

char* AIToolboxMessage::tooltip_deprecated = nullptr

This is a deprecated field and will only be filled with an empty string.

---

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

• AIToolbox.h