#include <IGraphicAttributeSuite.h>

Inheritance diagram for IGraphicAttributeSuite:

Public Types
enum	{ kDefaultIID = IID_IGRAPHICATTRIBUTESUITE }

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

virtual int16	GetAttributeValueCount (ClassID attrClassID, uint32 whichAttribute)=0

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

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

virtual ErrorCode	AddAttribute (const IPMUnknown *iNewAttribute)=0

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

virtual ErrorCode	RemoveAttribute (ClassID attrClassID)=0

virtual ErrorCode	RemoveAllAttributes (ClassID *pAttrClassList, uint16 count)=0

virtual ErrorCode	AddMultAttributes (IGraphicStyleAttributeBossList *iAttrList)=0

virtual IGraphicStyleAttributeBossList *	CreateAttributeListCopy (void)=0

virtual ErrorCode	SwapStrokeAndFill (void)=0

virtual ErrorCode	ChangeStrokeRenderObject (ClassID renderingClass, UID renderingUID)=0

virtual ErrorCode	ChangeFillRenderObject (ClassID renderingClass, UID renderingUID)=0

virtual UID	GetFillRenderObjectUID (ClassID)=0

virtual UID	GetStrokeRenderObjectUID (ClassID)=0

virtual bool16	IsFillRenderObjectIndeterminant (ClassID)=0

virtual bool16	IsStrokeRenderObjectIndeterminant (ClassID)=0

virtual ErrorCode	ApplyRenderUIDToSelection (ClassID renderingClass, UID renderingUID, ClassID renderingAttrClass)=0

virtual ClassID	GetCurrentRenderObjectClass (void)=0

virtual ClassID	GetFillClass (void)=0

virtual ClassID	GetStrokeClass (void)=0

virtual bool16	IsAttributeEnabled (ClassID attributeClass)=0

virtual bool16	IsLineTypeEnabled (ClassID attributeClass)=0

virtual void	UpdateRenderObjectsToProxyState (void)=0

virtual void	GetDisabledAttributesList (K2Vector< ClassID > *pDisabledAttrClassList)=0

virtual void	GetDisabledRenderingTypesList (K2Vector< ClassID > pDisabledFillRenderClassList, K2Vector< ClassID > pDisabledStrokeRenderClassList)=0

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This is a general graphic attribute suite interface for getting and setting of graphic attributes. A graphic attribute object must support the interface, IGraphicAttributeInfo. It usually has a persistent data interface as well. Currently these basic data interfaces are provided:

See Also: IGraphicAttrBoolean.h for a boolean data interface.; IGraphicAttrInt16.h for a int16 data interface.; IGraphicAttrInt32.h for a int32 data interface.; IGraphicAttrClassID.h for a ClassID data interface.; IGraphicAttrRealNumber.h for a PMReal data interface.; IGraphicAttrPoint.h for a PMPoint data interface.; IGraphicAttributeInfo.h for information on IGraphicAttributeInfo.; GraphicStylesID.h for a list of required graphic attribute classes supported by InDesign.

Other attribute classes supported by InDesign are defined in GradientFillID.h, XPID.h, and InstStrokeFillID.h New attribute classes and attribute data interfaces can be added.

Member Function Documentation

virtual ErrorCode IGraphicAttributeSuite::AddAttribute ( const IPMUnknown * iNewAttribute )

pure virtual

Add the specified attribute, "iNewAttribute", to the attribute boss list in the current selection.

Parameters

iNewAttribute the attribute to add.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::AddMultAttributes ( IGraphicStyleAttributeBossList * iAttrList )

pure virtual

Add the attributes in the list, "iAttrList", to the attribute boss list in the current selection.

Parameters

iAttrList the list of attributes to add.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::ApplyRenderUIDToSelection	(	ClassID	renderingClass,
		UID	renderingUID,
		ClassID	renderingAttrClass
	)

pure virtual

Apply the specified rendering class and UID to specified renderint attribute in the current selection.

Parameters

renderingClass	the rendering class.
renderingUID	the rendering UID.
renderingAttrClass	the rendering rendering class (kGraphicStyleFillRenderingAttrBoss or kGraphicStyleStrokeRenderingAttrBoss).

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::ChangeFillRenderObject	(	ClassID	renderingClass,
		UID	renderingUID
	)

pure virtual

Change the fill rendering attributes in the current selection to the specified rendering class and UID.

Parameters

renderingClass	the fill rendering class.
renderingUID	the rendering UID.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::ChangeStrokeRenderObject	(	ClassID	renderingClass,
		UID	renderingUID
	)

pure virtual

Change the stroke rendering attributes in the current selection to the specified rendering class and UID.

Parameters

renderingClass	the stroke rendering class.
renderingUID	the rendering UID.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::CopyIntoAttribute	(	uint32	whichAttribute,
		IPMUnknown *	iNewAttribute
	)

pure virtual

Copy the content of the specified attribute, "iNewAttribute", into the nth attribute of the same attribute class in the current selection.

Parameters

whichAttribute	the nth attribute index starting from 0.
iNewAttribute	the attribute to copy.

Returns: kSuccess if successful, else an error code

virtual IPMUnknown* IGraphicAttributeSuite::CreateAttributeCopy	(	uint32	whichAttribute,
		ClassID	attrClassID,
		const PMIID &	= `IID_IUNKNOWN`
	)

pure virtual

Create a copy of the nth attribute and returns the specified IID in the selection.

Parameters

whichAttribute	the nth attribute index starting from 0.
attrClassID	the attribute class ID.
interfaceID	the requested interface IID on the attribute boss.

Returns: the requested Interface pointer (as IPMUnknown*) or nil. The result may be cast to the 'type' identified by IID.

virtual IGraphicStyleAttributeBossList* IGraphicAttributeSuite::CreateAttributeListCopy ( void )

pure virtual

Returns a copy of the list of attributes in the current selection.

Returns: a copy of the current attribute list.

virtual uint16 IGraphicAttributeSuite::GetAttributeCount ( ClassID attrClassID )

pure virtual

Returns the number of unique attribute count of the specified attribute class in the selection.

virtual int16 IGraphicAttributeSuite::GetAttributeValueCount	(	ClassID	attrClassID,
		uint32	whichAttribute
	)

pure virtual

Returns the number of nth attribute value of the specified attribute class specified by whichAttribute in the selection.

virtual ClassID IGraphicAttributeSuite::GetCurrentRenderObjectClass ( void )

pure virtual

Returns the active rendering class in the current selection.

Returns: active rendering ClassID in the current selection

virtual void IGraphicAttributeSuite::GetDisabledAttributesList ( K2Vector< ClassID > * pDisabledAttrClassList )

pure virtual

Returns a list of disabled attributes in the current selection.

Parameters

pDisabledAttrClassList list of disabled attribute class list.

virtual void IGraphicAttributeSuite::GetDisabledRenderingTypesList	(	K2Vector< ClassID > *	pDisabledFillRenderClassList,
		K2Vector< ClassID > *	pDisabledStrokeRenderClassList
	)

pure virtual

Returns a list of disabled rendering types in the current selection.

Parameters

pDisabledFillRenderClassList	list of disabled fill rendering class list.
pDisabledStrokeRenderClassList	list of disabled stroke rendering list.

virtual ClassID IGraphicAttributeSuite::GetFillClass ( void )

pure virtual

Returns the current fill rendering class in the current selection.

Returns: fill rendering ClassID in the current selection

virtual UID IGraphicAttributeSuite::GetFillRenderObjectUID ( ClassID )

pure virtual

Returns the fill renderingClass rendering UID of the specified rendering class in the current selection.

Parameters

renderingClass the fill rendering class.

Returns: the renderingClass rendering UID of the specified rendering class

virtual ClassID IGraphicAttributeSuite::GetStrokeClass ( void )

pure virtual

Returns the current stroke rendering class in the current selection.

Returns: stroke rendering ClassID in the current selection

virtual UID IGraphicAttributeSuite::GetStrokeRenderObjectUID ( ClassID )

pure virtual

Returns the stroke rendering UID of the specified rendering class in the current selection.

Parameters

renderingClass the fill rendering class.

Returns: the stroke rendering UID of the specified rendering class

virtual bool16 IGraphicAttributeSuite::IsAttributeEnabled ( ClassID attributeClass )

pure virtual

Returns kTrue if the specified attribute class is enabled in the current selection.

Parameters

attributeClass the attribute class.

Returns: kTrue if the specified attribute class is enabled

virtual bool16 IGraphicAttributeSuite::IsFillRenderObjectIndeterminant ( ClassID )

pure virtual

Returns kTrue if the specified fill rendering class is indeterminant in the current selection.

Parameters

renderingClass the fill rendering class.

Returns: kTrue if the specified fill rendering class is indeterminant

virtual bool16 IGraphicAttributeSuite::IsLineTypeEnabled ( ClassID attributeClass )

pure virtual

Returns kTrue if the specified line type is enabled in the current selection.

Parameters

attributeClass the ClassID of the line type.

Returns: kTrue if the specified line type is enabled

virtual bool16 IGraphicAttributeSuite::IsStrokeRenderObjectIndeterminant ( ClassID )

pure virtual

Returns kTrue if the specified stroke rendering class is indeterminant in the current selection.

Parameters

renderingClass the fill rendering class.

Returns: kTrue if the specified stroke rendering class is indeterminant

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

pure virtual

Query the nth attribute for the specified IID in the selection.

Parameters

whichAttribute	the nth attribute index starting from 0.
attrClassID	the attribute class ID.
interfaceID	the requested interface IID on the attribute boss.

Returns: the requested Interface pointer (as IPMUnknown*) or nil. The result may be cast to the 'type' identified by IID.

virtual ErrorCode IGraphicAttributeSuite::RemoveAllAttributes	(	ClassID *	pAttrClassList,
		uint16	count
	)

pure virtual

Remove all attributes of the specified attribute classes in the current selection.

Parameters

pAttrClassList	the list of attribute class IDs.
count	the number attribute classes in pAttrClassList.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::RemoveAttribute ( ClassID attrClassID )

pure virtual

Remove all attributes of attribute classID in the current selection.

Parameters

attrClassID the attribute class ID.

Returns: kSuccess if successful, else an error code

virtual ErrorCode IGraphicAttributeSuite::SwapStrokeAndFill ( void )

pure virtual

Swap stroke and fill rendering attributes in the current selection.

Returns: kSuccess if successful, else an error code

virtual void IGraphicAttributeSuite::UpdateRenderObjectsToProxyState ( void )

pure virtual

Directly update the graphic state IGraphicStateRenderObjects interface to the current proxy state in the current selection.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation