ICreateTFCData Class Reference

#include <ICreateTFCData.h>

Inheritance diagram for ICreateTFCData:

Public Types
enum	{ kDefaultIID = IID_ICREATETFCDATA }

Public Member Functions
virtual void	SetFrameListData (const UIDRef &framelist, int32 insertAt)=0
virtual UIDRef	GetFrameListRef () const =0
virtual int32	GetInsertIndex () const =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 data interface is used when creating a TextFrameColumn. To create a MultiColumnTextFrame, see ICreateMCFrameData.h.

Member Function Documentation

virtual UIDRef ICreateTFCData::GetFrameListRef ( ) const

pure virtual

Get the FrameList passed nto SetFrameList().

Returns

the UID of the frame list.

virtual int32 ICreateTFCData::GetInsertIndex ( ) const

pure virtual

This is the index to insert the new frame at.

Returns

the index to use in the frame list.

virtual void ICreateTFCData::SetFrameListData ( const UIDRef &  framelist, int32  insertAt  )

pure virtual

SetFrameList is used when creating a new TextFrameColumn

Parameters

framelist	the UID of the frameList to insert into. Must be valid
insertAt	the index of the new TextFrameColumn to create within the frameList or IFrameList::kAtEnd