ICreateMCFrameData.h

//========================================================================================
// 
// $File$
// 
// Owner: eric_menninga
// 
// $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 __ICreateMCFrameData__
#define __ICreateMCFrameData__

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

class IDataBase;
class IDocument;
class IControlView;

class ICreateMCFrameData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICREATEMCFRAMEDATA };

 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;

 enum Orientation { kHorizontal, kVertical };

 virtual void SetOrientation( Orientation nOrientation ) = 0;

 virtual Orientation GetOrientation() const = 0;

 enum Direction { kLeftToRight, kRightToLeft };

 virtual void SetDirection( Direction nDirection ) = 0;

 virtual Direction GetDirection() const = 0;

 virtual void SetIsEndnoteStory(bool16 isEndnoteStory) = 0;

 virtual bool16 GetIsEndnoteStory() const = 0;

};

#endif