AIEntry.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AILayer.h"
#include "AICustomColor.h"
#include "AIObjectSet.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIEntrySuite
	This suite provides functions for constructing and inspecting dictionary and array entries. More...
Defines
#define	kAIEntrySuite   "AI Entry Suite"
#define	kAIEntrySuiteVersion7   AIAPI_VERSION(7)
#define	kAIEntrySuiteVersion   kAIEntrySuiteVersion7
#define	kAIEntryVersion   kAIEntrySuiteVersion
#define	kNoSuchEntry   'EnNS'
#define	kWrongEntryType   100
	Returned when trying to access an entries value and the entry is not of the requested type.
#define	kNoConversionErr   'NoCV'
	Returned when trying to convert an entry to a particular value type and the underlying value of the entry is not convertible.
Typedefs
typedef struct _AIEntry *	AIEntryRef
	A reference to a container dictionary entry, which associates a string key with a value of a given type (AIEntryType).
typedef struct _AIArray *	AIArrayRef
	An array is a heterogeneous sequence of entries indexed by integers.
typedef struct _AIDictionary *	AIDictionaryRef
	A dictionary is a heterogeneous collection of entries indexed by keys that are character strings.
typedef struct _AIDictionary *	ConstAIDictionaryRef
typedef struct _AIUID *	AIUIDRef
	A unique identifier, which can be stored in dictionaries and arrays.
typedef struct _AIUIDREF *	AIUIDREFRef
	An opaque reference to a unique identifier.
typedef struct _AIXMLNode *	AIXMLNodeRef
	A reference to an XML element.
typedef struct _t_AISVGFilterOpaque *	AISVGFilterHandle
	A reference to an SVG filter.
typedef struct _t_AIArtStyle *	AIArtStyleHandle
	A reference to an art style.
typedef ai::int32	AIEntryType
	Container entry type, the data type for the value of an entry.
Enumerations
enum	{   UnknownType, IntegerType, BooleanType, RealType,   StringType, DictType, ArrayType, BinaryType,   PointType, MatrixType, PatternRefType, BrushPatternRefType,   CustomColorRefType, GradientRefType, PluginObjectRefType, FillStyleType,   StrokeStyleType, UIDType, UIDREFType, XMLNodeType,   SVGFilterType, ArtStyleType, SymbolPatternRefType, GraphDesignRefType,   BlendStyleType, GraphicObjectType, UnicodeStringType, PointerType,   ArtworkPointType, SmoothShadingType }
	The container entry types. More...

---

Detailed Description

---

Define Documentation

#define kAIEntrySuite   "AI Entry Suite"

#define kAIEntrySuiteVersion   kAIEntrySuiteVersion7

#define kAIEntrySuiteVersion7   AIAPI_VERSION(7)

#define kAIEntryVersion   kAIEntrySuiteVersion

---

Typedef Documentation

typedef struct _AIArray* AIArrayRef

An array is a heterogeneous sequence of entries indexed by integers.

See also:

AIArraySuite

typedef struct _t_AIArtStyle* AIArtStyleHandle

A reference to an art style.

See also:

AIArtStyleSuite.

typedef struct _AIDictionary* AIDictionaryRef

A dictionary is a heterogeneous collection of entries indexed by keys that are character strings.

See also:

AIDictionarySuite

typedef struct _AIEntry* AIEntryRef

A reference to a container dictionary entry, which associates a string key with a value of a given type (AIEntryType).

• Use the AIDictionarySuite functions to get and set keys, and to get and set entries by key.
• Use the AIEntrySuite functions to get and set entry values of specific data types.

typedef ai::int32 AIEntryType

Container entry type, the data type for the value of an entry.

typedef struct _t_AISVGFilterOpaque* AISVGFilterHandle

A reference to an SVG filter.

See also:

AISVGFilterSuite

typedef struct _AIUID* AIUIDRef

A unique identifier, which can be stored in dictionaries and arrays.

A unique identifier cannot occur in more than one container, or more than once in a container.

See also:

AIUIDREFSuite

typedef struct _AIUIDREF* AIUIDREFRef

An opaque reference to a unique identifier.

The AIEntrySuite provides methods to convert between AIEntryRef and AIUIDRef.

See also:

AIUIDREFSuite

typedef struct _AIXMLNode* AIXMLNodeRef

A reference to an XML element.

See also:

AIXMLElementSuite

typedef struct _AIDictionary* ConstAIDictionaryRef

---

Enumeration Type Documentation

anonymous enum

The container entry types.

Some correspond directly to data types, and some to objects defined in other suites.

Enumerator:

UnknownType	Value type is unknown to this version of the API.
IntegerType	Integer (32 bit signed).
BooleanType	Boolean.
RealType	Real (single precision floating point).
StringType	String (null terminated sequence of 8-bit values).
DictType	Dictionary. An art object is stored in a container by storing its dictionary.
ArrayType	Array.
BinaryType	Binary data. If you store the data to file, you are responsible for the byte order of the data.
PointType	An (x,y) location. A convenience over an ArrayType of 2 Reals
MatrixType	A transformation matrix. A convenience over an ArrayType of 6 Reals
PatternRefType	A reference to a pattern. See AIPatternSuite.
BrushPatternRefType	A reference to a brush pattern.
CustomColorRefType	A reference to a custom color (either spot or global process). See AICustomColorSuite.
GradientRefType	A reference to a gradient. See AIGradientSuite.
PluginObjectRefType	A reference to a plug-in global object. See AIPluginSuite.
FillStyleType	A fill style. See AIArtStyleSuite.
StrokeStyleType	A stroke style. See AIArtStyleSuite.
UIDType	A unique identifier. See AIUIDSuite.
UIDREFType	A unique identifier reference. See AIUIDSuite.
XMLNodeType	An XML node. See AIXMLElementSuite.
SVGFilterType	An SVG filter. See AISVGFilterSuite.
ArtStyleType	An art style. See AIArtStyleSuite.
SymbolPatternRefType	A symbol definition reference. See AISymbolSuite.
GraphDesignRefType	A graph design reference.
BlendStyleType	A blend style (transparency attributes). See AIGradientSuite.
GraphicObjectType	A graphical object.
UnicodeStringType	A UnicodeString object. See AIUnicodeStringSuite.
PointerType	A pointer which is 8-bytes in 64-bit and 4-bytes in 32 bit.
ArtworkPointType	PointType which is written as relative to ruler origin in document.
SmoothShadingType	A Smooth Shading Style. See ToDo AIArtStyleSuite.