AILayerListSuite Struct Reference
[API Suite List]

The artwork in an Illustrator document is contained within layers. More...

#include <AILayerList.h>

Public Attributes
AIAPI AIErr(*	Push )(SPPluginRef self, char tag, void data, AILayerListMode mode, AILayerList *list)
	Creates a new layer list and pushes it onto the stack, making it current.
AIAPI AIErr(*	Pop )(void)
	Pops the current layer list from the top of the layer list stack.
AIAPI AIErr(*	GetLayerOfArt )(AIArtHandle art, AILayerList list, AILayerHandle layer)
	Retrieves both the layer list and the layer on which an art object resides, if any.
AIAPI AIErr(*	Count )(ai::int32 *count)
	Gets the number of layer lists on the stack.
AIAPI AIErr(*	GetFirst )(AILayerList *list)
	Retrieves the current layer list (the most recently pushed list at the top of the stack).
AIAPI AIErr(*	GetLast )(AILayerList *list)
	Retrieves the document layer list (the bottom of the stack).
AIAPI AIErr(*	GetNext )(AILayerList list, AILayerList *next)
	Retrieves the next lower layer list in the stack.
AIAPI AIErr(*	CountLayers )(AILayerList list, ai::int32 *count)
	Gets the number of layers in a layer list.
AIAPI AIErr(*	GetFirstLayer )(AILayerList list, AILayerHandle *layer)
	Retrieves the topmost layer in the stacking order of a layer list.
AIAPI AIErr(*	GetLastLayer )(AILayerList list, AILayerHandle *layer)
	Retrieves the bottommost layer in the stacking order of a layer list.
AIAPI AIErr(*	GetNextLayer )(AILayerList list, AILayerHandle layer, AILayerHandle *next)
	Retrieves the next lower layer in the stacking order of a layer list.
AIAPI AIErr(*	GetPrevLayer )(AILayerList list, AILayerHandle layer, AILayerHandle *prev)
	Retrieves the next higher layer in the stacking order of a layer list.
AIAPI AIErr(*	SetDisplayMode )(AILayerList list, AILayerListMode mode)
	Sets the display mode to be used when rendering the layer list.
AIAPI AILayerListMode(*	GetDisplayMode )(AILayerList list)
	Retrieves the display mode used when rendering the layer list.
AIAPI const char (	GetTag )(AILayerList list)
	Retrieves the tag that identifies the purpose of a layer list.
AIAPI AIErr(*	SetEditabilityMode )(AILayerList list, AILayerListEditabilityMode mode)
	Sets the editability mode of a layer list.
AIAPI AILayerListEditabilityMode(*	GetEditabilityMode )(AILayerList list)
	Retrieves the editability mode of a layer list.

Detailed Description

The artwork in an Illustrator document is contained within layers.

A list of layers, the document layer list, is saved when a document is saved. It is possible to create new layer lists, which are maintained in a stack. The bottommost list on the stack is the document layer list. The topmost list, called the current layer list, contains artwork that the user is currently editing.

Editing operations do not normally affect objects in layer lists below the current list.Most functions operate only on layers in the current layer list. For example, the AILayerSuite allows you to access the layers in a list sequentially, but the functions operate only on the current list. Similarly the AIMatchingArtSuite functions operate only on the current layer list.

Each layer list has a display mode, which affects how the contents of the layer list are drawn, and an editability mode, which affects the editing operations allowed on the list.

Each layer list is given a tag when it is pushed onto the stack, which identifies the purpose of the list, either kAIDocumentLayerList or kAITransparencyMaskLayerList.

There is one notifier associated with the layer lists, kAILayerListChangedNotifier.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAILayerListSuite and kAILayerListVersion.

Member Data Documentation

AIAPI AIErr(* AILayerListSuite::Count)(ai::int32 *count)

Gets the number of layer lists on the stack.

Use with GetFirst() and GetNext() to iterate through lists.

Parameters:

count

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

AIAPI AIErr(* AILayerListSuite::CountLayers)(AILayerList list, ai::int32 *count)

Gets the number of layers in a layer list.

Use with GetFirstLayer() and GetNextLayer() to iterate through the layers.

Parameters:

	list	The layer list.
	count	[out] A buffer in which to return the number of layers.

AIAPI AILayerListMode(* AILayerListSuite::GetDisplayMode)(AILayerList list)

Retrieves the display mode used when rendering the layer list.

(Note that this function returns a constant value, not an error code.)

Parameters:

list

The layer list.

Returns:: The display mode, an AILayerListModeValues value.

AIAPI AILayerListEditabilityMode(* AILayerListSuite::GetEditabilityMode)(AILayerList list)

Retrieves the editability mode of a layer list.

(Note that this function returns a constant value, not an error code.)

Parameters:

list

The layer list.

Returns:: The mode, one of the AILayerListEditabilityModeValues.

AIAPI AIErr(* AILayerListSuite::GetFirst)(AILayerList *list)

Retrieves the current layer list (the most recently pushed list at the top of the stack).

Parameters:

list

[out] A buffer in which to return the layer list.

AIAPI AIErr(* AILayerListSuite::GetFirstLayer)(AILayerList list, AILayerHandle *layer)

Retrieves the topmost layer in the stacking order of a layer list.

Parameters:

	list	The layer list.
	layer	[out] A buffer in which to return the layer.

AIAPI AIErr(* AILayerListSuite::GetLast)(AILayerList *list)

Retrieves the document layer list (the bottom of the stack).

Parameters:

list

[out] A buffer in which to return the layer list.

AIAPI AIErr(* AILayerListSuite::GetLastLayer)(AILayerList list, AILayerHandle *layer)

Retrieves the bottommost layer in the stacking order of a layer list.

Parameters:

	list	The layer list.
	layer	[out] A buffer in which to return the layer.

AIAPI AIErr(* AILayerListSuite::GetLayerOfArt)(AIArtHandle art, AILayerList *list, AILayerHandle *layer)

Retrieves both the layer list and the layer on which an art object resides, if any.

Parameters:

	art	The art object.
	list	[out] A buffer in which to return the layer list, or `NULL` if this information is not needed.
	layer	[out] A buffer in which to return the layer, or `NULL` if this information is not needed.

AIAPI AIErr(* AILayerListSuite::GetNext)(AILayerList list, AILayerList *next)

Retrieves the next lower layer list in the stack.

Parameters:

	list	A layer list in the stack.
	next	[out] A buffer in which to return the next layer list, or `NULL` if this is the lowest list.

AIAPI AIErr(* AILayerListSuite::GetNextLayer)(AILayerList list, AILayerHandle layer, AILayerHandle *next)

Retrieves the next lower layer in the stacking order of a layer list.

Parameters:

	list	The layer list.
	layer	A layer in the list.
	layer	[out] A buffer in which to return the next lower layer, or `NULL` if this is the lowest layer.

AIAPI AIErr(* AILayerListSuite::GetPrevLayer)(AILayerList list, AILayerHandle layer, AILayerHandle *prev)

Retrieves the next higher layer in the stacking order of a layer list.

Parameters:

	list	The layer list.
	layer	A layer in the list.
	layer	[out] A buffer in which to return the next higher layer, or `NULL` if this is the highest layer.

AIAPI const char*(* AILayerListSuite::GetTag)(AILayerList list)

Retrieves the tag that identifies the purpose of a layer list.

(Note that this function returns a constant value, not an error code.)

Parameters:

list

The layer list.

Returns:: The tag, kAIDocumentLayerList or kAITransparencyMaskLayerList.

AIAPI AIErr(* AILayerListSuite::Pop)(void)

Pops the current layer list from the top of the layer list stack.

The plug-in that pushed the layer list receives the kSelectorAIPopLayerList message which allows it to perform any actions associated with the pop, even if it did not initiate the pop.

AIAPI AIErr(* AILayerListSuite::Push)(SPPluginRef self, char *tag, void *data, AILayerListMode mode, AILayerList *list)

Creates a new layer list and pushes it onto the stack, making it current.

The plug-in receives the kSelectorAIPushLayerList message before the call returns, allowing it to initialize the list.

Parameters:

	self	This plug-in
	tag	The type of list, one of `kAIDocumentLayerList` or `kAITransparencyMaskLayerList`.
	data	A pointer to developer-defined data to be passed to `kSelectorAIPushLayerList` in `AILayerListMessage::data`. Parameter may be `NULL`.
	mode	The display and editability mode of the new layer list.
	list	[out] A buffer in which to return the new layer list. This memory is not freed until it is no longer needed for undo/redo. of push or pop operations. The plug-in must preserve its private data for the list until it receives the `kSelectorAIDeleteLayerList` message. Parameter may be `NULL`.

AIAPI AIErr(* AILayerListSuite::SetDisplayMode)(AILayerList list, AILayerListMode mode)

Sets the display mode to be used when rendering the layer list.

Parameters:

	list	The layer list.
	mode	The new display mode, an `AILayerListModeValues` value.

AIAPI AIErr(* AILayerListSuite::SetEditabilityMode)(AILayerList list, AILayerListEditabilityMode mode)

Sets the editability mode of a layer list.

Use to set non-default editability for a transparency-mask layer. It is best to set this immediately after initializing the layer list, while processing the kSelectorAIPushLayerList message. You cannot modify the editability mode of the document layer list.

Parameters:

	list	The layer list.
	mode	The new editability mode, one of the `AILayerListEditabilityModeValues`.

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

AILayerList.h

AILayerListSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AILayerListSuite Struct Reference
[API Suite List]