#include <IAttributesUtils.h>

Inheritance diagram for IAttributesUtils:

Public Types
enum	{ kDefaultIID = IID_IATTRIBUTESUTILS }

Public Member Functions
virtual ErrorCode	SetInt32Value (const PMString &inCommandString, IGraphicAttributeSuite *iGfxAttrSuite, const ClassID inAttrBoss, const int32 &inValue)=0

virtual ErrorCode	SetBoolValue (const PMString &inCommandString, IGraphicAttributeSuite *iGfxAttrSuite, const ClassID inAttrBoss, const bool16 &inValue)=0

virtual ErrorCode	SetStringValue (const PMString &inCommandString, IGraphicAttributeSuite *iGfxAttrSuite, const ClassID inAttrBoss, const PMString &inValue)=0

virtual ErrorCode	SetRealValue (const PMString &inCommandString, IGraphicAttributeSuite *iGfxAttrSuite, const ClassID inAttrBoss, const PMReal &inValue)=0

virtual bool16	HasUniqueValue (IGraphicAttributeSuite iGfxAttrSuite, const ClassID inAttrBoss, int32 outCommonValue)=0

virtual bool16	HasUniqueValue (IGraphicAttributeSuite iGfxAttrSuite, const ClassID inAttrBoss, bool16 outCommonValue)=0

virtual bool16	HasUniqueValue (IGraphicAttributeSuite iGfxAttrSuite, const ClassID inAttrBoss, PMString outCommonValue)=0

virtual bool16	HasUniqueValue (IGraphicAttributeSuite iGfxAttrSuite, const ClassID inAttrBoss, PMReal outCommonValue)=0

virtual bool16	HasUniqueValue (IGraphicAttributeSuite *iGfxAttrSuite, const ClassID inAttrBoss)=0

virtual int32	GetInt32Value (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual bool16	GetBoolValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual PMString	GetStringValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual PMReal	GetRealValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual Form::ChoiceList	GetChoiceList (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual IPMUnknown *	QueryValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss, PMIID inInterfaceID)=0

virtual ErrorCode	SetInt32Value (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss, const int32 &inValue)=0

virtual ErrorCode	SetBoolValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss, const bool16 &inValue)=0

virtual ErrorCode	SetStringValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss, const PMString &inValue)=0

virtual ErrorCode	SetRealValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss, const PMReal &inValue)=0

