IXMLElementCommands.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 __IXMLElementCommands__
#define __IXMLElementCommands__

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

class ICommand;
class ITextStoryThread;
class RangeData;
class XMLDTDInsertElement;
class XMLDTDReplaceElement;

class IXMLElementCommands : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IXMLELEMENTCOMMANDS};

 virtual ErrorCode CreateElement(const WideString& tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLR = kInvalidXMLReference, XMLReference *createdElement = nil, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ICommand* CreateElementCommand(const WideString& tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLR = kInvalidXMLReference, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ErrorCode CreateElement(const WideString& tagToApply, UIDRef storyUIDRef, const RangeData& range, const XMLReference& parentXMLR = kInvalidXMLReference, XMLReference *createdElement = nil, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ICommand* CreateElementCommand(const WideString& tagToApply, UIDRef storyUIDRef, const RangeData& range, const XMLReference& parentXMLR = kInvalidXMLReference, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ErrorCode CreateElement(UID tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLRef = kInvalidXMLReference, XMLReference *createdElement = nil, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ICommand* CreateElementCommand(UID tagToApply, UIDRef storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex, const XMLReference& parentXMLRef = kInvalidXMLReference, bool16 doVerify = kTrue, bool16 useExistingMarkers = kFalse) = 0;

 virtual ErrorCode CreateElement(const WideString& tagToApply, UID contentItem, const XMLReference& parentXMLRef, int32 indexInParent, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(UID tagToApply, UID contentItem, const XMLReference& parentXMLRef, int32 indexInParent, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;
 
 virtual ErrorCode CreateElement(const WideString& tagToApply, const UIDRef& table, GridID anchor, const GridSpan& span, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(UID tagToApply, const UIDRef& table, GridID anchor, const GridSpan& span, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(const WideString& tagToApply, const UIDRef& tableModelUIDRef, GridID cellGridID, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(UID tagToApply, const UIDRef& tableModelUIDRef, GridID cellGridID, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ICommand *CreateElementCommand(UID tagToApply, const UIDRef& tableModelUIDRef, GridID cellGridID, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(const XMLDTDInsertElement& xmlDTDInsertElement, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateElement(UID tagToApply, const UIDRef& storyUIDRef, UID contentItem, bool16 addToDocRefList, XMLReference *createdElement = nil, bool16 doVerify = kTrue) = 0;

 virtual ErrorCode CreateTableElement(const WideString& tableTagToApply, const WideString& tableCellTagToApply, const UIDRef& storyUIDRef, TextIndex textIndex, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;


 virtual ICommand *CreateTableElementCommand(const WideString& tableTagToApply, const WideString& tableCellTagToApply, const UIDRef& storyUIDRef, TextIndex textIndex, bool16 doVerify = kTrue) = 0;


 virtual ErrorCode CreateTableElement(UID tableTagToApply, UID tableCellTagToApply, const UIDRef& storyUIDRef, TextIndex textIndex, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;


 virtual ICommand *CreateTableElementCommand(UID tableTagToApply, UID tableCellTagToApply, const UIDRef& storyUIDRef, TextIndex textIndex, bool16 doVerify = kTrue) = 0;


 virtual ErrorCode CreateTableElement(const WideString& tableTagToApply, const WideString& tableCellTagToApply, const UIDRef& tableModelUIDRef, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;


 virtual ICommand *CreateTableElementCommand(const WideString& tableTagToApply, const WideString& tableCellTagToApply, const UIDRef& tableModelUIDRef, bool16 doVerify = kTrue) = 0;


 virtual ErrorCode CreateTableElement(UID tableTagToApply, UID tableCellTagToApply, const UIDRef& tableModelUIDRef, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;


 virtual ICommand *CreateTableElementCommand(UID tableTagToApply, UID tableCellTagToApply, const UIDRef& tableModelUIDRef, bool16 doVerify = kTrue) = 0;
 
 virtual ErrorCode CreateTableElement(const TableTagData& tableTagData, const UIDRef& tableModelUIDRef, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;
 
 virtual ErrorCode CreateTableElement(const TableTagData& tableTagData, const UIDRef& storyUIDRef, TextIndex textIndex, XMLReference *createdTableElement = nil, bool16 doVerify = kTrue) = 0;
 
 virtual ICommand *CreateTableElementCommand(const TableTagData& tableTagData, const UIDRef& tableModelUIDRef, bool16 doVerify = kTrue) = 0;
 
 virtual ICommand *CreateTableElementCommand(const TableTagData& tableTagData, const UIDRef& storyUIDRef, TextIndex textIndex, bool16 doVerify = kTrue) = 0;
 
 virtual ErrorCode CreateStyleToTagElements(const UIDRef& docUIDRef, UID storyTagUID = kInvalidUID) = 0;

 virtual ErrorCode DeleteElement(const XMLReference& deleteElementXMLRef, bool16 deleteChildren, bool16 deleteInSameStoryOnly = kFalse, bool16 reconnectChildren = kFalse, bool16 doVerify = kTrue) = 0;

 virtual ICommand *DeleteElementCommand(const XMLReference& deleteElementXMLRef, bool16 deleteChildren, bool16 deleteInSameStoryOnly = kFalse, bool16 reconnectChildren = kFalse, bool16 doVerify = kTrue) = 0;
 
 virtual ErrorCode RangeDeleteElement(const UIDRef& storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex) = 0;

 virtual ErrorCode RangeDeleteElement(const UIDRef& storyUIDRef, const RangeData& range) = 0;

 virtual ICommand *RangeDeleteElementCommand(const UIDRef& storyUIDRef, TextIndex startTextIndex, TextIndex endTextIndex) = 0;

 virtual ErrorCode DeleteElementAndContent(const XMLReference& deleteElementXMLRef, bool16 deletePageItems = kFalse) = 0;
 
 
 virtual ErrorCode MoveElement(const XMLReference& moveElementXMLRef, const XMLReference& newParentXMLRef, int32 newIndexInParent, TextIndex contentOffset, bool16 doVerify = kTrue) = 0;
 

 virtual ErrorCode PlaceElement(const XMLReference& elementToPlace, const UIDRef& graphicFrame) = 0;

 virtual ErrorCode UnplaceElement(const UIDRef& elementToUnplace) = 0;

 virtual ICommand *UnplaceElementCommand(const UIDRef& elementToUnplace) = 0;
 
 virtual ErrorCode SetElement(const XMLReference& elementRef, UID tag) = 0;

 virtual ErrorCode SetElement(const XMLReference& elementRef, const WideString& tag) = 0;
 
 virtual ErrorCode SetElement(const XMLDTDReplaceElement& replaceElement) = 0;
 
 virtual ErrorCode DeleteElementContent(const XMLReference& elementRef) = 0;

 enum TableTagPreference { 
 kTagByRow, 
 kTagByColumn, 
 kNone, 
 kTagByRowAndBody
 };
 
 virtual ErrorCode SetTableTagPreference(const XMLReference& tableElement, TableTagPreference newSetting, const TableTagData& tableTagData) = 0;

 virtual ErrorCode MakeParentStoryThreadTagged(ITextStoryThread *textStoryThread, bool16 doVerify = kTrue) = 0;

 
};
 
#endif // __IXMLElementCommands__