IXMLCreateElementCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: robin briggs
// 
// $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 __IXMLCreateElementCmdData__
#define __IXMLCreateElementCmdData__

#include "IPMUnknown.h"
#include "XMLID.h"
#include "XMLReference.h"
#include "TableTypes.h" // for GridID

class IXMLCreateElementCmdData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IXMLCREATEELEMENTCMDDATA };

 virtual void Set(const WideString& tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLRef = kInvalidXMLReference) = 0;

 virtual void Set(UID tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLRef = kInvalidXMLReference) = 0;

 virtual void Set(const WideString& tagToApply, UID contentItem, const XMLReference& parentXMLRef, int32 indexInParent) = 0;

 virtual void Set(UID tagToApply, UID contentItem, const XMLReference& parentXMLRef, int32 indexInParent) = 0;


 virtual void Set(const WideString& tagToApply, const UIDRef& table, GridID anchor, const GridSpan& span) = 0;

 virtual void Set(UID tagToApply, const UIDRef& table, GridID anchor, const GridSpan& span) = 0;


 virtual void Set(const WideString& tagToApply, const UIDRef& tableModelUIDRef, GridID cellGridID) = 0;

 virtual void Set(UID tagToApply, const UIDRef& tableModelUIDRef, GridID cellGridID) = 0;
 
 
 virtual void Set(const WideString& tagToApply, const XMLReference& parentXMLRef, int32 indexInParent) = 0;
 
 virtual void Set(UID tagToApply, const XMLReference& parentXMLRef, int32 indexInParent) = 0;
 
 virtual void Set(UID tagToApply, const UIDRef& storyUIDRef, UID contentItem, bool16 addToDocRefList) = 0;
 
 virtual const XMLReference& GetCreatedElement() const = 0;
 
 virtual void SetCreatedElement(const XMLReference& newItem) = 0;
 
 virtual bool16 UsedTableSet() const = 0;

 virtual bool16 UsedTextSet() const = 0;

 virtual bool16 UsedTableCellSet() const = 0;
 
 virtual bool16 UsedStructuralSet() const = 0;

 virtual void SetSetMethod(bool16 usedTextSet) = 0;
 
 virtual UID GetTag() const = 0;
 

 virtual UIDRef GetStoryUIDRef() const = 0;

 virtual void SetStoryUIDRef(const UIDRef& storyUIDRef) = 0;
 
 virtual TextIndex GetStartTextIndex() const = 0;

 virtual TextIndex GetEndTextIndex() const = 0;

 virtual const UIDRef& GetTable() const = 0;

 virtual GridID GetAnchor() const = 0;

 virtual const GridSpan& GetSpan() const = 0;

 virtual void SetTextRange(TextIndex startTextIndex, TextIndex endTextIndex) = 0;
 
 virtual const XMLReference& GetParent() const = 0;

 virtual void SetParent(const XMLReference& parentXMLRef) = 0;

 virtual bool16 GetAddToDocRefList() const = 0;

 virtual int32 GetIndexInParent() const = 0;

 virtual void SetIndexInParent(int32 indexInParent) = 0;

 virtual UID GetContentItem() const = 0; 

 virtual void SetContentItem(UID contentItemUID) = 0;

 virtual ClassID GetBossID() const = 0;

 virtual void SetBossID(ClassID bossID) = 0;

 virtual bool16 IsTextOnPathInline() const = 0;

 virtual void SetTextOnPathInline(bool16 isTOP) = 0;

 virtual bool16 DoInlineCheck() const = 0;

 virtual void SetDoInlineCheck(bool16 doInlineCheck) = 0;

 virtual bool16 DoForwardCalcXMLParent() const = 0;

 virtual void SetDoForwardCalcXMLParent(bool16 forwardCalcXMLParent) = 0;

 virtual bool16 UseExistingMarkers() const = 0;

 virtual void SetUseExistingMarkers(const bool16 shouldUse) = 0;

};

#endif // __IXMLCreateElementCmdData__