AIPlaced.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIRaster.h"
#include "IAIFilePath.hpp"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIPlaceRequestData
	Request data for AIPlacedSuite::ExecPlaceRequest(). More...
struct	AIPlacedSuite
	This suite provides functions that allow you to access and manipulate placed art. More...
Defines
#define	kAIPlacedSuite   "AI Placed Suite"
#define	kAIPlacedSuiteVersion9   AIAPI_VERSION(9)
#define	kAIPlacedSuiteVersion   kAIPlacedSuiteVersion9
#define	kAIPlacedVersion   kAIPlacedSuiteVersion
Typedefs
typedef enum PlaceRequestMode	ePlaceRequestMode
	Request types for AIPlacedSuite::ExecPlaceRequest().
Enumerations
enum	AIPlacedObjectType { kEPSType = 0, kOtherType }
	Types of placed object. More...
enum	PlaceMethod {   kAsIs, kFill, kFit, kConform,   kReconform }
	Methods for positioning and sizing a linked object. More...
enum	PlaceAlignment {   kTopLeft, kMidLeft, kBotLeft, kTopMid,   kMidMid, kBotMid, kTopRight, kMidRight,   kBotRight }
	Alignment options for positioning a linked object. More...
enum	PlaceRequestMode {   kVanillaPlace = 0, kQueryReplace, kForceReplace, kUnlinkPlaced,   kCreateNewArt, kForceReplaceEx, kQueryUnlinkPlaced }
	Request types for AIPlacedSuite::ExecPlaceRequest(). More...
enum	AIPlacedPlateInfo {   kAIPlacedHasBlack = (1<<0), kAIPlacedHasCyan = (1<<1), kAIPlacedHasMagenta = (1<<2), kAIPlacedHasYellow = (1<<3),   kAIPlacedHasCustomColors = (1<<4) }
	Flag value to represent plates used by Placed object. More...
enum	AIPlaceTransformType { kAIPlaceTransformTypeNone = 0, kAIPlacedTransformTypeFitToView = 1 }

---

Detailed Description

---

Define Documentation

#define kAIPlacedSuite   "AI Placed Suite"

#define kAIPlacedSuiteVersion   kAIPlacedSuiteVersion9

#define kAIPlacedSuiteVersion9   AIAPI_VERSION(9)

#define kAIPlacedVersion   kAIPlacedSuiteVersion

---

Typedef Documentation

typedef enum PlaceRequestMode ePlaceRequestMode

Request types for AIPlacedSuite::ExecPlaceRequest().

---

Enumeration Type Documentation

enum AIPlacedObjectType

Types of placed object.

Enumerator:

kEPSType	EPS file.
kOtherType	Not EPS.

enum AIPlacedPlateInfo

Flag value to represent plates used by Placed object.

Enumerator:

kAIPlacedHasBlack	Placed object has Black(K) Plate.
kAIPlacedHasCyan	Placed object has Cyan Plate.
kAIPlacedHasMagenta	Placed object has Magenta Plate.
kAIPlacedHasYellow	Placed object has Yellow Plate.
kAIPlacedHasCustomColors	Placed object has at least one spot Plate.

enum AIPlaceTransformType

Enumerator:

kAIPlaceTransformTypeNone
kAIPlacedTransformTypeFitToView

enum PlaceAlignment

Alignment options for positioning a linked object.

See also:

AIPlacedSuite::SetPlaceOptions(), AIPlacedSuite::GetPlaceOptions()

Enumerator:

kTopLeft
kMidLeft
kBotLeft
kTopMid
kMidMid
kBotMid
kTopRight
kMidRight
kBotRight

enum PlaceMethod

Methods for positioning and sizing a linked object.

See also:

AIPlacedSuite::SetPlaceOptions(), AIPlacedSuite::GetPlaceOptions()

Enumerator:

kAsIs	Preserve original dimensions regardless of bounding box size and transformations.
kFill	Fill bounding box while preserving proportions. Can overlap edges in one dimension.
kFit	Fit fully inside bounding box while preserving proportions.
kConform	Fit to bounding box; replaced file preserves bounds but not proportions.
kReconform	Fit to bounding box; replaced file preserves transformations and tries to preserve size. Default.

enum PlaceRequestMode

Request types for AIPlacedSuite::ExecPlaceRequest().

Enumerator:

kVanillaPlace	Place the file. If the new art can be read, places it, and returns the new art handle in AIPlaceRequestData::m_hNewArt.
kQueryReplace	Consult selection for whether to place or replace. If exactly one placed object is selected, show "File.Place" dialog to query user on whether to simply place the new art, or use it to replace the selection. If there is no selection, or if more than one placed object is selected, simply places the new art and returns the new art handle in AIPlaceRequestData::m_hNewArt.
kForceReplace	Replace the file. The art to be replaced must be in AIPlaceRequestData::m_hOldArt.
kUnlinkPlaced	Replace placed art with its parsed contents. Returns the group containing the new art tree in AIPlaceRequestData::m_hNewArt.
kCreateNewArt	Create new art in current layer's top group, if allowed by that layer's editability and visibility states. . You must specify the art type you want created in AIPlaceRequestData::m_lParam. Returns the new art handle in AIPlaceRequestData::m_hNewArt.
kForceReplaceEx	Replace the file, first validating the SPPlatformFileSpecification. The art to be replaced must be in AIPlaceRequestData::m_hOldArt.
kQueryUnlinkPlaced	Replace placed art with its parsed contents, querying user for parameters. Returns the group containing the new art tree in AIPlaceRequestData::m_hNewArt.