#include <IXPAttributeSuite.h>

Inheritance diagram for IXPAttributeSuite:

Classes
class	AttributeTypeAndValue

class	AttributeValue

class	PartialADXY

Public Types
enum	{ kDefaultIID = IID_IXPATTRIBUTESUITE }

enum	AttributeTarget { kTargetInvalid, kTargetPageItem, kTargetStroke, kTargetFill, kTargetContent, kMaxTarget }

enum	AttributeGroup { kGroupInvalid = -1, kGroupBlending, kGroupDropShadow, kGroupFeather, kGroupInnerShadow, kGroupOuterGlow, kGroupInnerGlow, kGroupBevelEmboss, kGroupSatin, kGroupDirectionalFeather, kGroupGradientFeather, kMaxGroup }

enum	AttributeDataType { kDataTypeInvalid = -1, kDataTypeColor, kDataTypeBoolean, kDataTypeReal, kDataTypePMBlendingMode, kDataTypePMDropShadowMode, kDataTypePMVignetteMode, kDataTypePMVignetteCorners, kDataTypePMGlowTechnique, kDataTypePMInnerGlowSource, kDataTypePMBevelEmbossStyle, kDataTypePMBevelEmbossTechnique, kDataTypePMBevelEmbossDirection, kDataTypePMFollowShapeMode, kDataTypeGradientType, kDataTypeOpacityGradientStops, kDataTypePoint }

enum	AttributeRealKind { kRealKindInvalid, kRealKindXOffset, kRealKindYOffset, kRealKindDistance, kRealKindPercentage, kRealKindBlurWidth, kRealKindAngle, kRealKindAltitude, kRealKindEmbossDepth, kRealKindSoftenAmount, kRealKindFeatherWidth }

