IDOMElement.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Pellegrin
// 
// $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 __IDOMElement_h__
#define __IDOMElement_h__

// Adobe Patent or Adobe Patent Pending Invention Included Within this File
// Adobe patent application tracking B234, entitled Method and apparatus for formatting portion of content, inventors: Craig Rainwater, Steve Pellegrin, Robin Briggs 

// ----- Interfaces -----

#include "IPMUnknown.h"

// ----- Includes -----

#include "K2Vector.h"
#include "KeyValuePair.h"
#include <adobe/vector.hpp>

// ----- ID.h files -----

#include "INXCoreID.h"

class WideString;
class DOMAttributeValue;

#define kInvalidDOMElementID ((IDOMElement::DOMElementID)kInvalidScriptID)
#define kInvalidDOMAttributeID ((IDOMElement::DOMAttributeID)kInvalidScriptID)

#define kSelfAttributeID ((IDOMElement::DOMAttributeID)'Self')
#define kSelfAttributeName IDOMElement::DOMElementName(L"Self")

#define kPICharAttributeName IDOMElement::DOMElementName(L"Char")

class IDOMElement : public IPMUnknown
{
public:
 typedef object_type data_type;

 enum { kDefaultIID = IID_IDOMELEMENT };

 typedef ScriptID DOMElementID;
 typedef WideString DOMElementName;
 typedef ScriptID DOMAttributeID;
 typedef WideString DOMAttributeName;
 typedef KeyValuePair<DOMAttributeID, DOMAttributeValue> AttributeIDValuePair;
 typedef K2Vector<InterfacePtr<IDOMElement> > ElementList;
 typedef K2Vector<DOMElementID> ElementIDList;
 typedef adobe::vector<AttributeIDValuePair> AttributeList;
 typedef K2Vector<DOMAttributeID> AttributeIDList;

 typedef enum {kTextContent, kBreakContent, kNonContent} ContentType;

public:
 virtual void Reset() = 0;

 virtual DOMElementID GetElementID() const = 0;

 virtual DOMElementName GetElementName() const = 0;
 
 virtual bool16 IsSameElement(IDOMElement *other) const = 0;

 virtual IDOMElement * QueryParent() const = 0;

 virtual bool16 HasAttribute(const DOMAttributeID id) = 0;

 virtual bool16 IsAttributeReadOnly(const DOMAttributeID id) = 0;

 virtual int32 GetAttributeIDs(AttributeIDList &ids) = 0;

 virtual bool16 GetAttribute(const DOMAttributeID id, DOMAttributeValue &value) = 0;

 virtual int32 GetMultipleAttributes(const AttributeIDList & idList, AttributeList & attributes) = 0;

 virtual int32 GetAttributes(AttributeList &attributes) = 0;

 virtual bool16 SetAttribute(const DOMAttributeID id, const DOMAttributeValue &value) = 0;

 virtual bool16 SetAttributes(const AttributeList &attributes) = 0;

 virtual int32 GetChildElements(ElementList &children) = 0;

 virtual int32 GetSpecificChildElements(DOMElementID childType, ElementList &children, bool includeSubtypes = kFalse) = 0;

 virtual IDOMElement * CreateChildElement(DOMElementID type, const AttributeList &attributes) = 0;

 virtual bool16 DeleteChildElement(IDOMElement *child) = 0;

 virtual bool16 DeleteChildElements(const ElementList &children) = 0;

 virtual void SetDontDiscoverResource(bool16 flag) = 0;

 virtual bool16 GetDontDiscoverResource() const = 0;

 virtual bool16 AddChildElement(IDOMElement * child) = 0;

 virtual bool16 RemoveChildElement(IDOMElement * child) = 0;

 virtual bool16 AddAttribute(const DOMAttributeID id, const DOMAttributeValue &value) = 0;

 virtual bool16 RemoveAttribute(const DOMAttributeID id) = 0;

 virtual bool16 InitializeAttributes(const IDOMElement::AttributeList &attributes, bool16 checkForSpecialObjects = kTrue) = 0;

 virtual bool16 HasContentChildren() = 0;

 virtual void AddContent(ContentType type, WideString& content) = 0;

};

#endif // __IDOMElement_h__