#include <IXDocBkFacade.h>

Inheritance diagram for IXDocBkFacade:

Public Types
enum	{ kDefaultIID = IID_IXDOCBKFACADE }

Public Member Functions
virtual ErrorCode	SetOptions (const K2Vector< WideString > &optionsVec)=0

virtual bool16	AreOptionsSet ()=0

virtual ErrorCode	ResizeInlines (const UIDRef &documentUIDRef)=0

virtual ErrorCode	ImportXMLFile (const IDFile &xmlFile, const UIDRef &destDocumentUIDRef, const PMString &stylesheetPath)=0

virtual ErrorCode	ExportXMLFile (const IDFile &sysFile, IDocument doc, IPMUnknown targetboss, const PMString &formatName, UIFlags uiFlags)=0

virtual PMString	GetTemplatePath ()=0

virtual PMString	GetDefaultTemplateFromFolder (const IDFile &importingXMLFile)=0

virtual PMString	GetStylesheetPath ()=0

virtual ErrorCode	SetUseXMLTransformer (bool16 newState)=0

virtual ErrorCode	SetUsePostImportIterator (bool16 newState)=0

virtual ErrorCode	SetUseCALSContentHandler (bool16 newState)=0

virtual bool16	IsUsingXMLTransformer ()=0

virtual bool16	IsUsingPostImportIterator ()=0

virtual bool16	IsUsingCALSContentHandler ()=0

virtual ErrorCode	SetDeleteNamespacedAttrs (bool16 newState)=0

virtual bool16	IsDeleteNamespacedAttrs ()=0

virtual ErrorCode	SetDeleteInboundStrucTableElements (bool16 newState)=0

virtual bool16	IsDeleteInboundStrucTableElements ()=0

virtual bool16	IsTaggingTable ()=0

virtual bool16	IsSuppliedXSLOverridingPI ()=0

virtual ErrorCode	SetSuppliedXSLOverridingPI (bool16 newState)=0

virtual ErrorCode	SetTaggingTable (bool16 newState)=0

virtual void	UnitTestFacade ()=0

virtual PMString	AddPathSeparator (const PMString &path)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

From SDK sample; facade interface that represents the main capabilities required from client code.

TODO the comment above seems to indicate that the class is not cohesive enough to be described functionally. facade that does this or that (import/import XML) would be more useful to reader.

TODO "From SDK sample" are you suggesting all sample code needs this?

See Also: XDocBookWorkflowUI

Member Enumeration Documentation

anonymous enum

Default interface identifier for UseDefaultIID

See Also: UseDefaultIID

Member Function Documentation

virtual PMString IXDocBkFacade::AddPathSeparator ( const PMString & path )

pure virtual

Append platform path separator to string

Parameters

path	input string

Returns: path input with platform path separator appended

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::AreOptionsSet ( )

pure virtual

Have options been set up? Decouple client code from knowledge of all options

Returns: kTrue if options set, kFalse otherwise

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::ExportXMLFile	(	const IDFile &	sysFile,
		IDocument *	doc,
		IPMUnknown *	targetboss,
		const PMString &	formatName,
		UIFlags	uiFlags
	)

pure virtual

Export XML logical structure from given document into specified file

Parameters

sysFile	IN file to export to
doc	IN where logical structure comes from
targetBoss	IN may carry a selection or nil if not exporting from selection

Returns: kSuccess on success, other ErrorCode otherwise.

virtual PMString IXDocBkFacade::GetDefaultTemplateFromFolder ( const IDFile & importingXMLFile )

pure virtual

Return string based representation of path for default template in same folder

Parameters

importingXMLFile

Returns: string giving path to template

Implemented in XDocBkFacade.

virtual PMString IXDocBkFacade::GetStylesheetPath ( )

pure virtual

Return path to optional XSL stylesheet

Returns: stylesheet path, empty if not set up

Implemented in XDocBkFacade.

