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

#include <IXPSetAttributesCmdData.h>

Inheritance diagram for IXPSetAttributesCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXPSETATTRIBUTESCMDDATA }
 

Public Member Functions

virtual void SetAttributeList (const IXPAttributeSuite::AttributeList &newList)=0
 
virtual void GetAttributeList (IXPAttributeSuite::AttributeList &list) const =0
 
virtual void SetAutoInitializeGradientFeatherGeometry (bool32 doInit)=0
 
virtual bool32 GetAutoInitializeGradientFeatherGeometry () const =0
 
virtual void SetPartialADXYVector (const IXPAttributeSuite::PartialADXYVector &partials)=0
 
virtual const
IXPAttributeSuite::PartialADXYVector
GetPartialADXYVector () const =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

Data interface for setting arbitrary transparency attributes on page item(s).

Member Function Documentation

virtual void IXPSetAttributesCmdData::GetAttributeList (IXPAttributeSuite::AttributeListlist) const
pure virtual

Gets the list of attributes.

Parameters
listOUT A list whose contents (if any) are replaced with the list of attributes to be applied.
virtual bool32 IXPSetAttributesCmdData::GetAutoInitializeGradientFeatherGeometry () const
pure virtual

Returns the auto initialize of gradient feather geometry attributes state.

Returns
True if the command will auto-initialize gradient feather attrs, false otherwise.
virtual const IXPAttributeSuite::PartialADXYVector& IXPSetAttributesCmdData::GetPartialADXYVector () const
pure virtual

Returns the list of partial ADXYs to apply.

Returns
A const reference to the list.
virtual void IXPSetAttributesCmdData::SetAttributeList (const IXPAttributeSuite::AttributeListnewList)
pure virtual

Sets the list of attributes to apply to the page items.

Parameters
newListIN The list of attributes and values. A copy of this list is stored.
virtual void IXPSetAttributesCmdData::SetAutoInitializeGradientFeatherGeometry (bool32 doInit)
pure virtual

When applying the command to more than one page item, it's not possible to specify a single value for the gradient feather length and center attributes. This method specifies how to handle these attributes. (These work for single page items too.)

Parameters
doInitIN If true, the command will automatically inspect the page item(s) and the list of attributes being applied. If the command is applying a gradient-feather-apply=true attribute, the command will check for corresponding center and length attributes in the attribute list. If these are missing and the page items for the command don't have length/center attributes established (or the length/center values are zero), the command will initialize those attributes to their defaults based on the page item's geometry. If false, no such inspection occurs. The default value is false.
virtual void IXPSetAttributesCmdData::SetPartialADXYVector (const IXPAttributeSuite::PartialADXYVectorpartials)
pure virtual

When applying the command to more than one page item we need special processing for partial angle/distance/x/y application – eg applying X offset only to inner shadow, since inner shadow represents the shadow location in terms of angle and distance. So in order to apply only xoffset we have to process each page item independently. The default is an empty list (no partial applications).

Parameters
partialsIN The list of partial ADXY values to apply. The list is copied.