InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXCatHndFacade Class Referenceabstract

#include <IXCatHndFacade.h>

Inheritance diagram for IXCatHndFacade:
IPMUnknownCPMUnknown< IXCatHndFacade >XCatHndFacade

Public Types

enum  { kDefaultIID = IID_IXCATHNDFACADE }
 

Public Member Functions

virtual ErrorCode AddPublicToUriMapping (const WideString &publicId, const WideString &uri)=0
 
virtual WideString ResolvePublicToUri (const WideString &publicId)=0
 
virtual ErrorCode LoadCatalog (const IDFile &catalogName) const =0
 
virtual IDFile GetDefaultXMLCatalogFile () const =0
 
virtual bool16 IsUsingAcquirerFilter () const =0
 
virtual int32 GetXMLBaseCount () const =0
 
virtual WideString GetNthXMLBase (int32 n) const =0
 
virtual ErrorCode AddXMLBase (const WideString &xmlBase)=0
 
virtual ErrorCode LoadPeerCatalog (const IDFile &xmlFile)=0
 
virtual WideString TranslateURIToPlatformSpec (const WideString &uri) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Facade interface defining utility methods used by disparate objects within this plug-in, and also offers API to a potential UI plug-in to interact this model plug-in.

Member Enumeration Documentation

anonymous enum

Default interface identifier for UseDefaultIID

See Also
UseDefaultIID

Member Function Documentation

virtual ErrorCode IXCatHndFacade::AddPublicToUriMapping (const WideStringpublicId,
const WideStringuri 
)
pure virtual

Adds another entry to stored mapping between PUBLIC and SYSTEM ids IXCatHndEntityMapping::AddMapping

Parameters
publicId
uri
Returns
ErrorCode

Implemented in XCatHndFacade.

virtual ErrorCode IXCatHndFacade::AddXMLBase (const WideStringxmlBase)
pure virtual

Add another xml:base to list stored

Parameters
xmlBase
Returns
ErrorCode

Implemented in XCatHndFacade.

virtual IDFile IXCatHndFacade::GetDefaultXMLCatalogFile () const
pure virtual

Get identifier for the default XML catalog to load (for instance on startup)

Returns
IDFile

Implemented in XCatHndFacade.

virtual WideString IXCatHndFacade::GetNthXMLBase (int32 n) const
pure virtual

Get an xml:base by index

Parameters
n
Returns
WideString

Implemented in XCatHndFacade.

virtual int32 IXCatHndFacade::GetXMLBaseCount () const
pure virtual

Get size of list of xml:base paths stored

Parameters
none
Returns
int32
See Also
IXCatHndEntityMapping

Implemented in XCatHndFacade.

virtual bool16 IXCatHndFacade::IsUsingAcquirerFilter () const
pure virtual
Returns
kTrue if on

Implemented in XCatHndFacade.

virtual ErrorCode IXCatHndFacade::LoadCatalog (const IDFilecatalogName) const
pure virtual

Load a catalog by file identifier

Parameters
catalogName
Returns
ErrorCode

Implemented in XCatHndFacade.

virtual ErrorCode IXCatHndFacade::LoadPeerCatalog (const IDFilexmlFile)
pure virtual

Load a catalog that is in same folder as XML file to import

Parameters
xmlFile
Returns
ErrorCode

Implemented in XCatHndFacade.

virtual WideString IXCatHndFacade::ResolvePublicToUri (const WideStringpublicId)
pure virtual

Given a public identifier, find associated URI referring to local system

Parameters
publicId
Returns
WideString

Implemented in XCatHndFacade.