enum	AttributeType { kUnknownAttrType = -1, kBSOpacity = 0, kBSBlendMode, kBSKnockoutGroup, kBSIsolationGroup, kDSMode, kDSOffsetX, kDSOffsetY, kDSGray_Obsolete, kDSOpacity, kDSBlendMode, kDSBlurRadius, kVTMode, kVTWidth, kVTOuterOpacity, kVTInnerOpacity, kVTCorners, kDSColor, kDSSpread, kDSNoise, kVTNoise, kDropShadowBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupDropShadow), kDropShadowUseGlobalLight, kDropShadowKO, kDropShadowHonorFX, kFeatherBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupFeather), kFeatherChoke, kInnerShadowBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupInnerShadow), kInnerShadowApply, kInnerShadowColor, kInnerShadowBlendMode, kInnerShadowOpacity, kInnerShadowAngle, kInnerShadowDistance, kInnerShadowUseGlobalLight, kInnerShadowChoke, kInnerShadowSize, kInnerShadowNoise, kOuterGlowBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupOuterGlow), kOuterGlowApply, kOuterGlowBlendMode, kOuterGlowOpacity, kOuterGlowNoise, kOuterGlowColor, kOuterGlowTechnique, kOuterGlowSpread, kOuterGlowSize, kInnerGlowBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupInnerGlow), kInnerGlowApply, kInnerGlowBlendMode, kInnerGlowOpacity, kInnerGlowNoise, kInnerGlowColor, kInnerGlowTechnique, kInnerGlowSpread, kInnerGlowSize, kInnerGlowSource, kBevelEmbossBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupBevelEmboss), kBevelEmbossApply, kBevelEmbossStyle, kBevelEmbossTechnique, kBevelEmbossDepth, kBevelEmbossDirection, kBevelEmbossSize, kBevelEmbossSoften, kBevelEmbossAngle, kBevelEmbossAltitude, kBevelEmbossUseGlobalLight, kBevelEmbossHighlightColor, kBevelEmbossHighlightBlendMode, kBevelEmbossHighlightOpacity, kBevelEmbossShadowColor, kBevelEmbossShadowBlendMode, kBevelEmbossShadowOpacity, kSatinBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupSatin), kSatinApply, kSatinColor, kSatinBlendMode, kSatinOpacity, kSatinAngle, kSatinDistance, kSatinSize, kSatinInvert, kDirectionalFeatherBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupDirectionalFeather), kDirectionalFeatherApply, kDirectionalFeatherWidthLeft, kDirectionalFeatherWidthRight, kDirectionalFeatherWidthTop, kDirectionalFeatherWidthBottom, kDirectionalFeatherAngle, kDirectionalFeatherFollowShape, kDirectionalFeatherNoise, kDirectionalFeatherChoke, kGradientFeatherBaseID = BASE_XP_ATTR(kTargetPageItem, kGroupGradientFeather), kGradientFeatherApply, kGradientFeatherType, kGradientFeatherOpacityStops, kGradientFeatherAngle, kGradientFeatherLength, kGradientFeatherCenter, kGradientFeatherRadius, kGradientFeatherHiliteAngle, kGradientFeatherHiliteLength, kStrokeBlendingBaseID = BASE_XP_ATTR(kTargetStroke, kGroupBlending), kStrokeBlendingOpacity, kStrokeBlendingBlendMode, kStrokeBlendingKnockoutGroup, kStrokeBlendingIsolationGroup, kStrokeDropShadowBaseID = BASE_XP_ATTR(kTargetStroke, kGroupDropShadow), kStrokeDropShadowMode, kStrokeDropShadowOffsetX, kStrokeDropShadowOffsetY, kStrokeDropShadowOpacity, kStrokeDropShadowBlendMode, kStrokeDropShadowBlurRadius, kStrokeDropShadowSpread, kStrokeDropShadowNoise, kStrokeDropShadowColor, kStrokeDropShadowUseGlobalLight, kStrokeDropShadowKO, kStrokeDropShadowHonorFX, kStrokeFeatherBaseID = BASE_XP_ATTR(kTargetStroke, kGroupFeather), kStrokeFeatherMode, kStrokeFeatherWidth, kStrokeFeatherCorners, kStrokeFeatherNoise, kStrokeFeatherChoke, kStrokeInnerShadowBaseID = BASE_XP_ATTR(kTargetStroke, kGroupInnerShadow), kStrokeInnerShadowApply, kStrokeInnerShadowColor, kStrokeInnerShadowBlendMode, kStrokeInnerShadowOpacity, kStrokeInnerShadowAngle, kStrokeInnerShadowDistance, kStrokeInnerShadowUseGlobalLight, kStrokeInnerShadowChoke, kStrokeInnerShadowSize, kStrokeInnerShadowNoise, kStrokeOuterGlowBaseID = BASE_XP_ATTR(kTargetStroke, kGroupOuterGlow), kStrokeOuterGlowApply, kStrokeOuterGlowBlendMode, kStrokeOuterGlowOpacity, kStrokeOuterGlowNoise, kStrokeOuterGlowColor, kStrokeOuterGlowTechnique, kStrokeOuterGlowSpread, kStrokeOuterGlowSize, kStrokeInnerGlowBaseID = BASE_XP_ATTR(kTargetStroke, kGroupInnerGlow), kStrokeInnerGlowApply, kStrokeInnerGlowBlendMode, kStrokeInnerGlowOpacity, kStrokeInnerGlowNoise, kStrokeInnerGlowColor, kStrokeInnerGlowTechnique, kStrokeInnerGlowSpread, kStrokeInnerGlowSize, kStrokeInnerGlowSource, kStrokeBevelEmbossBaseID = BASE_XP_ATTR(kTargetStroke, kGroupBevelEmboss), kStrokeBevelEmbossApply, kStrokeBevelEmbossStyle, kStrokeBevelEmbossTechnique, kStrokeBevelEmbossDepth, kStrokeBevelEmbossDirection, kStrokeBevelEmbossSize, kStrokeBevelEmbossSoften, kStrokeBevelEmbossAngle, kStrokeBevelEmbossAltitude, kStrokeBevelEmbossUseGlobalLight, kStrokeBevelEmbossHighlightColor, kStrokeBevelEmbossHighlightBlendMode, kStrokeBevelEmbossHighlightOpacity, kStrokeBevelEmbossShadowColor, kStrokeBevelEmbossShadowBlendMode, kStrokeBevelEmbossShadowOpacity, kStrokeSatinBaseID = BASE_XP_ATTR(kTargetStroke, kGroupSatin), kStrokeSatinApply, kStrokeSatinColor, kStrokeSatinBlendMode, kStrokeSatinOpacity, kStrokeSatinAngle, kStrokeSatinDistance, kStrokeSatinSize, kStrokeSatinInvert, kStrokeDirectionalFeatherBaseID = BASE_XP_ATTR(kTargetStroke, kGroupDirectionalFeather), kStrokeDirectionalFeatherApply, kStrokeDirectionalFeatherWidthLeft, kStrokeDirectionalFeatherWidthRight, kStrokeDirectionalFeatherWidthTop, kStrokeDirectionalFeatherWidthBottom, kStrokeDirectionalFeatherAngle, kStrokeDirectionalFeatherFollowShape, kStrokeDirectionalFeatherNoise, kStrokeDirectionalFeatherChoke, kStrokeGradientFeatherBaseID = BASE_XP_ATTR(kTargetStroke, kGroupGradientFeather), kStrokeGradientFeatherApply, kStrokeGradientFeatherType, kStrokeGradientFeatherOpacityStops, kStrokeGradientFeatherAngle, kStrokeGradientFeatherLength, kStrokeGradientFeatherCenter, kStrokeGradientFeatherRadius, kStrokeGradientFeatherHiliteAngle, kStrokeGradientFeatherHiliteLength, kFillBlendingBaseID = BASE_XP_ATTR(kTargetFill, kGroupBlending), kFillBlendingOpacity, kFillBlendingBlendMode, kFillBlendingKnockoutGroup, kFillBlendingIsolationGroup, kFillDropShadowBaseID = BASE_XP_ATTR(kTargetFill, kGroupDropShadow), kFillDropShadowMode, kFillDropShadowOffsetX, kFillDropShadowOffsetY, kFillDropShadowOpacity, kFillDropShadowBlendMode, kFillDropShadowBlurRadius, kFillDropShadowSpread, kFillDropShadowNoise, kFillDropShadowColor, kFillDropShadowUseGlobalLight, kFillDropShadowKO, kFillDropShadowHonorFX, kFillFeatherBaseID = BASE_XP_ATTR(kTargetFill, kGroupFeather), kFillFeatherMode, kFillFeatherWidth, kFillFeatherCorners, kFillFeatherNoise, kFillFeatherChoke, kFillInnerShadowBaseID = BASE_XP_ATTR(kTargetFill, kGroupInnerShadow), kFillInnerShadowApply, kFillInnerShadowColor, kFillInnerShadowBlendMode, kFillInnerShadowOpacity, kFillInnerShadowAngle, kFillInnerShadowDistance, kFillInnerShadowUseGlobalLight, kFillInnerShadowChoke, kFillInnerShadowSize, kFillInnerShadowNoise, kFillOuterGlowBaseID = BASE_XP_ATTR(kTargetFill, kGroupOuterGlow), kFillOuterGlowApply, kFillOuterGlowBlendMode, kFillOuterGlowOpacity, kFillOuterGlowNoise, kFillOuterGlowColor, kFillOuterGlowTechnique, kFillOuterGlowSpread, kFillOuterGlowSize, kFillInnerGlowBaseID = BASE_XP_ATTR(kTargetFill, kGroupInnerGlow), kFillInnerGlowApply, kFillInnerGlowBlendMode, kFillInnerGlowOpacity, kFillInnerGlowNoise, kFillInnerGlowColor, kFillInnerGlowTechnique, kFillInnerGlowSpread, kFillInnerGlowSize, kFillInnerGlowSource, kFillBevelEmbossBaseID = BASE_XP_ATTR(kTargetFill, kGroupBevelEmboss), kFillBevelEmbossApply, kFillBevelEmbossStyle, kFillBevelEmbossTechnique, kFillBevelEmbossDepth, kFillBevelEmbossDirection, kFillBevelEmbossSize, kFillBevelEmbossSoften, kFillBevelEmbossAngle, kFillBevelEmbossAltitude, kFillBevelEmbossUseGlobalLight, kFillBevelEmbossHighlightColor, kFillBevelEmbossHighlightBlendMode, kFillBevelEmbossHighlightOpacity, kFillBevelEmbossShadowColor, kFillBevelEmbossShadowBlendMode, kFillBevelEmbossShadowOpacity, kFillSatinBaseID = BASE_XP_ATTR(kTargetFill, kGroupSatin), kFillSatinApply, kFillSatinColor, kFillSatinBlendMode, kFillSatinOpacity, kFillSatinAngle, kFillSatinDistance, kFillSatinSize, kFillSatinInvert, kFillDirectionalFeatherBaseID = BASE_XP_ATTR(kTargetFill, kGroupDirectionalFeather), kFillDirectionalFeatherApply, kFillDirectionalFeatherWidthLeft, kFillDirectionalFeatherWidthRight, kFillDirectionalFeatherWidthTop, kFillDirectionalFeatherWidthBottom, kFillDirectionalFeatherAngle, kFillDirectionalFeatherFollowShape, kFillDirectionalFeatherNoise, kFillDirectionalFeatherChoke, kFillGradientFeatherBaseID = BASE_XP_ATTR(kTargetFill, kGroupGradientFeather), kFillGradientFeatherApply, kFillGradientFeatherType, kFillGradientFeatherOpacityStops, kFillGradientFeatherAngle, kFillGradientFeatherLength, kFillGradientFeatherCenter, kFillGradientFeatherRadius, kFillGradientFeatherHiliteAngle, kFillGradientFeatherHiliteLength, kContentBlendingBaseID = BASE_XP_ATTR(kTargetContent, kGroupBlending), kContentBlendingOpacity, kContentBlendingBlendMode, kContentBlendingKnockoutGroup, kContentBlendingIsolationGroup, kContentDropShadowBaseID = BASE_XP_ATTR(kTargetContent, kGroupDropShadow), kContentDropShadowMode, kContentDropShadowOffsetX, kContentDropShadowOffsetY, kContentDropShadowOpacity, kContentDropShadowBlendMode, kContentDropShadowBlurRadius, kContentDropShadowSpread, kContentDropShadowNoise, kContentDropShadowColor, kContentDropShadowUseGlobalLight, kContentDropShadowKO, kContentDropShadowHonorFX, kContentFeatherBaseID = BASE_XP_ATTR(kTargetContent, kGroupFeather), kContentFeatherMode, kContentFeatherWidth, kContentFeatherCorners, kContentFeatherNoise, kContentFeatherChoke, kContentInnerShadowBaseID = BASE_XP_ATTR(kTargetContent, kGroupInnerShadow), kContentInnerShadowApply, kContentInnerShadowColor, kContentInnerShadowBlendMode, kContentInnerShadowOpacity, kContentInnerShadowAngle, kContentInnerShadowDistance, kContentInnerShadowUseGlobalLight, kContentInnerShadowChoke, kContentInnerShadowSize, kContentInnerShadowNoise, kContentOuterGlowBaseID = BASE_XP_ATTR(kTargetContent, kGroupOuterGlow), kContentOuterGlowApply, kContentOuterGlowBlendMode, kContentOuterGlowOpacity, kContentOuterGlowNoise, kContentOuterGlowColor, kContentOuterGlowTechnique, kContentOuterGlowSpread, kContentOuterGlowSize, kContentInnerGlowBaseID = BASE_XP_ATTR(kTargetContent, kGroupInnerGlow), kContentInnerGlowApply, kContentInnerGlowBlendMode, kContentInnerGlowOpacity, kContentInnerGlowNoise, kContentInnerGlowColor, kContentInnerGlowTechnique, kContentInnerGlowSpread, kContentInnerGlowSize, kContentInnerGlowSource, kContentBevelEmbossBaseID = BASE_XP_ATTR(kTargetContent, kGroupBevelEmboss), kContentBevelEmbossApply, kContentBevelEmbossStyle, kContentBevelEmbossTechnique, kContentBevelEmbossDepth, kContentBevelEmbossDirection, kContentBevelEmbossSize, kContentBevelEmbossSoften, kContentBevelEmbossAngle, kContentBevelEmbossAltitude, kContentBevelEmbossUseGlobalLight, kContentBevelEmbossHighlightColor, kContentBevelEmbossHighlightBlendMode, kContentBevelEmbossHighlightOpacity, kContentBevelEmbossShadowColor, kContentBevelEmbossShadowBlendMode, kContentBevelEmbossShadowOpacity, kContentSatinBaseID = BASE_XP_ATTR(kTargetContent, kGroupSatin), kContentSatinApply, kContentSatinColor, kContentSatinBlendMode, kContentSatinOpacity, kContentSatinAngle, kContentSatinDistance, kContentSatinSize, kContentSatinInvert, kContentDirectionalFeatherBaseID = BASE_XP_ATTR(kTargetContent, kGroupDirectionalFeather), kContentDirectionalFeatherApply, kContentDirectionalFeatherWidthLeft, kContentDirectionalFeatherWidthRight, kContentDirectionalFeatherWidthTop, kContentDirectionalFeatherWidthBottom, kContentDirectionalFeatherAngle, kContentDirectionalFeatherFollowShape, kContentDirectionalFeatherNoise, kContentDirectionalFeatherChoke, kContentGradientFeatherBaseID = BASE_XP_ATTR(kTargetContent, kGroupGradientFeather), kContentGradientFeatherApply, kContentGradientFeatherType, kContentGradientFeatherOpacityStops, kContentGradientFeatherAngle, kContentGradientFeatherLength, kContentGradientFeatherCenter, kContentGradientFeatherRadius, kContentGradientFeatherHiliteAngle, kContentGradientFeatherHiliteLength, kMaxNumberAttrTypes }