virtual PMString IXDocBkFacade::GetTemplatePath ( )

pure virtual

Return string based representation of path to template for importing into

Returns: string giving path to template, empty if not set up (see SetOptions)

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::ImportXMLFile	(	const IDFile &	xmlFile,
		const UIDRef &	destDocumentUIDRef,
		const PMString &	stylesheetPath
	)

pure virtual

Imports XML file into specified document

Parameters

xmlFile	IN file to import
destDocumentUIDRef	IN target document
stylesheetPath	optional XSL stylesheet path, which can be empty

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsDeleteInboundStrucTableElements ( )

pure virtual

Determine if option to delete aid:xxx attrs is turned on

Returns: kTrue if turned on, kFalse if turned off

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsDeleteNamespacedAttrs ( )

pure virtual

Determine if option to delete aid:xxx attrs is turned on

Returns: kTrue if turned on, kFalse if turned off

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsTaggingTable ( )

pure virtual

Determine whether the option to tag created table is turned on

Returns: kTrue if turned on, kFalse if turned off

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsUsingCALSContentHandler ( )

pure virtual

Determine if SAX Handler to create tables from CALS model is turned on

Returns: kTrue if using CALS SAX handler to create tables, kFalse otherwise

See Also: ISAXDOMSerializerHandler

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsUsingPostImportIterator ( )

pure virtual

Returns: kTrue if post-import iterator for placing images is enabled, kFalse if not

See Also: IXMLPostImportIteration

Implemented in XDocBkFacade.

virtual bool16 IXDocBkFacade::IsUsingXMLTransformer ( )

pure virtual

Determine if the XML transformer (on stream) is being used to apply context sensitive styling through XSLT

Returns: kTrue if use of XML transformer on inbound stream is enabled, kFalse if not

See Also: IXMLTransformer

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::ResizeInlines ( const UIDRef & documentUIDRef )

pure virtual

Resize inlines in document to fit within width of columns

Returns: kSuccess on success, other ErrorCode otherwise

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetDeleteInboundStrucTableElements ( bool16 newState )

pure virtual

Set option to delete aid:xxx attrs on import

Returns: kSuccess on success, other ErrorCode otherwise

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetDeleteNamespacedAttrs ( bool16 newState )

pure virtual

Set option to delete aid:xxx attrs on import

Returns: kSuccess on success, other ErrorCode otherwise

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetOptions ( const K2Vector< WideString > & optionsVec )

pure virtual

Sets the persistent options (IXDocBkOptions) on the session workspace (kWorkspaceBoss).

Parameters

optionsVec IN K2Vector of PMString objects, containing the options.

Returns: kSuccess on success, other ErrorCode otherwise.

See Also: IXDocBkOptions; kWorkspaceBoss; kXDocBkChangeOptionsCmdBoss

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetTaggingTable ( bool16 newState )

pure virtual

Set option to tag created table

Returns: kSuccess on success, other ErrorCode otherwise

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetUseCALSContentHandler ( bool16 newState )

pure virtual

Change service-specific preference to use SAX handler to create images

Returns: kSuccess on success, other ErrorCode otherwise

See Also: ISAXDOMSerializerHandler

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetUsePostImportIterator ( bool16 newState )

pure virtual

Change service-specific preference to use post-import iterator to place images

Returns: kSuccess on success, other ErrorCode otherwise

See Also: IXMLPostImportIteration

Implemented in XDocBkFacade.

virtual ErrorCode IXDocBkFacade::SetUseXMLTransformer ( bool16 newState )

pure virtual

Change service-specific preference to use our XML transformer on stream.

Parameters

newState specifies turn on (kTrue) or off (kFalse)

Returns: kSuccess on success, other ErrorCode otherwise

See Also: IXMLTransformer

Implemented in XDocBkFacade.

virtual void IXDocBkFacade::UnitTestFacade ( )

pure virtual

Method that just exercises methods on this facade

Implemented in XDocBkFacade.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation