Adobe.com
Contents Suites Classes Class Index Member Index

AIActionManager.h File Reference

#include "AITypes.h"
#include "SPPlugs.h"
#include "AIUnicodeString.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes

struct  DoActionMessage
 A plug-in receives this message with the request to execute an action. More...
struct  AIActionManagerSuite
 The Action Manager suite allows you to access the internal scripting system built into Adobe Illustrator. More...

Defines

#define kAIActionManagerSuite   "AI Action Manager Suite"
#define kAIActionManagerSuiteVersion5   AIAPI_VERSION(5)
#define kAIActionManagerSuiteVersion   kAIActionManagerSuiteVersion5
#define kAIActionManagerVersion   kAIActionManagerSuiteVersion
#define kAIActionManagerPlayActionEventDoneNotifier   "AI Action Manager PlayActionEvent Done Notifier"
 Sent when an action event has completed execution.
#define kAIActionActualExecutionFinishedNotifier   "AI Action Actual Execution Finished Notifier"
#define kActionCaller   "Action Manager"
 Caller id for messages sent to plug-ins from the action manager.
#define kDoActionSelector   "Do Action"
 Message selector sent when requesting a plug-in to play an action.

Typedefs

typedef ai::uint32 ActionParamTypeID
 Identifies the data type of an action parameter.
typedef ai::uint32 ActionParamUnitID
 Identifies units for some numeric parameters.
typedef ai::uint32 ActionParamKeyID
 Identifies a unique key associated with a parameter block.
typedef struct ActionParamType * AIActionParamTypeRef
 A reference to a Type Parameter Block (TPB).
typedef struct ActionParamValue * AIActionParamValueRef
 A reference to a Value Parameter Block (VPB).
typedef void * AIActionUserData
 User-defined data.
typedef ASErr(* AIActionCallbackProc )(AIActionParamValueRef parameter, AIActionUserData userData, AIBoolean showDialog)
 Callback procedure prototype.
typedef void(* AIActionIdleProc )(void)
 Idle procedure prototype.
typedef enum _ActionDialogStatus ActionDialogStatus
 Choices for whether a parameters dialog appears by default when an action is played back.
typedef enum _ActionValueVisibility ActionValueVisibility
 Values that control whether values are shown in the Actions palette.

Enumerations

enum  {
  actionTypeInteger = 'long', actionTypeReal = 'real', actionTypeBoolean = 'bool', actionTypeEnum = 'enum',
  actionTypeString = 'strn', actionTypeUnitReal = 'utrl', actionTypeRawData = 'rwdt', actionTypeNull = 'null'
}
 

Allowed values for ActionParamTypeID.

More...
enum  {
  unitNone = '#Nne', unitDistance = '#Rlt', unitAngle = '#Ang', unitDensity = '#Rsl',
  unitPoints = '#Pxl', unitPercent = '#Prc'
}
 

Allowed values for ActionParamUnitID.

More...
enum  _ActionDialogStatus { kDialogNone, kDialogOn, kDialogPartialOn, kDialogOff }
 

Choices for whether a parameters dialog appears by default when an action is played back.

More...
enum  _ActionValueVisibility { kDependOnParamType = -1, kHideInPalette, kShowInPalette }
 

Values that control whether values are shown in the Actions palette.

More...

Detailed Description


Define Documentation

#define kAIActionActualExecutionFinishedNotifier   "AI Action Actual Execution Finished Notifier"
#define kAIActionManagerSuite   "AI Action Manager Suite"
#define kAIActionManagerSuiteVersion   kAIActionManagerSuiteVersion5
#define kAIActionManagerSuiteVersion5   AIAPI_VERSION(5)
#define kAIActionManagerVersion   kAIActionManagerSuiteVersion

Typedef Documentation

Choices for whether a parameters dialog appears by default when an action is played back.

This status is visually represented by a dialog icon to the left of the event name in the Actions palette.

typedef ai::uint32 ActionParamKeyID

Identifies a unique key associated with a parameter block.

typedef ai::uint32 ActionParamTypeID

Identifies the data type of an action parameter.

typedef ai::uint32 ActionParamUnitID

Identifies units for some numeric parameters.

Units are shown when type is actionTypeUnitReal.

Values that control whether values are shown in the Actions palette.

typedef ASErr(* AIActionCallbackProc)(AIActionParamValueRef parameter, AIActionUserData userData, AIBoolean showDialog)

Callback procedure prototype.

typedef void(* AIActionIdleProc)(void)

Idle procedure prototype.

typedef struct ActionParamType* AIActionParamTypeRef

A reference to a Type Parameter Block (TPB).

typedef struct ActionParamValue* AIActionParamValueRef

A reference to a Value Parameter Block (VPB).

typedef void* AIActionUserData

User-defined data.

This is cast after it has been defined.


Enumeration Type Documentation

anonymous enum

Allowed values for ActionParamTypeID.

Enumerator:
actionTypeInteger 

integer

actionTypeReal 

real number

actionTypeBoolean 

boolean

actionTypeEnum 

enumeration

actionTypeString 

string

actionTypeUnitReal 

real number with associated unit

actionTypeRawData 

user-defined data

actionTypeNull 

null

anonymous enum

Allowed values for ActionParamUnitID.

Enumerator:
unitNone 

unit value - coerced

unitDistance 

unit value - base 72ppi

unitAngle 

unit value - base degrees

unitDensity 

unit value - base per inch

unitPoints 

tagged unit value, document points

unitPercent 

tagged unit value, percentage

Choices for whether a parameters dialog appears by default when an action is played back.

This status is visually represented by a dialog icon to the left of the event name in the Actions palette.

Enumerator:
kDialogNone 

No dialog is defined for this action.

kDialogOn 

Dialog appears on playback.

kDialogPartialOn 

Internal, not used by 3rd-party plug-ins.

kDialogOff 

Dialog does not appear on playback.

Values that control whether values are shown in the Actions palette.

Enumerator:
kDependOnParamType 

shown or hidden according to parameter data type

kHideInPalette 

hidden

kShowInPalette 

shown



Contents Suites Classes Class Index Member Index
Adobe Solutions Network
 
Copyright © 2014 Adobe Systems Incorporated. All rights reserved.
Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks