#include <IXMLMappingCommands.h>

Inheritance diagram for IXMLMappingCommands:

Public Types
enum	{ kDefaultIID = IID_IXMLMAPPINGCOMMANDS }

Public Member Functions
virtual ErrorCode	MapTagToStyle (const UIDRef &tagToStyleMap, UID tag, UID style)=0

virtual ErrorCode	UnMapTagToStyle (const UIDRef &tagToStyleMap, UID tag)=0

virtual ErrorCode	CopyTagToStyleMap (const UIDRef &sourceMap, const UIDRef &targetMap)=0

virtual ErrorCode	MapStyleToTag (const UIDRef &styleToTagMap, UID style, UID tag)=0

virtual ErrorCode	UnMapStyleToTag (const UIDRef &styleToTagMap, UID style)=0

virtual ErrorCode	CopyStyleToTagMap (const UIDRef &sourceMap, const UIDRef &targetMap)=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

Processes commands for creating, deleting, and manipulating mappings from tags to styles and styles to tags. Tag to style mappings are referenced during the XML import process to apply the approriate text styles to the incoming XML content. Style to tag mappings are used to automatically tag a document based on the ranges of text specified by style ranges.

Member Function Documentation

virtual ErrorCode IXMLMappingCommands::CopyStyleToTagMap	(	const UIDRef &	sourceMap,
		const UIDRef &	targetMap
	)

pure virtual

Copy the set of associations from one map to another.

Parameters

sourceMap	specifies source map (IXMLStyleToTagMap)
targetMap	specifies destination map (IXMLStyleToTagMap)

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

virtual ErrorCode IXMLMappingCommands::CopyTagToStyleMap	(	const UIDRef &	sourceMap,
		const UIDRef &	targetMap
	)

pure virtual

Copy the set of associations from one map to another.

Parameters

sourceMap	specifies source map (IXMLTagToStyleMap)
targetMap	specifies destination map (IXMLTagToStyleMap)

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

virtual ErrorCode IXMLMappingCommands::MapStyleToTag	(	const UIDRef &	styleToTagMap,
		UID	style,
		UID	tag
	)

pure virtual

Map the specified style to the specified tag. If the style has already been been associated with a tag then this will map the style to the new tag.

Parameters

styleToTagMap	styleToTagMap specifies IXMLStyleToTagMap
style	specifies style (from style name table, e.g. IStyleInfo)
tag	specifies the tag (IXMLTag) to associate with given style

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

virtual ErrorCode IXMLMappingCommands::MapTagToStyle	(	const UIDRef &	tagToStyleMap,
		UID	tag,
		UID	style
	)

pure virtual

Map the specified tag to the specified style. If the tag has already been been associated with a style then this will map the tag to the new style. Processes kXMLMapTagToStyleCmdBoss behind the facade

Parameters

tagToStyleMap	specifies tag-to-style map (IXMLTagToStyleMap)
tag	specifies tag to associate (IXMLTag)
style	specifies style (from style name table, e.g. IStyleInfo)

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

virtual ErrorCode IXMLMappingCommands::UnMapStyleToTag	(	const UIDRef &	styleToTagMap,
		UID	style
	)

pure virtual

Delete the mapping between a style and a tag.

Parameters

styleToTagMap	styleToTagMap specifies IXMLStyleToTagMap
style	from style name table (IStyleInfo) to remove from mapping

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

virtual ErrorCode IXMLMappingCommands::UnMapTagToStyle	(	const UIDRef &	tagToStyleMap,
		UID	tag
	)

pure virtual

Delete the mapping between a tag and a style. Processes kXMLUnMapTagToStyleCmdBoss behind the facade.

Parameters

tagToStyleMap	specifies tag-to-style map (IXMLTagToStyleMap)
tag	specifies the tag (IXMLTag)to remove from the mapping

Returns: ErrorCode kSuccess if operation could be completed, kFailure otherwise.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation