InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXPAttributeUtils Class Referenceabstract

#include <IXPAttributeUtils.h>

Inheritance diagram for IXPAttributeUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXPATTRIBUTEUTILS }
 

Public Member Functions

virtual bool16 IsBasicTransparencyAttribute (ClassID attrClass)=0
 
virtual bool16 IsDropShadowAttribute (ClassID attrClass)=0
 
virtual bool16 IsVignetteAttribute (ClassID attrClass)=0
 
virtual K2Vector< ClassID > * GetTransparencyAttributesFromList (const K2Vector< ClassID > *pAttrClassList)=0
 
virtual ErrorCode ApplyBasicTransparencyToPageItems (IGraphicStyleAttributeBossList *iAttrList, const UIDList &pageItemList, bool16 bSkipDefaults=kFalse)=0
 
virtual ErrorCode ApplyDropShadowToPageItems (IGraphicStyleAttributeBossList *iAttrList, const UIDList &pageItemList, bool16 bSkipDefaults=kFalse)=0
 
virtual ErrorCode ApplyVignetteToPageItems (IGraphicStyleAttributeBossList *iAttrList, const UIDList &pageItemList, bool16 bSkipDefaults=kFalse)=0
 
virtual ErrorCode ApplyAttributesToPageItems (IGraphicStyleAttributeBossList *iAttrList, const UIDList &pageItemList, const IXPAttributeSuite::PartialADXYVector *partialADXYs=nil, bool32 autoInitializeGradientFeatherGeometry=kFalse)=0
 
virtual ErrorCode ApplyAttributesToPageItems (const IXPAttributeSuite::AttributeList &attrList, const UIDList &pageItemList, const IXPAttributeSuite::PartialADXYVector *partialADXYs=nil, bool32 autoInitializeGradientFeatherGeometry=kFalse)=0
 
virtual
IXPAttributeSuite::AttributeType 
TranslateToTarget (IXPAttributeSuite::AttributeType attrType, IXPAttributeSuite::AttributeTarget attrTarget=IXPAttributeSuite::kTargetPageItem)=0
 
virtual ClassID GetAttributeClassID (IXPAttributeSuite::AttributeType attributeType)=0
 
virtual
IXPAttributeSuite::AttributeType 
GetAttributeFromClassID (ClassID attrClass)=0
 
virtual bool16 IsAttributeTransparencyAttribute (ClassID attributeClass)=0
 
virtual int32 GetAttributeDefaultValue (IXPAttributeSuite::AttributeType attributeType)=0
 
virtual ErrorCode GetAttributeDefaultValue (IXPAttributeSuite::AttributeType attrType, IXPAttributeSuite::AttributeValue &value)=0
 
virtual PMIID GetAttributeInterfaceIID (IXPAttributeSuite::AttributeType attributeType)=0
 
virtual
IXPAttributeSuite::AttributeDataType 
GetAttributeDataType (IXPAttributeSuite::AttributeType attrType)=0
 
virtual
IXPAttributeSuite::AttributeGroup 
GetAttributeGroup (IXPAttributeSuite::AttributeType attributeType)=0
 
virtual
IXPAttributeSuite::AttributeTarget 
GetAttributeTarget (IXPAttributeSuite::AttributeType attributeType)=0
 
virtual void GetAttributeGroupAttributeTypes (const IXPAttributeSuite::AttributeGroup &attributeGroup, const IXPAttributeSuite::AttributeTarget &attributeTarget, std::vector< IXPAttributeSuite::AttributeType > &groupAttrList)=0
 
virtual UID GetAttributeDefaultSwatchUID (IXPAttributeSuite::AttributeType type, IDataBase *db)=0
 
virtual bool16 GetAttributeName (IXPAttributeSuite::AttributeType type, PMString &name)=0
 
virtual ErrorCode GetAttributeMinMax (IXPAttributeSuite::AttributeType type, IXPAttributeSuite::AttributeValue &minValue, IXPAttributeSuite::AttributeValue &maxValue)=0
 
virtual bool16 IsValidAttributeValue (IXPAttributeSuite::AttributeType type, const IXPAttributeSuite::AttributeValue &value)=0
 
virtual
IXPAttributeSuite::AttributeRealKind 
GetAttributeRealKind (IXPAttributeSuite::AttributeType type)=0
 
virtual ScriptData::UnitType GetAttributeUnits (IXPAttributeSuite::AttributeType type)=0
 
virtual
IGraphicStyleAttributeBossList
CreateAttrBossListFromAttrList (const IXPAttributeSuite::AttributeList &attrList)=0
 
virtual bool16 GetAttrListFromAttrBossList (const IGraphicStyleAttributeBossList *iBossList, IXPAttributeSuite::AttributeList &attrList)=0
 
virtual bool16 GetValueAsString (IXPAttributeSuite::AttributeType type, const IXPAttributeSuite::AttributeValue &val, IDataBase *db, PMString &s)=0
 
virtual int32 GetNumAttributeTargets ()=0
 
virtual
IXPAttributeSuite::AttributeTarget 
GetNthAttributeTarget (int32 n)=0
 
virtual int32 GetAttributeTargetIndex (IXPAttributeSuite::AttributeTarget)=0
 
virtual int32 GetNumAttributeGroups ()=0
 
virtual
IXPAttributeSuite::AttributeGroup 
GetNthAttributeGroup (int32 n)=0
 
virtual int32 GetAttributeGroupIndex (IXPAttributeSuite::AttributeGroup)=0
 
virtual bool16 GetAttributeScriptInfo (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue, IDataBase *iDataBase, IScript *iScript, IScriptRequestData *data, ScriptData *pScriptData, ScriptElementID *pElementID, ScriptID *pScriptID)=0
 
virtual
IXPAttributeSuite::AttributeType 
GetAttributeFromScriptID (IXPAttributeSuite::AttributeTarget target, IXPAttributeSuite::AttributeGroup group, ScriptID propID)=0
 
virtual void LookupScriptInfo (IScriptRequestData *data, ScriptID propID, IScript *iScript, IXPAttributeSuite::AttributeTarget &target, IXPAttributeSuite::AttributeGroup &group, IXPAttributeSuite::AttributeType &type)=0
 
virtual ErrorCode GetAttributeDataFromScriptData (IScript *iScript, const ScriptID &propID, IScriptRequestData *data, IXPAttributeSuite::AttributeTypeAndValue &attr)=0
 
virtual ErrorCode GetAttributeDataFromScriptData (const ScriptData &scriptData, IScriptRequestData *data, const IXPAttributeSuite::AttributeType &attrType, IXPAttributeSuite::AttributeTypeAndValue &attr)=0
 
virtual
IXPAttributeSuite::AttributeTarget 
GetTargetFromScriptID (ScriptID id)=0
 
virtual
IXPAttributeSuite::AttributeGroup 
GetGroupFromScriptID (ScriptID id)=0
 
virtual ErrorCode GetAttributeValue (IXPAttributeSuite::AttributeType attrType, IXPAttributeSuite::AttributeValue &attrValue, const IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual ErrorCode GetAttributeValue (IXPAttributeSuite::AttributeType attrType, IXPAttributeSuite::AttributeValue &attrValue, const IPMUnknown *iAttr)=0
 
virtual IPMUnknownCreateAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IPMUnknownCreateAttribute (const IXPAttributeSuite::AttributeTypeAndValue &attr)=0
 
virtual IGraphicAttrRealNumberCreateRealNumberAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IGraphicAttrBooleanCreateBooleanAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IPersistUIDDataCreateUIDAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IGraphicAttrInt32CreateInt32Attribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IOpacityGradientStopsCreateOpacityGradientStopsAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual IGraphicAttrPointCreatePointAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue)=0
 
