AILayerList.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "SPPlugs.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AILayerListMessage
	The message data for layer list messages. More...
struct	AILayerListSuite
	The artwork in an Illustrator document is contained within layers. More...
Defines
#define	kAILayerListSuite   "AI Layer List"
#define	kAILayerListSuiteVersion4   AIAPI_VERSION(4)
#define	kAILayerListSuiteVersion   kAILayerListSuiteVersion4
#define	kAILayerListVersion   kAILayerListSuiteVersion
#define	kCallerAILayerList   "AI Layer List"
	Caller for layer list messages.
#define	kSelectorAIPushLayerList   "AI Push Layer List"
	Sent to the plug-in owning a layer list when it is pushed onto the stack.
#define	kSelectorAIPopLayerList   "AI Pop Layer List"
	Sent to the plug-in owning a layer list when it is popped.
#define	kSelectorAIDeleteLayerList   "AI Delete Layer List"
	Sent to the plug-in owning a layer list to request that it dispose of any data it allocated on push.
#define	kAILayerListChangedNotifier   "AI Edit Layer List Changed Notifier"
	Sent when a layer list is pushed or popped.
#define	kAIDocumentLayerList   "AI Document Layer List"
	Tag for the document layer list.
#define	kAITransparencyMaskLayerList   "AI Transparency Mask Layer List"
	Tag for a transparency mask layer list.
Typedefs
typedef struct LayerList *	AILayerList
	An opaque reference to a layer list.
typedef ai::int32	AILayerListMode
	Controls how the contents of a layer list are rendered.
typedef ai::int32	AILayerListEditabilityMode
	Controls the types of editing operations allowed for a layer list, one of the AILayerListEditabilityModeValues.
Enumerations
enum	AILayerListModeRenderingOptions { kAILayerListRenderMask = (0x000000FF), kAILayerListRenderSelection = (1<<0), kAILayerListRenderPreview = (1<<1) }
	What is rendered when a layer list is drawn. More...
enum	AILayerListModePreviewOptions { kAILayerListPreviewMask = (0x00000F00), kAILayerListPreviewColor = (0<<8), kAILayerListPreviewGray = (1<<8) }
	How previews of objects on a layer list are drawn, when AILayerListModeRenderingOptions::kAILayerListRenderPreview is set. More...
enum	AILayerListModeValues { kAILayerListInvisibleMode = 0, kAILayerListSelectionMode = kAILayerListRenderSelection, kAILayerListPreviewMode = (kAILayerListRenderSelection|kAILayerListRenderPreview), kAILayerListGrayscaleMode = (kAILayerListRenderSelection|kAILayerListRenderPreview|kAILayerListPreviewGray) }
	Pre-defined combinations of AILayerListModeRenderingOptions and AILayerListModePreviewOptions. More...
enum	AILayerListEditabilityModeValues { kAIRegularEditabilityMode = 0, kAINoNewLayersMode = (1<<0) }
	Layer list editability modes. More...

---

Detailed Description

---

Define Documentation

#define kAIDocumentLayerList   "AI Document Layer List"

Tag for the document layer list.

#define kAILayerListSuite   "AI Layer List"

#define kAILayerListSuiteVersion   kAILayerListSuiteVersion4

#define kAILayerListSuiteVersion4   AIAPI_VERSION(4)

#define kAILayerListVersion   kAILayerListSuiteVersion

#define kAITransparencyMaskLayerList   "AI Transparency Mask Layer List"

Tag for a transparency mask layer list.

---

Typedef Documentation

typedef struct LayerList* AILayerList

An opaque reference to a layer list.

typedef ai::int32 AILayerListEditabilityMode

Controls the types of editing operations allowed for a layer list, one of the AILayerListEditabilityModeValues.

typedef ai::int32 AILayerListMode

Controls how the contents of a layer list are rendered.

A logical OR of an AILayerListModeRenderingOptions value and an AILayerListModePreviewOptions value. Predefined combinations are defined by AILayerListModeValues.

---

Enumeration Type Documentation

enum AILayerListEditabilityModeValues

Layer list editability modes.

Enumerator:

kAIRegularEditabilityMode	Allows all types of edits. Set by default when a new layer list is pushed.
kAINoNewLayersMode	Forces the Layers palette to disable the new layer and new sublayer functionality. Transparency mask layer lists use this mode.

enum AILayerListModePreviewOptions

How previews of objects on a layer list are drawn, when AILayerListModeRenderingOptions::kAILayerListRenderPreview is set.

See also:

AILayerListMode
AILayerListModeValues

Enumerator:

kAILayerListPreviewMask	Mask value to isolate the preview option bits from the AILayerListMode.
kAILayerListPreviewColor	Draw a full color preview.
kAILayerListPreviewGray	Draw a grayscale preview.

enum AILayerListModeRenderingOptions

What is rendered when a layer list is drawn.

See also:

AILayerListMode
AILayerListModeValues

Enumerator:

kAILayerListRenderMask	Mask value to isolate the rendering option bits from the AILayerListMode.
kAILayerListRenderSelection	Render only the selection highlighting on the layer list.
kAILayerListRenderPreview	Render both the selection highlighting and the previews of the objects on the layer list.

enum AILayerListModeValues

Pre-defined combinations of AILayerListModeRenderingOptions and AILayerListModePreviewOptions.

See also:

AILayerListMode

Enumerator:

kAILayerListInvisibleMode	Draws neither selection highlighting nor the preview of objects.
kAILayerListSelectionMode	Draws only the selection highlighting of selected objects in the layer list.
kAILayerListPreviewMode	Draws both selection highlighting and preview of the objects.
kAILayerListGrayscaleMode	Draws both the selection highlighting and a grayscale preview of the objects.