typedef K2Vector < AttributeTypeAndValue >	AttributeList

typedef K2Vector< PartialADXY >	PartialADXYVector

Public Member Functions
virtual uint16	GetAttributeCount (ClassID attrClass)=0

virtual uint16	GetAttributeCount (AttributeType attrType)=0

virtual bool16	IsAttributeEnabled (ClassID attrClass)=0

virtual bool16	IsAttributeEnabled (AttributeType attrType)=0

virtual const IPMUnknown *	QueryAttribute (uint32 whichAttribute, ClassID attrClass, const PMIID &interfaceID=IID_IUNKNOWN)=0

virtual IPMUnknown *	CreateAttributeCopy (uint32 whichAttribute, ClassID attrClass, const PMIID &interfaceID=IID_IUNKNOWN)=0

virtual ErrorCode	CopyIntoAttribute (uint32 whichAttribute, IPMUnknown *iAttribute)=0

virtual PMReal	GetRealNumberAttributeValue (uint32 whichAttribute, AttributeType attrType)=0

virtual bool16	GetBooleanAttributeValue (uint32 whichAttribute, AttributeType attrType)=0

virtual int32	GetInt32AttributeValue (uint32 whichAttribute, AttributeType attrType)=0

virtual UID	GetUIDAttributeValue (uint32 whichAttribute, AttributeType attrType)=0

virtual void	GetAttributeValue (uint32 whichAttribute, AttributeType attrType, AttributeValue &value)=0

virtual void	GetAttributeValueLists (uint32 attrCount, const AttributeType attrTypeArray, AttributeList *attrListArray)=0

virtual bool16	IsAttributeUnique (ClassID attrClass)=0

virtual bool16	IsAttributeUnique (AttributeType attrType)=0

virtual ErrorCode	ApplyAttributes (IGraphicStyleAttributeBossList iAttrList, const PartialADXYVector partialADXYs=nil, bool32 autoInitializeGradientFeatherGeometry=kFalse)=0

virtual ErrorCode	ApplyAttributes (const AttributeList &attrList, const PartialADXYVector *partialADXYs=nil, bool32 autoInitializeGradientFeatherGeometry=kFalse)=0

virtual ErrorCode	ApplyBasicAttributes (BasicAttributesData *basicData, const K2Vector< AttributeType > &attrTypeList)=0

virtual ErrorCode	ApplyDropShadowAttributes (DropShadowData *dropshadowData, const K2Vector< AttributeType > &attrTypeList)=0

virtual ErrorCode	ApplyVignetteAttributes (VignetteData *featherData, const K2Vector< AttributeType > &attrTypeList)=0

virtual PMRect	GetImageTrueBBox (void)=0

