ai Namespace Reference

These constants identifier can be used to determine the quadrant in a plane. More...

Namespaces
namespace	ArtboardUtils
	The `ArtboardUtils` object is a collection of utility functions for common operations.
namespace	PointTraits
namespace	RectTraits
Classes
class	AutoCoordinateSystem
	A stack object used to change the coordinate system to be used by Illustrator API functions. More...
class	Error
	Exception class thrown by C++ classes. More...
struct	CompileTimeChecker
	Provides compile-time errors that are similar to run-time assertions. More...
struct	CompileTimeChecker< false >
	There is no instantiation of CompileTimeChecker for a false value. More...
class	ArtboardProperties
	The `ArtboardProperties` object encapsulates all the attributes associated with an artboard. More...
class	ArtboardList
	The `ArtboardList` object is the interface to the set of artboards associated with a document. More...
class	SPAlloc
	Allocator object class for the AutoBuffer template. More...
class	AutoBuffer
	An `AutoBuffer` class object allows you to retrieve string contents into a buffer, or to pass or retrieve any array of data types, without having to manage the buffer's memory. More...
struct	PlatformTraits
	Encoding characteristics and functions for platform encoding. More...
struct	UTF8Traits
	Encoding characteristics and functions for UTF-8 encoding. More...
struct	UTF16Traits
	Encoding characteristics and functions for UTF-16 encoding. More...
class	EncodedString
	This class represents an encoded string. More...
class	ColorSpace
	This class represents an Illustrator color space. More...
class	ColorSpaceList
	This class represents a list of color spaces for Illustrator. More...
class	CopyScope
	A wrapper class for the `AICopyScopeHandle` object. More...
class	FilePath
class	Locale
	This class represents a predefined set of locales used in Illustrator, with a unique identifying code and associated descriptive string for the language and region. More...
class	Paint
	This class describes how an art object is painted using a fully-defined paint. More...
class	PartialPaint
	This class describes how an art object is painted using a partially-defined paint. More...
struct	Absolute
struct	Absolute< AIReal >
class	Ref
	Many object types are reference counted, such as dictionaries (`AIDictionaryRef`) and arrays (`AIArrayRef`). More...
class	NumberFormat
	Class used for locale-dependent number formatting. More...
class	const_PStr
	Constant Pascal string adapter object. More...
class	PStr
	Mutable Pascal string adapter object. More...
class	WCHARStr
	In Windows only. More...
class	UnicodeString
	`UnicodeString` objects provide basic string functionality for Unicode-based strings, similar to that provided by the standard C string library. More...
Typedefs
typedef signed char	int8
typedef unsigned char	uint8
typedef signed short	int16
typedef unsigned short	uint16
typedef int64_t	int64
typedef u_int64_t	uint64
typedef int32_t	int32
typedef u_int32_t	uint32
typedef ptrdiff_t	sizediff_t
typedef intptr_t	intptr
typedef uintptr_t	uintptr
typedef size_t	SizeType
typedef enum ai::Quadrant	Quadrant
typedef ai::int32	ArtboardID
	Artboard identifier.
typedef CAIArtboardProperties *	ArtboardRef
	Artboard object.
typedef CAIArtboardList *	ArtboardListRef
	Artboard list object.
typedef EncodedString < PlatformTraits >	PlatformString
	Encoded string type: platform encoding.
typedef EncodedString< UTF8Traits >	UTF8String
	Encoded string type: UTF-8 encoding.
typedef EncodedString < UTF16Traits >	UTF16String
	Encoded string type: UTF-16 encoding.
typedef Locale::ID	LocaleID
	Locale unique identifying code.
Enumerations
enum	ESliceOrigin { eSliceOrigin_autoGenerated, eSliceOrigin_layerGenerated, eSliceOrigin_userGenerated, eSliceOrigin_Unknown = kForceEnumSize }
	Identifies how a slice was created. More...
enum	ESliceType { eSliceType_NoImage, eSliceType_Image, eSliceType_Rollover, eSliceType_LinkedText, eSliceType_Unknown = kForceEnumSize }
	Identifies the type of a slice; see `ASSliceSettings`. More...
