IXMLParsingContext.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:
// An interface for keeping track of the parsing information when importing XML content.
// 
//========================================================================================

#ifndef __IXMLParsingContext_h__
#define __IXMLParsingContext_h__

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

class IXMLParsingContext : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IXMLPARSINGCONTEXT };
 
 virtual void Set(const XMLReference& element, const WideString& tagName, int32 childIndex, const UIDRef& storyRef, TextIndex insertPos, bool16 shouldInsert = kFalse) = 0;

 virtual void Set(IXMLParsingContext* parsingContext) = 0;

 virtual XMLReference GetElement() const = 0;
 
 virtual void SetElement(const XMLReference& element) = 0;
 
 virtual WideString GetTagName() const = 0;
 
 virtual void SetTagName(const WideString& tagName) = 0;
 
 virtual int32 GetChildIndex() const = 0;
 
 virtual void SetChildIndex(int32 childIndex) = 0;

 virtual UIDRef GetStoryRef() const = 0;
 
 virtual void SetStoryRef(const UIDRef& storyRef) = 0;
 
 virtual TextIndex GetInsertPos() const = 0;

 virtual void SetInsertPos(TextIndex insertPos) = 0;

 virtual bool16 ShouldInsert() const = 0;
 virtual void SetShouldInsert(bool16 doInsert) = 0;
};

#endif