virtual bool16	CanApplyAttributes (void)=0

virtual bool16	CanApplyAttributes (const AttributeList &attrList)=0

virtual bool16	CanApplyAttributes (AttributeGroup grp)=0

virtual bool16	CanApplyBasicAttributes (void)=0

virtual bool16	CanApplyDropShadowAttributes (void)=0

virtual bool16	CanApplyVignetteAttributes (void)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This is the high level transparency attribute suite for the current selection. Transparency attributes are graphic attributes and they are a subset of graphic attributes. Each transparency attribute ClassID mapped into a IXPAttributeSuite::AttributeType. Transparency attributes are furthered classified into groups: basic, drop shadow, feather/vignette, inner glow, etc.

Only transparency attributes defined in XPID.h are handled by this suite. All other graphic attributes are ignored.

See Also: also XPID.h; also IGraphicStyleAttributeBossList; also IGraphicAttributeInfo

Member Enumeration Documentation

enum IXPAttributeSuite::AttributeDataType

The following data types are used for transparency attribute values.

enum IXPAttributeSuite::AttributeGroup

Transparency attributes are arranged into groups, as follows.

enum IXPAttributeSuite::AttributeRealKind

The following are the kinds of real values that are used in transparency attributes. These are used to control formatting, min/max values, and so on.

enum IXPAttributeSuite::AttributeTarget

Transparency attributes can be applied to page items, stroke, fill, and content, independently.

Member Function Documentation

virtual ErrorCode IXPAttributeSuite::ApplyAttributes	(	IGraphicStyleAttributeBossList *	iAttrList,
		const PartialADXYVector *	partialADXYs = `nil`,
		bool32	autoInitializeGradientFeatherGeometry = `kFalse`
	)

pure virtual

Apply the specified transparency attr list (and other optional odds and ends) to the current selection.

Parameters

iAttrList	the attribute list to apply. Only transparency attributes from the list are applied.
partialADXYs	IN If non-nil, the list of partial ADXY values to apply.
autoInitializeGradientFeatherGeometry	IN If true, and the list of attributes includes any of those related to opacity gradients, the command will initialize any currently- uninitialized attributes related to the geometry of the feather. Otherwise you'd have to do all those computations yourself and set up the appropriate attributes.

Returns: kSuccess if successful; otherwise returns an error code.

virtual ErrorCode IXPAttributeSuite::ApplyAttributes	(	const AttributeList &	attrList,
		const PartialADXYVector *	partialADXYs = `nil`,
		bool32	autoInitializeGradientFeatherGeometry = `kFalse`
	)

pure virtual

Apply the specified set of attributes (and other optional odds and ends) to the current selection.

Parameters

attrList	The list of type/value pairs to apply.
partialADXYs	IN If non-nil, the list of partial ADXY values to apply.
autoInitializeGradientFeatherGeometry	IN If true, and the list of attributes includes any of those related to opacity gradients, the command will initialize any currently- uninitialized attributes related to the geometry of the feather. Otherwise you'd have to do all those computations yourself and set up the appropriate attributes.

Returns: kSuccess if successful otherwise returns an error code.

virtual ErrorCode IXPAttributeSuite::ApplyBasicAttributes	(	BasicAttributesData *	basicData,
		const K2Vector< AttributeType > &	attrTypeList
	)

pure virtual

Apply the spcified set of basic transparency attributes to the current selection. Only those data specified by the attrTypeList are applied.

Parameters

basicData	the basic transparency data
attrTypeList	the list of basic transparency attribute types to apply.

Returns: kSuccess if successfull otherwise returns an error code.

virtual ErrorCode IXPAttributeSuite::ApplyDropShadowAttributes	(	DropShadowData *	dropshadowData,
		const K2Vector< AttributeType > &	attrTypeList
	)

pure virtual

Apply the spcified set of drop shadow attributes to the current selection. Only those data specified by the attrTypeList are applied.

Parameters

dropshadowData	the dropshadow data to apply
attrTypeList	the list of dropshadow attribute types to apply.

Returns: kSuccess if successfull otherwise returns an error code.

virtual ErrorCode IXPAttributeSuite::ApplyVignetteAttributes	(	VignetteData *	featherData,
		const K2Vector< AttributeType > &	attrTypeList
	)

pure virtual

Apply the spcified set of feather attributes to the current selection. Only those data specified by the attrTypeList are applied.

Parameters

featherData	the feather data
attrTypeList	the list of feather attribute types to apply.

Returns: kSuccess if successfull otherwise returns an error code.

virtual bool16 IXPAttributeSuite::CanApplyAttributes ( void )

