IXMLRuleActionFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Lonnie Millett
// 
// $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.
// 
// 
// Purpose:
// Processes commands for creating, deleting, and manipulating XML element attributes.
// 
//========================================================================================

#ifndef __IXMLRuleActionFacade__
#define __IXMLRuleActionFacade__

#include "IPMUnknown.h"
#include "XMLID.h"
#include "XMLReference.h"
#include "ISpread.h"

class ICommand;
 
namespace Facade
{
 class IXMLRuleActionFacade : public IPMUnknown
 {
 public:
 enum {kDefaultIID = IID_IXMLRULEACTIONFACADE};

 
 virtual ErrorCode ApplyParagraphStyle(const IIDXMLElement *element, const PMString& styleString, bool16 clearOverrides) = 0;


 virtual ErrorCode ApplyParagraphStyle(const IIDXMLElement *element, const UIDRef& styleRef, bool16 clearOverrides) = 0;

 virtual ErrorCode ApplyCharacterStyle(const IIDXMLElement *element, const PMString& styleString) = 0;
 
 virtual ErrorCode ApplyCharacterStyle(const IIDXMLElement *element, const UIDRef& styleRef) = 0;

 virtual ErrorCode ApplyObjectStyle(const IIDXMLElement *element, const PMString& styleName, bool16 clearOverrides, bool16 clearOverridesThruRoot) = 0;

 virtual ErrorCode ApplyObjectStyle(const IIDXMLElement *element, const UIDRef& styleRef, bool16 clearOverrides, bool16 clearOverridesThruRoot) = 0;

 enum ElementLocation { kAtStart, kAtEnd };
 virtual ErrorCode ConvertAttributeToChildElement(IIDXMLElement *element, const PMString& attributeName, ElementLocation location, const PMString& alternateTagName = "", XMLReference* outNewChildElement = nil) = 0;

 virtual ErrorCode ConvertAttributeToChildElement(IIDXMLElement *element, const WideString& attributeName, ElementLocation location, const WideString& alternateTagName = (WideString)"", XMLReference* outNewChildElement = nil) = 0;

 //virtual ErrorCode ConvertElementToAttributeOnParent(IIDXMLElement *element, const PMString& alternateAttributeName = "", PMString* outNewAttrName = nil) = 0;

 virtual ErrorCode ConvertElementToAttributeOnParent(IIDXMLElement *element, const WideString& alternateAttributeName = (WideString)"", WideString* outNewAttrName = nil) = 0;

 virtual ErrorCode ConvertElementToTable(IIDXMLElement* element, const PMString& tableRowTagName, const PMString& tableCellTagName, UIDRef& newTable ) = 0;
 
 virtual ErrorCode ConvertElementToTable(IIDXMLElement* element, const WideString& tableRowTagName, const WideString& tableCellTagName, UIDRef& newTable ) = 0;
 
 virtual ErrorCode PlaceIntoFrame(const IIDXMLElement *element, ISpread* spread, const PMRect& pasteboardBounds, UIDRef& newFrame) = 0;

 virtual ErrorCode PlaceIntoCopy(const IIDXMLElement *element, ISpread* spread, const PMPoint& pasteboardLocation, UID frameToCopy, bool16 retainExistingFrame, UIDRef& newFrame) = 0;

 virtual ErrorCode PlaceIntoInlineFrame(const IIDXMLElement *element, const PMPoint& dimensions, UIDRef& newFrame) = 0;

 virtual ErrorCode PlaceIntoInlineCopy(const IIDXMLElement *element, UID frameToCopy, bool16 retainExistingFrame, UIDRef& newFrame) = 0;

 virtual ErrorCode SetContent(const IIDXMLElement *element, const PMString& filePath, const PMString& baseReleativePath = "") = 0;

 virtual UID PlaceOntoPage(const IIDXMLElement *element, const UIDRef& pageOrSpread, const PMPoint& placePoint, bool16 autoflow) = 0;

 virtual UIDList GetElementFrames(const IIDXMLElement *element) = 0;
 };
} 
#endif // __IXMLRuleActionFacade__