IXMLStructureSuite.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 _IXMLStructureSuite_
#define _IXMLStructureSuite_
//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "IXMLAccess.h"
 #include "IXMLElementCommands.h"
 #include "IXMLHandler.h"
 #include "ISAXServices.h"
 
class IXMLValidationErrorsCtrlData;
class XMLDTDValidationError;
class IDataLink;
class IXMLValidator;
class IAttributeErrorList;

//========================================================================================
//________________________________________________________________________________________
// CLASS DECLARATIONS
//________________________________________________________________________________________
class IXMLStructureSuite : public IPMUnknown
{
 //____________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IXMLSTRUCTURESUITE };

 virtual bool16 CanAddElement() const = 0;

 virtual bool16 WillAddChangeGraphicElementToText() const = 0;

 virtual ErrorCode AddElement(const UIDRef& tagRef) = 0;

 virtual bool16 CanWrapWithElement() const = 0;
 
 virtual ErrorCode WrapWithElement(const UIDRef& tagRef) = 0;

 virtual bool16 CanDeleteElements( bool16 deleteChildren = kTrue, bool16 deleteContent = kFalse ) const = 0;

 virtual ErrorCode DeleteElements( bool16 deleteChildren = kTrue, bool16 deleteContent = kFalse ) = 0;

 virtual bool16 CanDeleteSelection( bool16 deleteChildren = kTrue, bool16 deleteContent = kFalse ) const = 0;

 virtual ErrorCode DeleteSelection( bool16 deleteChildren = kTrue, bool16 deleteContent = kFalse ) = 0;

 virtual bool16 CanEditSelection() const = 0;

 virtual ErrorCode EditSelection() = 0;

 virtual void GetCommentInfo( PMString* comment) = 0;
 
 virtual void GetProcessingInstructionInfo( PMString* target, PMString* data) = 0;

 virtual bool16 CanAddAttribute() const = 0;

 virtual bool16 CanAddSpecificAttribute(const PMString& name) const = 0;

 virtual ErrorCode AddAttribute(const PMString& name, const PMString& value) = 0;


 virtual bool16 CanChangeOrReplaceAttribute() const = 0;

 virtual bool16 CanReplaceAttribute(const PMString& name) const = 0;

 virtual ErrorCode ChangeAttribute(const PMString& name, const PMString& value) = 0;

 virtual ErrorCode ReplaceAttribute(const PMString& name, const PMString& value) = 0;


 virtual bool16 CanDeleteAttributes() const = 0;

 virtual ErrorCode DeleteAttributes() = 0;


 virtual void GetAttributeInfo( PMString* name, PMString* value) = 0;

 virtual ErrorCode Export( IXMLAccess* access, IXMLHandler* exportHandler, const IDFile& sysFile, bool16 exportPageItem = kFalse,
 const PMString& formatName = "XML", UIFlags uiFlags = kSuppressUI) = 0;

 virtual bool16 IsExportable() const = 0;

 virtual ErrorCode Import( IDataBase *db, const IDFile *file, UIFlags flags ) = 0;

 virtual bool16 IsImportable() const = 0;

 virtual bool16 IsSelectionInErrorState(IAttributeErrorList *attrErrors) const = 0;

 virtual ErrorCode SelectErrorInValidation(IXMLValidationErrorsCtrlData *validationErrors, IAttributeErrorList *attrErrors) = 0;
 
 virtual bool16 CanValidateSelection() const = 0;

 virtual void ValidateSelection(IXMLValidator *errors) = 0;
 
 virtual bool16 CanSetTableTagPreference() const = 0;
 
 virtual ErrorCode SetTableTagPreference(IXMLElementCommands::TableTagPreference newSetting) = 0;
};



#endif // _IXMLStructureSuite_