virtual int32	GetInt32Value (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual bool16	GetBoolValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual PMString	GetStringValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual PMReal	GetRealValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual PMPoint	GetPointValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual ErrorCode	AddInt32Value (IGraphicStyleAttributeBossList *inAttrs, const ClassID inAttrBoss, int32 inValue)=0

virtual ErrorCode	AddBoolValue (IGraphicStyleAttributeBossList *inAttrs, const ClassID inAttrBoss, bool16 inValue)=0

virtual ErrorCode	AddStringValue (IGraphicStyleAttributeBossList *inAttrs, const ClassID inAttrBoss, const PMString &inValue)=0

virtual ErrorCode	AddRealValue (IGraphicStyleAttributeBossList *inAttrs, const ClassID inAttrBoss, const PMReal &inValue)=0

virtual ErrorCode	AddPointValue (IGraphicStyleAttributeBossList *inAttrs, const ClassID inAttrBoss, const PMPoint &inValue)=0

virtual ErrorCode	AddValue (IGraphicStyleAttributeBossList inAttrs, const ClassID inAttrBoss, IPMUnknown inAttrValue)=0

virtual PMString	GetFontValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual PMString	GetFontValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=0

virtual UID	GetFontFamilyUIDValue (IGraphicStyleDescriptor *inBoss, const ClassID inAttrBoss)=0

virtual UID	GetFontFamilyUIDValue (IGraphicStyleAttributeBossList *inBoss, const ClassID inAttrBoss)=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

Utility interface for getting and setting graphic attributes. In particular, used to get and set form field graphic attributes.

Member Function Documentation

virtual ErrorCode IAttributesUtils::AddInt32Value	(	IGraphicStyleAttributeBossList *	inAttrs,
		const ClassID	inAttrBoss,
		int32	inValue
	)

pure virtual

Add a graphic attribute on a IGraphicStyleAttributeBossList. Will assert and return a dummy default if attribute doesn't exist.

Used when setting multiple attributes, or when setting default attributes (eg the Form FIeld setting dialogs)

Parameters

inAttrs	the list of attributes
inAttrBoss	attribute to set eg kTextMaxLengthAttrBoss
inValue	new value of attribute

Returns: result of attribute setting command.

virtual int32 IAttributesUtils::GetInt32Value	(	IGraphicStyleDescriptor *	inBoss,
		const ClassID	inAttrBoss
	)

pure virtual

Get a graphic attribute on a IGraphicStyleDescriptor. Used to get attributes from a single page item. (eg kPushButtonItemBoss) Will assert and return a dummy default if attribute doesn't exist.

Parameters

inBoss	the list of attributes, typically a page item.
inAttrBoss	attribute to get eg kTextMaxLengthAttrBoss

Returns: values of attribute.

virtual int32 IAttributesUtils::GetInt32Value	(	IGraphicStyleAttributeBossList *	inBoss,
		const ClassID	inAttrBoss
	)

pure virtual

Get a graphic attribute on a IGraphicStyleAttributeBossList. Will assert and return a dummy default if attribute doesn't exist.

Parameters

inBoss	the list of attributes
inAttrBoss	attribute to get eg kTextMaxLengthAttrBoss

Returns: values of attribute.

virtual bool16 IAttributesUtils::HasUniqueValue	(	IGraphicAttributeSuite *	iGfxAttrSuite,
		const ClassID	inAttrBoss,
		int32 *	outCommonValue
	)

pure virtual

Get a graphic attribute on a selection. Properly handles multiple selections of items.

Parameters

iGfxAttrSuite	the selection to modify
inAttrBoss	attribute to get eg kTextMaxLengthAttrBoss
outCommonValue	value of attribute if all items in the selection match

Returns: true if all the values of the attribute in the selection are the same.

virtual IPMUnknown* IAttributesUtils::QueryValue	(	IGraphicStyleDescriptor *	inBoss,
		const ClassID	inAttrBoss,
		PMIID	inInterfaceID
	)

pure virtual

Get a graphic attribute on a IGraphicStyleDescriptor. Used to get attributes from a single page item. (eg kPushButtonItemBoss) Will assert and return a dummy default if attribute doesn't exist.

Parameters

inBoss	the list of attributes, typically a page item.
inAttrBoss	attribute to get eg kTextMaxLengthAttrBoss
inInterfaceID	interface to get eg IID_IINTEGER

Returns: values of attribute.

virtual ErrorCode IAttributesUtils::SetInt32Value	(	const PMString &	inCommandString,
		IGraphicAttributeSuite *	iGfxAttrSuite,
		const ClassID	inAttrBoss,
		const int32 &	inValue
	)

pure virtual

Set a graphic attribute on a selection

Parameters

inCommandString,the	command string to use for the set. This is what shows up as the Undo <command>
iGfxAttrSuite	the selection to modify
inAttrBoss	attribute to modify eg kTextMaxLengthAttrBoss
inValue	new value of attribute

virtual ErrorCode IAttributesUtils::SetInt32Value	(	IGraphicStyleDescriptor *	inBoss,
		const ClassID	inAttrBoss,
		const int32 &	inValue
	)

pure virtual

Set a graphic attribute on a IGraphicStyleDescriptor. Used to get attributes from a single page item. (eg kPushButtonItemBoss) Note: These Set* routines that take IGraphicAttributeSuite are normally preferred (these handle selections, defaults, etc.) These only operate on one item, and need to take place within a Command...

Parameters

inBoss	the list of attributes, typically a page item.
inAttrBoss	attribute to get eg kTextMaxLengthAttrBoss
inValue	new value of attribute

Returns: result of attribute setting command.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation