AIPaintStyle.h File Reference

#include "ASTypes.h"
#include "AIColor.h"
#include "AIPathStyle.h"
#include "AISwatchList.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIStrokeWidthMessage
	The new stroke width for a kAIPaintStyleSetStrokeWidthSelector. More...
struct	AIUpdatePathStyleNotifyData
	Data for kAIUpdatePathStyleNotifier. More...
struct	AIColorEditorOptions
	Behavior options for Color Editor. More...
struct	AIColorPickerOptions
	Behavior options for opening the Color Picker using AIPaintStyleSuite::DisplayColorPickerWithOptions(). More...
struct	AIColorEditorColor
	Color specification for the Color Editor. More...
struct	AIPaintStyleSuite
	This suite provides functions to examine and operate on the Color and Gradient palettes, which display and modify the paint style of the current selection, and the Color Editor, which allows a user to choose and edit colors. More...
Defines
#define	kAIPaintStyleSuite   "AI Paint Style Suite"
#define	kAIPaintStyleSuiteVersion10   AIAPI_VERSION(10)
#define	kAIPaintStyleSuiteVersion   kAIPaintStyleSuiteVersion10
#define	kAIPaintStyleVersion   kAIPaintStyleSuiteVersion
#define	kAIPaintStyleModifierCaller   "AI PaintStyle Modifier Caller"
	Caller for updating any paint style properties.
#define	kAIUpdatePathStyleNotifier   "AI Update PathStyle Notifier"
	The eyedropper sends this while tracking a mouse drag, to notify the Color palette to update its proxies during the drag, using the path style and map in the AIUpdatePathStyleNotifyData.
#define	kAIPaintStyleFillStrokeChangedNotifier   "AI Paint Style Fill Stroke Changed Notifier"
	See AIPaintStyleSuite.
#define	kAIPaintStyleGradientStopChangedNotifier   "AI Paint Style Gradient Stop Changed Notifier"
	See AIPaintStyleSuite.
#define	kAIPaintStyleSetStrokeWidthSelector   "AI Paint Style Set Stroke Width Selector"
	Used by the Control palette to set stroke width with AIStrokeWidthMessage.
#define	kAIPaintStyleIndicatorType   "AI Paint Style Indicator Type"
	Indicator type for ADM.
#define	kAIPaintStyleIndicatorSmallType   "AI Paint Style Indicator Small Type"
	Indicator type for ADM.
#define	kAIPaintStyleColorEditorType   "AI Paint Style Color Editor Type"
	Color editor type for ADM.
#define	kMinStrokeDashLength   0.01
	Minimum dash stroke length.
Typedefs
typedef void *	ColorEditorClientData
	Developer-defined data to pass to your color-editor tracking procedure.
typedef void(*	ColorEditorTrackProc )(ColorEditorClientData clientData)
	Prototype for an event tracking procedure associated with a color-editor dialog item.
Enumerations
enum	ColorSpace {   kUnknownSpace = 0, kGrayscaleSpace, kRGBSpace, kHSVSpace,   kCMYKSpace, kWebSpace, kTintSpace, kLabSpace }
	Colorspaces that can be displayed by the Color palette for editing colors. More...
enum	AIColorEditorColorSpace {   kAIColorEditorColorUnknown = 0, kAIColorEditorColorGray, kAIColorEditorColorRGB, kAIColorEditorColorCMYK,   kAIColorEditorColorLab, kAIColorEditorColorDummy = 0xFFFFFFFF }
	Possible colorspaces for specifying colors for a Color Editor. More...
enum	AIColorEditorReadOnlyOption { kAIColorEditorReadOnlyDefault = 0 }
	Color Editor read-only flag. More...
enum	AIStrokeAlignmentType { kAIStrokeAlignmentCenter = 0, kAIStrokeAlignmentInside = 1, kAIStrokeAlignmentOutside = 2 }
	Possible values for stroke alignment. More...

---

Define Documentation

#define kAIPaintStyleColorEditorType   "AI Paint Style Color Editor Type"

Color editor type for ADM.

#define kAIPaintStyleIndicatorSmallType   "AI Paint Style Indicator Small Type"

Indicator type for ADM.

#define kAIPaintStyleIndicatorType   "AI Paint Style Indicator Type"

Indicator type for ADM.

#define kAIPaintStyleSuite   "AI Paint Style Suite"

#define kAIPaintStyleSuiteVersion   kAIPaintStyleSuiteVersion10

#define kAIPaintStyleSuiteVersion10   AIAPI_VERSION(10)

#define kAIPaintStyleVersion   kAIPaintStyleSuiteVersion

#define kMinStrokeDashLength   0.01

Minimum dash stroke length.

---

Typedef Documentation

typedef void* ColorEditorClientData

Developer-defined data to pass to your color-editor tracking procedure.

See also:

ColorEditorTrackProc, AIPaintStyleSuite::SetColorEditorTrackProc()

typedef void(* ColorEditorTrackProc)(ColorEditorClientData clientData)

Prototype for an event tracking procedure associated with a color-editor dialog item.

Called when the user makes any change in the editor. Use it to update other UI features according to the current Color Editor state. If supplied, it must not modify the state of the Color Editor itself.

Parameters:

clientData

Developer-defined data passed with the event.

Returns:

Nothing.

See also:

AIPaintStyleSuite::SetColorEditorTrackProc()

---

Enumeration Type Documentation

enum AIColorEditorColorSpace

Possible colorspaces for specifying colors for a Color Editor.

Enumerator:

kAIColorEditorColorUnknown
kAIColorEditorColorGray
kAIColorEditorColorRGB
kAIColorEditorColorCMYK
kAIColorEditorColorLab
kAIColorEditorColorDummy	Internal.

enum AIColorEditorReadOnlyOption

Color Editor read-only flag.

See AIPaintStyleSuite::SetColorEditorReadOnly().

Enumerator:

kAIColorEditorReadOnlyDefault

enum AIStrokeAlignmentType

Possible values for stroke alignment.

See AIPaintStyleSuite.

Enumerator:

kAIStrokeAlignmentCenter
kAIStrokeAlignmentInside
kAIStrokeAlignmentOutside

enum ColorSpace

Colorspaces that can be displayed by the Color palette for editing colors.

Enumerator:

kUnknownSpace
kGrayscaleSpace
kRGBSpace
kHSVSpace
kCMYKSpace
kWebSpace
kTintSpace
kLabSpace