IStoryList Class Reference

#include <IStoryList.h>

Inheritance diagram for IStoryList:

Public Types
enum	{ kDefaultIID = IID_ISTORYLIST }

Public Member Functions
virtual void	AddNewStory (UID story, TextStory_StoryAccess access)=0
virtual void	ProcessAddNewStory (UID story, TextStory_StoryAccess access)=0
virtual void	RemoveStory (UID story)=0
virtual int32	GetUserAccessibleStoryCount () const =0
virtual int32	GetAllTextModelCount () const =0
virtual UIDRef	GetNthUserAccessibleStoryUID (int32 storyIndex) const =0
virtual UIDRef	GetNthTextModelUID (int32 storyIndex) const =0
virtual TextStory_StoryAccess	GetNthTextModelAccess (int32 storyIndex) const =0
virtual int32	GetUserAccessibleStoryIndex (UID story) const =0
virtual int32	GetTextModelIndex (UID model) const =0
virtual void	MarkStoryDamaged (UID story)=0
virtual void	MarkStoryComposed (UID story)=0
virtual UIDRef	GetLastDamagedStory () const =0
virtual int32	CountDamagedStories () const =0
virtual UID	GetNthDamagedTextModelUID (int32 n) const =0
virtual bool16	ModifiedStory (UID Story)=0
virtual void	ReorderStories (const UIDList &desiredOrder)=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 encapsulates a list of stories- each story being a UID. The stories are NOT created or deleted here, only managed. Use "NewStoryCmd" and "DeleteStoryCmd" for that.

User accessibility is used across the interface to identify if a story was created by the user or whether it was created for internal use. Internal stories are not subject to search through find change, spell checking, and other activities that make sense only for user created stories.

Member Function Documentation

virtual void IStoryList::AddNewStory ( UID  story, TextStory_StoryAccess  access  )

pure virtual

Add an already created story to the list.

Parameters

story	IN story uid to add.
access	IN whether the story is user accessible.

virtual int32 IStoryList::CountDamagedStories ( ) const

pure virtual

Returns

number of marked need composing stories. Use when iterating over the need composing stories.

virtual int32 IStoryList::GetAllTextModelCount ( ) const

pure virtual

Returns

number of all stories in the document (both user accessible and not). Use this function when iterating over all stories.

virtual UIDRef IStoryList::GetLastDamagedStory ( ) const

pure virtual

Returns

last story marked as need composing.

virtual UID IStoryList::GetNthDamagedTextModelUID ( int32  n ) const

pure virtual

Returns

Nth damaged story UID. Use when iterating over need composing stories.

Parameters

n	IN index in damaged story list.

virtual TextStory_StoryAccess IStoryList::GetNthTextModelAccess ( int32  storyIndex ) const

pure virtual

Returns

user accessibility of a particular story. Use this function when iterating over all stories.

Parameters

storyIndex

IN index in the list of all stories.

virtual UIDRef IStoryList::GetNthTextModelUID ( int32  storyIndex ) const

pure virtual

Returns

UIDRef to Nth story. Use this function when iterating over all stories.

Parameters

storyIndex

IN index in the list of all stories.

virtual UIDRef IStoryList::GetNthUserAccessibleStoryUID ( int32  storyIndex ) const

pure virtual

Returns

UIDRef to Nth user accessible story. Use this function when iterating over user accessible stories.

Parameters

storyIndex

IN index in the list of user accessible stories.

virtual int32 IStoryList::GetTextModelIndex ( UID  model ) const

pure virtual

Returns

index of a particular story in the list of all stories. -1 is returned when the story is not in story list.

Parameters

story

IN story UID.

virtual int32 IStoryList::GetUserAccessibleStoryCount ( ) const

pure virtual

Returns

number of user accessible stories in the document. Use this function when iterating over user accessible stories.

virtual int32 IStoryList::GetUserAccessibleStoryIndex ( UID  story ) const

pure virtual

Returns

index of a particular story in the list of user accessible stories. -1 is returned when the story is not in user accessible story list.

Parameters

story

IN story UID.

virtual void IStoryList::MarkStoryComposed ( UID  story )

pure virtual

Mark story as composed.

Parameters

story

IN story UID.

virtual void IStoryList::MarkStoryDamaged ( UID  story )

pure virtual

Mark a story as needs composing.

Parameters

story

IN story UID.

virtual void IStoryList::RemoveStory ( UID  story )

pure virtual

Remove a story from the list – doesn't affect the story itself in any way.

Parameters

story

IN removed story UID.

virtual void IStoryList::ReorderStories ( const UIDList &  desiredOrder )

pure virtual

reorder the list of story UIDs to match the parameter. can NOT change user accessible stories to be after non-accessible stories.