IInCopyWorkFlowUtils.h

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

#include "IStyleInfoMapData.h"

#include "GraphicTypes.h"
#include "InCopyWorkflowID.h"
#include "UIDList.h"

class UIDRef;
class WideString;
class IInCopyXMLElementAttr;
class ITextModel;
class IStyleNameTable;
class InCopyTextStyle;
class IInCopyImportOptions;
class ITextTarget;
class IDocument;
class RangeData;

class IInCopyWorkFlowUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IIINCOPYWORKFLOWUTILS};
 
 virtual void SetFileTypeCreator(
 const IDFile& file,
 FileTypeInfoID type
 ) = 0; 

 virtual UID FindSwatchByName(
 IDataBase* db,
 const PMString swatchName
 ) = 0;

 virtual UID ColorFromAttr(
 const UIDRef& storyRef, 
 const WideString& elemName, 
 IInCopyXMLElementAttr* iAttrs
 ) = 0; 
 
 virtual UID CreateTintSwatch(
 IDataBase* db,
 const PMString tintName,
 const PMReal tintPercent
 ) = 0;

 virtual UID CreateGradient(
 IDataBase* db,
 const PMString& gradientName,
 const GradientType gradientType,
 K2Vector<UID> stopColor,
 K2Vector<PMReal> stopPos,
 K2Vector<PMReal> midPoint
 ) = 0;
 
 virtual void MakeQName(
 const WideString& localName, 
 WideString& qName
 ) = 0;
 
 virtual ConstWString GrabQName(
 const WideString& localName
 ) = 0;

 ConstWString GrabQName(const UTF16TextChar* localName)
 { return this->GrabQName(WideString(localName)); }
 
 virtual IPMUnknown *QueryTextMetaDataBoss(
 ITextModel *textModel,
 bool16 bForceCreate = kTrue
 ) = 0;
 
 
 virtual IPMUnknown *QueryNthStoryMetaDataBoss(
 IDocument *document, 
 int32 index
 ) = 0;
 
 virtual int32 CopyInlines(
 const UIDRef& oldStory,
 const UIDRef& newStory
 ) = 0;

 virtual TextIndex FindInlineInStory(
 TextIndex startPos,
 const UIDRef& tgtStory,
 const int32 inLineUIDVal
 ) = 0;

 virtual void SearchStoriesForInline(
 IDataBase *db,
 const int32 inLineUIDVal,
 UIDRef& tgtStory,
 TextIndex& startPos,
 UIDList *omitStories
 ) = 0;

 virtual void MapInlineToOriginal(
 TextIndex index,
 const UIDRef& newStory,
 const UIDRef& originalInline
 ) = 0;
 
 
 virtual void GetInlineInCopyStories(
 IDocument *doc, 
 UIDList& stories
 ) = 0;

 virtual UIDList GetNonInCopyTextAndGraphicStories( const IDocument *fromDoc, bool16 doIncludeMasterItems = kTrue ) const = 0;

 virtual UIDList GetNonInCopyTextStories( const IDocument *fromDoc, bool16 doIncludeMasterItems = kTrue ) const = 0;

 virtual UIDList GetNonInCopyGraphicStories( const IDocument *fromDoc, bool16 doIncludeMasterItems = kTrue ) const = 0;

 virtual UIDList GetAllGraphics( const IDocument *fromDoc, bool16 all = kTrue, UID thisLayer = kInvalidUID, bool16 doIncludeMasterItems = kTrue ) const = 0;

 virtual UIDRef GetFirstGraphicStory( const UIDRef& fromDoc ) const = 0;

 virtual UIDRef GetStandaloneStory( const UIDRef& fromDoc ) const = 0;

 virtual bool16 IsImporting() = 0;

 virtual void SetImporting(bool16 importing) = 0;

 virtual bool16 GetElementName(ClassID cls, WideString *elementName) = 0;
 
 virtual UIDRef GetContainingInCopyStory( const UIDRef& linkedItemRef ) const = 0;

 virtual UIDRef GetOutermostParentStory(const UIDRef& target, const RangeData& range) const = 0;

 virtual bool16 IsAFormObject(const UIDRef& itemRef) const = 0;
};

#endif // __IInCopyWorkFlowUtils__