IIDXMLDOMNode.h

//========================================================================================
// 
// $File$
// 
// Owner: Ryan Gano
// 
// $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 __IIDXMLDOMNode_h__
#define __IIDXMLDOMNode_h__

class ISAXServices;
class IIDXMLDOMNamedNodeMap;
class IIDXMLDOMNList;
class IIDXMLDOMDocument;

// Forward declare this in the proper namespace
namespace BIB_NAMESPACE {
 class CAXENodeDOM;
}

class IIDXMLDOMNode
{
public:
 typedef enum {
 kElement, 
 kDocument, 
 kText, 
 kProcessingInstruction, 
 kAttribute, 
 kComment, 
 kUnknown} kNodeTypes;

 virtual ~IIDXMLDOMNode() {}
 
 virtual IIDXMLDOMNode *CloneNode(bool deepClone) = 0;

 virtual bool16 IsValid() const = 0;

 virtual IIDXMLDOMNode::kNodeTypes GetNodeType() const = 0;

 virtual bool16 GetLocalName(WideString& localName) const = 0;

 virtual bool16 GetNamespaceURI(WideString& namespaceURI) const = 0;

 virtual bool16 GetNodeName(WideString& name) const = 0;
 
 virtual bool16 GetNodeValue(WideString& value) const = 0;

 virtual void SetNodeValue(const WideString& val) = 0;

 virtual bool16 GetPrefix(WideString& prefix) const = 0;

 virtual void SetPrefix(const WideString& prefix) = 0;
 
 virtual IIDXMLDOMNamedNodeMap *GetAttributes() const = 0;
 
 virtual bool16 HasChildNodes() const = 0;
 
 virtual IIDXMLDOMNList *GetChildNodes() const = 0;

 virtual IIDXMLDOMNode *GetFirstChild() const = 0;

 virtual IIDXMLDOMNode *GetLastChild() const = 0;
 
 virtual IIDXMLDOMNode *GetNextSibling() const = 0;

 virtual IIDXMLDOMNode *GetPreviousSibling() const = 0;
 
 virtual IIDXMLDOMNode *GetParentNode() const = 0;

 /*
 Owner document

 Get the owner document for this node. This is also the
 CAXEDocumentDOM object used to create new nodes. When this
 node is a CAXEDocumentDOM or a CAXEDocTypeDOM which is not
 used with any document yet, false is returned.

 @param owner An output parameter that is assigned
 with the owner document node, if
 there is one, otherwise it is left
 unchanged.

 @return 'true' if there is an owner document,
 'false' otherwise.

 */
 virtual IIDXMLDOMDocument *GetOwnerDocument() const = 0;
 
 virtual void InsertBefore(IIDXMLDOMNode* newNode, IIDXMLDOMNode* whichNode) = 0;

 virtual void AppendChild(IIDXMLDOMNode *newChild) = 0;

 virtual void ReplaceChild(IIDXMLDOMNode *newChild, IIDXMLDOMNode *oldChild) = 0;

 /*
 Remove child node
 
 Removes the child node from the list of children
 
 @param oldChild Child node to remove from child list
 
 @return The node removed
 */
 virtual IIDXMLDOMNode *RemoveChild(IIDXMLDOMNode* oldChild) = 0;

 virtual BIB_NAMESPACE::CAXENodeDOM GetAXEObject() = 0;
};

#endif