enum	ESliceHorzAlign { eSliceHorzAlign_Default = 0, eSliceHorzAlign_Left, eSliceHorzAlign_Center, eSliceHorzAlign_Right, eSliceHorzAlign_Unknown = kForceEnumSize }
	Horizontal alignment types for slices; see `ASSliceSettings`. More...
enum	ESliceVertAlign { eSliceVertAlign_Default = 0, eSliceVertAlign_Top, eSliceVertAlign_Middle, eSliceVertAlign_Bottom, eSliceVertAlign_Baseline, eSlicevertAlign_Unknown = kForceEnumSize }
	Vertical alignment types for slices; see `ASSliceSettings`. More...
enum	ESliceBGColorType { eSliceBGColorType_Color = 0, eSliceBGColorType_None, eSliceBGColorType_Matte, eSliceBGColorType_Unknown = kForceEnumSize }
	Background color types for slices; see `ASSliceSettings`. More...
enum	Quadrant { kFirstQuadrant = 1, kSecondQuadrant, kThirdQuadrant, kFourthQuadrant }
enum	IncrementPolicy { DoIncrement, DoNotIncrement }
Functions
template<typename T >
const T &	Min (const T &obj1, const T &obj2)
template<typename T >
const T &	Max (const T &obj1, const T &obj2)
void	check_ai_error (AIErr err)
	Validate an AIErr error code.
template<typename T >
void	check_precondition (T condition, AIErr err=kBadParameterErr)
	Validate that condition is met.
AICountedObjectSuite *	GetAICountedObjectSuitePtr ()
	Returns a valid reference to the counted-object suite, which can be passed to `ai::IAIRef` functions.
void	Replace (const RefReplaceParam &)
Variables
const ASInt32	kImageReadySlicesVersion = 5
	Version of ImageReady slices.
const ASInt32	kImageReadySlicesOriginVersion = 6
	Version of ImageReady slices.
const ASInt32	kInvalidSliceID = -1
	Identifies an invalid slice.
const ASInt32	kDefaultSliceID = 0
	Identifies the default slice.
const ASInt32	kInvalidSliceGroupID = -1
	Identifies an invalid slice group.
const ASInt32	kDefaultSliceGroupID = 0
	Identifies the default slice group.
const ASInt32	kFirstUserSliceGroupID = 1
	Identifies the first specifically defined slice group.
const ASInt32	kFirstUserSliceSoloGroupID = kFirstUserSliceGroupID + 100000
	Identifies the first group with a single slice (unlinked slice).
const ASInt32	kMinSliceDim = 1
	Minimum slice dimension value.
const ASInt32	kForceEnumSize = 0x7FFFFFFF
	Internal.
const ai::uint32	MaxPath = 259
const ai::uint32	MaxFile = 255

Detailed Description

These constants identifier can be used to determine the quadrant in a plane.

| SecondQ | FirstQ -------------------- ThirdQ | FourthQ |

Typedef Documentation

typedef ai::int32 ai::ArtboardID

Artboard identifier.

typedef CAIArtboardList* ai::ArtboardListRef

Artboard list object.

typedef CAIArtboardProperties* ai::ArtboardRef

Artboard object.

typedef signed short ai::int16

typedef int32_t ai::int32

typedef int64_t ai::int64

typedef signed char ai::int8

typedef intptr_t ai::intptr

typedef Locale::ID ai::LocaleID

Locale unique identifying code.

typedef EncodedString<PlatformTraits> ai::PlatformString

Encoded string type: platform encoding.

typedef enum ai::Quadrant ai::Quadrant

typedef ptrdiff_t ai::sizediff_t

typedef size_t ai::SizeType

typedef unsigned short ai::uint16

typedef u_int32_t ai::uint32

typedef u_int64_t ai::uint64

typedef unsigned char ai::uint8

typedef uintptr_t ai::uintptr

typedef EncodedString<UTF16Traits> ai::UTF16String

Encoded string type: UTF-16 encoding.

typedef EncodedString<UTF8Traits> ai::UTF8String

Encoded string type: UTF-8 encoding.

Enumeration Type Documentation

