IIDXMLElement.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 __IIDXMLElement__
#define __IIDXMLElement__

#include "K2Iterator.h"
#include "TextRange.h"
#include "XMLContentReference.h"
#include "XMLID.h"
#include "XMLReference.h" // for LSID

#include "IPMUnknown.h"


typedef int32 LayoutSelector;
const LayoutSelector kStandardLayout = 1;


class ITextStoryThread;
class XMLContentIterator;
class XMLDTDInsertElementList;
class XMLDTDReplaceElementList;

class IIDXMLElement : public IPMUnknown {
public:
 enum { kDefaultIID = IID_IIDXMLELEMENT };

 enum _Placement { kEndIndex = -2 };

 // Typedefs for content iteration
 typedef InDesign::TextRange value_type;
 typedef XMLContentIterator iterator;
 typedef XMLContentIterator const_iterator;
 typedef const value_type* pointer;
 typedef const value_type* const_pointer;
 typedef const value_type& reference;
 typedef const value_type& const_reference;
 typedef K2Reverse_iterator<iterator, value_type, std::ptrdiff_t, pointer, reference> reverse_iterator;
 typedef K2Reverse_iterator<const_iterator, value_type, std::ptrdiff_t, const_pointer, const_reference> const_reverse_iterator;

 virtual const XMLReference& GetXMLReference() const = 0;

 virtual void SetXMLReference(const XMLReference& newXMLRef) = 0;

 virtual int32 GetChildCount() const = 0;
 
 virtual XMLReference GetNthChild(int32) const = 0;
 
 virtual const XMLReference& GetParent() const = 0;
 

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

 virtual XMLReference FindChild(const WideString& tag, int32 index) const = 0;

 virtual int32 FindChild(const XMLReference& childToFind) const = 0;


 virtual void AddChildAt(const XMLReference& newChild, int32 indexAt, bool16 setChildsParent = kTrue) = 0;


 virtual void RemoveChild(const XMLReference& childToRemove, bool16 resetChild = kTrue) = 0;

 virtual void RemoveChild(int32 indexAt, bool16 resetChild = kTrue) = 0;

 virtual void SetChildAt(const XMLReference& newChildXMLRef, int32 indexAt) = 0;


 virtual UID GetTagUID() const = 0;

 virtual WideString GetTagString() const = 0;

 virtual void SetTag(UID newTag) = 0;

 virtual void SetTag(const WideString& newTag) = 0;
 
 virtual UID GetContentItem(LayoutSelector selector = kStandardLayout) const = 0;

 virtual void SetContentItem(UID contentItem, LayoutSelector selector = kStandardLayout) = 0;

 virtual const XMLContentReference& GetContentReference(void) const = 0;

 virtual void SetContentReference(const XMLContentReference& contentReference) = 0;

 virtual ITextStoryThread *QueryContentTextStoryThread(void) const = 0;
 
 virtual void AddAttribute(const WideString& name, const WideString& value, bool16 removable = kTrue) = 0;

 virtual void RemoveAttribute(const WideString& name) = 0;

 virtual void SetAttributeName(const WideString& name, const WideString& newName) = 0;

 virtual void SetAttributeValue(const WideString& name, const WideString& newValue) = 0;


 virtual int32 GetAttributeCount() const = 0;

 virtual bool16 HasAttribute(const WideString& name) const = 0;

 virtual WideString GetAttributeNameAt(int32 pos) const = 0;

 virtual WideString GetAttributeValue(const WideString& name) const = 0;

 virtual WideString GetAttributeValueAt(int32 pos) const = 0;

 virtual bool16 IsAttributeRemovable(const WideString& name) const = 0;


 virtual const_iterator begin() const = 0;

 virtual const_iterator end() const = 0;

 virtual const_iterator make_iterator(int32 position) const = 0;


 virtual const_reverse_iterator rbegin() const = 0;

 virtual const_reverse_iterator rend() const = 0;

 virtual const_reverse_iterator rmake_iterator(int32 position) const = 0;
 
 virtual void GetInsertChildElementList(XMLDTDInsertElementList& childElementList) const = 0;
 
 virtual void GetInsertSiblingAfterList(XMLDTDInsertElementList& siblingAfterList) const = 0;
 
 virtual void GetReplaceElementList(XMLDTDReplaceElementList& replaceElementList) const = 0;
};


#endif // __IIDXMLElement__