IStoryList.h

//========================================================================================
// 
// $File$
// 
// Owner: EricK
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ISTORYLIST__
#define __ISTORYLIST__

#include "IPMUnknown.h"
#include "TextID.h"
#include "textstoryaccesstypes.h"

class UIDList;

class IStoryList : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISTORYLIST }; 

 virtual void AddNewStory(UID story, TextStory_StoryAccess access ) = 0;

 /* Same as AddNewStory except we do it in a command.
 */
 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;
};

DECLARE_OBJECT_TYPE (TextStory_StoryAccess);
#endif // __ISTORYLIST__