AISwatchList.h File Reference

#include "AITypes.h"
#include "AIColor.h"
#include "AIDocument.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AISwatchListSuite
	This suite provides functions that allow you to access and modify swatches and swatch lists. More...
struct	AISwatchGroupSuite
	Swatch lists are hierarchically organized into swatch groups, which can be named. More...
Defines
#define	kAISwatchListSuite   "AI Swatch List Suite"
#define	kAISwatchListSuiteVersion7   AIAPI_VERSION(7)
#define	kAISwatchListSuiteVersion   kAISwatchListSuiteVersion7
#define	kAISwatchListVersion   kAISwatchListSuiteVersion
#define	kAISwatchGroupSuite   "AI Swatch Group Suite"
#define	kAISwatchGroupSuiteVersion3   AIAPI_VERSION(3)
#define	kAISwatchGroupSuiteVersion   kAISwatchGroupSuiteVersion3
#define	kAISwatchGroupVersion   kAISwatchGroupSuiteVersion
#define	kAISwatchLibraryDialogChangedNotifier   "AI Swatch Library Dialog Changed Notifier"
	Sent when a change is made to any swatch library from swatch library dialog.
#define	kAISwatchListChangedNotifier   "AI Swatch List Changed Notifier"
	Sent when a change is made to any swatch list for any open document (including libraries).
#define	kAISwatchListChangedInternallyNotifier   "AI Swatch List Changed Internally Notifier"
	Sent when the definition of an object in the swatch list has changed.
#define	kAISwatchReplaceColorNotifier   "AI Swatch Replace Color Notifier"
	Sent when a color is replaced in a swatch.
#define	kAICreateNewSwatchNotifier   "AI Create New Swatch Notifier"
	Sent when a new swatch is created.
#define	kAIDeleteSwatchNotifier   "AI Delete Selected Swatch Notifier"
	Sent when a selected swatch is deleted.
#define	kAICreateNewSwatchWithDefaultParamNotifier   "AI Create New Swatch With Default Param Notifier"
	Sent when a new swatch is created.
#define	kAIDocSwatchesSelectionChangedNotifier   "AI Doc Swatches Selection Changed Notifier"
	Sent when the selection state of the document Swatches palette changes.
#define	kCantDeleteSwatchErr   '!XDS'
	See AISwatchListSuite.
#define	kInvalidSwatchTypeForDest   '!vST'
	See AISwatchListSuite.
#define	kTooManySwatchGroupsErr   '>#sg'
	See AISwatchGroupSuite.
#define	kTooManySwatchesInGrpErr   '>#sw'
	See AISwatchGroupSuite.
#define	kMaxNumberSwatchGroups   ((ASInt16) 0x7FFF)
	Maximum allowed number of swatch groups.
#define	kMaxNumberSwatchesPerGroup   ((ASInt16) 0xFFFF)
	Maximum allowed number of swatches in a swatch group.
Typedefs
typedef struct _AISwatchOpaque *	AISwatchRef
	Opaque reference to a swatch.
typedef struct _AISwatchListOpaque *	AISwatchListRef
	Opaque reference to a swatch list.
typedef struct _AISwatchGroupOpaque *	AISwatchGroupRef
	Opaque reference to a swatch group.See AISwatchGroupSuite.
Enumerations
enum	AISwatchGroupKind { kAISGKindGeneric, kAISGKindSolidColorsOnly, kAISGKindPatternsOnly, kAISGKindGradientsOnly }
	Restrictions on the kinds of swatches allowed in a swatch groups. More...

---

Detailed Description

---

Define Documentation

#define kAICreateNewSwatchNotifier   "AI Create New Swatch Notifier"

Sent when a new swatch is created.

See AISwatchListSuite.

#define kAICreateNewSwatchWithDefaultParamNotifier   "AI Create New Swatch With Default Param Notifier"

Sent when a new swatch is created.

See AISwatchListSuite.

#define kAIDeleteSwatchNotifier   "AI Delete Selected Swatch Notifier"

Sent when a selected swatch is deleted.

See AISwatchListSuite.

#define kAIDocSwatchesSelectionChangedNotifier   "AI Doc Swatches Selection Changed Notifier"

Sent when the selection state of the document Swatches palette changes.

See AISwatchListSuite.

#define kAISwatchGroupSuite   "AI Swatch Group Suite"

#define kAISwatchGroupSuiteVersion   kAISwatchGroupSuiteVersion3

#define kAISwatchGroupSuiteVersion3   AIAPI_VERSION(3)

#define kAISwatchGroupVersion   kAISwatchGroupSuiteVersion

#define kAISwatchLibraryDialogChangedNotifier   "AI Swatch Library Dialog Changed Notifier"

Sent when a change is made to any swatch library from swatch library dialog.

Changes include change of swatch library using left/right arrow keys.

#define kAISwatchListChangedInternallyNotifier   "AI Swatch List Changed Internally Notifier"

Sent when the definition of an object in the swatch list has changed.

Can be followed by a kAISwatchListChangedNotifier if the swatch list itself has also changed. If both are sent, both have the same refStamp as their notifier data. See AISwatchListSuite.

#define kAISwatchListChangedNotifier   "AI Swatch List Changed Notifier"

Sent when a change is made to any swatch list for any open document (including libraries).

Changes include insertion or deletion of a swatch, and redefinition of a swatch color or name. No data is sent with the notifier. Use AISwatchListSuite functions to determine what change occurred.

#define kAISwatchListSuite   "AI Swatch List Suite"

#define kAISwatchListSuiteVersion   kAISwatchListSuiteVersion7

#define kAISwatchListSuiteVersion7   AIAPI_VERSION(7)

#define kAISwatchListVersion   kAISwatchListSuiteVersion

#define kAISwatchReplaceColorNotifier   "AI Swatch Replace Color Notifier"

Sent when a color is replaced in a swatch.

See AISwatchListSuite.

#define kMaxNumberSwatchesPerGroup   ((ASInt16) 0xFFFF)

Maximum allowed number of swatches in a swatch group.

See AISwatchGroupSuite.

#define kMaxNumberSwatchGroups   ((ASInt16) 0x7FFF)

Maximum allowed number of swatch groups.

See AISwatchGroupSuite.

---

Typedef Documentation

typedef struct _AISwatchGroupOpaque* AISwatchGroupRef

Opaque reference to a swatch group.See AISwatchGroupSuite.

typedef struct _AISwatchListOpaque* AISwatchListRef

Opaque reference to a swatch list.

See AISwatchListSuite.

typedef struct _AISwatchOpaque* AISwatchRef

Opaque reference to a swatch.

See AISwatchListSuite.

---

Enumeration Type Documentation

enum AISwatchGroupKind

Restrictions on the kinds of swatches allowed in a swatch groups.

See AISwatchGroupSuite::NewSwatchGroup(), AISwatchGroupSuite::GetSwatchGroupKind().

Enumerator:

kAISGKindGeneric	The group can contain any kind of swatches, and usually has a null name. The first swatch group (index 0) must be of this kind.
kAISGKindSolidColorsOnly	The group cannot contain patterns or gradients, but can contain tints of global colors. Is usually named.
kAISGKindPatternsOnly	The group is only allowed to contain pattern swatches. Is usually named.
kAISGKindGradientsOnly	The group is only allowed to contain gradient swatches. Is usually named.