AISwatchLibraries.h File Reference

#include "ASTypes.h"
#include "AIColor.h"
#include "AISwatchList.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AISwatchLibraryChangedNotifierData
	Message data sent with kAISwatchLibraryChangedNotifier. More...
struct	AISwatchLibrariesSuite
	Supplied by the Swatch Libraries plug-in, these functions allow you to open, access, and manipulate libraries of color, custom color, pattern, and gradient swatches, also called swatch lists. More...
Defines
#define	kAISwatchLibrariesSuite   "AI Swatch Libraries Suite"
#define	kAISwatchLibrariesSuiteVersion   AIAPI_VERSION(8)
#define	kAISwatchLibrariesVersion   kAISwatchLibrariesSuiteVersion
#define	kAISwatchLibsCaller   "Swatch Libraries"
	Caller ID for messages sent to plug-ins from the Swatch Libraries plug-in.
#define	kAISwatchLibraryChangedNotifier   "AI Swatch Library Changed Notifier"
	Sent when the Swatch Library is opened and has been modified since the last load or when it is reloaded because the user saved to it.
#define	kAIPresetSwatches   1
	An AISwatchLibraryType value.
#define	kAIPresetColorBooks   2
	An AISwatchLibraryType value.
#define	kAIPresetGradients   4
	An AISwatchLibraryType value.
#define	kAIPresetPatterns   8
	An AISwatchLibraryType value.
#define	kAIUserWritableSwatches   16
	An AISwatchLibraryType value.
#define	kAIOtherLibraries   32
	An AISwatchLibraryType value.
#define	kAIAllSwatchLibraries   kAIPresetSwatches | kAIPresetColorBooks | kAIPresetGradients | kAIPresetPatterns | kAIUserWritableSwatches | kAIOtherLibraries
	An AISwatchLibraryType value.
#define	kSwatchDoesNotExistErr   '!SNE'
	See AISwatchLibrariesSuite::GetRelativeDocSwatch().
#define	kNoActiveSwatchError   '!NAS'
	See AISwatchLibrariesSuite::GetRelativeDocSwatch().
Typedefs
typedef struct _t_OS_MenuPtr *	AIMenuPtr
typedef ai::uint32	AISwatchLibraryType
	Specifies the library types that should be included when building a library list.
Enumerations
enum	AIRelativeDocSwatchKind {   kAICurDocSwatch, kAINextDocSwatch, kAIPrevDocSwatch, kAISwatchInNextDocSwatchGroup,   kAISwatchInPrevDocSwatchGroup }
	Specifies a swatch position relative to the currently active swatch in a document Swatch palette. More...
enum	AIWhichDocSwatchesPalette { kAIMainDocSwatches, kAIDocFillSwatches, kAIDocStrokeSwatches }
	Specifies which Swatches palette for the current document is the target of a swatch selection query. More...

---

Detailed Description

---

Define Documentation

#define kAIAllSwatchLibraries   kAIPresetSwatches | kAIPresetColorBooks | kAIPresetGradients | kAIPresetPatterns | kAIUserWritableSwatches | kAIOtherLibraries

An AISwatchLibraryType value.

Include all libraries.

#define kAIOtherLibraries   32

An AISwatchLibraryType value.

Include other libraries opened from Illustrator.

#define kAIPresetColorBooks   2

An AISwatchLibraryType value.

Include all libraries in the Preset ColorBooks folder.

#define kAIPresetGradients   4

An AISwatchLibraryType value.

Include all libraries in the Preset Gradients folder.

#define kAIPresetPatterns   8

An AISwatchLibraryType value.

Include all libraries in the Preset Patterns folder.

#define kAIPresetSwatches   1

An AISwatchLibraryType value.

Include all libraries in the Preset Swatches folder. This does not include the preset color books, gradients and patterns folders.

#define kAISwatchLibrariesSuite   "AI Swatch Libraries Suite"

#define kAISwatchLibrariesSuiteVersion   AIAPI_VERSION(8)

#define kAISwatchLibrariesVersion   kAISwatchLibrariesSuiteVersion

#define kAIUserWritableSwatches   16

An AISwatchLibraryType value.

Include all libraries in the User Writable Swatch libraries folder.

---

Typedef Documentation

typedef struct _t_OS_MenuPtr* AIMenuPtr

typedef ai::uint32 AISwatchLibraryType

Specifies the library types that should be included when building a library list.

See AISwatchLibrariesSuite::BuildLibrariesList(). For the various folder types see AIFoldersSuite

---

Enumeration Type Documentation

enum AIRelativeDocSwatchKind

Specifies a swatch position relative to the currently active swatch in a document Swatch palette.

The behavior depends on whether wrapping is on or off. See AISwatchLibrariesSuite::GetRelativeDocSwatch()

Enumerator:

kAICurDocSwatch	The active swatch itself.
kAINextDocSwatch	The next swatch in the group or list.
kAIPrevDocSwatch	The previous swatch in the group or list.
kAISwatchInNextDocSwatchGroup	The first swatch in the next group.
kAISwatchInPrevDocSwatchGroup	The last swatch in the previous group.

enum AIWhichDocSwatchesPalette

Specifies which Swatches palette for the current document is the target of a swatch selection query.

See AISwatchLibrariesSuite::GetRelativeDocSwatch()

Enumerator:

kAIMainDocSwatches	The main swatches palette in the regular palette.
kAIDocFillSwatches	The Fill swatches palette in the Control palette. When the toolbox's Fill/Stroke indicator is in Fill mode, this has the same selection as the main document Swatches palette.
kAIDocStrokeSwatches	The Stroke swatches palette in the Control palette. When the toolbox's Fill/Stroke indicator is in Stroke mode, this has the same selection as the main document Swatches palette.