AIWorkspaceSuite Struct Reference
[API Suite List]

This suite allows you to access workspaces. More...

#include <AIWorkspace.h>

Public Attributes
AIAPI AIErr(*	GetIntegerValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, int *value)
	Retrieves an integer value from a workspace.
AIAPI AIErr(*	SetIntegerValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, ai::int32 value)
	Sets an integer value for a workspace.
AIAPI AIErr(*	GetRealValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIReal *value)
	Retrieves a real-number value from a workspace.
AIAPI AIErr(*	SetRealValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIReal value)
	Sets a real-number value for a workspace.
AIAPI AIErr(*	GetBooleanValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIBoolean *value)
	Retrieves a boolean value from a workspace.
AIAPI AIErr(*	SetBooleanValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIBoolean value)
	Sets a boolean value for a workspace.
AIAPI AIErr(*	GetStringValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, char *value, ai::int32 length)
	Retrieves a string value from a workspace.
AIAPI AIErr(*	SetStringValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, const char *value)
	Sets a string value for a workspace.
AIAPI AIErr(*	GetPointValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIPoint *value)
	Retrieves a point value from a workspace.
AIAPI AIErr(*	SetPointValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIPoint value)
	Sets a point value for a workspace.
AIAPI AIErr(*	GetRealPointValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRealPoint *value)
	Retrieves a real-number point value from a workspace.
AIAPI AIErr(*	SetRealPointValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRealPoint value)
	Sets a real-number point value for a workspace.
AIAPI AIErr(*	GetRectValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRect *value)
	Retrieves a rectangle value from a workspace.
AIAPI AIErr(*	SetRectValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRect value)
	Sets a rectangle value for a workspace.
AIAPI AIErr(*	GetRealRectValue )(AIWorkspaceHandle collectioRef, const char prefix, const char suffix, AIRealRect *value)
	Retrieves a real-number rectangle value from a workspace.
AIAPI AIErr(*	SetRealRectValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRealRect value)
	Sets a real-number rectangle value for a workspace.
AIAPI AIErr(*	GetRealMatrixValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRealMatrix *value)
	Retrieves a transformation matrix value from a workspace.
AIAPI AIErr(*	SetRealMatrixValue )(AIWorkspaceHandle workspace, const char prefix, const char suffix, AIRealMatrix value)
	Sets a transformation matrix value for a workspace.

Detailed Description

This suite allows you to access workspaces.

A workspace is an object in which to store the screen layout of floating tabbed palettes, such as the Tool and Control palettes. The workspace can store current size, visibility, physical location, docking information, and any other palette-specific options (such as the list view option in the brushes palette).

These functions retrieve and set values in the workspace object, according to the data type.

The workspace does not control persistence, which governs the behavior at startup. This is determined in the individual libraries (Brush, Graphic Style, Swatch, and Symbol).

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIWorkspaceSuite and kAIWorkspaceVersion.

Member Data Documentation

AIAPI AIErr(* AIWorkspaceSuite::GetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean *value)

Retrieves a boolean value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, int *value)

Retrieves an integer value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint *value)

Retrieves a point value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix *value)

Retrieves a transformation matrix value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint *value)

Retrieves a real-number point value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetRealRectValue)(AIWorkspaceHandle collectioRef, const char *prefix, const char *suffix, AIRealRect *value)

Retrieves a real-number rectangle value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal *value)

Retrieves a real-number value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect *value)

Retrieves a rectangle value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::GetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, char *value, ai::int32 length)

Retrieves a string value from a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	[out] A buffer in which to return the value.

AIAPI AIErr(* AIWorkspaceSuite::SetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean value)

Sets a boolean value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, ai::int32 value)

Sets an integer value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint value)

Sets a point value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix value)

Sets a transformation matrix value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint value)

Sets a real-number point value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetRealRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealRect value)

Sets a real-number rectangle value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal value)

Sets a real-number value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect value)

Sets a rectangle value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

AIAPI AIErr(* AIWorkspaceSuite::SetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, const char *value)

Sets a string value for a workspace.

Parameters:

	workspace	The workspace object.
	prefix	The palette name, as returned by `sADMDialog->GetDialogName(fDialog)`.
	suffix	A configuration item in the plug-in, such as "ListView" or "ShowOption".
	value	The new value.

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

AIWorkspace.h

AIWorkspaceSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIWorkspaceSuite Struct Reference
[API Suite List]