IInCopyStoryList Class Reference

#include <IInCopyStoryList.h>

Inheritance diagram for IInCopyStoryList:

Public Types
enum	{ kDefaultIID = IID_IINCOPYSTORYLIST }

Public Member Functions
virtual void	ProcessAddStory (UID story)=0
virtual void	ProcessRemoveStory (UID story)=0
virtual int32	GetStoryCount () const =0
virtual UIDRef	GetNthStoryRef (int32 nth) const =0
virtual UID	GetNthStoryUID (int32 nth) const =0
virtual int32	Location (UID story) const =0
virtual void	AddStory (UID story)=0
virtual void	RemoveStory (UID story)=0
virtual bool16	HasTextStory () const =0
virtual bool16	HasGraphicStory () 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 interface is added to each document (kDocBoss) to indicate the stories in the current pub that are InCopy stories. Code that imports InCopy stories should add the imported stories to this list.

In general, you should use the Process calls to Add/remove from the list. The commands that are processed will call AddStory/RemoveStory to do the direct modifications

ADDITIONAL NOTE (6/23/2004): This interface now holds incopy text and graphic stories, callers should check for appropriate interfaces.

Member Function Documentation

virtual void IInCopyStoryList::AddStory ( UID  story )

pure virtual

Adds the story if not already in the list

Parameters

story

virtual UIDRef IInCopyStoryList::GetNthStoryRef ( int32  nth ) const

pure virtual

Get the nth story UIDRef

Parameters

nth

Returns

UIDRef

virtual UID IInCopyStoryList::GetNthStoryUID ( int32  nth ) const

pure virtual

Get the nth story UID

Parameters

nth

Returns

UID

virtual int32 IInCopyStoryList::GetStoryCount ( ) const

pure virtual

Get the number of stories in the list

Parameters

none

Returns

int32

virtual bool16 IInCopyStoryList::HasGraphicStory ( ) const

pure virtual

Is there a graphic story in the list?

Parameters

none

Returns

bool16

virtual bool16 IInCopyStoryList::HasTextStory ( ) const

pure virtual

Is there a text story in the list?

Parameters

none

Returns

bool16

virtual int32 IInCopyStoryList::Location ( UID  story ) const

pure virtual

Get the index of giving story in the list

Parameters

story

Returns

int32 -1 means the story is not in the list

virtual void IInCopyStoryList::ProcessAddStory ( UID  story )

pure virtual

Uses a command to add a story to the list

Parameters

story

The story being added in the list

virtual void IInCopyStoryList::ProcessRemoveStory ( UID  story )

pure virtual

Uses a command to remove a story from the list

Parameters

story

The story being removed from the list

virtual void IInCopyStoryList::RemoveStory ( UID  story )

pure virtual

Removes a story from the list

Parameters

story