virtual ErrorCode AddAttribute (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &attrValue, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateApplyAttributeCommand (IXPAttributeSuite::AttributeType attrType, const IXPAttributeSuite::AttributeValue &val, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual IOpacityGradientStopsCloneOpacityGradientStops (const IOpacityGradientStops *iStops)=0
 
virtual ErrorCode GetBasicBlendMode (PMBlendingMode &blendMode, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrInt32CreateBasicBlendModeAttribute (PMBlendingMode blendMode)=0
 
virtual ErrorCode AddBasicBlendModeAttribute (PMBlendingMode blendMode, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateBasicBlendModeCommand (PMBlendingMode blendMode, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetBasicOpacity (PMReal &opacity, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateBasicOpacityAttribute (PMReal opacity)=0
 
virtual ErrorCode AddBasicOpacityAttribute (PMReal opacity, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateBasicOpacityCommand (PMReal opacity, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetBasicKnockoutGroup (bool16 &basicKnockoutGrouop, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrBooleanCreateBasicKnockoutGroupAttribute (bool16 basicKnockoutGrouop)=0
 
virtual ErrorCode AddBasicKnockoutGroupAttribute (bool16 basicKnockoutGrouop, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateBasicKnockoutGroupCommand (bool16 opacity, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetBasicIsolationGroup (bool16 &basicIsolationGrouop, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrBooleanCreateBasicIsolationGroupAttribute (bool16 basicIsolationGrouop)=0
 
virtual ErrorCode AddBasicIsolationGroupAttribute (bool16 basicIsolationGroup, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateBasicIsolationGroupCommand (bool16 basicIsolationGroup, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowMode (PMDropShadowMode &dropShadowMode, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrInt32CreateDropShadowModeAttribute (PMDropShadowMode dropShadowMode)=0
 
virtual ErrorCode AddDropShadowModeAttribute (PMDropShadowMode dropShadowMode, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowModeCommand (PMDropShadowMode dropShadowMode, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowBlendMode (PMBlendingMode &blendMode, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrInt32CreateDropShadowBlendModeAttribute (PMBlendingMode blendMode)=0
 
virtual ErrorCode AddDropShadowBlendModeAttribute (PMBlendingMode blendMode, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowBlendModeCommand (PMBlendingMode blendMode, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowOpacity (PMReal &opacity, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowOpacityAttribute (PMReal opacity)=0
 
virtual ErrorCode AddDropShadowOpacityAttribute (PMReal opacity, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowOpacityCommand (PMReal opacity, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowOffsetX (PMReal &dropShadowOffsetX, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowOffsetXAttribute (PMReal dropShadowOffsetX)=0
 
virtual ErrorCode AddDropShadowOffsetXAttribute (PMReal dropShadowOffsetX, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowOffsetXCommand (PMReal dropShadowOffsetX, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowOffsetY (PMReal &dropShadowOffsetY, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowOffsetYAttribute (PMReal dropShadowOffsetY)=0
 
virtual ErrorCode AddDropShadowOffsetYAttribute (PMReal dropShadowOffsetY, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowOffsetYCommand (PMReal dropShadowOffsetY, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowBlurRadius (PMReal &blurRadius, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowBlurRadiusAttribute (PMReal blurRadius)=0
 
virtual ErrorCode AddDropShadowBlurRadiusAttribute (PMReal blurRadius, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowBlurRadiusCommand (PMReal blurRadius, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowColorUID (UID &colorUID, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IPersistUIDDataCreateDropShadowColorAttribute (IDataBase *iDataBase, UID colorUID)=0
 
virtual ErrorCode AddDropShadowColorAttribute (IDataBase *iDataBase, UID colorUID, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowColorCommand (const UIDRef &colorRef, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowSpread (PMReal &spread, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowSpreadAttribute (PMReal spread)=0
 
virtual ErrorCode AddDropShadowSpreadAttribute (PMReal spread, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowSpreadCommand (PMReal spread, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetDropShadowNoise (PMReal &noise, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateDropShadowNoiseAttribute (PMReal noise)=0
 
virtual ErrorCode AddDropShadowNoiseAttribute (PMReal noise, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateDropShadowNoiseCommand (PMReal noise, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteMode (PMVignetteMode &vignetteMode, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrInt32CreateVignetteModeAttribute (PMVignetteMode vignetteMode)=0
 
virtual ErrorCode AddVignetteModeAttribute (PMVignetteMode vignetteMode, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteModeCommand (PMVignetteMode vignetteMode, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteWidth (PMReal &width, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateVignetteWidthAttribute (PMReal width)=0
 
virtual ErrorCode AddVignetteWidthAttribute (PMReal width, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteWidthCommand (PMReal width, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteOuterOpacity (PMReal &outerOpacity, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateVignetteOuterOpacityAttribute (PMReal outerOpacity)=0
 
virtual ErrorCode AddVignetteOuterOpacityAttribute (PMReal outerOpacity, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteOuterOpacityCommand (PMReal outerOpacity, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteInnerOpacity (PMReal &innerOpacity, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateVignetteInnerOpacityAttribute (PMReal innerOpacity)=0
 
virtual ErrorCode AddVignetteInnerOpacityAttribute (PMReal innerOpacity, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteInnerOpacityCommand (PMReal innerOpacity, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteCorners (PMVignetteCorners &corners, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrInt32CreateVignetteCornersAttribute (PMVignetteCorners corners)=0
 
virtual ErrorCode AddVignetteCornersAttribute (PMVignetteCorners corners, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteCornersCommand (PMVignetteCorners corners, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ErrorCode GetVignetteNoise (PMReal &noise, IGraphicStyleDescriptor *styleDescriptor)=0
 
virtual IGraphicAttrRealNumberCreateVignetteNoiseAttribute (PMReal noise)=0
 
virtual ErrorCode AddVignetteNoiseAttribute (PMReal noise, IGraphicStyleAttributeBossList *attributeList)=0
 
virtual ICommandCreateVignetteNoiseCommand (PMReal noise, const UIDList *targetItemList, bool16 doPrePost, bool16 enableDoNotify)=0
 
virtual ScriptID GetScriptEnumFromBlendMode (PMBlendingMode mode)=0
 
virtual PMBlendingMode GetBlendModeFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromDSMode (PMDropShadowMode mode)=0
 
virtual PMDropShadowMode GetDSModeFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromVignetteMode (PMVignetteMode mode)=0
 
virtual PMVignetteMode GetVignetteModeFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromCornerType (PMVignetteCorners mode)=0
 
virtual PMVignetteCorners GetCornerTypeFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromGlowTechnique (PMGlowTechnique glowTechnique)=0
 
virtual PMGlowTechnique GetGlowTechniqueFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromInnerGlowSource (PMInnerGlowSource innerGlowSource)=0
 
virtual PMInnerGlowSource GetInnerGlowSourceFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromBevelEmbossStyle (PMBevelEmbossStyle bevelEmbossStyle)=0
 
virtual PMBevelEmbossStyle GetBevelEmbossStyleFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromBevelEmbossTechnique (PMBevelEmbossTechnique bevelEmbossTechnique)=0
 
virtual PMBevelEmbossTechnique GetBevelEmbossTechniqueFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromBevelEmbossDirection (PMBevelEmbossDirection bevelEmbossDirection)=0
 
virtual PMBevelEmbossDirection GetBevelEmbossDirectionFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromFollowShapeMode (PMFollowShapeMode followShapeMode)=0
 
virtual PMFollowShapeMode GetFollowShapeModeFromScriptEnum (ScriptID asEnum)=0
 
virtual ScriptID GetScriptEnumFromGradientType (GradientType gradientType)=0
 
virtual GradientType GetGradientTypeFromScriptEnum (ScriptID asEnum)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Transparency attribute related utility functions.

See Also
XPID.h for definition of transparency attribute ClassID.

Member Function Documentation

virtual ErrorCode IXPAttributeUtils::AddAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add an attribute to the specified attribute list.

Parameters
attrTypeThe attribute type to add.
attrValueThe value of the attribute.
attributeListThe attribute list to which to add the attribute.
Returns
kSuccess if successful or returns an error code.
virtual ErrorCode IXPAttributeUtils::AddBasicBlendModeAttribute (PMBlendingMode blendMode,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a blend mode attribute to the specified attribute list.

Parameters
blendModethe blending mdoe to add. This is a PMBlendingMode.
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code GraphicTypes.h
virtual ErrorCode IXPAttributeUtils::AddBasicIsolationGroupAttribute (bool16 basicIsolationGroup,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a isolation attribute to the specified attribute list.

Parameters
basicIsolationGroupthe isolation setting to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddBasicKnockoutGroupAttribute (bool16 basicKnockoutGrouop,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a knockout group attribute to the specified attribute list.

Parameters
basicKnockoutGrouopthe knockout group setting to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddBasicOpacityAttribute (PMReal opacity,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a opacity attribute to the specified attribute list.

Parameters
opacitythe basic opacity to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowBlendModeAttribute (PMBlendingMode blendMode,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow blend mode attribute to the specified attribute list.

Parameters
blendModethe drop shadow blend mode to add. This is a PMBlendingMode.
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code GraphicTypes.h
virtual ErrorCode IXPAttributeUtils::AddDropShadowBlurRadiusAttribute (PMReal blurRadius,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow blur radius attribute to the specified attribute list.

Parameters
blurRadiusthe drop shadow blur radius to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowColorAttribute (IDataBaseiDataBase,
UID colorUID,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow color UID attribute to the specified attribute list.

Parameters
colorUIDthe drop shadow color UID to add. This must be an UID of a kPMColorBoss.
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowModeAttribute (PMDropShadowMode dropShadowMode,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow apply attribute to the specified attribute list.

Parameters
dropShadowModethe drop shadow apply setting to add. This is a PMDropShadowMode.
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
See Also
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::AddDropShadowNoiseAttribute (PMReal noise,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow noise attribute to the specified attribute list.

Parameters
noisethe drop shadow noise to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowOffsetXAttribute (PMReal dropShadowOffsetX,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow x offset attribute to the specified attribute list.

Parameters
dropShadowOffsetXthe drop shadow x offset to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowOffsetYAttribute (PMReal dropShadowOffsetY,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow y offset attribute to the specified attribute list.

Parameters
dropShadowOffsetYthe drop shadow y offset to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowOpacityAttribute (PMReal opacity,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow opacity attribute to the specified attribute list.

Parameters
opacitythe drop shadow opacity to get
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddDropShadowSpreadAttribute (PMReal spread,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a drop shadow spread attribute to the specified attribute list.

Parameters
spreadthe drop shadow spread to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddVignetteCornersAttribute (PMVignetteCorners corners,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather corner type attribute to the specified attribute list.

Parameters
cornersthe feather corner type to add. This is a PMVignetteCorners.
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
See Also
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::AddVignetteInnerOpacityAttribute (PMReal innerOpacity,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather inner opacity attribute to the specified attribute list.

Parameters
innerOpacitythe feather inner opacity to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddVignetteModeAttribute (PMVignetteMode vignetteMode,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather apply attribute to the specified attribute list.

Parameters
vignetteModethe feather apply setting to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
See Also
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::AddVignetteNoiseAttribute (PMReal noise,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather noise attribute to the specified attribute list.

Parameters
noisethe feather noise to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddVignetteOuterOpacityAttribute (PMReal outerOpacity,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather outer opacity attribute to the specified attribute list.

Parameters
outerOpacitythe feather outer opacity to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::AddVignetteWidthAttribute (PMReal width,
IGraphicStyleAttributeBossListattributeList 
)
pure virtual

Create and add a feather width attribute to the specified attribute list.

Parameters
widththe feather width to add
attributeListthe attribute list
Returns
kSuccess if successful or returns an error code
virtual ErrorCode IXPAttributeUtils::ApplyAttributesToPageItems (IGraphicStyleAttributeBossListiAttrList,
const UIDListpageItemList,
const IXPAttributeSuite::PartialADXYVectorpartialADXYs = nil,
bool32 autoInitializeGradientFeatherGeometry = kFalse 
)
pure virtual

Process the command to apply the specified attributes (in IGraphicStyleAttributeBossList form) to the specified page items. This exercises the kXPSetAttributesCmdBoss.

Parameters
iAttrListIN The attribute list to set.
pageItemListIN The page items to which to apply the attributes
partialADXYsIN If specified (ie, non-nil), the list of ADXY partials to apply.
autoInitializeGradientFeatherGeometryIN True to do auto-adjustment of gradient feather geometry.
Returns
kSuccess if successful otherwise returns an error code
virtual ErrorCode IXPAttributeUtils::ApplyAttributesToPageItems (const IXPAttributeSuite::AttributeListattrList,
const UIDListpageItemList,
const IXPAttributeSuite::PartialADXYVectorpartialADXYs = nil,
bool32 autoInitializeGradientFeatherGeometry = kFalse 
)
pure virtual

Process the command to apply the specified attributes (in AttributeList form) to the specified page items. This exercises the kXPSetAttributesCmdBoss.

Parameters
iAttrListIN The attribute list to set.
pageItemListIN The page items to which to apply the attributes
partialADXYsIN If specified (ie, non-nil), the list of ADXY partials to apply.
autoInitializeGradientFeatherGeometryIN True to do auto-adjustment of gradient feather geometry.
Returns
kSuccess if successful otherwise returns an error code
virtual ErrorCode IXPAttributeUtils::ApplyBasicTransparencyToPageItems (IGraphicStyleAttributeBossListiAttrList,
const UIDListpageItemList,
bool16 bSkipDefaults = kFalse 
)
pure virtual

Process the command to apply basic transparency attributes, drop shadow attributes, or feather (or vignette) attributes from the given attribute list to the page items. Only those attributes whose class ID is part of the specified attributes are applied The command used is kXPSetBasicAttributesCmdBoss for basic transparency attributes, kXPSetDropShadowCmdBoss for drop shadow attributes, and kXPSetVignetteCmdBoss for feather attributes.

Parameters
iAttrListthe attribute list to apply
pageItemListthe target page item list
bSkipDefaultskTrue if to skip defaults
Returns
kSuccess if successful otherwise returns an error code
virtual ErrorCode IXPAttributeUtils::ApplyDropShadowToPageItems (IGraphicStyleAttributeBossListiAttrList,
const UIDListpageItemList,
bool16 bSkipDefaults = kFalse 
)
pure virtual
virtual ErrorCode IXPAttributeUtils::ApplyVignetteToPageItems (IGraphicStyleAttributeBossListiAttrList,
const UIDListpageItemList,
bool16 bSkipDefaults = kFalse 
)
pure virtual
virtual IOpacityGradientStops* IXPAttributeUtils::CloneOpacityGradientStops (const IOpacityGradientStopsiStops)
pure virtual

Makes a copy of the specified opacity gradient stops as a lightweight in-memory object. This is typically used to modify an existing opacity gradient; ie you make a copy of it, change the copy, then use that in a SetAttributes command.

Parameters
iStopsIN The gradient stops you want to copy.
Returns
A refcounted in-memory copy of the source gradient, or nil if there was an error.
virtual ICommand* IXPAttributeUtils::CreateApplyAttributeCommand (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueval,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create attribute command to apply to the specified page item list.

Parameters
noisethe feather noise to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
The apply attribute command or nil.
virtual IGraphicStyleAttributeBossList* IXPAttributeUtils::CreateAttrBossListFromAttrList (const IXPAttributeSuite::AttributeListattrList)
pure virtual

Creates a IGraphicStyleAttributeBossList attribute list from an AttributeList.

Parameters
attrListIN The attribute list.
Returns
A refcounted boss list.
virtual IPMUnknown* IXPAttributeUtils::CreateAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a graphic attribute with the specified value.

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The new attribute.
virtual IPMUnknown* IXPAttributeUtils::CreateAttribute (const IXPAttributeSuite::AttributeTypeAndValueattr)
pure virtual

Create and return a graphic attribute with the specified value.

Parameters
attrThe attribute type and value to create.
Returns
The new attribute.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateBasicBlendModeAttribute (PMBlendingMode blendMode)
pure virtual

Create and return a blend mode attribute with the specified blend mode.

Parameters
blendModethe blending mdoe to create. This is a PMBlendingMode.
Returns
the IGraphicAttrInt32* to the new blend mode attribute. GraphicTypes.h
virtual ICommand* IXPAttributeUtils::CreateBasicBlendModeCommand (PMBlendingMode blendMode,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create blend mode attribute command to apply to the specified page item list.

Parameters
blendModethe blending mdoe to apply. This is a PMBlendingMode.
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil. GraphicTypes.h
virtual IGraphicAttrBoolean* IXPAttributeUtils::CreateBasicIsolationGroupAttribute (bool16 basicIsolationGrouop)
pure virtual

Create and return a attribute with the specified isolation setting.

Parameters
basicIsolationGroupthe isolation setting to create
Returns
the IGraphicAttrBoolean* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateBasicIsolationGroupCommand (bool16 basicIsolationGroup,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create isolation attribute command to apply to the specified page item list.

Parameters
basicIsolationGroupthe isolation setting to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrBoolean* IXPAttributeUtils::CreateBasicKnockoutGroupAttribute (bool16 basicKnockoutGrouop)
pure virtual

Create and return a attribute with the specified knockout group setting.

Parameters
basicKnockoutGrouopthe knockout group setting to create
Returns
the IGraphicAttrBoolean* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateBasicKnockoutGroupCommand (bool16 opacity,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create knockout group attribute command to apply to the specified page item list.

Parameters
basicKnockoutGrouopthe knockout group setting to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateBasicOpacityAttribute (PMReal opacity)
pure virtual

Create and return a attribute with the specified opacity value.

Parameters
opacitythe basic opacity to create
Returns
the IGraphicAttrRealNumber* to the new opacity attribute.
virtual ICommand* IXPAttributeUtils::CreateBasicOpacityCommand (PMReal opacity,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create opacity attribute command to apply to the specified page item list.

Parameters
opacitythe basic opacity to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrBoolean* IXPAttributeUtils::CreateBooleanAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a Boolean graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not boolean.

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IGraphicAttrBoolean* to the new attribute.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateDropShadowBlendModeAttribute (PMBlendingMode blendMode)
pure virtual

Create and return a attribute with the specified drop shadow blend mode.

Parameters
blendModethe drop shadow blend mode to create. This is a PMBlendingMode.
Returns
the IGraphicAttrInt32* to the new attribute. GraphicTypes.h
virtual ICommand* IXPAttributeUtils::CreateDropShadowBlendModeCommand (PMBlendingMode blendMode,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create rop shadow blend mode attribute command to apply to the specified page item list.

Parameters
blendModethe drop shadow blend mode to apply. This is a PMBlendingMode.
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil. GraphicTypes.h
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowBlurRadiusAttribute (PMReal blurRadius)
pure virtual

Create and return a attribute with the specified drop shadow blur radius.

Parameters
blurRadiusthe drop shadow blur radius to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowBlurRadiusCommand (PMReal blurRadius,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create drop shadow blur radius attribute command to apply to the specified page item list.

Parameters
blurRadiusthe drop shadow blur radius to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IPersistUIDData* IXPAttributeUtils::CreateDropShadowColorAttribute (IDataBaseiDataBase,
UID colorUID 
)
pure virtual

Create and return a attribute with the specified drop shadow color UID.

Parameters
colorUIDthe drop shadow color UID to Create. This must be an UID of a kPMColorBoss.
Returns
the IPersistUIDRefData* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowColorCommand (const UIDRefcolorRef,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create drop shadow color UID attribute command to apply to the specified page item list.

Parameters
colorUIDthe drop shadow color UID to apply. This must be an UID of a kPMColorBoss.
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateDropShadowModeAttribute (PMDropShadowMode dropShadowMode)
pure virtual

Create and return a attribute with the specified drop shadow apply setting.

Parameters
dropShadowModethe drop shadow apply setting to create. This is a PMDropShadowMode.
Returns
the IGraphicAttrInt32* to the new attribute.
See Also
GraphicTypes.h.
virtual ICommand* IXPAttributeUtils::CreateDropShadowModeCommand (PMDropShadowMode dropShadowMode,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create rop shadow apply attribute command to apply to the specified page item list.

Parameters
dropShadowModethe drop shadow apply setting to apply. This is a PMDropShadowMode.
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
See Also
GraphicTypes.h.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowNoiseAttribute (PMReal noise)
pure virtual

Create and return a attribute with the specified drop shadow noise.

Parameters
noisethe drop shadow noise to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowNoiseCommand (PMReal noise,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create drop shadow noise attribute command to apply to the specified page item list.

Parameters
noisethe drop shadow noise to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowOffsetXAttribute (PMReal dropShadowOffsetX)
pure virtual

Create and return a attribute with the specified drop shadow x offset.

Parameters
dropShadowOffsetXthe drop shadow x offset to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowOffsetXCommand (PMReal dropShadowOffsetX,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create rop shadow x offset attribute command to apply to the specified page item list.

Parameters
dropShadowOffsetXthe drop shadow x offset to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowOffsetYAttribute (PMReal dropShadowOffsetY)
pure virtual

Create and return a attribute with the specified drop shadow y offset.

Parameters
dropShadowOffsetYthe drop shadow y offset to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowOffsetYCommand (PMReal dropShadowOffsetY,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create drop shadow y offset attribute command to apply to the specified page item list.

Parameters
dropShadowOffsetYthe drop shadow y offset to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowOpacityAttribute (PMReal opacity)
pure virtual

Create and return a attribute with the specified drop shadow opacity.

Parameters
opacitythe drop shadow opacity to cereate
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowOpacityCommand (PMReal opacity,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create rop shadow opacity attribute command to apply to the specified page item list.

Parameters
opacitythe drop shadow opacity to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateDropShadowSpreadAttribute (PMReal spread)
pure virtual

Create and return a attribute with the specified drop shadow spread.

Parameters
spreadthe drop shadow spread to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateDropShadowSpreadCommand (PMReal spread,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create drop shadow spread attribute command to apply to the specified page item list.

Parameters
spreadthe drop shadow spread to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateInt32Attribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a int32 graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not int32-based (including enums).

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IGraphicAttrInt32* to the new attribute.
virtual IOpacityGradientStops* IXPAttributeUtils::CreateOpacityGradientStopsAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return an OpacityGradientStops graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not opacity gradient-based (including enums).

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IOpacityGradientStops* to the new attribute.
virtual IGraphicAttrPoint* IXPAttributeUtils::CreatePointAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a PMPoint graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not PMPoint-based (including enums).

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IGraphicAttrPoint* to the new attribute.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateRealNumberAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a RealNumber graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not Real.

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IGraphicAttrRealNumber* to the new attribute.
virtual IPersistUIDData* IXPAttributeUtils::CreateUIDAttribute (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue 
)
pure virtual

Create and return a UID (color) graphic attribute with the specified value. Note that because graphic attributes are not inherited from a common base (other than IPMUnknown) we need different Create methods for each of the basic storage types, if you want type safety. This method will fail if the attribute type is not UID-based.

Parameters
attrTypeThe attribute type to create.
attrValueThe value to use for the new attribute.
Returns
The IGraphicAttrRealNumber* to the new attribute.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateVignetteCornersAttribute (PMVignetteCorners corners)
pure virtual

Create and return a attribute with the specified feather corner type.

Parameters
cornersthe feather corner type to create. This is a PMVignetteCorners.
Returns
the IGraphicAttrInt32* to the new attribute.
See Also
GraphicTypes.h.
virtual ICommand* IXPAttributeUtils::CreateVignetteCornersCommand (PMVignetteCorners corners,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather corner type attribute command to apply to the specified page item list.

Parameters
cornersthe feather corner type to apply. This is a PMVignetteCorners.
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
See Also
GraphicTypes.h.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateVignetteInnerOpacityAttribute (PMReal innerOpacity)
pure virtual

Create and return a attribute with the specified feather inner opacity.

Parameters
innerOpacitythe feather inner opacity to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateVignetteInnerOpacityCommand (PMReal innerOpacity,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather inner opacity attribute command to apply to the specified page item list.

Parameters
innerOpacitythe feather inner opacity to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrInt32* IXPAttributeUtils::CreateVignetteModeAttribute (PMVignetteMode vignetteMode)
pure virtual

Create and return a attribute with the specified feather apply setting.

Parameters
vignetteModethe feather apply setting to create
Returns
the IGraphicAttrInt32* to the new attribute.
See Also
GraphicTypes.h.
virtual ICommand* IXPAttributeUtils::CreateVignetteModeCommand (PMVignetteMode vignetteMode,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather apply setting attribute command to apply to the specified page item list.

Parameters
vignetteModethe feather apply setting to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
See Also
GraphicTypes.h.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateVignetteNoiseAttribute (PMReal noise)
pure virtual

Create and return a attribute with the specified feather noise.

Parameters
noisethe feather noise to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateVignetteNoiseCommand (PMReal noise,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather noise attribute command to apply to the specified page item list.

Parameters
noisethe feather noise to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateVignetteOuterOpacityAttribute (PMReal outerOpacity)
pure virtual

Create and return a attribute with the specified feather outer opacity.

Parameters
outerOpacitythe feather outer opacity to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateVignetteOuterOpacityCommand (PMReal outerOpacity,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather outer opacity attribute command to apply to the specified page item list.

Parameters
outerOpacitythe feather outer opacity to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual IGraphicAttrRealNumber* IXPAttributeUtils::CreateVignetteWidthAttribute (PMReal width)
pure virtual

Create and return a attribute with the specified feather width.

Parameters
widththe feather width to create
Returns
the IGraphicAttrRealNumber* to the new attribute.
virtual ICommand* IXPAttributeUtils::CreateVignetteWidthCommand (PMReal width,
const UIDListtargetItemList,
bool16 doPrePost,
bool16 enableDoNotify 
)
pure virtual

Create feather width attribute command to apply to the specified page item list.

Parameters
widththe feather width to apply
targetItemListthe target page item list
doPrePostkTrue if to perform attribute pre/post actions.
enableDoNotifykTrue if notification should be sent.
Returns
the apply attribute command or nil.
virtual ClassID IXPAttributeUtils::GetAttributeClassID (IXPAttributeSuite::AttributeType attributeType)
pure virtual

Returns the attribute class ID given an attribute type.

Parameters
attributeTypeis the attribute type
Returns
attribute class ID. Returns kInvalidClass if attributeType is invalid.
virtual ErrorCode IXPAttributeUtils::GetAttributeDataFromScriptData (IScriptiScript,
const ScriptIDpropID,
IScriptRequestDatadata,
IXPAttributeSuite::AttributeTypeAndValueattr 
)
pure virtual

Given a script 'set' request, translate into a resulting attribute type and value.

Parameters
iScriptIN The IScript interface from the setter.
propIDIN The property ID to set.
dataIN The data to set.
attrOUT Receives the type and value.
Returns
Error code (kSuccess if successful).
virtual ErrorCode IXPAttributeUtils::GetAttributeDataFromScriptData (const ScriptDatascriptData,
IScriptRequestDatadata,
const IXPAttributeSuite::AttributeType & attrType,
IXPAttributeSuite::AttributeTypeAndValueattr 
)
pure virtual

Translate scriptData into a resulting attribute type and value.

Parameters
scriptDataIN The script data to translate.
dataIN The data to set.
attrTypeIN The AttributeType which script data will be translated to.
attrOUT Receives the type and value.
Returns
Error code (kSuccess if successful).
virtual IXPAttributeSuite::AttributeDataType IXPAttributeUtils::GetAttributeDataType (IXPAttributeSuite::AttributeType attrType)
pure virtual

Given a attribute, returns the associated data type.

Parameters
attrTypeIN The attribute type.
Returns
The attribute's data type.
virtual UID IXPAttributeUtils::GetAttributeDefaultSwatchUID (IXPAttributeSuite::AttributeType type,
IDataBasedb 
)
pure virtual

Return the default swatch UID for the given COLOR attribute type in the given document/database. Note that this is the hard coded value, not the application or document default.

Parameters
attrTypeIN The attribute you want; must be a color attr.
Returns
The default UID in the document/database, or kInvalidUID if an error or wrong type.
virtual int32 IXPAttributeUtils::GetAttributeDefaultValue (IXPAttributeSuite::AttributeType attributeType)
pure virtual

Returns the specify attribute type's default value.

Parameters
attributeTypeis the attribute type
Returns
Attribute type's default value.
virtual ErrorCode IXPAttributeUtils::GetAttributeDefaultValue (IXPAttributeSuite::AttributeType attrType,
IXPAttributeSuite::AttributeValuevalue 
)
pure virtual

Returns the specify attribute type's default value. This is the preferred method since it returns higher-quality information. Note that the default value here is the hard-coded default, not an application or document default.

Parameters
attrTypeIN The attribute you're interested in.
valueOUT Receives the default hard-coded default value.
Returns
Error code (typically kFailure for bad attribute types, kSuccess otherwise).
virtual IXPAttributeSuite::AttributeType IXPAttributeUtils::GetAttributeFromClassID (ClassID attrClass)
pure virtual

Returns the attribute class ID given an attribute type.

Parameters
attributeTypeis the attribute type
Returns
attribute class ID. Returns kInvalidClass if attributeType is invalid.
virtual IXPAttributeSuite::AttributeType IXPAttributeUtils::GetAttributeFromScriptID (IXPAttributeSuite::AttributeTarget target,
IXPAttributeSuite::AttributeGroup group,
ScriptID propID 
)
pure virtual

Given a script ID and an optional target/group, looks up the corresponding attribute. Note that the target and group are only optional if you want a "legacy" lookup – that is, a lookup for the script attributes (now only INX attributes) that sit on the page item boss itself. All of the new attributes sit in the hierarchy and require the target and group to 'localize' the property to the correct attribute.

Parameters
targetIN The target to localize to, or kTargetInvalid if you want a legacy lookup.
targetIN The group to localize to, or kGroupInvalid if you want a legacy lookup.
propIDIN The script property ID to look up.
Returns
Attribute type, or kUnknownAttrType if no associated type.
See Also
GetAttributeScriptInfo for looking up script info from attribute type.
virtual IXPAttributeSuite::AttributeGroup IXPAttributeUtils::GetAttributeGroup (IXPAttributeSuite::AttributeType attributeType)
pure virtual

Returns the attribute type's group (e.g., given drop shadow mode, returns drop shadow).

Parameters
attributeTypeis the attribute type
Returns
Attribute's group.
virtual void IXPAttributeUtils::GetAttributeGroupAttributeTypes (const IXPAttributeSuite::AttributeGroupattributeGroup,
const IXPAttributeSuite::AttributeTargetattributeTarget,
std::vector< IXPAttributeSuite::AttributeType > & groupAttrList 
)
pure virtual

Returns a list of attribute types for the given attribute group and target.

Parameters
attributeGroupis the attribute group
attributeTargetis the attribute target
groupAttrListis a list relevant attribute types for the specified attribute group and target.
virtual int32 IXPAttributeUtils::GetAttributeGroupIndex (IXPAttributeSuite::AttributeGroup )
pure virtual

Given an attribute group, returns the associated index.

Parameters
groupIN An attribute group.
Returns
The zero-based index of the group, or -1 if the group was invalid.
virtual PMIID IXPAttributeUtils::GetAttributeInterfaceIID (IXPAttributeSuite::AttributeType attributeType)
pure virtual

Returns the attribute type's interface IID.

Parameters
attributeTypeis the attribute type
Returns
attribute type's interface IID. Returns IID_IUNKNOWN if attribute type is invalid.
virtual ErrorCode IXPAttributeUtils::GetAttributeMinMax (IXPAttributeSuite::AttributeType type,
IXPAttributeSuite::AttributeValueminValue,
IXPAttributeSuite::AttributeValuemaxValue 
)
pure virtual

Return the minimum/maximum values for Real and enum attribute types.

Parameters
typeThe transparency attribute ID
Returns
An error code, or kSuccess if successful.
virtual bool16 IXPAttributeUtils::GetAttributeName (IXPAttributeSuite::AttributeType type,
PMStringname 
)
pure virtual

Return the name of the attribute.

Parameters
typeThe transparency attribute ID
Returns
An error code, or kSuccess if successful.
virtual IXPAttributeSuite::AttributeRealKind IXPAttributeUtils::GetAttributeRealKind (IXPAttributeSuite::AttributeType type)
pure virtual

Returns the real type associated with the given attribute (a real number attribute in all cases). Note that this gives more precise results than GetAttributeUnits, because ScriptData::UnitType doesn't capture all the aspects of the nature of the real.

Parameters
attrTypeIN The attribute.
Returns
The real kind, or kRealKindInvalid if it's not a real number attribute.
virtual bool16 IXPAttributeUtils::GetAttributeScriptInfo (IXPAttributeSuite::AttributeType attrType,
const IXPAttributeSuite::AttributeValueattrValue,
IDataBaseiDataBase,
IScriptiScript,
IScriptRequestDatadata,
ScriptDatapScriptData,
ScriptElementIDpElementID,
ScriptIDpScriptID 
)
pure virtual

Given an attribute type/value combination, creates a corresponding ScriptData, and/or returns the script ID, and/or returns the element ID. The latter two are simple lookups. The value conversion takes into account the enum-to-script space conversion, but does not check for valid value ranges.

Parameters
attrTypeIN The attribute type.
attrValueIN The attribute value (must be a compatible DataType).
iDataBaseIN The database for swatch inflation. Either this or iScript is required if pScriptData != nil.
iScriptIN The script interface. Either this or db is required iff pScriptData != nil.
scriptVersionIN The script event data
pScriptDataOUT If not nil, receives the scriptData to use for the attribute in a scripting context.
pElementIDOUT If not nil, receives the script element ID corresponding to the attribute.
pScriptIDOUT If not nil, receives the script ID corresponding to the attribute.
Returns
kTrue if successful, kFalse if not. Will only fail if the attrType is invalid or the associated value is of an incorrect type. And it'll only fail if the value is the wrong type if pScriptData is not nil.
virtual IXPAttributeSuite::AttributeTarget IXPAttributeUtils::GetAttributeTarget (IXPAttributeSuite::AttributeType attributeType)
pure virtual

Returns the attribute type's target (e.g., given stroke drop shadow, returns stroke).

Parameters
attributeTypeis the attribute type
Returns
Attribute's target.
virtual int32 IXPAttributeUtils::GetAttributeTargetIndex (IXPAttributeSuite::AttributeTarget )
pure virtual

Given an attribute target, returns the associated index.

Parameters
targetIN An attribute target.
Returns
The zero-based index of the target, or -1 if the target was invalid.
virtual ScriptData::UnitType IXPAttributeUtils::GetAttributeUnits (IXPAttributeSuite::AttributeType type)
pure virtual

Returns the unit type associated with the given attribute (a real number attribute in all cases). If the attribute has no unit type (e.g., opacity), returns -1. (Because ScriptData::UnitType has no 'invalid' value, unfortunately.)

Parameters
attrTypeIN The attribute.
Returns
The unit type, or ((ScriptData::UnitType)-1) if no units associted with the attr.
virtual ErrorCode IXPAttributeUtils::GetAttributeValue (IXPAttributeSuite::AttributeType attrType,
IXPAttributeSuite::AttributeValueattrValue,
const IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the attribute value from the graphic style descriptor

Parameters
attrTypeIndicates which attribute to get.
attrValueReceives the attribute value.
styleDescriptorThe graphic style descriptor to pull the value from.
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetAttributeValue (IXPAttributeSuite::AttributeType attrType,
IXPAttributeSuite::AttributeValueattrValue,
const IPMUnknowniAttr 
)
pure virtual

Get the attribute value from a graphics attribute boss.

Parameters
attrTypeIndicates which attribute to get.
iAttrThe attribute boss from which you're pulling the value.
attrValueReceives the attribute value.
Returns
kSuccess if successful or returns an error code
virtual bool16 IXPAttributeUtils::GetAttrListFromAttrBossList (const IGraphicStyleAttributeBossListiBossList,
IXPAttributeSuite::AttributeListattrList 
)
pure virtual

Creates a IGraphicStyleAttributeBossList attribute list from an AttributeList.

Parameters
iBossListIN The attribute list.
attrListOUT The converted attribute list.
virtual ErrorCode IXPAttributeUtils::GetBasicBlendMode (PMBlendingMode & blendMode,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the basic blending mode from the graphic style descriptor

Parameters
blendModethe blending mode to get. This is a PMBlendingMode.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::GetBasicIsolationGroup (bool16 & basicIsolationGrouop,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the isolation setting from the graphic style descriptor

Parameters
isolationthe isolation setting to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetBasicKnockoutGroup (bool16 & basicKnockoutGrouop,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the knockout group setting from the graphic style descriptor

Parameters
basicKnockoutGrouopthe knockout group setting to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetBasicOpacity (PMRealopacity,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the basic opacity from the graphic style descriptor

Parameters
opacitythe basic opacity to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual PMBevelEmbossDirection IXPAttributeUtils::GetBevelEmbossDirectionFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMBevelEmbossDirection given the scripting BevelEmbossDirection.

Parameters
asEnumthe scripting BevelEmbossDirection.
virtual PMBevelEmbossStyle IXPAttributeUtils::GetBevelEmbossStyleFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMBevelEmbossStyle given the scripting BevelEmbossStyle.

Parameters
asEnumthe scripting BevelEmbossStyle.
virtual PMBevelEmbossTechnique IXPAttributeUtils::GetBevelEmbossTechniqueFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMBevelEmbossTechnique given the scripting BevelEmbossTechnique.

Parameters
asEnumthe scripting BevelEmbossTechnique.
virtual PMBlendingMode IXPAttributeUtils::GetBlendModeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign blending mode given the scripting blending mode.

Parameters
asEnumthe scripting blending mode.
virtual PMVignetteCorners IXPAttributeUtils::GetCornerTypeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign feather corner type given the scripting feather corner type.

Parameters
asEnumthe scripting feather corner type.
virtual ErrorCode IXPAttributeUtils::GetDropShadowBlendMode (PMBlendingMode & blendMode,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow blend mode from the graphic style descriptor

Parameters
blendModethe drop shadow blend mode to get. This is a PMBlendingMode.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor. GraphicTypes.h
virtual ErrorCode IXPAttributeUtils::GetDropShadowBlurRadius (PMRealblurRadius,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow blur radius from the graphic style descriptor

Parameters
blurRadiusthe drop shadow blur radius to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowColorUID (UIDcolorUID,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow color UID from the graphic style descriptor

Parameters
colorUIDthe drop shadow color UID to get. This must be an UID of a kPMColorBoss.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowMode (PMDropShadowMode & dropShadowMode,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow apply setting from the graphic style descriptor

Parameters
dropShadowModethe drop shadow apply setting to get. This is a PMDropShadowMode.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::GetDropShadowNoise (PMRealnoise,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow noise from the graphic style descriptor

Parameters
noisethe drop shadow noise to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowOffsetX (PMRealdropShadowOffsetX,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow x offset from the graphic style descriptor

Parameters
dropShadowOffsetXthe drop shadow x offset to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowOffsetY (PMRealdropShadowOffsetY,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow y offset from the graphic style descriptor

Parameters
dropShadowOffsetYthe drop shadow y offset to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowOpacity (PMRealopacity,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow opacity from the graphic style descriptor

Parameters
opacitythe drop shadow opacity to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetDropShadowSpread (PMRealspread,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the drop shadow spread from the graphic style descriptor

Parameters
spreadthe drop shadow spread to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual PMDropShadowMode IXPAttributeUtils::GetDSModeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign drop shadow mode given the scripting drop shadow mode.

Parameters
asEnumthe scripting blending mode.
virtual PMFollowShapeMode IXPAttributeUtils::GetFollowShapeModeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMFollowShapeMode given the scripting FollowShapeMode.

Parameters
asEnumthe scripting FollowShapeMode.
virtual PMGlowTechnique IXPAttributeUtils::GetGlowTechniqueFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMGlowTechnique given the scripting GlowTechnique.

Parameters
asEnumthe scripting GlowTechnique.
virtual GradientType IXPAttributeUtils::GetGradientTypeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign GradientType given the scripting GradientType.

Parameters
asEnumthe scripting GradientType.
virtual IXPAttributeSuite::AttributeGroup IXPAttributeUtils::GetGroupFromScriptID (ScriptID id)
pure virtual

Given a scripting ID (either property or object), return the associated group. For example, passing p_XPBlendingSettings will return IXPAttributeSuite::kGroupBlending; passing c_FeatherSettings will return IXPAttributeSuite::kGroupFeather.

Parameters
idIN The ID to match against known group script IDs (objects or properties)
Returns
The corresponding group, or IXPAttributeSuite::kGroupInvalid if the script ID doesn't match any.
virtual PMInnerGlowSource IXPAttributeUtils::GetInnerGlowSourceFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign PMInnerGlowSource given the scripting InnerGlowSource.

Parameters
asEnumthe scripting InnerGlowSource.
virtual IXPAttributeSuite::AttributeGroup IXPAttributeUtils::GetNthAttributeGroup (int32 n)
pure virtual

Given an index, returns the associated attribute group.

Parameters
nIN The index, between 0 and GetNumAttributeGroups.
Returns
An attribute group, or IXPAttributeSuite::kGroupInvalid if n is out of range.
virtual IXPAttributeSuite::AttributeTarget IXPAttributeUtils::GetNthAttributeTarget (int32 n)
pure virtual

Given an index, returns the associated attribute target.

Parameters
nIN The index, between 0 and GetNumAttributeTargets.
Returns
An attribute target, or IXPAttributeSuite::kTargetInvalid if n is out of range.
virtual int32 IXPAttributeUtils::GetNumAttributeGroups ()
pure virtual

Returns the number of attribute groups. Yes, you could figure this out just by looking at the enumeration, but this allows you to write code that will still work if we ever add any new groups in the future.

Returns
The number of attribute groups per target.
virtual int32 IXPAttributeUtils::GetNumAttributeTargets ()
pure virtual

Returns the number of attribute targets. Yes, you could figure this out just by looking at the enumeration, but this allows you to write code that will still work if we ever add any new targets in the future.

Returns
The number of attribute targets.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromBevelEmbossDirection (PMBevelEmbossDirection bevelEmbossDirection)
pure virtual

Return the scripting BevelEmbossDirection given the InDesign PMBevelEmbossDirection.

Parameters
bevelEmbossDirectionthe InDesign BevelEmbossDirection.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromBevelEmbossStyle (PMBevelEmbossStyle bevelEmbossStyle)
pure virtual

Return the scripting BevelEmbossStyle given the InDesign PMBevelEmbossStyle.

Parameters
bevelEmbossStylethe InDesign BevelEmbossStyle.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromBevelEmbossTechnique (PMBevelEmbossTechnique bevelEmbossTechnique)
pure virtual

Return the scripting BevelEmbossTechnique given the InDesign PMBevelEmbossTechnique.

Parameters
bevelEmbossTechniquethe InDesign BevelEmbossTechnique.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromBlendMode (PMBlendingMode mode)
pure virtual

Return the scripting blending mode given the InDesign blending mode.

Parameters
modethe InDesign blending mode.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromCornerType (PMVignetteCorners mode)
pure virtual

Return the scripting feather corner type given the InDesign feather corner type.

Parameters
modethe InDesign blending mode.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromDSMode (PMDropShadowMode mode)
pure virtual

Return the scripting drop shadow mode given the InDesign drop shadow mode.

Parameters
modethe InDesign drop shadow mode.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromFollowShapeMode (PMFollowShapeMode followShapeMode)
pure virtual

Return the scripting FollowShapeMode given the InDesign PMFollowShapeMode.

Parameters
FollowShapeModethe InDesign FollowShapeMode.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromGlowTechnique (PMGlowTechnique glowTechnique)
pure virtual

Return the scripting GlowTechnique given the InDesign PMGlowTechnique.

Parameters
glowTechniquethe InDesign GlowTechnique.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromGradientType (GradientType gradientType)
pure virtual

Return the scripting GradientType given the InDesign GradientType.

Parameters
gradientTypethe InDesign GradientType.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromInnerGlowSource (PMInnerGlowSource innerGlowSource)
pure virtual

Return the scripting InnerGlowSource given the InDesign PMInnerGlowSource.

Parameters
innerGlowSourcethe InDesign InnerGlowSource.
virtual ScriptID IXPAttributeUtils::GetScriptEnumFromVignetteMode (PMVignetteMode mode)
pure virtual

Return the scripting feather mode given the InDesign feather mode.

Parameters
modethe InDesign feather mode.
virtual IXPAttributeSuite::AttributeTarget IXPAttributeUtils::GetTargetFromScriptID (ScriptID id)
pure virtual

Given a scripting ID (either property or object), return the associated target. For example, passing p_XPPageItemSettings will return IXPAttributeSuite::kTargetPageItem; passing c_StrokeTransparencySettings will return IXPAttributeSuite::kTargetStroke.

Parameters
idIN The ID to match against known target script IDs (objects or properties)
Returns
The corresponding target, or IXPAttributeSuite::kTargetInvalid if the script ID doesn't match any.
virtual K2Vector<ClassID>* IXPAttributeUtils::GetTransparencyAttributesFromList (const K2Vector< ClassID > * pAttrClassList)
pure virtual

Returns a list of transparency attribute class list from the specified attribute class list.

Parameters
pAttrClassListthe source attribute class list
Returns
a transparency-only attribute class list.
virtual bool16 IXPAttributeUtils::GetValueAsString (IXPAttributeSuite::AttributeType type,
const IXPAttributeSuite::AttributeValueval,
IDataBasedb,
PMStrings 
)
pure virtual

Translates an attribute type/value into a string. The type and database are needed to handle specific formatting needs for real values and colors, respectively.

virtual ErrorCode IXPAttributeUtils::GetVignetteCorners (PMVignetteCorners & corners,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather corner type from the graphic style descriptor

Parameters
cornersthe feather corner type to get. This is a PMVignetteCorners.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
GraphicTypes.h.
virtual ErrorCode IXPAttributeUtils::GetVignetteInnerOpacity (PMRealinnerOpacity,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather inner opacity from the graphic style descriptor

Parameters
innerOpacitythe feather inner opacity to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetVignetteMode (PMVignetteMode & vignetteMode,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather apply setting from the graphic style descriptor

Parameters
vignetteModethe feather apply setting to get. This is a PMVignetteMode.
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
GraphicTypes.h.
virtual PMVignetteMode IXPAttributeUtils::GetVignetteModeFromScriptEnum (ScriptID asEnum)
pure virtual

Return the InDesign feather mode given the scripting feather mode.

Parameters
asEnumthe scripting feather mode.
virtual ErrorCode IXPAttributeUtils::GetVignetteNoise (PMRealnoise,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather noise from the graphic style descriptor

Parameters
noisethe feather noise to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetVignetteOuterOpacity (PMRealouterOpacity,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather outer opacity from the graphic style descriptor

Parameters
outerOpacitythe feather outer opacity to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual ErrorCode IXPAttributeUtils::GetVignetteWidth (PMRealwidth,
IGraphicStyleDescriptorstyleDescriptor 
)
pure virtual

Get the feather width from the graphic style descriptor

Parameters
widththe feather width to get
styleDescriptorthe graphic style descriptor
Returns
kSuccess if successful or returns an error code
See Also
IGraphicStyleDescriptor.
virtual bool16 IXPAttributeUtils::IsAttributeTransparencyAttribute (ClassID attributeClass)
pure virtual

Returns kTrue if the specified attribute class is a transparency attribute.

Parameters
attrClassthe attribute class ID
Returns
kTrue if attribute class is a transparency attribute otherwise kFalse
virtual bool16 IXPAttributeUtils::IsBasicTransparencyAttribute (ClassID attrClass)
pure virtual

Returns kTrue if the specified attribute class is a basic transparency attribute.

Parameters
attrClassthe transparency attribute class ID
Returns
kTrue if attribute class is a basic transparency attribute otherwise kFalse
virtual bool16 IXPAttributeUtils::IsDropShadowAttribute (ClassID attrClass)
pure virtual

Returns kTrue if the specified attribute class is a dropshadow attribute.

Parameters
attrClassthe transparency attribute class ID
Returns
kTrue if attribute class is a dropshadow attribute otherwise kFalse
virtual bool16 IXPAttributeUtils::IsValidAttributeValue (IXPAttributeSuite::AttributeType type,
const IXPAttributeSuite::AttributeValuevalue 
)
pure virtual

Determines whether the given value (Real and enum types only) is allowed. For non-real/enum types no check is made and the attribute is declared 'valid.'

Parameters
typeThe transparency attribute ID
valueThe value to check
Returns
An error code, or kSuccess if successful.
virtual bool16 IXPAttributeUtils::IsVignetteAttribute (ClassID attrClass)
pure virtual

Returns kTrue if the specified attribute class is a feather attribute.

Parameters
attrClassthe transparency attribute class ID
Returns
kTrue if attribute class is a feather attribute otherwise kFalse
virtual void IXPAttributeUtils::LookupScriptInfo (IScriptRequestDatadata,
ScriptID propID,
IScriptiScript,
IXPAttributeSuite::AttributeTargettarget,
IXPAttributeSuite::AttributeGroupgroup,
IXPAttributeSuite::AttributeType & type 
)
pure virtual

Looks up scripting information based on a script request (property ID and iScript object). From these two inputs, determines the target, group, and attribute type, as appropriate. If the property corresponds to a first-tier (item, stroke, fill, content) object or property, returns the target and leaves group/type as invalid. If the property corresponds to a second-tier (blending, drop shadow, etc) property or object, returns the target and group and leaves 'type' invalid. If the property corresponds to any transparency property anywhere in the hierarchy, returns 'type' as valid and sets up the target. If the property is in the hierarchy, also returns 'group', although you could derive that from the attribute.

Parameters
propIDIN The property ID.
iScriptIN The scripting object on which the property lives.
targetOUT Receives the target, or kTargetInvalid if we found no match for the property (error).
groupOUT Receives the group, or kGroupInvalid if the property is a legacy property on the page item.
typeOUT Receives the attribute, or kUnknownAttrType if the property isn't an attribute-level property.
virtual IXPAttributeSuite::AttributeType IXPAttributeUtils::TranslateToTarget (IXPAttributeSuite::AttributeType attrType,
IXPAttributeSuite::AttributeTarget attrTarget = IXPAttributeSuite::kTargetPageItem 
)
pure virtual

Translates attribute types between targets. For example:

TranslateAttributeType(kInnerShadowColor, kTargetStroke) -> kStrokeInnerShadowColor

TranslateAttributeType(kStrokeInnerShadowColor, kTargetPageItem) -> kTargetStroke

TranslateAttributeType(kTargetStroke, kTargetPageItem) -> kTargetStroke

The most common usage is to translate from an attribute type that might be page item, fill, or stroke to the page item equivalent; thus the default param value for attrTarget.

Parameters
attrTypeIN The attribute type (page item, stroke, fill).
attrTargetIN The attribute target to translate the attribute into.
Returns
The translated attribute type; or kUnknownAttrType if the passed-in type isn't valid in the first place.