pure virtual

Check if there are items selected that can have transparency attributes applied.

Returns: kTrue if items can have attribute applied.

virtual bool16 IXPAttributeSuite::CanApplyAttributes ( const AttributeList & attrList )

pure virtual

Check if there are items selected that can have the specified attributes applied.

Returns: kTrue if items can have attribute applied.

virtual bool16 IXPAttributeSuite::CanApplyAttributes ( AttributeGroup grp )

pure virtual

Check if there are items selected that can have attributes of the specified group applied. Note that this works for any of the AttributeGroups; the above methods are 'legacy' versions before we had so many different groups.

Returns: kTrue if items can have attribute applied.

virtual bool16 IXPAttributeSuite::CanApplyBasicAttributes ( void )

pure virtual

Check if there are items selected that can have basic transparency attributes applied.

Returns: kTrue if items can have attribute applied.

virtual bool16 IXPAttributeSuite::CanApplyDropShadowAttributes ( void )

pure virtual

Check if there are items selected that can have drop shadow attributes applied.

Returns: kTrue if items can have attribute applied.

virtual bool16 IXPAttributeSuite::CanApplyVignetteAttributes ( void )

pure virtual

Check if there are items selected that can have feather attributes applied.

Returns: kTrue if items can have attribute applied.

virtual ErrorCode IXPAttributeSuite::CopyIntoAttribute	(	uint32	whichAttribute,
		IPMUnknown *	iAttribute
	)

pure virtual

Copy the content of iAttribute to the nth attribute

Parameters

whichAttribute	is the nth attribute starting from 0.
iAttribute	the content of transparency attribute to be copied.

Returns: kSuccess if successfull otherwise returns an error code.

virtual IPMUnknown* IXPAttributeSuite::CreateAttributeCopy	(	uint32	whichAttribute,
		ClassID	attrClass,
		const PMIID &	interfaceID = `IID_IUNKNOWN`
	)

pure virtual

Returns a copy of the nth attribute specified by the attribute class ID

Parameters

whichAttribute	is the nth attribute starting from 0.
attrClass	the transparency attribute class.
interfaceID	the requested interface pointer. This is typically IID_IGRAPHICATTR_INFO or a persistent data interface IID.

Returns: IPMUnknown* to the requested interface pointer or nil. This can be cast to the type of IID.

virtual uint16 IXPAttributeSuite::GetAttributeCount ( ClassID attrClass )

pure virtual

Returns the number of unique attributes of the specified attribute class

Parameters

attrClass the transparency attribute class

Returns: attribute count

virtual uint16 IXPAttributeSuite::GetAttributeCount ( AttributeType attrType )

pure virtual

Returns the number of unique attributes of the specified transparency attribute type

Parameters

attrType the transparency attribute type

Returns: attribute count

virtual void IXPAttributeSuite::GetAttributeValue	(	uint32	whichAttribute,
		AttributeType	attrType,
		AttributeValue &	value
	)

pure virtual

The general form of Get-Value that leverages the AttributeValue helper class.

Parameters

whichAttribute	Is the nth attribute starting from 0.
attrType	The transparency attribute type.
value	OUT Receives the value of the nth attribute.

virtual void IXPAttributeSuite::GetAttributeValueLists	(	uint32	attrCount,
		const AttributeType *	attrTypeArray,
		AttributeList **	attrListArray
	)

pure virtual

Obtains a list of all combinations of attributes given the current selection. This is needed for determining how multiple x/y and angle/distance pairs should be presented in the UI. Or maybe some other purpose; it's a pretty general API.

You pass in an array of attribute types, which represent the attributes you're interested in. For example, in the case of drop shadows we'd normally pass in the X and Y offset attributes.

You also pass in an array of attribute lists. This method fills in those lists with all of the values from the selection. For example, if you had two objects selected, there would be two entries in the list, and the first entry in each list would correspond to the first selected object, and the second entry in the list would correspond to the second selected object.

Note that this differs significantly from how attributes are typically reported, which has been condensed into lists of only the unique attributes. Thus you could have two objects, one with X,Y = 1,2 and the other with X,Y = 2,1. In both cases the other methods here would report that there are X values of 1 and 2 and Y values of 1 and 2, but you wouldn't know if it was (1,2),(2,1) or (1,1),(2,2). Which is fine for most UI but in the case of x/y/a/d we need to know which angles and distances are unique, which requires correlation with the original data sets.

