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

#include <IXPAttributeFacade.h>

Inheritance diagram for IXPAttributeFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXPATTRIBUTEFACADE }
 

Public Member Functions

virtual ErrorCode SetBlendMode (const UIDList &itemList, PMBlendingMode blendMode)=0
 
virtual ErrorCode GetBlendMode (const UIDList &itemList, K2Vector< int32 > &blendModeList)=0
 
virtual ErrorCode SetOpacity (const UIDList &itemList, PMReal opacity)=0
 
virtual ErrorCode GetOpacity (const UIDList &itemList, K2Vector< PMReal > &opacityList)=0
 
virtual ErrorCode SetKnockoutGroup (const UIDList &itemList, bool16 knockoutGroup)=0
 
virtual ErrorCode GetKnockoutGroup (const UIDList &itemList, K2Vector< bool16 > &knockoutGroupList)=0
 
virtual ErrorCode SetIsolateBlending (const UIDList &itemList, bool16 isolateBlending)=0
 
virtual ErrorCode GetIsolateBlending (const UIDList &itemList, K2Vector< bool16 > &isolateBlendingList)=0
 
virtual ErrorCode SetShadowMode (const UIDList &itemList, PMDropShadowMode shadowMode)=0
 
virtual ErrorCode GetShadowMode (const UIDList &itemList, K2Vector< int32 > &shadowModeList)=0
 
virtual ErrorCode SetShadowBlendMode (const UIDList &itemList, PMBlendingMode shadowBlendMode)=0
 
virtual ErrorCode GetShadowBlendMode (const UIDList &itemList, K2Vector< int32 > &shadowBlendModeList)=0
 
virtual ErrorCode SetShadowXOffset (const UIDList &itemList, PMReal shadowXOffset)=0
 
virtual ErrorCode GetShadowXOffset (const UIDList &itemList, K2Vector< PMReal > &shadowXOffsetList)=0
 
virtual ErrorCode SetShadowYOffset (const UIDList &itemList, PMReal shadowYOffset)=0
 
virtual ErrorCode GetShadowYOffset (const UIDList &itemList, K2Vector< PMReal > &shadowYOffsetList)=0
 
virtual ErrorCode SetShadowBlurRadius (const UIDList &itemList, PMReal shadowBlurRadius)=0
 
virtual ErrorCode GetShadowBlurRadius (const UIDList &itemList, K2Vector< PMReal > &shadowBlurRadiusList)=0
 
virtual ErrorCode SetShadowColor (const UIDList &itemList, UID shadowColor)=0
 
virtual ErrorCode GetShadowColor (const UIDList &itemList, K2Vector< UID > &shadowColorList)=0
 
virtual ErrorCode SetShadowOpacity (const UIDList &itemList, PMReal shadowOpacity)=0
 
virtual ErrorCode GetShadowOpacity (const UIDList &itemList, K2Vector< PMReal > &shadowOpacityList)=0
 
virtual ErrorCode SetShadowSpread (const UIDList &itemList, PMReal shadowSpread)=0
 
virtual ErrorCode GetShadowSpread (const UIDList &itemList, K2Vector< PMReal > &shadowSpreadList)=0
 
virtual ErrorCode SetShadowNoise (const UIDList &itemList, PMReal shadowNoise)=0
 
virtual ErrorCode GetShadowNoise (const UIDList &itemList, K2Vector< PMReal > &shadowNoiseList)=0
 
virtual ErrorCode SetFeatherMode (const UIDList &itemList, PMVignetteMode featherMode)=0
 
virtual ErrorCode GetFeatherMode (const UIDList &itemList, K2Vector< int32 > &featherModeList)=0
 
virtual ErrorCode SetFeatherWidth (const UIDList &itemList, PMReal featherWidth)=0
 
virtual ErrorCode GetFeatherWidth (const UIDList &itemList, K2Vector< PMReal > &featherWidthList)=0
 
virtual ErrorCode SetFeatherNoise (const UIDList &itemList, PMReal noise)=0
 
virtual ErrorCode GetFeatherNoise (const UIDList &itemList, K2Vector< PMReal > &noiseList)=0
 
virtual ErrorCode SetFeatherInnerOpacity (const UIDList &itemList, PMReal featherInnerOpacity)=0
 
virtual ErrorCode GetFeatherInnerOpacity (const UIDList &itemList, K2Vector< PMReal > &featherInnerOpacityList)=0
 
virtual ErrorCode SetFeatherOuterOpacity (const UIDList &itemList, PMReal featherOuterOpacity)=0
 
virtual ErrorCode GetFeatherOuterOpacity (const UIDList &itemList, K2Vector< PMReal > &featherOuterOpacityList)=0
 
virtual ErrorCode SetFeatherCornerType (const UIDList &itemList, PMVignetteCorners featherCornerType)=0
 
virtual ErrorCode GetFeatherCornerType (const UIDList &itemList, K2Vector< int32 > &featherCornerTypeList)=0
 
virtual ErrorCode ApplyAttributes (const UIDList &itemList, IGraphicStyleAttributeBossList *iAttrList)=0
 
virtual ErrorCode ApplyAttributes (const UIDList &itemList, const IXPAttributeSuite::AttributeList &attrList)=0
 
virtual ErrorCode ApplyBasicAttributes (const UIDList &itemList, BasicAttributesData *basicData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=0
 
virtual ErrorCode ApplyDropShadowAttributes (const UIDList &itemList, DropShadowData *dropshadowData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=0
 
virtual ErrorCode ApplyVignetteAttributes (const UIDList &itemList, VignetteData *featherData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=0
 
virtual void RecordApplyAttributes (AutomationContext *pAutomationContext, IDataBase *iDataBase, IGraphicStyleAttributeBossList *iAttrList)=0
 
virtual void RecordApplyAttributes (AutomationContext *pAutomationContext, IDataBase *iDataBase, const IXPAttributeSuite::AttributeList &attrList)=0
 
virtual void RecordApplyBasicAttributes (AutomationContext *pAutomationContext, BasicAttributesData *basicData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=0
 
virtual void RecordApplyDropShadowAttributes (AutomationContext *pAutomationContext, IDataBase *, DropShadowData *dropshadowData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=0
 
virtual void RecordApplyVignetteAttributes (AutomationContext *pAutomationContext, VignetteData *featherData, const K2Vector< IXPAttributeSuite::AttributeType > &attrTypeList)=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

This is the high level transparency attribute facade. It defines methods to Get and Set all transparency attributes. It also defines methods for recording user action related to setting transparency attributes.

Member Function Documentation

virtual ErrorCode IXPAttributeFacade::ApplyAttributes (const UIDListitemList,
IGraphicStyleAttributeBossListiAttrList 
)
pure virtual

Apply the specified transparency attr list to the specified item list

Parameters
itemListthe item list to apply.
iAttrListthe attribute list to apply. Only transparency attributes from the list are applied.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::ApplyAttributes (const UIDListitemList,
const IXPAttributeSuite::AttributeListattrList 
)
pure virtual

Apply the specified transparency attr list to the specified item list

Parameters
itemListthe item list to apply.
iAttrListthe attribute list to apply.
Returns
kSuccess if successful otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::ApplyBasicAttributes (const UIDListitemList,
BasicAttributesDatabasicData,
const K2Vector< IXPAttributeSuite::AttributeType > & attrTypeList 
)
pure virtual

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

Parameters
itemListthe item list to apply.
basicDatathe basic transparency data
attrTypeListthe list of basic transparency attribute types to apply.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::ApplyDropShadowAttributes (const UIDListitemList,
DropShadowDatadropshadowData,
const K2Vector< IXPAttributeSuite::AttributeType > & attrTypeList 
)
pure virtual

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

Parameters
itemListthe item list to apply.
dropshadowDatathe dropshadow data to apply
attrTypeListthe list of dropshadow attribute types to apply.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::ApplyVignetteAttributes (const UIDListitemList,
VignetteDatafeatherData,
const K2Vector< IXPAttributeSuite::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
itemListthe item list to apply.
featherDatathe feather data
attrTypeListthe list of feather attribute types to apply.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetBlendMode (const UIDListitemList,
K2Vector< int32 > & blendModeList 
)
pure virtual

Get the blend mode property

Parameters
itemListthe item list to get.
Theblend mode list of the items.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherCornerType (const UIDListitemList,
K2Vector< int32 > & featherCornerTypeList 
)
pure virtual

Get the feather corner type property

Parameters
itemListthe item list to get.
Thetype of feathering.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherInnerOpacity (const UIDListitemList,
K2Vector< PMReal > & featherInnerOpacityList 
)
pure virtual

Set the feather inner opacity property The feather inner opacity

Parameters
itemListthe item list to get.
Thefeather inner opacity.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherMode (const UIDListitemList,
K2Vector< int32 > & featherModeList 
)
pure virtual

Get the feather mode property The feather mode

Parameters
itemListthe item list to get.
Thefeather mode.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherNoise (const UIDListitemList,
K2Vector< PMReal > & noiseList 
)
pure virtual

get the feather noise property The feather noise

Parameters
itemListthe item list to get.
Thefeather noise.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherOuterOpacity (const UIDListitemList,
K2Vector< PMReal > & featherOuterOpacityList 
)
pure virtual

Get the feather outer opacity property The feather outer opacity

Parameters
itemListthe item list to get.
Thefeather outer opacity.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetFeatherWidth (const UIDListitemList,
K2Vector< PMReal > & featherWidthList 
)
pure virtual

Set the feather width property The width of the feathering

Parameters
itemListthe item list to get.
Thewidth of the feathering.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetIsolateBlending (const UIDListitemList,
K2Vector< bool16 > & isolateBlendingList 
)
pure virtual

Get the isolate blending property

Parameters
itemListthe item list to get.
isolationblendings of the items.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetKnockoutGroup (const UIDListitemList,
K2Vector< bool16 > & knockoutGroupList 
)
pure virtual

Get the knockout group property

Parameters
itemListthe item list to get.
knockoutgroup list of the items.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetOpacity (const UIDListitemList,
K2Vector< PMReal > & opacityList 
)
pure virtual

Get the opacity property

Parameters
itemListthe item list to get.
Theopacity list of the items.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowBlendMode (const UIDListitemList,
K2Vector< int32 > & shadowBlendModeList 
)
pure virtual

Get the shadow blend mode property

Parameters
itemListthe item list to get.
Theblend mode list for the items.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowBlurRadius (const UIDListitemList,
K2Vector< PMReal > & shadowBlurRadiusList 
)
pure virtual

Get the shadow blur radius property The radius of the blur to apply to the shadow

Parameters
itemListthe item list to get.
Theradius of the blur.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowColor (const UIDListitemList,
K2Vector< UID > & shadowColorList 
)
pure virtual

Get the shadow color property

Parameters
itemListthe item list to get.
Thecolor to apply to the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowMode (const UIDListitemList,
K2Vector< int32 > & shadowModeList 
)
pure virtual

Get the shadow mode property

Parameters
itemListthe item list to get.
Theshadow mode list.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowNoise (const UIDListitemList,
K2Vector< PMReal > & shadowNoiseList 
)
pure virtual

Get the shadow noise property

Parameters
itemListthe item list to get.
Thenoise of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowOpacity (const UIDListitemList,
K2Vector< PMReal > & shadowOpacityList 
)
pure virtual

Get the shadow opacity property

Parameters
itemListthe item list to get.
Theopacity of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowSpread (const UIDListitemList,
K2Vector< PMReal > & shadowSpreadList 
)
pure virtual

Get the shadow spread property

Parameters
itemListthe item list to get.
Thespread of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowXOffset (const UIDListitemList,
K2Vector< PMReal > & shadowXOffsetList 
)
pure virtual

Get the shadow x offset property

Parameters
itemListthe item list to get.
Thehorizontal offset of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::GetShadowYOffset (const UIDListitemList,
K2Vector< PMReal > & shadowYOffsetList 
)
pure virtual

Get the shadow y offset property

Parameters
itemListthe item list to get.
Thevertical offset of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual void IXPAttributeFacade::RecordApplyAttributes (AutomationContext * pAutomationContext,
IDataBaseiDataBase,
IGraphicStyleAttributeBossListiAttrList 
)
pure virtual

Record the spcified list of transparency attributes. Only those data specified by the attrTypeList are recorded.

Parameters
pAutomationContextspecifies the recording context
iDataBasethe database with which the attirubtes are recorded.
iAttrListthe list of transparency attribute types to record.
virtual void IXPAttributeFacade::RecordApplyAttributes (AutomationContext * pAutomationContext,
IDataBaseiDataBase,
const IXPAttributeSuite::AttributeListattrList 
)
pure virtual

Record the spcified list of transparency attributes. Only those data specified by the attrTypeList are recorded.

Parameters
pAutomationContextspecifies the recording context
iDataBasethe database with which the attirubtes are recorded.
attrListThe list of transparency attributes to record.
virtual void IXPAttributeFacade::RecordApplyBasicAttributes (AutomationContext * pAutomationContext,
BasicAttributesDatabasicData,
const K2Vector< IXPAttributeSuite::AttributeType > & attrTypeList 
)
pure virtual

Record the spcified set of basic transparency attributes.. Only those data specified by the attrTypeList are recorded.

Parameters
pAutomationContextspecifies the recording context
basicDatathe basic transparency data
attrTypeListthe list of basic transparency attribute types to record.
virtual void IXPAttributeFacade::RecordApplyDropShadowAttributes (AutomationContext * pAutomationContext,
IDataBase,
DropShadowDatadropshadowData,
const K2Vector< IXPAttributeSuite::AttributeType > & attrTypeList 
)
pure virtual

Record the spcified set of drop shadow attributes.. Only those data specified by the attrTypeList are recorded.

Parameters
pAutomationContextspecifies the recording context
iDataBasethe database with which the attirubtes are recorded.
dropshadowDatathe dropshadow data to apply
attrTypeListthe list of dropshadow attribute types to record.
virtual void IXPAttributeFacade::RecordApplyVignetteAttributes (AutomationContext * pAutomationContext,
VignetteDatafeatherData,
const K2Vector< IXPAttributeSuite::AttributeType > & attrTypeList 
)
pure virtual

Record the spcified set of feather attributes. Only those data specified by the attrTypeList are recorded.

Parameters
pAutomationContextspecifies the recording context
featherDatathe feather data
attrTypeListthe list of feather attribute types to record.
virtual ErrorCode IXPAttributeFacade::SetBlendMode (const UIDListitemList,
PMBlendingMode blendMode 
)
pure virtual

Set the blend mode property

Parameters
itemListthe item list to apply.
Theblend mode used to combine the object's color with the background.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherCornerType (const UIDListitemList,
PMVignetteCorners featherCornerType 
)
pure virtual

Set the feather corner type property The type of feathering to apply

Parameters
itemListthe item list to apply.
Thetype of feathering to apply.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherInnerOpacity (const UIDListitemList,
PMReal featherInnerOpacity 
)
pure virtual

Set the feather inner opacity property The feather inner opacity

Parameters
itemListthe item list to apply.
Thefeather inner opacity.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherMode (const UIDListitemList,
PMVignetteMode featherMode 
)
pure virtual

Set the feather mode property The feather mode

Parameters
itemListthe item list to apply.
Thefeather mode.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherNoise (const UIDListitemList,
PMReal noise 
)
pure virtual

Set the feather noise property The feather noise

Parameters
itemListthe item list to apply.
Thefeather noise.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherOuterOpacity (const UIDListitemList,
PMReal featherOuterOpacity 
)
pure virtual

Set the feather outer opacity property The feather outer opacity

Parameters
itemListthe item list to apply.
Thefeather outer opacity.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetFeatherWidth (const UIDListitemList,
PMReal featherWidth 
)
pure virtual

Set the feather width property The width of the feathering

Parameters
itemListthe item list to apply.
Thewidth of the feathering.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetIsolateBlending (const UIDListitemList,
bool16 isolateBlending 
)
pure virtual

Set the isolate blending property

Parameters
itemListthe item list to apply.
Indicateswhether the object should blend in isolation.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetKnockoutGroup (const UIDListitemList,
bool16 knockoutGroup 
)
pure virtual

Set the knockout group property

Parameters
itemListthe item list to apply.
Indicateswhether the object is a knockout group.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetOpacity (const UIDListitemList,
PMReal opacity 
)
pure virtual

Set the opacity property

Parameters
itemListthe item list to apply.
Theopacity of the object.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowBlendMode (const UIDListitemList,
PMBlendingMode shadowBlendMode 
)
pure virtual

Set the shadow blend mode property

Parameters
itemListthe item list to apply.
Theblend mode to use for drawing the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowBlurRadius (const UIDListitemList,
PMReal shadowBlurRadius 
)
pure virtual

Set the shadow blur radius property The radius of the blur to apply to the shadow

Parameters
itemListthe item list to apply.
Theradius of the blur to apply to the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowColor (const UIDListitemList,
UID shadowColor 
)
pure virtual

Set the shadow color property The color to apply to the shadow

Parameters
itemListthe item list to apply.
Thecolor to apply to the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowMode (const UIDListitemList,
PMDropShadowMode shadowMode 
)
pure virtual

Set the shadow mode property

Parameters
itemListthe item list to apply.
Theshadow mode.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowNoise (const UIDListitemList,
PMReal shadowNoise 
)
pure virtual

Set the shadow noise property The noise of the shadow

Parameters
itemListthe item list to apply.
Thenoise of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowOpacity (const UIDListitemList,
PMReal shadowOpacity 
)
pure virtual

Set the shadow opacity property The opacity of the shadow

Parameters
itemListthe item list to apply.
Theopacity of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowSpread (const UIDListitemList,
PMReal shadowSpread 
)
pure virtual

Set the shadow spread property The spread of the shadow

Parameters
itemListthe item list to apply.
Thespread of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowXOffset (const UIDListitemList,
PMReal shadowXOffset 
)
pure virtual

Set the shadow x offset property The horizontal offset of the shadow

Parameters
itemListthe item list to apply.
Thehorizontal offset of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.
virtual ErrorCode IXPAttributeFacade::SetShadowYOffset (const UIDListitemList,
PMReal shadowYOffset 
)
pure virtual

Set the shadow y offset property The vertical offset of the shadow

Parameters
itemListthe item list to apply.
Thevertical offset of the shadow.
Returns
kSuccess if successfull otherwise returns an error code.