AIArtStyleParserSuite Struct Reference
[API Suite List]

The AIArtStyleParser allows you to manipulate art styles, and access information typically shown in the Appearance palette. More...

#include <AIArtStyleParser.h>

List of all members.

Public Attributes
AIAPI AIErr(*	NewParser )(AIStyleParser *parser)
	Constructs a new parser.
AIAPI AIErr(*	DisposeParser )(AIStyleParser parser)
	Frees memory associated with a parser that is no longer needed.
AIAPI AIErr(*	ParseStyle )(AIStyleParser parser, AIArtStyleHandle artStyle)
	Parses the contents of an art style, creating parser data structures accordingly.
AIAPI AIErr(*	MergeStyleIntoParser )(AIStyleParser parser, AIArtStyleHandle artStyle)
	Merges the properties of an art style into a parser.
AIAPI AIBoolean(*	IsStyleParseable )(AIStyleParser parser)
	Reports whether a parser was able to successfully parse an art style.
AIAPI ai::int32(*	CountPreEffects )(AIStyleParser parser)
	Counts the number of pre-effects in a parser.
AIAPI ai::int32(*	CountPostEffects )(AIStyleParser parser)
	Counts the number of post-effects in a parser.
AIAPI ai::int32(*	CountPaintFields )(AIStyleParser parser)
	Counts the number of paint fields in a parser.
AIAPI ai::int32(*	CountEffectsOfPaintField )(AIParserPaintField paintField)
	Counts the number of Live Effects in a paint field.
AIAPI AIErr(*	GetNthPreEffect )(AIStyleParser parser, ai::int32 n, AIParserLiveEffect *effect)
	Retrieves a Pre-Effect from a parser by position index.
AIAPI AIErr(*	GetNthPostEffect )(AIStyleParser parser, ai::int32 n, AIParserLiveEffect *effect)
	Retrieves a Post-Effect from a parser by position index.
AIAPI AIErr(*	GetNthPaintField )(AIStyleParser parser, ai::int32 n, AIParserPaintField *paintField)
	Retrieves a paint field from a parser by position index.
AIAPI AIErr(*	GetNthEffectOfPaintField )(AIParserPaintField paintField, ai::int32 n, AIParserLiveEffect *effect)
	Retrieves a Live Effect from a paint field by position index.
AIAPI AIErr(*	GetStyleBlendField )(AIStyleParser parser, AIParserBlendField *blendField)
	Retrieves the overall art style transparency from a parser in the form of a blend field.
AIAPI AIErr(*	InsertNthPreEffect )(AIStyleParser parser, ai::int32 n, AIParserLiveEffect effect)
	Inserts a Pre-Effect into a parser at a specified index.
AIAPI AIErr(*	InsertNthPostEffect )(AIStyleParser parser, ai::int32 n, AIParserLiveEffect effect)
	Inserts a Post-Effect into the parser at a specified index.
AIAPI AIErr(*	InsertNthPaintField )(AIStyleParser parser, ai::int32 n, AIParserPaintField paintField)
	Inserts a paint field into a parser at a specified index.
AIAPI AIErr(*	InsertNthEffectOfPaintField )(AIStyleParser parser, AIParserPaintField paintField, ai::int32 n, AIParserLiveEffect effect)
	Inserts a Live Effect into a paint field in a parser at specified index.
AIAPI AIErr(*	RemovePreEffect )(AIStyleParser parser, AIParserLiveEffect effect, AIBoolean doDelete)
	Removes a Pre-Effect from a parser.
AIAPI AIErr(*	RemovePostEffect )(AIStyleParser parser, AIParserLiveEffect effect, AIBoolean doDelete)
	Removes a Post-Effect from a parser.
AIAPI AIErr(*	RemovePaintField )(AIStyleParser parser, AIParserPaintField paintField, AIBoolean doDelete)
	Removes a paint field from a parser.
AIAPI AIErr(*	RemoveEffectOfPaintField )(AIStyleParser parser, AIParserPaintField paintField, AIParserLiveEffect effect, AIBoolean doDelete)
	Removes a Live Effect from a paint field in a parser.
AIAPI AIErr(*	RemoveAllEffects )(AIStyleParser parser)
	Removes all the effects from a parser.
AIAPI AIErr(*	Simplify )(AIStyleParser parser)
	Removes all the effects and all the paint fields from a parser, except the focus fill and stroke.
AIAPI AIErr(*	GetFocusFill )(AIStyleParser parser, AIParserPaintField *paintField)
	Retrieves the focus fill from a parser.
AIAPI AIErr(*	GetFocusStroke )(AIStyleParser parser, AIParserPaintField *paintField)
	Retrieves the focus stroke from a parser.
AIAPI AIErr(*	SetParserFocus )(AIStyleParser parser, AIParserPaintField paintField)
	Sets the focus fill or focus stroke for a parser.
AIAPI AIErr(*	SetFocus )(AIArtStyleHandle artStyle, AIStyleParser parser, AIParserPaintField paintField)
	Sets the focus fill or focus stroke for a parser, and also modifies the art style from which the parser's data structures were constructed.
AIAPI ai::int32(*	GetGroupContentsPosition )(AIStyleParser parser)
	Retrieves the position in the stacking order (from top to bottom) where the Group Contents for a parser would be rendered.
AIAPI AIErr(*	MoveGroupContentsPosition )(AIStyleParser parser, ai::int32 position)
	Move the Group Contents position in a parser.
AIAPI AIErr(*	CreateNewStyle )(AIStyleParser parser, AIArtStyleHandle *artStyle)
	Constructs a new art style based on the elements in a parser.
AIAPI AIBoolean(*	IsStyleVisible )(AIStyleParser parser)
	Reports whether a style is invisible; that is, there are no effects, all the paint fields have a color of `none`, and the overall transparency contains default values.
AIAPI AIBoolean(*	ContainsPaint )(AIStyleParser parser)
	Reports whether a parser has fill or stroke.
AIAPI AIBoolean(*	ContainsEffects )(AIStyleParser parser)
	Reports whether a parser has any Live Effects.
AIAPI AIBoolean(*	ContainsTransparency )(AIStyleParser parser)
	Reports whether a parser has transparency.
AIAPI AIErr(*	GetLiveEffectHandle )(AIParserLiveEffect effect, AILiveEffectHandle *liveEffectHandle)
	Retrieves the Live Effect object reference from a parser.
AIAPI AIErr(*	GetLiveEffectParams )(AIParserLiveEffect effect, AILiveEffectParameters *params)
	Retrieves the LiveEffect parameters data structure from a parser.
AIAPI AIErr(*	SetLiveEffectHandle )(AIParserLiveEffect effect, AILiveEffectHandle liveEffectHandle)
	Sets the Live Effect object reference in a parser.
AIAPI AIErr(*	SetLiveEffectParams )(AIParserLiveEffect effect, AILiveEffectParameters params)
	Sets the Live Effect parameters data structure in a parser.
AIAPI AIErr(*	CloneLiveEffect )(AIParserLiveEffect effect, AIParserLiveEffect *clonedEffect)
	Copies a Live Effect data structure into a new equivalent structure.
AIAPI AIErr(*	EditEffectParameters )(AIArtStyleHandle artStyle, AIParserLiveEffect effect)
	Opens the editing dialog, allowing the user to edit the parameters of an effect in an art style, and creates a new art style with the user's choices, which is applied to all the art objects currently targeted in the document.
AIAPI AIBoolean(*	IsFill )(AIParserPaintField paintField)
	Reports whether a paint field corresponds to a fill.
AIAPI AIBoolean(*	IsStroke )(AIParserPaintField paintField)
	Reports whether a paint field corresponds to a stroke.
AIAPI AIErr(*	GetFill )(AIParserPaintField paintField, AIFillStyle fill, AIArtStylePaintData paintData)
	Retrieves fill information from a paint field.
AIAPI AIErr(*	GetStroke )(AIParserPaintField paintField, AIStrokeStyle stroke, AIArtStylePaintData paintData)
	Retrieves stroke information from a paint field.
AIAPI AIErr(*	SetFill )(AIParserPaintField paintField, AIFillStyle fill, AIArtStylePaintData paintData)
	Sets fill information for a paint field.
AIAPI AIErr(*	SetStroke )(AIParserPaintField paintField, AIStrokeStyle stroke, AIArtStylePaintData paintData)
	Sets stroke information for a paint field.
AIAPI AIErr(*	GetPaintBlendDictionary )(AIParserPaintField paintField, AIDictionaryRef blendDict)
	Retrieves transparency information from a paint field.
AIAPI AIErr(*	SetPaintBlendDictionary )(AIParserPaintField paintField, AIDictionaryRef blendDict)
	Sets the transparency information for a paint field.
AIAPI ai::int32(*	GetColorPosn )(AIParserPaintField paintField)
	Retrieves the color position of a paint field (the point in effect order at which painting occurs).
AIAPI AIErr(*	SetColorPosn )(AIParserPaintField paintField, ai::int32 colorPosn)
	Sets the color position of a paint field (the point in the effect order at which painting occurs).
AIAPI AIErr(*	ClonePaintField )(AIParserPaintField paintField, AIParserPaintField *clonedPaintField)
	Copies a paint field data structure into a newly created equivalent structure.
AIAPI AIErr(*	GetPaintLiveEffectInfo )(AIParserPaintField paintField, AILiveEffectHandle liveEffectHandle, AILiveEffectParameters params)
	Retrieves LiveEffect and/or parameter references for Live Effects in a paint field that substitute for the built-in fill or stroke behavior.
AIAPI AIErr(*	SetPaintLiveEffectInfo )(AIParserPaintField paintField, AILiveEffectHandle liveEffectHandle, AILiveEffectParameters params)
	Sets the LiveEffect and/or parameter references for Live Effects in a paint field that substitute for the built-in fill or stroke behavior.
AIAPI AIErr(*	GetBlendDictionary )(AIParserBlendField blendField, AIDictionaryRef blendDict)
	Retrieves the transparency information for a blend field.
AIAPI AIErr(*	SetBlendDictionary )(AIParserBlendField blendField, AIDictionaryRef blendDict)
	Sets the transparency information for a blend field.
AIAPI AIErr(*	GetEvenOdd )(AIParserPaintField paintField, AIBoolean *evenodd)
	Retrieves the even-odd fill rule for a paint field.
AIAPI AIErr(*	SetEvenOdd )(AIParserPaintField paintField, AIBoolean evenodd)
	Sets the even-odd fill rule for a paint field.
AIAPI AIErr(*	NewPaintFieldFill )(const AIFillStyle fill, AIBoolean evenOdd, const AIArtStylePaintData paintData, AIParserPaintField *paintField)
	Constructs a new paint field with a given fill, even-odd fill rule, and gradient vector information.
AIAPI AIErr(*	NewPaintFieldStroke )(const AIStrokeStyle stroke, const AIArtStylePaintData paintData, AIParserPaintField *paintField)
	Constructs a new paint field with a given stroke.
AIAPI AIErr(*	DisposePaintField )(AIParserPaintField paintField)
	Frees the memory associated with a paint field.
AIAPI AIErr(*	NewParserLiveEffect )(AILiveEffectHandle liveEffectHandle, AILiveEffectParameters params, AIParserLiveEffect *effect)
	Constructs a new Live Effect parser data structure from Live Effect and parameters references.
AIAPI AIErr(*	DisposeParserLiveEffect )(AIParserLiveEffect effect)
	Frees the memory associated with a Live Effect parser data structure.
AIAPI AIErr(*	GetCurrentArtStyle )(AIArtStyleHandle *style)
	Retrieves the art style that is currently selected in the Graphic Styles palette.
AIAPI AIErr(*	EditPaintEffectParameters )(AIArtStyleHandle artStyle, AIParserPaintField paintField)
	Opens the editing dialog, allowing the user to edit the parameters of an effect that is substituting for a fill or stroke.
AIAPI AIBoolean(*	IsNormalOpaquePaintBlend )(AIParserPaintField paintField)
	Reports whether a paint field has normal 100% opacity.
AIAPI AIBoolean(*	IsNormalOpaqueBlend )(AIParserBlendField blendField)
	Reports whether a blend field has normal 100% opacity.
AIAPI AIBoolean(*	IsDefaultPaintBlend )(AIParserPaintField paintField)
	Reports whether a paint field has a default blend, that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit.
AIAPI AIErr(*	SetDefaultPaintBlend )(AIParserPaintField paintField)
	Sets a paint field to have a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute set to off.
AIAPI AIBoolean(*	IsDefaultBlend )(AIParserBlendField blendField)
	Reports whether a blend field is a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute set to either off or inherit.
AIAPI AIErr(*	SetDefaultBlend )(AIParserBlendField blendField, AIBoolean knockoutOff)
	Sets a blend field to a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute either set to off or maintained at the inherited value.
AIAPI AIBoolean(*	IsStyleSimple )(AIStyleParser parser)
	Reports whether the style parsed by a parser is a simple style; that is, a style with no effects, only one normal fully opaque fill and one normal fully opaque stroke, and the stroke stacked on top of the fill.
AIAPI AIErr(*	GetLiveEffectNameAndVersion )(AIParserLiveEffect effect, const char *name, ai::int32 major, ai::int32 *minor)
	Retrieves the name and major and minor versions of the Live Effect data structure in a parser.
AIAPI AIErr(*	GetPaintLiveEffectNameAndVersion )(AIParserPaintField paintField, const char *name, ai::int32 major, ai::int32 *minor)
	Retrieves the name and major and minor versions of the Live Effect in a paint field data structure in a parser.
AIAPI AIBoolean(*	CompareStyles )(AIStyleParser parserStyle1, AIStyleParser parserStyle2)
	Compares two parsed styles to check if they are equivalent.
AIAPI AIErr(*	GetEffectVisible )(AIParserLiveEffect effect, AIBoolean *visible)
	Reports the visibility status of an effect, which affects whether it is drawn.
AIAPI AIErr(*	SetEffectVisible )(AIArtStyleHandle artStyle, AIParserLiveEffect effect, AIBoolean visible)
	Sets the visibility status of an effect, which affects whether it is drawn.
AIAPI AIErr(*	GetPaintFieldVisible )(AIParserPaintField paintField, AIBoolean *visible)
	Reports the visibility status of a paint field, which affects whether it is drawn.
AIAPI AIErr(*	SetPaintFieldVisible )(AIArtStyleHandle artStyle, AIParserPaintField paintField, AIBoolean visible)
	Sets the visibility status of a paint field, which affects whether it is drawn.
AIAPI AIErr(*	GetBlendFieldVisible )(AIParserBlendField blendField, AIBoolean *visible)
	Reports the visibility status of a blend field, which affects whether it is drawn.
AIAPI AIErr(*	SetBlendFieldVisible )(AIArtStyleHandle artStyle, AIParserBlendField blendField, AIBoolean visible)
	Sets the visibility status of a blend field, which affects whether it is drawn.
AIAPI AIErr(*	GetPaintBlendVisible )(AIParserPaintField paintField, AIBoolean *visible)
	Reports the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn.
AIAPI AIErr(*	SetPaintBlendVisible )(AIArtStyleHandle artStyle, AIParserPaintField paintField, AIBoolean visible)
	Sets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn.
AIAPI AIErr(*	IntersectStyleWithParser )(AIStyleParser parser, AIArtStyleHandle artStyle)
	Modifies the properties of a parser, retaining properties that are common to both the parser and the given style, and discarding all other properties.
AIAPI AIErr(*	FindEquivalentPaintField )(AIStyleParser parser, AIParserPaintField paintField, ai::int32 startIndex, ai::int32 *index)
	Retrieves a paint field from a parser that is equivalent to a given paint field, starting at a given index in the parser.
AIAPI AIErr(*	GetFocusEffect )(AIStyleParser parser, AIParserLiveEffect *effectField)
	Retrieves the focus effect from a parser.
AIAPI AIErr(*	SetFocusEffect )(AIArtStyleHandle artStyle, AIStyleParser parser, AIParserLiveEffect effectField)
	Sets the focus effect for a parser, and also modifies the art style from which the parser's data structures were constructed.
AIAPI AIErr(*	SetParserFocusEffect )(AIStyleParser parser, AIParserLiveEffect effectField)
	Sets the focus effect for a parser.
AIAPI AIErr(*	EditEffectParametersInSelection )(AIParserLiveEffect effectField)
	Opens the editing dialog, allowing the user to edit the parameters of an effect.
AIAPI AIErr(*	FindEquivalentEffect )(AIStyleParser parser, AIParserPaintField paintField, AIParserLiveEffect effectField, AIBoolean preEffect, ai::int32 startIndex, ai::int32 *index)
	Searches a parser for an equivalent effect.
AIAPI AIBoolean(*	StyleContainsAttributes )(AIArtStyleHandle artStyle, AIStyleParser attributes, AIBoolean includeTransparency)
	Reports whether a style contains given attributes.
AIAPI AIErr(*	SetParserEffectVisible )(AIParserLiveEffect effect, AIBoolean visible)
	Sets the visibility of an effect for a parser.
AIAPI AIErr(*	SetParserPaintFieldVisible )(AIParserPaintField paintField, AIBoolean visible)
	Sets the visibility of a paint field for a parser.
AIAPI AIErr(*	SetParserBlendFieldVisible )(AIParserBlendField blendField, AIBoolean visible)
	Sets the visibility of a blend field for a parser.
AIAPI AIErr(*	SetParserPaintBlendVisible )(AIParserPaintField paintField, AIBoolean visible)
	Sets the visibility of a blend of a paint field (fill/stroke) for a parser.
AIAPI AIErr(*	NewPaintFieldSmoothShading )(AISmoothShadingStyle smoothStyle, AIParserPaintField &paintField)
	Constructs a new paint field with a given smooth shading.
AIAPI AIBoolean(*	IsSmoothShadingStyle )(AIParserPaintField paintField)
	Reports whether a paint field corresponds to a smooth shading style.
AIAPI AIErr(*	GetSmoothShadingStyle )(AIParserPaintField paintField, AISmoothShadingStylePtr &outSmoothStyle)
	Retrieves SmoothShadingStyle information from a paint field.
AIAPI AIErr(*	CloneEffectsList )(AIStyleParser parser, AIParserPaintField &fromPaintField, AIParserPaintField &toPaintField)
	Clone all the effect from fromPaintField field to toPaintField.
AIAPI AIErr(*	SetSmoothShadingStyle )(AIParserPaintField paintField, AISmoothShadingStylePtr inSmoothShadingStyle)
	Sets SmoothShadingStyle information for a paint field.

Detailed Description

The AIArtStyleParser allows you to manipulate art styles, and access information typically shown in the Appearance palette.

The parser constructs its own data structures when asked to parse an art style, which are tied to that art style unless modified. When parser data structures are modified, the relationship between the parser structure and art style becomes unreliable, and you should avoid making calls to SetFocus() and EditEffectParameters(), which depend on that relationship.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIArtStyleParserSuite and kAIArtStyleParserVersion.

You can call CreateNewStyle() to build a new style from an existing parser data structure, using a workflow like this:

NewParser(&parser)
ParseStyle(parser, artStyle)
...
<Manipulate the data structures - reordering, adding, removing, redefining properties, and so on.>
        ...
CreateNewStyle(parser, &newArtStyle)
DisposeParser(parser)

Member Data Documentation

AIAPI AIErr(* AIArtStyleParserSuite::CloneEffectsList)(AIStyleParser parser, AIParserPaintField &fromPaintField, AIParserPaintField &toPaintField)

Clone all the effect from fromPaintField field to toPaintField.

All existing effects on toPaintField will be lost.

Parameters:

	parser	: The parser.
	fromPaintField	: Source paint field from which effects should be applied.
	toPaintField	: Destination paint field on which effects will be applied.

AIAPI AIErr(* AIArtStyleParserSuite::CloneLiveEffect)(AIParserLiveEffect effect, AIParserLiveEffect *clonedEffect)

Copies a Live Effect data structure into a new equivalent structure.

Used by the Appearance palette when users duplicate a Live Effect.

Parameters:

	effect	The effect.
	clonedEffect	[out] A buffer in which to return the new Live Effect.

AIAPI AIErr(* AIArtStyleParserSuite::ClonePaintField)(AIParserPaintField paintField, AIParserPaintField *clonedPaintField)

Copies a paint field data structure into a newly created equivalent structure.

Used by the Appearance palette when users duplicate a fill or stroke.

Parameters:

	paintField	The paint field.
	clonedPaintField	[out] A buffer in which to return the new paint field.

AIAPI AIBoolean(* AIArtStyleParserSuite::CompareStyles)(AIStyleParser parserStyle1, AIStyleParser parserStyle2)

Compares two parsed styles to check if they are equivalent.

(Note that this function returns a boolean value, not an error code.) To compare two styles, create two AIStyleParser objects, call ParseStyle() for each object, then call this function.

Parameters:

	parserStyle1	The first style parser.
	parserStyle2	The second style parser.

Returns:: True if the parsed styles are equivalent, false otherwise.

AIAPI AIBoolean(* AIArtStyleParserSuite::ContainsEffects)(AIStyleParser parser)

Reports whether a parser has any Live Effects.

(Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the parser contains any effects.

AIAPI AIBoolean(* AIArtStyleParserSuite::ContainsPaint)(AIStyleParser parser)

Reports whether a parser has fill or stroke.

(Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the parser contains any non-empty fill or stroke values.

AIAPI AIBoolean(* AIArtStyleParserSuite::ContainsTransparency)(AIStyleParser parser)

Reports whether a parser has transparency.

(Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the parser contains any non-default transparency information.

AIAPI ai::int32(* AIArtStyleParserSuite::CountEffectsOfPaintField)(AIParserPaintField paintField)

Counts the number of Live Effects in a paint field.

(Note that this function returns a numeric value, not an error code.)

Parameters:

parser

The paint field.

Returns:: The number of Live Effects.

AIAPI ai::int32(* AIArtStyleParserSuite::CountPaintFields)(AIStyleParser parser)

Counts the number of paint fields in a parser.

A paint field corresponds to either a fill or a stroke in the art style. Each paint field can also contain Live Effects and transparency information. (Note that this function returns a numeric value, not an error code.)

Parameters:

parser

The parser.

Returns:: The number of paint fields.

AIAPI ai::int32(* AIArtStyleParserSuite::CountPostEffects)(AIStyleParser parser)

Counts the number of post-effects in a parser.

Post-effects are Live Effects that show up after all the fills and strokes in the Appearance palette. (Note that this function returns a numeric value, not an error code.)

Parameters:

parser

The parser.

Returns:: The number of post-Effects.

AIAPI ai::int32(* AIArtStyleParserSuite::CountPreEffects)(AIStyleParser parser)

Counts the number of pre-effects in a parser.

Pre-effects are Live Effects that show up before any fills and strokes in the Appearance palette. (Note that this function returns a numeric value, not an error code.)

Parameters:

parser

The parser.

Returns:: The number of pre-effects.

AIAPI AIErr(* AIArtStyleParserSuite::CreateNewStyle)(AIStyleParser parser, AIArtStyleHandle *artStyle)

Constructs a new art style based on the elements in a parser.

Call ParseStyle() with the new style before using SetFocus() or EditEffectParameters().

Parameters:

	parser	The parser.
	artStyle	[out] A buffer in which to return the new art style reference.

AIAPI AIErr(* AIArtStyleParserSuite::DisposePaintField)(AIParserPaintField paintField)

Frees the memory associated with a paint field.

Note:: Do not use on paint fields that are retrieved from or inserted into a parser. Freeing the parser with DisposeParser() frees its contained data structures.

Parameters:

paintField

The paint field. Upon return, this reference is no longer valid.

AIAPI AIErr(* AIArtStyleParserSuite::DisposeParser)(AIStyleParser parser)

Frees memory associated with a parser that is no longer needed.

Parameters:

The

parser. Upon return, this reference in no longer valid.

AIAPI AIErr(* AIArtStyleParserSuite::DisposeParserLiveEffect)(AIParserLiveEffect effect)

Frees the memory associated with a Live Effect parser data structure.

Note:: Do not use on effects that are retrieved from or inserted into a parser. Freeing the parser with DisposeParser() frees its contained data structures.

Parameters:

effect

The Live Effect data structure. Upon return, this reference is no longer valid.

AIAPI AIErr(* AIArtStyleParserSuite::EditEffectParameters)(AIArtStyleHandle artStyle, AIParserLiveEffect effect)

Opens the editing dialog, allowing the user to edit the parameters of an effect in an art style, and creates a new art style with the user's choices, which is applied to all the art objects currently targeted in the document.

Note:: Use this function with caution.

Parameters:

	artStyle	The art style, as previously passed to `ParseStyle()`.
	effect	The effect, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.

AIAPI AIErr(* AIArtStyleParserSuite::EditEffectParametersInSelection)(AIParserLiveEffect effectField)

Opens the editing dialog, allowing the user to edit the parameters of an effect.

Sets this as the focus effect, and updates the art styles of all the art objects currently targeted in the document with the user's choices.

Use this function with caution.

Parameters:

effectField The effect, as retrieved from a parser whose data structures have not been modified since a call to ParseStyle().

AIAPI AIErr(* AIArtStyleParserSuite::EditPaintEffectParameters)(AIArtStyleHandle artStyle, AIParserPaintField paintField)

Opens the editing dialog, allowing the user to edit the parameters of an effect that is substituting for a fill or stroke.

Creates a new art style with the user's choices, and applies it to all the art objects currently targeted in the document.

Note:: Use this function with caution.

Parameters:

	artStyle	The art style, as previously passed to `ParseStyle()`.
	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.

See also:: EditEffectParameters()

AIAPI AIErr(* AIArtStyleParserSuite::FindEquivalentEffect)(AIStyleParser parser, AIParserPaintField paintField, AIParserLiveEffect effectField, AIBoolean preEffect, ai::int32 startIndex, ai::int32 *index)

Searches a parser for an equivalent effect.

Searches post-effects by default; you can also choose to search pre-effects and/or paint fields.

Parameters:

	parser	The parser object.
	paintField	A paint field in which to search, or null to search only in pre- and/or post-effects.
	effectField	The effect for which an equivalent is wanted.
	preEffect	True to search pre-effects as well as post-effects.
	startIndex	The 0-based index into the parser at which to begin the search.
	index	[out] A buffer in which to return the 0-based index of the equivalent effect, or -1 if none is found.

AIAPI AIErr(* AIArtStyleParserSuite::FindEquivalentPaintField)(AIStyleParser parser, AIParserPaintField paintField, ai::int32 startIndex, ai::int32 *index)

Retrieves a paint field from a parser that is equivalent to a given paint field, starting at a given index in the parser.

Parameters:

	parser	The parser in which to search.
	paintField	The paint field to search for.
	startIndex	The 0-based index into the parser at which to begin the search.
	index	A buffer in which to return the 0-based index of the equivalent paint field, or -1 if none is found.

AIAPI AIErr(* AIArtStyleParserSuite::GetBlendDictionary)(AIParserBlendField blendField, AIDictionaryRef blendDict)

Retrieves the transparency information for a blend field.

See AIMask.h for the keys used to access information in the dictionary.

Parameters:

	blendField	The blend field.
	blendDict	The dictionary in which to return the transparency information.

AIAPI AIErr(* AIArtStyleParserSuite::GetBlendFieldVisible)(AIParserBlendField blendField, AIBoolean *visible)

Reports the visibility status of a blend field, which affects whether it is drawn.

Parameters:

	blendField	The blend field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	[out] A buffer in which to return true if the blend field is visible.

AIAPI ai::int32(* AIArtStyleParserSuite::GetColorPosn)(AIParserPaintField paintField)

Retrieves the color position of a paint field (the point in effect order at which painting occurs).

Parameters:

paintField

The paint field.

AIAPI AIErr(* AIArtStyleParserSuite::GetCurrentArtStyle)(AIArtStyleHandle *style)

Retrieves the art style that is currently selected in the Graphic Styles palette.

Gets the first of multiple selected styles.

Parameters:

style [out] A buffer in which to return the art style, or NULL if no style is selected.

AIAPI AIErr(* AIArtStyleParserSuite::GetEffectVisible)(AIParserLiveEffect effect, AIBoolean *visible)

Reports the visibility status of an effect, which affects whether it is drawn.

Parameters:

	effect	The effect, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	[out] A buffer in which to return true if the effect is visible.

AIAPI AIErr(* AIArtStyleParserSuite::GetEvenOdd)(AIParserPaintField paintField, AIBoolean *evenodd)

Retrieves the even-odd fill rule for a paint field.

(See the evenodd field in the AIPathStyle structure.)

Parameters:

	paintField	The paint field.
	evenodd	[out] A buffer in which to return true if the even-odd rule is used to determine path insideness.

Returns:: An error kBadParameterErr if the paint field does not correspond to a fill.

AIAPI AIErr(* AIArtStyleParserSuite::GetFill)(AIParserPaintField paintField, AIFillStyle *fill, AIArtStylePaintData *paintData)

Retrieves fill information from a paint field.

Parameters:

	paintField	The paint field.
	fill	[out] A buffer in which to return the fill style.
	paintData	[out] A buffer in which to return additional paint data.

AIAPI AIErr(* AIArtStyleParserSuite::GetFocusEffect)(AIStyleParser parser, AIParserLiveEffect *effectField)

Retrieves the focus effect from a parser.

If an art style has multiple effects, the user can only edit one at a time; the one currently being edited is the focus effect.

Parameters:

	parser	The parser.
	effectField	[out] A buffer in which to return the focus effect.

See also:: SetParserFocusEffect()

AIAPI AIErr(* AIArtStyleParserSuite::GetFocusFill)(AIStyleParser parser, AIParserPaintField *paintField)

Retrieves the focus fill from a parser.

If an art style has multiple fills, the user can only edit one at a time. The one currently being edited is the focus fill, and it is shown in the fill/stroke proxies on the Tool and Color palettes.

Parameters:

	parser	The parser.
	paintField	[out] A buffer in which to return the focus fill.

AIAPI AIErr(* AIArtStyleParserSuite::GetFocusStroke)(AIStyleParser parser, AIParserPaintField *paintField)

Retrieves the focus stroke from a parser.

If an art style has multiple strokes, the user can only edit one at a time. The one currently being edited is the focus stroke, and it is shown in the fill/stroke proxies on the Tool and Color palettes.

Parameters:

	parser	The parser.
	paintField	[out] A buffer in which to return the focus stroke.

AIAPI ai::int32(* AIArtStyleParserSuite::GetGroupContentsPosition)(AIStyleParser parser)

Retrieves the position in the stacking order (from top to bottom) where the Group Contents for a parser would be rendered.

(Note that this function returns a numeric value, not an error code.)

Group Contents affects the generation of styled art when applied to art container objects like groups or text. The Group Contents controls where the original contents inside the group are rendered relative to the stacking order of the fills and strokes in the art styles.

Parameters:

parser

The parser.

Returns:: The position in the stacking order.

AIAPI AIErr(* AIArtStyleParserSuite::GetLiveEffectHandle)(AIParserLiveEffect effect, AILiveEffectHandle *liveEffectHandle)

Retrieves the Live Effect object reference from a parser.

Parameters:

	parser	The parser.
	liveEffectHandle	[out] A buffer in which to return the Live Effect reference.

AIAPI AIErr(* AIArtStyleParserSuite::GetLiveEffectNameAndVersion)(AIParserLiveEffect effect, const char **name, ai::int32 *major, ai::int32 *minor)

Retrieves the name and major and minor versions of the Live Effect data structure in a parser.

Gets the name and version numbers even if the plug-in that provides the effect is missing and there is no LiveEffect object reference associated with the data structure.

Parameters:

	effect	The Live Effect data structure.
	name	[out] A buffer in which to return the internal name of the effect.
	major	[out] A buffer in which to return the major version of the effect.
	minor	[out] A buffer in which to return the minor version of the effect.

AIAPI AIErr(* AIArtStyleParserSuite::GetLiveEffectParams)(AIParserLiveEffect effect, AILiveEffectParameters *params)

Retrieves the LiveEffect parameters data structure from a parser.

Parameters:

	effect	The effect.
	params	[out] A buffer in which to return the Live Effect parameters.

AIAPI AIErr(* AIArtStyleParserSuite::GetNthEffectOfPaintField)(AIParserPaintField paintField, ai::int32 n, AIParserLiveEffect *effect)

Retrieves a Live Effect from a paint field by position index.

Use with CountEffectsOfPaintField() to iterate through Live Effects.

Parameters:

	paintField	The paint field.
	n	The position index, in the range `[0..numEffects-1]`.
	effect	[out] A buffer in which to return the effect.

AIAPI AIErr(* AIArtStyleParserSuite::GetNthPaintField)(AIStyleParser parser, ai::int32 n, AIParserPaintField *paintField)

Retrieves a paint field from a parser by position index.

Use with CountPaintFields() to iterate through paint fields.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numFields-1]`.
	paintField	[out] A buffer in which to return the paint field.

AIAPI AIErr(* AIArtStyleParserSuite::GetNthPostEffect)(AIStyleParser parser, ai::int32 n, AIParserLiveEffect *effect)

Retrieves a Post-Effect from a parser by position index.

Use with CountPostEffects() to iterate through PostEffects.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numEffects-1]`.
	effect	[out] A buffer in which to return the effect.

AIAPI AIErr(* AIArtStyleParserSuite::GetNthPreEffect)(AIStyleParser parser, ai::int32 n, AIParserLiveEffect *effect)

Retrieves a Pre-Effect from a parser by position index.

Use with CountPreEffects() to iterate through PreEffects.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numEffects-1]`.
	effect	[out] A buffer in which to return the effect.

AIAPI AIErr(* AIArtStyleParserSuite::GetPaintBlendDictionary)(AIParserPaintField paintField, AIDictionaryRef blendDict)

Retrieves transparency information from a paint field.

See AIMask.h for the keys used to get information from the dictionary.

Parameters:

	paintField	The paint field.
	blendDict	[out] A buffer in which to return the dictionary containing transparency information.

AIAPI AIErr(* AIArtStyleParserSuite::GetPaintBlendVisible)(AIParserPaintField paintField, AIBoolean *visible)

Reports the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn.

Parameters:

	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	[out] A buffer in which to return true if the blend field is visible, false otherwise.

AIAPI AIErr(* AIArtStyleParserSuite::GetPaintFieldVisible)(AIParserPaintField paintField, AIBoolean *visible)

Reports the visibility status of a paint field, which affects whether it is drawn.

Parameters:

	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	[out] A buffer in which to return true if the paint field is visible, false otherwise.

AIAPI AIErr(* AIArtStyleParserSuite::GetPaintLiveEffectInfo)(AIParserPaintField paintField, AILiveEffectHandle *liveEffectHandle, AILiveEffectParameters *params)

Retrieves LiveEffect and/or parameter references for Live Effects in a paint field that substitute for the built-in fill or stroke behavior.

The returned parameters can be non-null even when the Live Effect reference is null, in the case where the built-in fill or stroke filter has a parameter dictionary that contains non-basic options other than transparency.

Note:: Current examples of strokes with an effect handle are Brushes and Inside/Outside Aligned strokes, which are implemented as Live Effects that replace the default stroking behavior. The only current example of a paint field that returns a null Live Effect reference but non-null parameters are strokes with dash adjustment, arrowheads, or other Beautiful Strokes options. (See AIBeautifulStrokes.h).

Parameters:

	paintField	The paint field
	liveEffectHandle	[out] A buffer in which to return the Live Effect reference. Can be `NULL`.
	params	[out] A buffer in which to return the Live Effect parameters. Can be `NULL`.

AIAPI AIErr(* AIArtStyleParserSuite::GetPaintLiveEffectNameAndVersion)(AIParserPaintField paintField, const char **name, ai::int32 *major, ai::int32 *minor)

Retrieves the name and major and minor versions of the Live Effect in a paint field data structure in a parser.

Gets the name and version numbers even if the plug-in that provides the effect is missing.

Parameters:

	paintField	The paint field data structure.
	name	[out] A buffer in which to return the internal name of the effect, or `NULL` if no Live Effect is substituting for the built-in fill or stroke behavior.
	major	[out] A buffer in which to return the major version of the effect, or 0 if no Live Effect is substituting for the built-in fill or stroke behavior.
	minor	[out] A buffer in which to return the minor version of the effect, or 0 if no Live Effect is substituting for the built-in fill or stroke behavior.

AIAPI AIErr(* AIArtStyleParserSuite::GetSmoothShadingStyle)(AIParserPaintField paintField, AISmoothShadingStylePtr &outSmoothStyle)

Retrieves SmoothShadingStyle information from a paint field.

Parameters:

	paintField	The paint field.
	outSmoothStyle	[out] A buffer in which to return the SmoothShadingStyle style.

AIAPI AIErr(* AIArtStyleParserSuite::GetStroke)(AIParserPaintField paintField, AIStrokeStyle *stroke, AIArtStylePaintData *paintData)

Retrieves stroke information from a paint field.

Parameters:

	paintField	The paint field.
	stroke	[out] A buffer in which to return the stroke style.
	paintData	[out] A buffer in which to return additional paint data.

AIAPI AIErr(* AIArtStyleParserSuite::GetStyleBlendField)(AIStyleParser parser, AIParserBlendField *blendField)

Retrieves the overall art style transparency from a parser in the form of a blend field.

Parameters:

	parser	The parser.
	blendField	[out] A buffer in which to return the blend field.

AIAPI AIErr(* AIArtStyleParserSuite::InsertNthEffectOfPaintField)(AIStyleParser parser, AIParserPaintField paintField, ai::int32 n, AIParserLiveEffect effect)

Inserts a Live Effect into a paint field in a parser at specified index.

Parameters:

	parser	The parser.
	paintField	The paint field.
	n	The position index, in the range `[0..numEffects-1]`. Use -1 to insert element at the end.
	effect	The Live Effect.

AIAPI AIErr(* AIArtStyleParserSuite::InsertNthPaintField)(AIStyleParser parser, ai::int32 n, AIParserPaintField paintField)

Inserts a paint field into a parser at a specified index.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numFields-1]`. Use -1 to insert element at the end.
	paintField	The paint field.

AIAPI AIErr(* AIArtStyleParserSuite::InsertNthPostEffect)(AIStyleParser parser, ai::int32 n, AIParserLiveEffect effect)

Inserts a Post-Effect into the parser at a specified index.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numEffects-1]`. Use -1 to insert element at the end.
	effect	The effect.

AIAPI AIErr(* AIArtStyleParserSuite::InsertNthPreEffect)(AIStyleParser parser, ai::int32 n, AIParserLiveEffect effect)

Inserts a Pre-Effect into a parser at a specified index.

Parameters:

	parser	The parser.
	n	The position index, in the range `[0..numEffects-1]`. Use -1 to insert element at the end.
	effect	The effect.

AIAPI AIErr(* AIArtStyleParserSuite::IntersectStyleWithParser)(AIStyleParser parser, AIArtStyleHandle artStyle)

Modifies the properties of a parser, retaining properties that are common to both the parser and the given style, and discarding all other properties.

You can use this to determine the common properties of two styles.

Parameters:

	parser	The parser.
	artStyle	The art style.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsDefaultBlend)(AIParserBlendField blendField)

Reports whether a blend field is a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute set to either off or inherit.

(Note that this function returns a boolean value, not an error code.)

Parameters:

blendField

The blend field.

Returns:: True if the blend field is a default blend.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsDefaultPaintBlend)(AIParserPaintField paintField)

Reports whether a paint field has a default blend, that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit.

(Note that this function returns a boolean value, not an error code.)

Parameters:

paintField

The paint field.

Returns:: True if the paint field has a default blend.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsFill)(AIParserPaintField paintField)

Reports whether a paint field corresponds to a fill.

(Note that this function returns a boolean value, not an error code.)

Parameters:

paintField

The paint field.

Returns:: True if the paint field is for a fill.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsNormalOpaqueBlend)(AIParserBlendField blendField)

Reports whether a blend field has normal 100% opacity.

Does not check other transparency attributes, such as knockout or isolated blending. (Note that this function returns a boolean value, not an error code.)

Parameters:

blendField

The blend field.

Returns:: True if the blend field is opaque.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsNormalOpaquePaintBlend)(AIParserPaintField paintField)

Reports whether a paint field has normal 100% opacity.

Does not check other transparency attributes, such as knockout or isolated blending. (Note that this function returns a boolean value, not an error code.)

Parameters:

paintField

The paint field.

Returns:: True if the paint field is opaque.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsSmoothShadingStyle)(AIParserPaintField paintField)

Reports whether a paint field corresponds to a smooth shading style.

(Note that this function returns a boolean value, not an error code.)

Parameters:

paintField

The paint field.

Returns:: True if the paint field is for a smooth shading style.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsStroke)(AIParserPaintField paintField)

Reports whether a paint field corresponds to a stroke.

(Note that this function returns a boolean value, not an error code.)

Parameters:

paintField

The paint field.

Returns:: True if the paint field is for a stroke.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsStyleParseable)(AIStyleParser parser)

Reports whether a parser was able to successfully parse an art style.

Valid only immediately after a call to ParseStyle() using this parser. (Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the most recent parsing operation was successful.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsStyleSimple)(AIStyleParser parser)

Reports whether the style parsed by a parser is a simple style; that is, a style with no effects, only one normal fully opaque fill and one normal fully opaque stroke, and the stroke stacked on top of the fill.

(Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the parsed style is simple.

AIAPI AIBoolean(* AIArtStyleParserSuite::IsStyleVisible)(AIStyleParser parser)

Reports whether a style is invisible; that is, there are no effects, all the paint fields have a color of none, and the overall transparency contains default values.

(Note that this function returns a boolean value, not an error code.)

Parameters:

parser

The parser.

Returns:: True if the associated style is invisible.

AIAPI AIErr(* AIArtStyleParserSuite::MergeStyleIntoParser)(AIStyleParser parser, AIArtStyleHandle artStyle)

Merges the properties of an art style into a parser.

The same as the "Merge Graphic Styles" option in the Graphic Styles palette flyout menu.

Parameters:

	parser	The parser.
	artStyle	The art style.

AIAPI AIErr(* AIArtStyleParserSuite::MoveGroupContentsPosition)(AIStyleParser parser, ai::int32 position)

Move the Group Contents position in a parser.

Parameters:

	parser	The parser.
	position	The new position in the stacking order, from top to bottom.

See also:: GetGroupContentsPosition()

AIAPI AIErr(* AIArtStyleParserSuite::NewPaintFieldFill)(const AIFillStyle *fill, AIBoolean evenOdd, const AIArtStylePaintData *paintData, AIParserPaintField *paintField)

Constructs a new paint field with a given fill, even-odd fill rule, and gradient vector information.

The new paint field is not associated with any parser.

Parameters:

	fill	The fill style.
	evenOdd	True if the even-odd rule should be used to determine path insideness.
	paintData	The paint data structure containing the gradient vector information. Can be `NULL`.
	paintField	[out] A buffer in which to return the new paint field.

AIAPI AIErr(* AIArtStyleParserSuite::NewPaintFieldSmoothShading)(AISmoothShadingStyle smoothStyle, AIParserPaintField &paintField)

Constructs a new paint field with a given smooth shading.

The new paint field is not associated with any parser.

Parameters:

	smoothStyle	The smoothStyle style.
	paintField	[out] A buffer in which to return the new paint field.

AIAPI AIErr(* AIArtStyleParserSuite::NewPaintFieldStroke)(const AIStrokeStyle *stroke, const AIArtStylePaintData *paintData, AIParserPaintField *paintField)

Constructs a new paint field with a given stroke.

The new paint field is not associated with any parser.

Parameters:

	stroke	The stroke style.
	paintData	Not used, pass `NULL`.
	paintField	[out] A buffer in which to return the new paint field.

AIAPI AIErr(* AIArtStyleParserSuite::NewParser)(AIStyleParser *parser)

Constructs a new parser.

Parameters:

parser

[out] A buffer in which to return the new parser reference.

AIAPI AIErr(* AIArtStyleParserSuite::NewParserLiveEffect)(AILiveEffectHandle liveEffectHandle, AILiveEffectParameters params, AIParserLiveEffect *effect)

Constructs a new Live Effect parser data structure from Live Effect and parameters references.

The new data structure is not associated with any parser.

Parameters:

	liveEffectHandle	The Live Effect reference.
	params	The parameters reference.
	effect	[out] A buffer in which to return the new effect.

AIAPI AIErr(* AIArtStyleParserSuite::ParseStyle)(AIStyleParser parser, AIArtStyleHandle artStyle)

Parses the contents of an art style, creating parser data structures accordingly.

Parameters:

	parser	The parser.
	artStyle	The art style.

AIAPI AIErr(* AIArtStyleParserSuite::RemoveAllEffects)(AIStyleParser parser)

Removes all the effects from a parser.

Parameters:

parser

The parser.

AIAPI AIErr(* AIArtStyleParserSuite::RemoveEffectOfPaintField)(AIStyleParser parser, AIParserPaintField paintField, AIParserLiveEffect effect, AIBoolean doDelete)

Removes a Live Effect from a paint field in a parser.

Parameters:

	parser	The parser.
	paintField	The paint field.
	effect	The effect.
	doDelete	When true, dispose of the memory associated with the element. You might not want to do this if you are moving elements from one position to another.

AIAPI AIErr(* AIArtStyleParserSuite::RemovePaintField)(AIStyleParser parser, AIParserPaintField paintField, AIBoolean doDelete)

Removes a paint field from a parser.

Parameters:

	parser	The parser.
	paintField	The paint field.
	doDelete	When true, dispose of the memory associated with the element. You might not want to do this if you are moving elements from one position to another.

AIAPI AIErr(* AIArtStyleParserSuite::RemovePostEffect)(AIStyleParser parser, AIParserLiveEffect effect, AIBoolean doDelete)

Removes a Post-Effect from a parser.

Parameters:

	parser	The parser.
	effect	The effect.
	doDelete	When true, dispose of the memory associated with the element. You might not want to do this if you are moving elements from one position to another.

AIAPI AIErr(* AIArtStyleParserSuite::RemovePreEffect)(AIStyleParser parser, AIParserLiveEffect effect, AIBoolean doDelete)

Removes a Pre-Effect from a parser.

Parameters:

	parser	The parser.
	effect	The effect.
	doDelete	When true, dispose of the memory associated with the element. You might not want to do this if you are moving elements from one position to another.

AIAPI AIErr(* AIArtStyleParserSuite::SetBlendDictionary)(AIParserBlendField blendField, AIDictionaryRef blendDict)

Sets the transparency information for a blend field.

See AIMask.h for the keys used to access information in the dictionary.

Parameters:

	blendField	The blend field.
	blendDict	The dictionary containing the transparency information.

AIAPI AIErr(* AIArtStyleParserSuite::SetBlendFieldVisible)(AIArtStyleHandle artStyle, AIParserBlendField blendField, AIBoolean visible)

Sets the visibility status of a blend field, which affects whether it is drawn.

This is applied to all the art objects currently targeted in the document.

Parameters:

	artStyle	The art style that contains the blend field (as previously passed to `ParseStyle()`).
	blendField	The blend field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the blend field.

AIAPI AIErr(* AIArtStyleParserSuite::SetColorPosn)(AIParserPaintField paintField, ai::int32 colorPosn)

Sets the color position of a paint field (the point in the effect order at which painting occurs).

Parameters:

paintField

The paint field.

AIAPI AIErr(* AIArtStyleParserSuite::SetDefaultBlend)(AIParserBlendField blendField, AIBoolean knockoutOff)

Sets a blend field to a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute either set to off or maintained at the inherited value.

Parameters:

	blendField	The blend field to set.
	knockoutOff	True to turn knockout off. False to maintain the inherited knockout value, unless that value is on, in which case it is set to off.

AIAPI AIErr(* AIArtStyleParserSuite::SetDefaultPaintBlend)(AIParserPaintField paintField)

Sets a paint field to have a default blend; that is, normal 100% opacity, with non-isolated blending and the knockout attribute set to off.

Parameters:

paintField

The paint field.

AIAPI AIErr(* AIArtStyleParserSuite::SetEffectVisible)(AIArtStyleHandle artStyle, AIParserLiveEffect effect, AIBoolean visible)

Sets the visibility status of an effect, which affects whether it is drawn.

This is applied to all the art objects currently targeted in the document.

Parameters:

	artStyle	The art style that contains the effect (as previously passed to `ParseStyle()`).
	effect	The effect, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the effect.

AIAPI AIErr(* AIArtStyleParserSuite::SetEvenOdd)(AIParserPaintField paintField, AIBoolean evenodd)

Sets the even-odd fill rule for a paint field.

(See the evenodd field in the AIPathStyle structure.)

Parameters:

	paintField	The paint field.
	evenodd	True if the even-odd rule should be used to determine path insideness.

Returns:: An error kBadParameterErr if the paint field does not correspond to a fill.

AIAPI AIErr(* AIArtStyleParserSuite::SetFill)(AIParserPaintField paintField, AIFillStyle *fill, AIArtStylePaintData *paintData)

Sets fill information for a paint field.

Parameters:

	paintField	The paint field.
	fill	The new fill style.
	paintData	Additional paint data.

AIAPI AIErr(* AIArtStyleParserSuite::SetFocus)(AIArtStyleHandle artStyle, AIStyleParser parser, AIParserPaintField paintField)

Sets the focus fill or focus stroke for a parser, and also modifies the art style from which the parser's data structures were constructed.

Use when the data structures in the given parser have not been modified since the call to ParseStyle().

Parameters:

	artStyle	The art style that was passed to `ParseStyle()` for this parser
	parser	The parser
	paintField	The fill or stroke.

See also:: SetParserFocus()

AIAPI AIErr(* AIArtStyleParserSuite::SetFocusEffect)(AIArtStyleHandle artStyle, AIStyleParser parser, AIParserLiveEffect effectField)

Sets the focus effect for a parser, and also modifies the art style from which the parser's data structures were constructed.

Use when the data structures in the given parser have not been modified since the call to ParseStyle().

Parameters:

	artStyle	The art style that was passed to `ParseStyle()` for this parser
	parser	The parser.
	effectField	The new focus effect.

See also:: SetParserFocusEffect()

AIAPI AIErr(* AIArtStyleParserSuite::SetLiveEffectHandle)(AIParserLiveEffect effect, AILiveEffectHandle liveEffectHandle)

Sets the Live Effect object reference in a parser.

Parameters:

	parser	The parser.
	liveEffectHandle	The Live Effect reference.

AIAPI AIErr(* AIArtStyleParserSuite::SetLiveEffectParams)(AIParserLiveEffect effect, AILiveEffectParameters params)

Sets the Live Effect parameters data structure in a parser.

Parameters:

	effect	The effect.
	params	The Live Effect parameters.

AIAPI AIErr(* AIArtStyleParserSuite::SetPaintBlendDictionary)(AIParserPaintField paintField, AIDictionaryRef blendDict)

Sets the transparency information for a paint field.

See AIMask.h for the keys used to set information in the dictionary.

Parameters:

	paintField	The paint field.
	blendDict	The dictionary containing transparency information.

AIAPI AIErr(* AIArtStyleParserSuite::SetPaintBlendVisible)(AIArtStyleHandle artStyle, AIParserPaintField paintField, AIBoolean visible)

Sets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn.

This is applied to all the art objects currently targeted in the document.

Parameters:

	artStyle	The art style that contains the blend field (as previously passed to `ParseStyle()`).
	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the blend field.

AIAPI AIErr(* AIArtStyleParserSuite::SetPaintFieldVisible)(AIArtStyleHandle artStyle, AIParserPaintField paintField, AIBoolean visible)

Sets the visibility status of a paint field, which affects whether it is drawn.

This is applied to all the art objects currently targeted in the document.

Parameters:

	artStyle	The art style that contains the paint field (as previously passed to `ParseStyle()`).
	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the paint field.

AIAPI AIErr(* AIArtStyleParserSuite::SetPaintLiveEffectInfo)(AIParserPaintField paintField, AILiveEffectHandle liveEffectHandle, AILiveEffectParameters params)

Sets the LiveEffect and/or parameter references for Live Effects in a paint field that substitute for the built-in fill or stroke behavior.

Parameters:

	paintField	The paint field
	liveEffectHandle	The Live Effect reference. Pass null to remove the live effect.
	params	The Live Effect parameters. Pass null to remove the live effect parameters.

AIAPI AIErr(* AIArtStyleParserSuite::SetParserBlendFieldVisible)(AIParserBlendField blendField, AIBoolean visible)

Sets the visibility of a blend field for a parser.

Parameters:

	blendField	The blend field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the blend field.

AIAPI AIErr(* AIArtStyleParserSuite::SetParserEffectVisible)(AIParserLiveEffect effect, AIBoolean visible)

Sets the visibility of an effect for a parser.

Parameters:

	effect	The effect, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the effect.

AIAPI AIErr(* AIArtStyleParserSuite::SetParserFocus)(AIStyleParser parser, AIParserPaintField paintField)

Sets the focus fill or focus stroke for a parser.

Parameters:

	parser	The parser.
	paintField	The fill or stroke.

See also:: SetFocus()

AIAPI AIErr(* AIArtStyleParserSuite::SetParserFocusEffect)(AIStyleParser parser, AIParserLiveEffect effectField)

Sets the focus effect for a parser.

Parameters:

	parser	The parser.
	effectField	The new focus effect.

See also:: SetFocusEffect()

AIAPI AIErr(* AIArtStyleParserSuite::SetParserPaintBlendVisible)(AIParserPaintField paintField, AIBoolean visible)

Sets the visibility of a blend of a paint field (fill/stroke) for a parser.

Parameters:

	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the paint blend

AIAPI AIErr(* AIArtStyleParserSuite::SetParserPaintFieldVisible)(AIParserPaintField paintField, AIBoolean visible)

Sets the visibility of a paint field for a parser.

Parameters:

	paintField	The paint field, as retrieved from a parser whose data structures have not been modified since the call `ParseStyle()`.
	visible	True to show, false to hide the paint field

AIAPI AIErr(* AIArtStyleParserSuite::SetSmoothShadingStyle)(AIParserPaintField paintField, AISmoothShadingStylePtr inSmoothShadingStyle)

Sets SmoothShadingStyle information for a paint field.

Parameters:

	paintField	The paint field.
	inSmoothShadingStyle,:	The new smooths shading style.

Returns:: error if paintField kind is not smooth shading.

AIAPI AIErr(* AIArtStyleParserSuite::SetStroke)(AIParserPaintField paintField, AIStrokeStyle *stroke, AIArtStylePaintData *paintData)

Sets stroke information for a paint field.

Parameters:

	paintField	The paint field.
	stroke	The new stroke style.
	paintData	Additional paint data.

AIAPI AIErr(* AIArtStyleParserSuite::Simplify)(AIStyleParser parser)

Removes all the effects and all the paint fields from a parser, except the focus fill and stroke.

These are the ones that the user is currently editing, which show in the fill and stroke proxies in the Tool and Color palettes. The function also resets all transparency to normal 100% opaque and places the focus stroke on top of the focus fill in the stacking order.

Parameters:

parser

The parser.

AIAPI AIBoolean(* AIArtStyleParserSuite::StyleContainsAttributes)(AIArtStyleHandle artStyle, AIStyleParser attributes, AIBoolean includeTransparency)

Reports whether a style contains given attributes.

Parameters:

	artStyle	The art style.
	attributes	The parser that contains the attributes to be matched.
	includeTransparency	True to include the transparency field in the attributes to be matched. .

The documentation for this struct was generated from the following file:

AIArtStyleParser.h

AIArtStyleParserSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIArtStyleParserSuite Struct Reference
[API Suite List]