Parameters

attrCount	IN The size of the following two arrays.
attrTypeArray	IN An array of attribute types. Must be at least as large as attrCount.
attrListArray	OUT An array of attribute lists to be filled in. These are emptied prior to appending. Must be at least as large as attrCount. Nil pointers are tolerated.

virtual bool16 IXPAttributeSuite::GetBooleanAttributeValue	(	uint32	whichAttribute,
		AttributeType	attrType
	)

pure virtual

Returns the boolean attribute value of the nth attribute of the specified attribute type.

Parameters

whichAttribute	is the nth attribute starting from 0.
attrType	the transparency attribute type.

Returns: a bool16 value. Returns kFalse if attrType is not a boolean attribute.

virtual PMRect IXPAttributeSuite::GetImageTrueBBox ( void )

pure virtual

Get the selected image's true bounding box. This is the bbox of the entire image. Returns only a valid bbox iff one single image is selected. Otherwise, returns an empty rect. This is called when an selected image is cropped and caller need to know the image's entire bbox. This method only make sense for LayoutCSB.

Parameters

featherData	the feather data
attrTypeList	the list of feather attribute types to apply.

Returns: a PMRect or an empty rect.

virtual int32 IXPAttributeSuite::GetInt32AttributeValue	(	uint32	whichAttribute,
		AttributeType	attrType
	)

pure virtual

Returns the long integer attribute value of the nth attribute of the specified attribute type.

Parameters

whichAttribute	is the nth attribute starting from 0.
attrType	the transparency attribute type.

Returns: a int32 value. Returns kInvalidInt32Value if attrType is not a integer attribute.

virtual PMReal IXPAttributeSuite::GetRealNumberAttributeValue	(	uint32	whichAttribute,
		AttributeType	attrType
	)

pure virtual

Returns the real number attribute value of the nth attribute of the specified attribute type.

Parameters

whichAttribute	is the nth attribute starting from 0.
attrType	the transparency attribute type.

Returns: a real number value. Returns kInvalidRealNumberValue if attrType is not a real number attribute.

virtual UID IXPAttributeSuite::GetUIDAttributeValue	(	uint32	whichAttribute,
		AttributeType	attrType
	)

pure virtual

Returns the UID attribute value of the nth attribute of the specified attribute type.

Parameters

whichAttribute	is the nth attribute starting from 0.
attrType	the transparency attribute type.

Returns: a UID value. Returns kInvalidUID if attrType is not a UID attribute.

virtual bool16 IXPAttributeSuite::IsAttributeEnabled ( ClassID attrClass )

pure virtual

Return kTrue if attribute class is enabled.

Parameters

attrClass the transparency attribute class

Returns: kTrue if enabled otherwise kFalse

virtual bool16 IXPAttributeSuite::IsAttributeEnabled ( AttributeType attrType )

pure virtual

Return kTrue if transparency attribute type is enabled.

Parameters

attrType the transparency attribute type

Returns: kTrue if enabled otherwise kFalse

virtual bool16 IXPAttributeSuite::IsAttributeUnique ( ClassID attrClass )

pure virtual

Return kTrue if the attribute specified by the attribute class ID and the attribute type is unique

Parameters

attrClass the transparency attribute class ID.

virtual bool16 IXPAttributeSuite::IsAttributeUnique ( AttributeType attrType )

pure virtual

See Also: IsAttributeUnique

Parameters

attrType the transparency attribute type.

virtual const IPMUnknown* IXPAttributeSuite::QueryAttribute	(	uint32	whichAttribute,
		ClassID	attrClass,
		const PMIID &	interfaceID = `IID_IUNKNOWN`
	)

pure virtual

Returns the nth attribute specified by the attribute class ID

Parameters

whichAttribute	is the nth attribute starting from 0.
attrClass	the transparency attribute class.
interfaceID	the requested interface pointer. This is typically IID_IGRAPHICATTR_INFO or a persistent data interface IID.

Returns: IPMUnknown to the requested interface pointer or nil. This can be cast to the type of IID.

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation