#include <ISelectivelyLoadstyleCmdData.h>

Inheritance diagram for ISelectivelyLoadStyleCmdData:

Public Types
enum	{ kDefaultIID = IID_ISELECTIVELYLOADSTYLECMDDATA }

enum	LoadChoice { kLoadParagraphStyles = 0, kLoadCharacterStyles, kLoadParaCharStyles, kLoadObjectStyles, kLoadTextVariableTable, kLoadTableStyles, kLoadCellStyles, kLoadTableCellStyles }

Public Member Functions
virtual void	SetLoadStyleCmdInfo (const std::map< PMString, bool32 > &importStatus, const std::map< PMString, bool32 > &clashStatus, const std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &resolveClashStrategy, PMIID styleProtocol)=0

virtual void	GetLoadStyleCmdInfo (std::map< PMString, bool32 > &importStatusMap, std::map< PMString, bool32 > &clashStatusMap, std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &resolveClashStrategy, PMIID styleProtocol)=0

virtual void	SetImportStatus (const PMString &strStyleName, const bool32 status, PMIID styleProtocol)=0

virtual bool32	GetImportStatus (const PMString &strStyleName, PMIID styleProtocol) const =0

virtual void	SetAllImportStatus (bool32 status, PMIID styleProtocol)=0

virtual void	SetResolveClashStrategy (const PMString &strStyleName, const StyleClashResolutionTypes::StyleClashResolutionStrategy status, PMIID styleProtocol)=0

virtual StyleClashResolutionTypes::StyleClashResolutionStrategy	GetResolveClashStrategy (const PMString &strStyleName, PMIID styleProtocol) const =0

virtual void	ResetLoadStyleCmdInfo ()=0

virtual void	SetSourceIDDoc (IDocument *doc)=0

virtual IDocument *	GetSourceIDDoc () const =0

virtual void	SetUserCancelled (bool32 UserCancelled)=0

virtual bool32	GetUserCancelled () const =0

virtual void	SetGlobalClashResolutionStrategy (const StyleClashResolutionTypes::GlobalClashResolutionStrategy val)=0

virtual StyleClashResolutionTypes::GlobalClashResolutionStrategy	GetGlobalClashResolutionStrategy () const =0

virtual bool32	GetStyleClashStatus (const PMString styleName, PMIID styleProtocol) const =0

virtual void	SetAutoStyleNameMap (const std::map< PMString, PMString > &AutoStyleNameMap, PMIID styleProtocol)=0

virtual void	GetAutoStyleNameMap (std::map< PMString, PMString > &AutoStyleNameMap, PMIID styleProtocol) const =0

virtual void	SetLoadStyleTypes (const K2Vector< PMIID > &loadStyleTypes)=0

virtual K2Vector< PMIID >	GetLoadStyleTypes () const =0

virtual void	SetStyleMatchingStrategy (StyleClashResolutionTypes::StyleMatchingStrategyEnum styleMatchingStrategy)=0

virtual StyleClashResolutionTypes::StyleMatchingStrategyEnum	GetStyleMatchingStrategy () const =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

ISelectivelyLoadStyleCmdData is an interface for getting/setting/modifying the data needed for selectively loading styles.

Member Enumeration Documentation

enum ISelectivelyLoadStyleCmdData::LoadChoice

The choices for loading styles
Enumerator
kLoadParagraphStyles
Load Paragraph styles
kLoadCharacterStyles
Load Character styles
kLoadParaCharStyles
Load both Paragraph and Character styles
kLoadObjectStyles
Load Object styles
kLoadTextVariableTable
Load Text Variables
kLoadTableStyles
Load Table styles
kLoadCellStyles
Load Cell styles
kLoadTableCellStyles
Load both Table and Cell styles

Member Function Documentation

virtual void ISelectivelyLoadStyleCmdData::GetAutoStyleNameMap	(	std::map< PMString, PMString > &	AutoStyleNameMap,
		PMIID	styleProtocol
	)		const

pure virtual

Gets the Auto styleName Map

Parameters

AutoStyleNameMap	OUT map of stylename1 and stylename2 (where stylename1 in source document is mapped to stylename2 in destination document)
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual StyleClashResolutionTypes::GlobalClashResolutionStrategy ISelectivelyLoadStyleCmdData::GetGlobalClashResolutionStrategy ( ) const

pure virtual

Get Global Clash Resolution Strategy

Returns: current Global Clash Resolution Strategy

virtual bool32 ISelectivelyLoadStyleCmdData::GetImportStatus	(	const PMString &	strStyleName,
		PMIID	styleProtocol
	)		const

pure virtual

Gets the Import Status of strStyleName

Parameters

strStyleName	"Style name"
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

Returns: Import status of strStyleName

virtual void ISelectivelyLoadStyleCmdData::GetLoadStyleCmdInfo	(	std::map< PMString, bool32 > &	importStatusMap,
		std::map< PMString, bool32 > &	clashStatusMap,
		std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &	resolveClashStrategy,
		PMIID	styleProtocol
	)

pure virtual

Gets the Load Style Command Data

Parameters

importStatusMap	OUT map of "Style name" and import status of this style
clashStatusMap	OUT map of "Style name" and clash status of this style
resolveClashStrategy	OUT map of "Style name" and strategy to resolve clash for this style
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual K2Vector<PMIID> ISelectivelyLoadStyleCmdData::GetLoadStyleTypes ( ) const

pure virtual

Gets the types of styles to load

Returns: loadStyleTypes vector of protocols to load

virtual StyleClashResolutionTypes::StyleClashResolutionStrategy ISelectivelyLoadStyleCmdData::GetResolveClashStrategy	(	const PMString &	strStyleName,
		PMIID	styleProtocol
	)		const

pure virtual

Gets the strategy to resolve clash of strStyleName

Parameters

strStyleName	"Style name"
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

Returns: strategy to resolve clash of strStyleName

virtual IDocument* ISelectivelyLoadStyleCmdData::GetSourceIDDoc ( ) const

pure virtual

Gets the Source Document

Returns: Source Document

virtual bool32 ISelectivelyLoadStyleCmdData::GetStyleClashStatus	(	const PMString	styleName,
		PMIID	styleProtocol
	)		const

pure virtual

Gets the Clash Status of styleName

Parameters

styleName	"Style name"
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

Returns: Clash status of styleName

virtual StyleClashResolutionTypes::StyleMatchingStrategyEnum ISelectivelyLoadStyleCmdData::GetStyleMatchingStrategy ( ) const

pure virtual

Return the style matching method.

Returns: the style matching method set via SetStyleMatchingMethod.

virtual bool32 ISelectivelyLoadStyleCmdData::GetUserCancelled ( ) const

pure virtual

Get if User Cancelled

Returns: whether user cancelled

virtual void ISelectivelyLoadStyleCmdData::ResetLoadStyleCmdInfo ( )

pure virtual

Reset the Load Style Command Data

virtual void ISelectivelyLoadStyleCmdData::SetAllImportStatus	(	bool32	status,
		PMIID	styleProtocol
	)

pure virtual

Sets the Import Status of All Styles to status

Parameters

status	Import status
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual void ISelectivelyLoadStyleCmdData::SetAutoStyleNameMap	(	const std::map< PMString, PMString > &	AutoStyleNameMap,
		PMIID	styleProtocol
	)

pure virtual

Sets the Auto styleName Map

Parameters

AutoStyleNameMap	map of stylename1 and stylename2 (where stylename1 in source document is mapped to stylename2 in destination document)
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual void ISelectivelyLoadStyleCmdData::SetGlobalClashResolutionStrategy ( const StyleClashResolutionTypes::GlobalClashResolutionStrategy val )

pure virtual

Set Global Clash Resolution Strategy

Parameters

val	option for Global Clash Resolution Strategy

virtual void ISelectivelyLoadStyleCmdData::SetImportStatus	(	const PMString &	strStyleName,
		const bool32	status,
		PMIID	styleProtocol
	)

pure virtual

Sets the Import Status of strStyleName to status

Parameters

strStyleName	"Style name"
status	Import status of strStyleName
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual void ISelectivelyLoadStyleCmdData::SetLoadStyleCmdInfo	(	const std::map< PMString, bool32 > &	importStatus,
		const std::map< PMString, bool32 > &	clashStatus,
		const std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &	resolveClashStrategy,
		PMIID	styleProtocol
	)

pure virtual

Sets the Load Style Command Data

Parameters

importStatusMap	map of "Style name" and import status of this style
clashStatusMap	map of "Style name" and clash status of this style
resolveClashStrategy	map of "Style name" and strategy to resolve clash for this style
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual void ISelectivelyLoadStyleCmdData::SetLoadStyleTypes ( const K2Vector< PMIID > & loadStyleTypes )

pure virtual

Sets the types of styles to load

Parameters

loadStyleTypes vector of protocols to load

virtual void ISelectivelyLoadStyleCmdData::SetResolveClashStrategy	(	const PMString &	strStyleName,
		const StyleClashResolutionTypes::StyleClashResolutionStrategy	status,
		PMIID	styleProtocol
	)

pure virtual

Sets the strategy to resolve clash of strStyleName to status

Parameters

strStyleName	"Style name"
status	strategy to resolve clash of strStyleName
styleProtocol	protocol to use (for example : IID_IPARASTYLEGROUPMANAGER, IID_ICHARSTYLEGROUPMANAGER or IID_IOBJECTSTYLEGROUPMANAGER)

virtual void ISelectivelyLoadStyleCmdData::SetSourceIDDoc ( IDocument * doc )

pure virtual

Sets the Source Document

Parameters

doc	Source Document

virtual void ISelectivelyLoadStyleCmdData::SetStyleMatchingStrategy ( StyleClashResolutionTypes::StyleMatchingStrategyEnum styleMatchingStrategy )

pure virtual

Sets the Style matching Strategy, This choice is not on per style type basis. If set then this will be used for all the style types for that load style command.

Note: This value will be only used if the global clash resolution strategy is StyleClashResolutionTypes::kLoadAllWithOverwrite or Individual styles resolve strategy is StyleClashResolutionStrategy::kUseIncomingStyleDefinition. In all other cases style's full path will be used for matching the styles in target.

Parameters

styleMatchingStrategy [IN] To find the clashing style in target, Uses full path of style if kMatchStyleFullPath is passed if kMatchStyleName is passed then matches style with the same name at any location if the style is unique in target. if same name style exist in more then one location then falls back to matching styles path.

virtual void ISelectivelyLoadStyleCmdData::SetUserCancelled ( bool32 UserCancelled )

pure virtual

Set if User Cancelled

Parameters

UserCancelled user cancelled choice

Enumerator
kLoadParagraphStyles	Load Paragraph styles
kLoadCharacterStyles	Load Character styles
kLoadParaCharStyles	Load both Paragraph and Character styles
kLoadObjectStyles	Load Object styles
kLoadTextVariableTable	Load Text Variables
kLoadTableStyles	Load Table styles
kLoadCellStyles	Load Cell styles
kLoadTableCellStyles	Load both Table and Cell styles

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation