Classes |
| struct | AIEffectiveToolChangeData |
| | Information about the change that caused a kAIEffectiveToolChangedNotifier notification. More...
|
| struct | AIAddToolData |
| | Information needed to add a tool using AIToolSuite::AddTool(). More...
|
| struct | AIAddToolDataPrivate |
| | For internal use only. More...
|
| struct | AIEventHistoryData |
| | History Data associated with an Event. More...
|
| struct | AIToolMessage |
| | The contents of a tool message. More...
|
| struct | AIRadialDeviceMessage |
| | The content of a radial device message. More...
|
| struct | AIToolNotifyData |
| | The contents of a tool notification. More...
|
| struct | AIEyedropperDragNotifyData |
| | The contents of an eyedropper drag notification, kAIEyedropperDragNotifier. More...
|
| struct | AIDocumentInkParams |
| struct | AIDocumentInkPoint |
| struct | AIToolDryInkMessage |
| | The contents of a tool message. More...
|
| struct | AIToolSuite |
| | This suite allows you to provide plug-in tools for Illustrator. More...
|
Defines |
| #define | kAIToolSuite "AI Tool Suite" |
| #define | kAIToolSuiteVersion19 AIAPI_VERSION(19) |
| #define | kAIToolSuiteVersion kAIToolSuiteVersion19 |
| #define | kAIToolVersion kAIToolSuiteVersion |
| #define | kAIEffectiveToolChangedNotifier "AI Effective Tool Changed Notifier" |
| | Sent when effective tool is changed, either permanently or temporarily using modifier keys (such as Cmd, Cntl, or Spacebar).
|
| #define | kAIUserToolChangedNotifier "AI User Tool Changed Notifier" |
| #define | kAIToolSelectedNotifier "AI Tool Selected Notifier" |
| | Sent when a tool is selected.
|
| #define | kAIToolDeselectedNotifier "AI Tool Deselected Notifier" |
| | Sent when a tool is deselected.
|
| #define | kAIInvalidateByScrollNotifier "AI Invalidate By Scroll Notifier" |
| | Send to notify tools to invalidate their current view when a scroll is happening on the document.
|
| #define | kAIToolClearStateNotifier "AI Tool Clear State Notifier" |
| | Sent to notify tools that they should clear any editing state that they maintain.
|
| #define | kAIToolTitleChangedNotifier "AI Tool Title Changed Notifier" |
| | Sent when the title string of a tool is changed.
|
| #define | kAIToolTooltipChangedNotifier "AI Tool Tooltip Changed Notifier" |
| | Sent when a tool's rollover tooltip is changed.
|
| #define | kAIToolHelpIDChangedNotifier "AI Tool Help ID Changed Notifier" |
| | Obsolete.
|
| #define | kAIToolIconChangedNotifier "AI Tool Icon Resources Changed Notifier" |
| | Sent when a tool's icon resources are changed.
|
| #define | kAIToolChangedNotifier "AI Tool Changed Notifier" |
| #define | kAIToolWindowChangedNotifier "AI Tool Window Changed Notifier" |
| | Sent when the tool window has changed.
|
| #define | kAIToolSuspendNotifier "AI Tool Suspend Notifier" |
| #define | kAIToolResumeNotifier "AI Tool Resume Notifier" |
| #define | kAIToolTabletPointerTypeChangedNotifier "AI Tablet Pointer Type Changed Notifier" |
| | Sent when AIToolTabletPointerType is changed.
|
| #define | kAIToolModifiersChangedNotifier "AI Tool Modifiers Changed Notifier" |
| | Sent when the modifier keys for the current tool are changed.
|
| #define | kAIToolSuspendedBySpacebarNotifier "AI Tool Suspended by Spacebar Notifier" |
| #define | kAIToolResumedBySpacebarNotifier "AI Tool Resumed by Spacebar Notifier" |
| #define | kAIToolSuspendedByCmdKeyNotifier "AI Tool Suspended by Cmd Key Notifier" |
| #define | kAIToolResumedByCmdKeyNotifier "AI Tool Resumed by Cmd Key Notifier" |
| #define | kAIEyedropperDragNotifier "AI Eyedropper Drag Notifier" |
| | Sent by the eyedropper when it is selected and dragged.
|
| #define | kCallerRadialDevice "AI Radial Device" |
| | The radial device caller.
|
| #define | kSelectorAIRadialDeviceRotated "Radial Device Rotated" |
| | ingroup Selectors Sent when the radial device is rotated
|
| #define | kSelectorAIRadialDeviceClicked "Radial Device Clicked" |
| | ingroup Selectors Sent when the radial device is clicked
|
| #define | kCallerAITool "AI Tool" |
| | The tool caller.
|
| #define | kSelectorAIEditToolOptions "AI Edit Options" |
| | Sent when the tool has been selected (double-clicked) in the Tool palette.
|
| #define | kSelectorAITrackToolCursor "AI Track Cursor" |
| | Sent when the tool is selected and as the cursor is moved over the artboard with the button up.
|
| #define | kSelectorAIToolMouseDown "AI Mouse Down" |
| | Sent when the mouse button is pressed.
|
| #define | kSelectorAIToolMouseDrag "AI Mouse Drag" |
| | Sent on drag (cursor move with button down).
|
| #define | kSelectorAIToolMouseUp "AI Mouse Up" |
| | Either follows the mouse-down selector immediately or ends the mouse-drag selectors.
|
| #define | kSelectorAISelectTool "AI Select" |
| | Sent to a plug-in when its tool has been selected, to allow initialization.
|
| #define | kSelectorAIDeselectTool "AI Deselect" |
| | Sent to a plug-in when a different tool is selected, to allow cleanup of any run-time variables.
|
| #define | kSelectorAIReselectTool "AI Reselect" |
| | Sent when an already-selected tool is reselected, with both kAIToolDeselectedNotifier and kAIToolSelectedNotifier.
|
| #define | kSelectorAIToolDecreaseDiameter "AI Decrease Diameter" |
| | Sent when shortcut '[' is activated to decrease a diameter.
|
| #define | kSelectorAIToolIncreaseDiameter "AI Increase Diameter" |
| | Sent when shortcut ']' is activated to increase a diameter.
|
| #define | kSelectorAIAlternateSelectionToolQuery "AI Alternate Selection Tool Query" |
| | Sent when the user requests a switch to an alternate selection tool by pressing Ctrl (in Windows) or Cmd (in MacOS) key, while using a tool that allows alternate selection tool, to determine whether the alternate selection tool is ready to be selected.
|
| #define | kSelectorAIAlternateSelectionToolActivate "AI Alternate Selection Tool Activate" |
| | Sent when the user switches to an alternate selection tool by pressing Ctrl (in Windows) or Cmd (in MacOS) key while using a tool that allows alternate selection tool.
|
| #define | kSelectorAIAlternateSelectionToolDeActivate "AI Alternate Selection Tool DeActivate" |
| | Sent when the user switches back from a temporary alternate selection tool.
|
| #define | kAcceptAlternateSelectionToolReply 'ASTR' |
| | Return code for response to kSelectorAIAlternateSelectionToolQuery when the alternate selection tool is ready for selection.
|
| #define | kSelectorAIToolDrawDryInk "AI Tool Draw Dry Ink" |
| | This can be used to get strokes directly without listening to mouse down, drag and up events.
|
| #define | kNoTool -2 |
| | An AIToolType value that creates a new group or toolset.
|
| #define | kPluginToolOffset 1000 |
| | Tool numbers less than this value are built-in, numbers greater than this are plug-in.
|
| #define | kToolCantTrackCursorErr 'TLTK' |
| | See AIToolSuite.
|
| #define | kToolTimeDurationSecond ((AIToolTime)1.0) |
| #define | kToolTimeDurationMillisecond ((AIToolTime)(kToolTimeDurationSecond/1000)) |
| #define | kToolTimeDurationNoWait ((AIToolTime)0.0) |
| #define | kToolTimeDurationForever ((AIToolTime)(-1.0)) |
| #define | kToolNormalIconDictKey "ToolNormalIconDictKey" |
| #define | kToolDarkNormalIconDictKey "ToolDarkNormalIconDictKey" |
Typedefs |
| typedef ai::int16 | AIToolType |
| | A tool number used to indicate a tool group or toolset.
|
| typedef double | AIToolTime |
| typedef struct _t_AIToolOpaque * | AIToolHandle |
| | Opaque reference to a tool plug-in, never dereferenced.
|
| typedef struct _AIDataStack * | AIDataStackRef |
| | For internal use only.
|
| typedef ai::int16 | AIToolTabletPointerType |
| | An AIToolTabletPointerTypeValue describing a type of pointing device.
|
| typedef ai::int16 | AIToolPressure |
| | An AIToolPressureValue indicating the amount of force being applied with a pressure-sensitive input device, such as a graphic tablet.
|
| typedef ai::int16 | AIToolAngle |
| | An AIToolAngleValue describing values of an input device such as tilt, rotation and bearing of a pen on a graphic tablet.
|
Enumerations |
| enum | AIToolOptions {
kToolWantsToTrackCursorOption = (1<<0),
kToolDoesntWantAutoScrollOption = (1<<1),
kToolWantsBufferedDraggingOption = (1<<2),
kToolMaintainEditContextOption = (1<<3),
kToolIsTextToolOption = (1<<4),
kToolWantsToChangeDiameterOption = (1<<5),
kToolWantsAlternateSelectionTool = (1<<6),
kToolWantsHiddenToolOption = (1<<7),
kToolDoesntWantSoftSelectionOption = (1<<8),
kToolWantsOSHandleInk = (1<<9),
kToolHasAlternateAction = (1<<10),
kToolWantsRadialDeviceEvents = (1 << 11),
kToolDoesntWantArtStyleExecutionSuspender = (1 << 12),
kToolHasItsOwnDragLoop = (1 << 13)
} |
| | Bit flags for options that can be set by a plug-in tool when it is installed with AIToolSuite::AddTool(), or later with AIToolSuite::SetToolOptions().
More...
|
| enum | AIToolInfoVariable {
kInfoPageX = 0,
kInfoPageY,
kInfoSizeX,
kInfoSizeY,
kInfoDistance,
kInfoVectorAngle,
kInfoScaleX,
kInfoScaleY,
kInfoZoom,
kInfoCornerRoundness,
kInfoRotAngle,
kInfoShearAngle,
kInfoFontAndSize,
kInfoTrackOrKern,
kInfoRawRotAngle,
kInfoDocX,
kInfoDocY,
kInfoText1,
kInfoText2,
kInfoText3,
kInfoText4,
kInfoText5,
kInfoText6,
kInfoLongText3,
kInfoTextX,
kInfoTextY,
kInfoTextW,
kInfoTextH,
kInfoNumVars,
kInfoBlank,
kInfoTextUnicode1,
kInfoTextUnicode2,
kInfoTextUnicode3,
kInfoTextUnicode4,
kInfoTextUnicode5,
kInfoTextUnicode6,
kInfoLongTextUnicode1,
kInfoLongTextUnicode2,
kInfoLongTextUnicode3,
kInfoLongText1 = kInfoFontAndSize,
kInfoLongText2 = kInfoTrackOrKern,
kInfoEndOfList = -1
} |
| | Tool information values.
More...
|
| enum | AIToolTabletPointerTypeValue { kAIToolTabletPointerTypeUnknown = 0,
kAIToolTabletPointerTypePen,
kAIToolTabletPointerTypeCursor,
kAIToolTabletPointerTypeEraser
} |
| | AIToolTabletPointerType constants that describe the type of input being received from input devices.
More...
|
| enum | AIToolPressureValue { kAIMaxToolPressure = 255,
kAIMinToolPressure = 0,
kAINormalToolPressure = 127
} |
| | AIToolPressure constants that indicate an amount of force applied to a pressure-sensitive input device.
More...
|
| enum | AIToolAngleValue {
kAIToolAngle0 = 0,
kAIToolAngle90 = 90,
kAIToolAngleNegative179 = -179,
kAIToolAngle180 = 180,
kAIToolAngle360 = 360,
kAIToolMinBearing = kAIToolAngleNegative179,
kAIToolMaxBearing = kAIToolAngle180,
kAIToolNormalBearing = kAIToolAngle0,
kAIToolMinRotation = kAIToolAngleNegative179,
kAIToolMaxRotation = kAIToolAngle180,
kAIToolNormalRotation = kAIToolAngle0,
kAIToolMinTilt = kAIToolAngle0,
kAIToolMaxTilt = kAIToolAngle90,
kAIToolNormalTilt = kAIToolMinTilt
} |
| | AIToolAngle constants that describe values of an input device such as tilt, rotation and bearing of a pen on a graphic tablet.
More...
|
| enum | AITabletCapabilities {
kXCoordinate = 1 << 0,
kYCoordinate = 1 << 1,
kZCoordinate = 1 << 2,
kNormalPressure = 1 << 3,
kTangentPressure = 1 << 4,
kAltitudeOrientation = 1 << 5,
kAzimuthOrientation = 1 << 6,
kTwistOrientation = 1 << 7
} |
| | AITabletCapabilities constants that describe the hardware capabilities of a graphic tablet/ Integrated digitizer.
More...
|
| enum | AIToolMessageFlags { kAIToolMsgInkSimulationFlag = 1 << 0,
kAIToolMsgModifierKeyPressedDuringInk = 1 << 1,
kAIToolMsgIsDragOver = 1 << 2
} |