enum ai::ESliceBGColorType

Background color types for slices; see ASSliceSettings.

Enumerator:

eSliceBGColorType_Color	Color, "colorBGColor".
eSliceBGColorType_None	None, "noneBGColor".
eSliceBGColorType_Matte	Matte, "matteBGColor".
eSliceBGColorType_Unknown	Internal.

enum ai::ESliceHorzAlign

Horizontal alignment types for slices; see ASSliceSettings.

Enumerator:

eSliceHorzAlign_Default	Default, "defaultHAlign".
eSliceHorzAlign_Left	Left, "leftHAlign".
eSliceHorzAlign_Center	Center, "centerHAlign".
eSliceHorzAlign_Right	Right, "rightHAlign".
eSliceHorzAlign_Unknown	Internal.

enum ai::ESliceOrigin

Identifies how a slice was created.

Enumerator:

eSliceOrigin_autoGenerated	Created automatically, "autoOrigin".
eSliceOrigin_layerGenerated	Created as part of layer creation, "layerOrigin".
eSliceOrigin_userGenerated	Created by the user, "userOrigin".
eSliceOrigin_Unknown	Internal.

enum ai::ESliceType

Identifies the type of a slice; see ASSliceSettings.

Enumerator:

eSliceType_NoImage	"noImageType"
eSliceType_Image	"imageType"
eSliceType_Rollover	"rollovertType"
eSliceType_LinkedText	"likedType"
eSliceType_Unknown

enum ai::ESliceVertAlign

Vertical alignment types for slices; see ASSliceSettings.

Enumerator:

eSliceVertAlign_Default	Default, "defaultVAlign".
eSliceVertAlign_Top	Top, "topVAlign".
eSliceVertAlign_Middle	Middle, "middleVAlign".
eSliceVertAlign_Bottom	Bottom, "bottomVAlign".
eSliceVertAlign_Baseline	Baseline, "baselineVAlign".
eSlicevertAlign_Unknown	Internal.

enum ai::IncrementPolicy

Enumerator:

DoIncrement

DoNotIncrement

Cause the reference count of newly assigned objects to be incremented.

Prevent the reference count of newly assigned objects from being incremented

enum ai::Quadrant

Enumerator:

kFirstQuadrant
kSecondQuadrant
kThirdQuadrant
kFourthQuadrant

Function Documentation

void ai::check_ai_error ( AIErr err ) [inline]

Validate an AIErr error code.

Throw an ai::Error exception if the provided code is not kNoErr.

Parameters:

err

error code to be tested.

References kNoErr.

template<typename T >

void ai::check_precondition	(	T	condition,
		AIErr	err = `kBadParameterErr`
	)			`[inline]`

Validate that condition is met.

Throw an ai::Error exception if the condition is not met. Unless otherwise specified in err the exception is thrown with kBadParameterErr.

Parameters:

	condition	value to be evaluated as a boolean condition.
	err	[optional] exception value to be thrown as an ai::Error if /c condition is not met.

AICountedObjectSuite * ai::GetAICountedObjectSuitePtr ( ) [inline]

Returns a valid reference to the counted-object suite, which can be passed to ai::IAIRef functions.

Implements GetAICountedObjectSuitePtr for standard naked suite pointers.

This function must be defined by each plug-in that uses this header. This header defines a default implementation for the function, which assumes that the global variable sAICountedObject contains a pointer to the suite, and returns the value of that pointer.

If your plug-in needs a different definition, you must first disable the default definition in this file by setting the constant

define AICOUNTEDOBJECTSUITE_DEFINED

to 1. You can then add your own definition of the function to the plug-in. For example, the file IAIRefAutoSuite.cpp supplies a definition of the function that assumes the counted object suite is supplied using the facilities of AutoSuite.h.

(The pointer to the suite is stored in a global variable of type AICountedObjectSuite*.)

References sAICountedObject.

Referenced by ai::Ref< X >::Assign(), ai::Ref< X >::operator<<(), ai::Ref< X >::operator=(), ai::Ref< X >::Ref(), ai::Ref< X >::to(), and ai::Ref< X >::~Ref().

template<typename T >