SnpXMLHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SnpXMLHelper_H_DEFINED__
#define __SnpXMLHelper_H_DEFINED__




class SnpXMLHelper
{
public:

 SnpXMLHelper() {}

 virtual ~SnpXMLHelper() {}


 UIDRef AcquireTag(const UIDRef& documentUIDRef,
 const PMString& tagName);


 ErrorCode AssociateDTD(const UIDRef& documentUIDRef, const IDFile& dtdFile);


 PMString AsString(const UIDRef& tagUIDRef);
 
 PMString AsString(const XMLReference& xmlReference);


 ErrorCode ChangeTagName(const UIDRef& tagUIDRef,
 const PMString& newTagName);


 PMString GetClassFrom(const ClassID& classID);

 PMString GetClassFrom(const UIDRef& objUIDRef);

 XMLReference GetRootXMLReference(const UIDRef& documentUIDRef);



 TextIndex InsertTaggedText(const UIDRef& textModelUIDRef, const PMString& pstr, 
 TextIndex startIndex, const PMString& tagName);


 ErrorCode PlaceElement(const XMLReference& xmlRef, const UIDRef& graphicFrameUIDRef);

 ErrorCode SetExportFromSelected(const UIDRef& workspaceUIDRef, bool16 state);

 ErrorCode SetImportIntoSelected(const UIDRef& workspaceUIDRef, bool16 state);

 ErrorCode SetRootTag(const UIDRef& documentUIDRef, const PMString& tagName);


 ErrorCode ShowHideTaggedFrames(bool16 setVisible);

 ErrorCode TagStory(const UIDRef& textModelUIDRef, const PMString& tagName);

 ErrorCode TagTable(const UIDRef& tableModelUIDRef, 
 const PMString & tableTagName, 
 const PMString& cellTagName, 
 XMLReference& outCreatedXMLReference);


 ErrorCode TagTextRange(const UIDRef& textModelUIDRef, 
 const PMString& tagName, 
 TextIndex startIndex, 
 TextIndex endIndex);
 

 
protected:
 ErrorCode InsertText(const UIDRef& textModelUIDRef, const PMString& data, const TextIndex& position);

};



#endif // __SnpXMLHelper_H_DEFINED__

//End, SnpXMLHelper.h