AIToolboxSuite Struct Reference
[API Suite List]

This suite allows you to create additional tool palettes, of which there can be any number. More...

#include <AIToolbox.h>

List of all members.

Public Attributes
AIAPI AIErr(*	AddToolbox )(SPPluginRef self, const char *name, AIToolboxHandle *toolbox)
	Registers a plug-in to receive toolbox selector messages and to use the other suite methods.
AIAPI AIErr(*	SetTool )(AIToolboxHandle toolbox, AIToolType tool)
	Makes a tool current for a toolbox.
AIAPI AIErr(*	AlternateAction )(AIToolboxHandle toolbox, AIToolType tool)
	Performs the alternate action for a tool, typically to show an options dialog.
AIAPI AIErr(*	CycleTool )(AIToolboxHandle toolbox, AIToolType tool)
	Sends the kSelectorAICycleTool message.
AIAPI AIErr(*	CountToolboxes )(ai::int32 *count)
	Gets the number of registered toolboxes.
AIAPI AIErr(*	GetNthToolbox )(ai::int32 n, AIToolboxHandle *toolbox)
	Retrieves a toolbox by index position.
AIAPI AIErr(*	GetCurrentToolType )(AIToolType *toolNum)
	Retrieves the currently selected tool type.
AIAPI AIErr(*	GetBuiltInToolboxVisibility )(ai::int16 toolBox, AIBoolean &visible)
	Retrieves the visibility for a built-in toolbox.

---

Detailed Description

This suite allows you to create additional tool palettes, of which there can be any number.

Some of the selectors are also useful for other plug-ins that want to know when the current tool changes.

At startup time, after all the tools have been added, the application sends a set of messages that describe the current tools. The messages are also sent if tools are added later, although this is unusual.

The caller is kCallerAIToolbox. These selectors are sent:
kSelectorAIStartToolbox
kSelectorAIEndToolbox
kSelectorAIStartToolGroup
kSelectorAIEndToolGroup
kSelectorAIStartToolSet
kSelectorAIEndToolSet
kSelectorAIAddTool
kSelectorAIAddRollover

These messages are sent during the execution of the program to notify other toolboxes of actions taken by a toolbox:
kSelectorAIToolSelected
kSelectorAIAlternateToolActionSelected
kSelectorAICycleTool
kSelectorAISoftCycleTool

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIToolboxSuite and kAIToolboxVersion.

---

Member Data Documentation

AIAPI AIErr(* AIToolboxSuite::AddToolbox)(SPPluginRef self, const char *name, AIToolboxHandle *toolbox)

Registers a plug-in to receive toolbox selector messages and to use the other suite methods.

Parameters:

	self	This plug-in.
	name	The unique identifying name of this plug-in.
	toolbox	[out] A buffer in which to return the toolbox reference. If you install multiple toolboxes, save to compare to the toolbox reference in message data.

AIAPI AIErr(* AIToolboxSuite::AlternateAction)(AIToolboxHandle toolbox, AIToolType tool)

Performs the alternate action for a tool, typically to show an options dialog.

Does not change the current tool.

Parameters:

	toolbox	The toolbox reference.
	tool	The tool reference.

AIAPI AIErr(* AIToolboxSuite::CountToolboxes)(ai::int32 *count)

Gets the number of registered toolboxes.

Use with GetNthToolbox() to iterate through plug-in toolboxes.

Parameters:

count

[out] A buffer in which to return the number of toolboxes.

AIAPI AIErr(* AIToolboxSuite::CycleTool)(AIToolboxHandle toolbox, AIToolType tool)

Sends the kSelectorAICycleTool message.

Parameters:

	toolbox	The toolbox reference.
	tool	The tool reference.

AIAPI AIErr(* AIToolboxSuite::GetBuiltInToolboxVisibility)(ai::int16 toolBox, AIBoolean &visible)

Retrieves the visibility for a built-in toolbox.

toolBox [in] A built-in toolbox taking AIBuiltInToolBox value. visible [out] The visibility of the toolbox

AIAPI AIErr(* AIToolboxSuite::GetCurrentToolType)(AIToolType *toolNum)

Retrieves the currently selected tool type.

The plug-in does not need to register as a toolbox plug-in to use this. toolNum [out] A buffer in which to return the tool number. See Toolsets and Groups in the Tools Palette

AIAPI AIErr(* AIToolboxSuite::GetNthToolbox)(ai::int32 n, AIToolboxHandle *toolbox)

Retrieves a toolbox by index position.

Use with CountToolboxes() to iterate through plug-in toolboxes.

Parameters:

	n	The 0-based position index.
	tool	[out] A buffer in which to return the toolbox reference.

AIAPI AIErr(* AIToolboxSuite::SetTool)(AIToolboxHandle toolbox, AIToolType tool)

Makes a tool current for a toolbox.

Parameters:

	toolbox	The toolbox reference. Use NULL to set the tool in the built-in toolbox.
	tool	The tool reference.

---

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

• AIToolbox.h