IMergeStoriesSignalData.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $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 __IMergeStoriesSignalData__
#define __IMergeStoriesSignalData__

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

class IMergeStoriesSignalData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IMERGESTORIESSIGNALDATA };
 
 typedef enum { 
 kBeforeDoMerge, 
 kAfterDoMerge, 
 kMergeError } State;
 
 virtual void Set(const UIDRef& targetStory, const UIDRef& appendingStory, TextIndex destIndex, int32 length, bool16 useAppendingStoryOptions) = 0;
 
 virtual void SetState( State state ) = 0;
 
 virtual UIDRef GetTargetStory() const = 0;
 
 virtual UIDRef GetAppendingStory() const = 0;
 
 virtual TextIndex GetDestinationTextIndex() const = 0;
 
 virtual int32 GetAppendingStoryLength() const = 0;
 
 virtual bool16 UseAppendingStoryOptions() const = 0;
 
 virtual State GetState() const = 0;
 
};


#endif
 // __IMergeStoriesSignalData__