IStyleSyncService Class Reference

#include <IStyleSyncService.h>

Inheritance diagram for IStyleSyncService:

Public Member Functions
virtual PMIID	GetStyleInterfaceID ()=0
virtual PMString	GetGroupName ()=0
virtual PMString	GetStyleName ()=0
virtual bool16	IsCJKStyle ()=0
virtual void	DoSynchronization (IDFile sourceFile, IDocument *target)=0
virtual bool16	IsOptionOnByDefault ()=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

This interface is used to provide information of styles that are registered as synchronizable and do the actual synchronization(adding/modifying styles) by comparing the source/target documents.

Member Function Documentation

virtual void IStyleSyncService::DoSynchronization ( IDFile  sourceFile, IDocument *  target  )

pure virtual

Do the actual synchronization, e.g., copy/modify the styles from source document to target document.

Parameters

sourceFile	refers to the master document(also called style source) of the book.
target	refers to the document whose styles may be modified or new styles may be added into.

Returns

void.

Implemented in StyleSyncService.

virtual PMString IStyleSyncService::GetGroupName ( )

pure virtual

Get the group name that the style belongs to. For Roman version, there is only one group("All Styles"); for J version, we have two groups("All Styles" and "CJK Styles").

Returns

PMString the group name.

Implemented in StyleSyncService.

virtual PMIID IStyleSyncService::GetStyleInterfaceID ( )

pure virtual

Get the interface ID of style.

Returns

PMIID interface ID of style.

Implemented in StyleSyncService.

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

pure virtual

Return the style matching method. 

Returns

the style matching method set via SetStyleMatchingMethod.

Implemented in StyleSyncService.

virtual PMString IStyleSyncService::GetStyleName ( )

pure virtual

Get the registered synchronizable style name.

Returns

PMString the style name(e.g., TOC Style, Paragraph Style, Character Style etc.)

Implemented in StyleSyncService.

virtual bool16 IStyleSyncService::IsCJKStyle ( )

pure virtual

Check if this is a CJK style or not.

Returns

bool16 kTrue is CJK style, kFalse is NOT CJK style.

Implemented in StyleSyncService.

virtual bool16 IStyleSyncService::IsOptionOnByDefault ( )

pure virtual

Check if this option is turned on or off by default.

Returns

bool16 kTrue if it is turned on, otherwise return kFalse.

Implemented in StyleSyncService.

virtual void IStyleSyncService::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.

Implemented in StyleSyncService.