#include <ICreateMCFrameData.h>

Inheritance diagram for ICreateMCFrameData:

Public Types
enum	{ kDefaultIID = IID_ICREATEMCFRAMEDATA }

enum	Orientation { kHorizontal, kVertical }

enum	Direction { kLeftToRight, kRightToLeft }

Public Member Functions
virtual void	CopyInto (ICreateMCFrameData *into) const =0

virtual void	SetFrameList (const UIDRef &framelist, int32 insertAt)=0

virtual void	SetStory (const UIDRef &story)=0

virtual void	SetDocument (IDocument *document)=0

virtual void	SetGraphicFrameParent (UID nGraphicFrameUID)=0

virtual bool16	IsStoryCreated () const =0

virtual bool16	IsFrameListCreated () const =0

virtual IDocument *	GetDocument () const =0

virtual IDataBase *	GetDataBase () const =0

virtual UID	GetGraphicFrameParent () const =0

virtual UID	GetCachedStory () const =0

virtual UID	GetCachedFrameList () const =0

virtual UID	GetStory () const =0

virtual UID	GetFrameList () const =0

virtual int32	GetInsertIndex () const =0

virtual void	SetOrientation (Orientation nOrientation)=0

virtual Orientation	GetOrientation () const =0

virtual void	SetDirection (Direction nDirection)=0

virtual Direction	GetDirection () const =0

virtual void	SetIsEndnoteStory (bool16 isEndnoteStory)=0

virtual bool16	GetIsEndnoteStory () 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 by a number of commands to describe how the frame is supposed to be created: what document, which story, linked or not, in what graphical frame, etc.

Member Function Documentation

virtual void ICreateMCFrameData::CopyInto ( ICreateMCFrameData * into ) const

pure virtual

Copy the data settings from one interface to another.

Parameters

into	is another interface to write these settings into.

virtual UID ICreateMCFrameData::GetCachedFrameList ( ) const

pure virtual

Get the FrameList UID cached locally.

Returns: the UID of the frame list.

virtual UID ICreateMCFrameData::GetCachedStory ( ) const

pure virtual

Returns the story UID cached locally.

Returns: the UID of the story.

virtual IDataBase* ICreateMCFrameData::GetDataBase ( ) const

pure virtual

What is the database?

Returns: the database being placed into.

virtual Direction ICreateMCFrameData::GetDirection ( ) const

pure virtual

Get the direction set.

Returns: Direction kRightToLeft or kLeftToRight?

virtual IDocument* ICreateMCFrameData::GetDocument ( ) const

pure virtual

What is the document being placed into?

Returns: a pointer to the document. Not referenced.

virtual UID ICreateMCFrameData::GetFrameList ( ) const

pure virtual

Get the FrameList of the created text farme. Will create one if one wasn't provided.

Returns: the UID of the frame list. (created or not).

virtual UID ICreateMCFrameData::GetGraphicFrameParent ( ) const

pure virtual

What is the graphic frame when converting a spline into a text frame.

Returns: the UID of the graphic frame which will contain the new text frame.

virtual int32 ICreateMCFrameData::GetInsertIndex ( ) const

pure virtual

when linking, the new frame has a position in an already existing frame list. This is the index to insert the new frame at.

Returns: the index to use in the frame list.

virtual bool16 ICreateMCFrameData::GetIsEndnoteStory ( ) const

pure virtual

Get whether the frame is being created for an endnotes story.

Returns: kTrue if the frame is being created for an endnotes story

virtual Orientation ICreateMCFrameData::GetOrientation ( ) const

pure virtual

Get the orientation set.

Returns: Orientation vertical or horizontal?

virtual UID ICreateMCFrameData::GetStory ( ) const

pure virtual

Returns the story of the created text frame. Will create one if one wasn't provided.

Returns: the UID of the story (created or not).

virtual bool16 ICreateMCFrameData::IsFrameListCreated ( ) const

pure virtual

was a framelist CREATED by this interface, or set to something already in existence?

Returns: kTrue when the frameList was created.

virtual bool16 ICreateMCFrameData::IsStoryCreated ( ) const

pure virtual

was a story CREATED by this interface, or set to something already in existence?

Returns: kTrue when the story was created.

virtual void ICreateMCFrameData::SetDirection ( Direction nDirection )

pure virtual

Is the frame to be left to right or right to left?

Parameters

nDirection kRightToLeft or kLeftToRight?

virtual void ICreateMCFrameData::SetDocument ( IDocument * document )

pure virtual

When we only know the document – story & framelist will be created.

Parameters

document a pointer to the document.

virtual void ICreateMCFrameData::SetFrameList	(	const UIDRef &	framelist,
		int32	insertAt
	)

pure virtual

SetFrameList is used when creating a new text frame by using the in/out ports of another.

Parameters

framelist	the UID of the frameList to insert into.
insertAt	the index of the new frame to create within the frameList.

virtual void ICreateMCFrameData::SetGraphicFrameParent ( UID nGraphicFrameUID )

pure virtual

Used when converting a graphic frame to a text frame.

Parameters

nGraphicFrameUID the UID of the graphic frame that will be converted.

virtual void ICreateMCFrameData::SetIsEndnoteStory ( bool16 isEndnoteStory )

pure virtual

Is the frame being created for an endnotes story?

Parameters

isEndnoteStory kTrue if the frame is being created for an endnotes story

virtual void ICreateMCFrameData::SetOrientation ( Orientation nOrientation )

pure virtual

Is the frame to be vertical or horizontal?

Parameters

nOrientation vertical or horizontal?

virtual void ICreateMCFrameData::SetStory ( const UIDRef & story )

pure virtual

When placing an existing story. No framelist, but the story exists.

Parameters

story is the story to place.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation