BPIHelper Class Reference

#include <BPIHelper.h>

Public Member Functions
	BPIHelper (void)
virtual	~BPIHelper (void)
virtual bool16	HasBPIData (const UIDList &itemList)
virtual void	GetBPIData (const UIDList &itemList, K2Vector< WideString > &values)
virtual void	FilterForBPIData (UIDList &itemList)
virtual ErrorCode	ProcessBPISetDataCmd (const UIDList &itemList, const WideString &value)
UID	FindAssociatedGraphicFrame (const InterfacePtr< ITextFrameColumn > &textFrameColumn)

Detailed Description

Facade that helps manipulate IBPIData.

Constructor & Destructor Documentation

BPIHelper::BPIHelper

(

void

)

Contructor

BPIHelper::~BPIHelper ( void  )

virtual

Destructor

Member Function Documentation

void BPIHelper::FilterForBPIData ( UIDList &  itemList )

virtual

Filter the given objects leaving only objects that have IBPIData.

Parameters

itemList

list of objects to be filtered

UID BPIHelper::FindAssociatedGraphicFrame

(

const InterfacePtr< ITextFrameColumn > &

textFrameColumn

)

Find the graphic frame, the spline, that is associated with the given textFrameColumn.

Parameters

textFrameColumn

Returns

UID of the frame associated with the given textFrameColumn

void BPIHelper::GetBPIData ( const UIDList &  itemList, K2Vector< WideString > &  values  )

virtual

Get all unique IBPIData values that apply to the given objects.

Parameters

itemList	IN of objects for which the IBPIData is wanted.
values	OUT unique IBPIData values found in the given objects. If two items have the same IBPIData value only one attribute with this value will be returned in the vector.

bool16 BPIHelper::HasBPIData ( const UIDList &  itemList )

virtual

Return kTrue if one of the given objects has IBPIData.

Parameters

itemList

list of objects to examine for IBPIData capability.

Returns

kTrue if one of the given objects has IBPIData.

ErrorCode BPIHelper::ProcessBPISetDataCmd ( const UIDList &  itemList, const WideString &  value  )

virtual

Process kBPISetDataCmdBoss to set the IBPIData for the given objects.

Parameters

itemList	IN list of objects for which the IBPIData value is to be changed
value	IN IBPIData value

Returns

kSuccess on success, other ErrorCode otherwise